Package org.xbill.DNS

Class Zone

java.lang.Object

org.xbill.DNS.Zone

All Implemented Interfaces:

Serializable, Iterable<RRset>

public class Zone
extends Object
implements Serializable, Iterable<RRset>

A DNS zone. This encapsulates all data related to a zone, and provides convenient lookup methods. A zone always contains a SOARecord and at least one NSRecord.

Author:

Brian Wellington

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PRIMARY	A primary zone.
static final int	SECONDARY	A secondary zone.

Constructor Summary

Constructors

Constructor	Description
Zone(Name zone, int dclass, String remote)	Creates a zone by performing a zone transfer from the specified host.
Zone(Name zone, String file)	Creates a zone from the records in the specified master file.
Zone(Name zone, Record... records)	Creates a zone from an array of records.
Zone(ZoneTransferIn xfrin)	Creates a zone by doing the specified zone transfer.

Method Summary

Modifier and Type	Method	Description
<T extends Record> void	addRecord(T r)	Adds a record to the zone.
void	addRRset(RRset rrset)	Adds an RRset to the zone.
Iterator<RRset>	AXFR()	Returns an Iterator over the RRsets in the zone that can be used to construct an AXFR response.
RRset	findExactMatch(Name name, int type)	Looks up Records in the zone, finding exact matches only.
SetResponse	findRecords(Name name, int type)	Looks up Records in the zone.
int	getDClass()	Returns the zone's class.
RRset	getNS()	Returns the zone origin's NS records.
Name	getOrigin()	Returns the zone's origin.
SOARecord	getSOA()	Returns the zone's SOA record.
Iterator<RRset>	iterator()	Returns an iterator over the RRsets in the zone.
void	removeRecord(Record r)	Removes a record from the zone.
void	removeRRset(Name name, int type)	Removes an RRset from the zone.
String	toMasterFile()	Returns the contents of the zone in master file format.
String	toString()	Returns the contents of the zone as a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

PRIMARY

public static final int PRIMARY

A primary zone.

See Also:

• Constant Field Values

SECONDARY

public static final int SECONDARY

A secondary zone.

See Also:

• Constant Field Values

Constructor Details

Zone

public Zone(Name zone,
 String file)
     throws IOException

Creates a zone from the records in the specified master file.

Parameters:

zone - The name of the zone.

file - The master file to read from.

Throws:

IllegalArgumentException - if zone or file is null.

IOException - if the zone file does not contain a SOARecord or no NSRecords.

See Also:

• Master

Zone

public Zone(Name zone,
 Record... records)
     throws IOException

Creates a zone from an array of records.

Parameters:

zone - The name of the zone.

records - The records to add to the zone.

Throws:

IllegalArgumentException - if zone or records is null.

IOException - if the records do not contain a SOARecord or no NSRecords.

See Also:

• Master

Zone

public Zone(ZoneTransferIn xfrin)
     throws IOException,
ZoneTransferException

Creates a zone by doing the specified zone transfer.

Parameters:

xfrin - The incoming zone transfer to execute.

Throws:

IllegalArgumentException - if xfrin is null.

IOException - if the zone does not contain a SOARecord or no NSRecords.

ZoneTransferException

See Also:

• ZoneTransferIn

Zone

public Zone(Name zone,
 int dclass,
 String remote)
     throws IOException,
ZoneTransferException

Creates a zone by performing a zone transfer from the specified host. This uses the default port and no TSIG. Use Zone(ZoneTransferIn) for more control.

Parameters:

zone - The zone to transfer.

dclass - The DClass of the zone to transfer.

remote - The remote host to transfer from.

Throws:

IllegalArgumentException - if zone or remote is null.

IOException - if the zone does not contain a SOARecord or no NSRecords.

InvalidDClassException - if dclass is not a valid DClass.

ZoneTransferException

See Also:

• ZoneTransferIn

Method Details

getDClass

public int getDClass()

Returns the zone's class.

getNS

public RRset getNS()

Returns the zone origin's NS records.

iterator

public Iterator<RRset> iterator()

Returns an iterator over the RRsets in the zone.

Specified by:

iterator in interface Iterable<RRset>

AXFR

public Iterator<RRset> AXFR()

Returns an Iterator over the RRsets in the zone that can be used to construct an AXFR response. This is identical to iterator() except that the SOA is returned at the end as well as the beginning.

addRecord

public <T extends Record> void addRecord(T r)

Adds a record to the zone. If there is an existing RRset of the same Name and Type, the record is added to this set.

Parameters:

r - The record to add.

Throws:

IllegalArgumentException - if name is null or if the rrset name does not match the zone origin.

removeRecord

public void removeRecord(Record r)

Removes a record from the zone.

Parameters:

r - The record to remove.

Throws:

IllegalArgumentException - if r is null, if the record to remove is the SOARecord or the last NSRecord.

addRRset

public void addRRset(RRset rrset)

Adds an RRset to the zone.

Parameters:

rrset - The RRset to add.

Throws:

IllegalArgumentException - if rrset is null or if the rrset name is not a subdomain of the zone origin (or, in case of a SOA, is not equal to the zone origin).

See Also:

• RRset

removeRRset

public void removeRRset(Name name,
 int type)

Removes an RRset from the zone.

Parameters:

name - The name to remove.

type - The type to remove.

Throws:

IllegalArgumentException - if name is null.

InvalidTypeException - if the specified type is invalid or Type.SOA or Type.NS.

Since:

3.6

See Also:

• RRset

findExactMatch

public RRset findExactMatch(Name name,
 int type)

Looks up Records in the zone, finding exact matches only.

Parameters:

name - The name to look up

type - The type to look up

Returns:

The matching RRset or null if no exact match is found.

Throws:

IllegalArgumentException - if name is null.

InvalidTypeException - if the specified type is invalid.

See Also:

• RRset

findRecords

public SetResponse findRecords(Name name,
 int type)

Looks up Records in the zone. The answer can be a CNAME instead of the actual requested type and wildcards are expanded.

Parameters:

name - The name to look up

type - The type to look up

Returns:

A SetResponse object

Throws:

IllegalArgumentException - if name is null.

InvalidTypeException - if the specified type is invalid.

See Also:

• SetResponse

toMasterFile

public String toMasterFile()

Returns the contents of the zone in master file format.

See Also:

• Master

toString

public String toString()

Returns the contents of the zone as a string.

Overrides:

toString in class Object

See Also:

• toMasterFile()

getOrigin

public Name getOrigin()

Returns the zone's origin.

getSOA

public SOARecord getSOA()

Returns the zone's SOA record.