Package org.xbill.DNS

Class ZoneTransferIn

java.lang.Object

org.xbill.DNS.ZoneTransferIn

public class ZoneTransferIn
extends Object

An incoming DNS Zone Transfer. To use this class, first initialize an object, then call the run() method. If run() doesn't throw an exception the result will either be an IXFR-style response, an AXFR-style response, or an indication that the zone is up to date.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ZoneTransferIn.BasicHandler
static class	ZoneTransferIn.Delta	All changes between two versions of a zone in an IXFR response.
static interface	ZoneTransferIn.ZoneTransferHandler	Handles a Zone Transfer.

Field Summary

Fields

Modifier and Type	Field	Description
private final SocketAddress	address
private static final int	AXFR
private TCPClient	client
private long	currentSerial
private int	dclass
private static final int	END
private long	endSerial
private static final int	FIRSTDATA
private ZoneTransferIn.ZoneTransferHandler	handler
private static final int	INITIALSOA
private Record	initialSoaRecord
private static final int	IXFR_ADD
private static final int	IXFR_ADDSOA
private static final int	IXFR_DEL
private static final int	IXFR_DELSOA
private final long	ixfrSerial
private SocketAddress	localAddress
private int	qtype
private int	rtype
private int	state
private Duration	timeout
private final TSIG	tsig
private TSIG.StreamVerifier	verifier
private final boolean	wantFallback
private final Name	zname

Constructor Summary

Constructors

Constructor	Description
ZoneTransferIn(Name zone, int xfrtype, long serial, boolean fallback, SocketAddress address, TSIG key)

Method Summary

Modifier and Type	Method	Description
private void	closeConnection()
(package private) TCPClient	createTcpClient(Duration timeout)
private void	doxfr()
private void	fail(String s)
private void	fallback()
List<Record>	getAXFR()	Gets the AXFR-style response.
private ZoneTransferIn.BasicHandler	getBasicHandler()
List<ZoneTransferIn.Delta>	getIXFR()	Gets the IXFR-style response.
Name	getName()	Gets the name of the zone being transferred.
private static long	getSOASerial(Record rec)
int	getType()	Gets the type of zone transfer (either AXFR or IXFR).
boolean	isAXFR()	Returns true if the response is an AXFR-style response (List of Records).
boolean	isCurrent()	Returns true if the response indicates that the zone is up to date.
boolean	isIXFR()	Returns true if the response is an IXFR-style response (List of Deltas).
private void	logxfr(String s)
static ZoneTransferIn	newAXFR(Name zone, String host, int port, TSIG key)	Instantiates a ZoneTransferIn object to do an AXFR (full zone transfer).
static ZoneTransferIn	newAXFR(Name zone, String host, TSIG key)	Instantiates a ZoneTransferIn object to do an AXFR (full zone transfer).
static ZoneTransferIn	newAXFR(Name zone, SocketAddress address, TSIG key)	Instantiates a ZoneTransferIn object to do an AXFR (full zone transfer).
static ZoneTransferIn	newIXFR(Name zone, long serial, boolean fallback, String host, int port, TSIG key)	Instantiates a ZoneTransferIn object to do an IXFR (incremental zone transfer).
static ZoneTransferIn	newIXFR(Name zone, long serial, boolean fallback, String host, TSIG key)	Instantiates a ZoneTransferIn object to do an IXFR (incremental zone transfer).
static ZoneTransferIn	newIXFR(Name zone, long serial, boolean fallback, SocketAddress address, TSIG key)	Instantiates a ZoneTransferIn object to do an IXFR (incremental zone transfer).
private void	openConnection()
private Message	parseMessage(byte[] b)
private void	parseRR(Record rec)
void	run()	Does the zone transfer using an internal handler.
void	run(ZoneTransferIn.ZoneTransferHandler handler)	Does the zone transfer.
private void	sendQuery()
void	setDClass(int dclass)	Sets an alternate DNS class for this zone transfer.
void	setLocalAddress(SocketAddress addr)	Sets the local address to bind to when sending messages.
void	setTimeout(int secs)	Deprecated. use setTimeout(Duration)
void	setTimeout(Duration t)	Sets a timeout on this zone transfer.

Methods inherited from class java.lang.Object

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

Field Details

INITIALSOA

private static final int INITIALSOA

See Also:

• Constant Field Values

FIRSTDATA

private static final int FIRSTDATA

See Also:

• Constant Field Values

IXFR_DELSOA

private static final int IXFR_DELSOA

See Also:

• Constant Field Values

IXFR_DEL

private static final int IXFR_DEL

See Also:

• Constant Field Values

IXFR_ADDSOA

private static final int IXFR_ADDSOA

See Also:

• Constant Field Values

IXFR_ADD

private static final int IXFR_ADD

See Also:

• Constant Field Values

AXFR

private static final int AXFR

See Also:

• Constant Field Values

END

private static final int END

See Also:

• Constant Field Values

zname

private final Name zname

qtype

private int qtype

dclass

private int dclass

ixfrSerial

private final long ixfrSerial

wantFallback

private final boolean wantFallback

handler

private ZoneTransferIn.ZoneTransferHandler handler

localAddress

private SocketAddress localAddress

address

private final SocketAddress address

client

private TCPClient client

tsig

private final TSIG tsig

verifier

private TSIG.StreamVerifier verifier

timeout

private Duration timeout

state

private int state

endSerial

private long endSerial

currentSerial

private long currentSerial

initialSoaRecord

private Record initialSoaRecord

rtype

private int rtype

Constructor Details

ZoneTransferIn

ZoneTransferIn(Name zone,
 int xfrtype,
 long serial,
 boolean fallback,
 SocketAddress address,
 TSIG key)

Method Details

newAXFR

public static ZoneTransferIn newAXFR(Name zone,
 SocketAddress address,
 TSIG key)

Instantiates a ZoneTransferIn object to do an AXFR (full zone transfer).

Parameters:

zone - The zone to transfer.

address - The host/port from which to transfer the zone.

key - The TSIG key used to authenticate the transfer, or null.

Returns:

The ZoneTransferIn object.

newAXFR

public static ZoneTransferIn newAXFR(Name zone,
 String host,
 int port,
 TSIG key)

Instantiates a ZoneTransferIn object to do an AXFR (full zone transfer).

Parameters:

zone - The zone to transfer.

host - The host from which to transfer the zone.

port - The port to connect to on the server, or 0 for the default.

key - The TSIG key used to authenticate the transfer, or null.

Returns:

The ZoneTransferIn object.

newAXFR

public static ZoneTransferIn newAXFR(Name zone,
 String host,
 TSIG key)

Instantiates a ZoneTransferIn object to do an AXFR (full zone transfer).

Parameters:

zone - The zone to transfer.

host - The host from which to transfer the zone.

key - The TSIG key used to authenticate the transfer, or null.

Returns:

The ZoneTransferIn object.

newIXFR

public static ZoneTransferIn newIXFR(Name zone,
 long serial,
 boolean fallback,
 SocketAddress address,
 TSIG key)

Instantiates a ZoneTransferIn object to do an IXFR (incremental zone transfer).

Parameters:

zone - The zone to transfer.

serial - The existing serial number.

fallback - If true, fall back to AXFR if IXFR is not supported.

address - The host/port from which to transfer the zone.

key - The TSIG key used to authenticate the transfer, or null.

Returns:

The ZoneTransferIn object.

newIXFR

public static ZoneTransferIn newIXFR(Name zone,
 long serial,
 boolean fallback,
 String host,
 int port,
 TSIG key)

Instantiates a ZoneTransferIn object to do an IXFR (incremental zone transfer).

Parameters:

zone - The zone to transfer.

serial - The existing serial number.

fallback - If true, fall back to AXFR if IXFR is not supported.

host - The host from which to transfer the zone.

port - The port to connect to on the server, or 0 for the default.

key - The TSIG key used to authenticate the transfer, or null.

Returns:

The ZoneTransferIn object.

newIXFR

public static ZoneTransferIn newIXFR(Name zone,
 long serial,
 boolean fallback,
 String host,
 TSIG key)

Instantiates a ZoneTransferIn object to do an IXFR (incremental zone transfer).

Parameters:

zone - The zone to transfer.

serial - The existing serial number.

fallback - If true, fall back to AXFR if IXFR is not supported.

host - The host from which to transfer the zone.

key - The TSIG key used to authenticate the transfer, or null.

Returns:

The ZoneTransferIn object.

getName

public Name getName()

Gets the name of the zone being transferred.

getType

public int getType()

Gets the type of zone transfer (either AXFR or IXFR).

setTimeout

@Deprecated
public void setTimeout(int secs)

Deprecated.

use setTimeout(Duration)

Sets a timeout on this zone transfer. The default is 900 seconds (15 minutes).

Parameters:

secs - The maximum amount of time that this zone transfer can take.

setTimeout

public void setTimeout(Duration t)

Sets a timeout on this zone transfer. The default is 900 seconds (15 minutes).

Parameters:

t - The maximum amount of time that this zone transfer can take.

setDClass

public void setDClass(int dclass)

Sets an alternate DNS class for this zone transfer.

Parameters:

dclass - The class to use instead of class IN.

setLocalAddress

public void setLocalAddress(SocketAddress addr)

Sets the local address to bind to when sending messages.

Parameters:

addr - The local address to send messages from.

openConnection

private void openConnection()
                     throws IOException

Throws:

IOException

createTcpClient

TCPClient createTcpClient(Duration timeout)
                   throws IOException

Throws:

IOException

sendQuery

private void sendQuery()
                throws IOException

Throws:

IOException

getSOASerial

private static long getSOASerial(Record rec)

logxfr

private void logxfr(String s)

fail

private void fail(String s)
           throws ZoneTransferException

Throws:

ZoneTransferException

fallback

private void fallback()
               throws ZoneTransferException

Throws:

ZoneTransferException

parseRR

private void parseRR(Record rec)
              throws ZoneTransferException

Throws:

ZoneTransferException

closeConnection

private void closeConnection()

parseMessage

private Message parseMessage(byte[] b)
                      throws WireParseException

Throws:

WireParseException

doxfr

private void doxfr()
            throws IOException,
ZoneTransferException

Throws:

IOException

ZoneTransferException

run

public void run(ZoneTransferIn.ZoneTransferHandler handler)
         throws IOException,
ZoneTransferException

Does the zone transfer.

Parameters:

handler - The callback object that handles the zone transfer data.

Throws:

IOException - The zone transfer failed to due an IO problem.

ZoneTransferException - The zone transfer failed to due a problem with the zone transfer itself.

run

public void run()
         throws IOException,
ZoneTransferException

Does the zone transfer using an internal handler. Results can be obtained by calling getAXFR() or getIXFR

Throws:

IOException - The zone transfer failed to due an IO problem.

ZoneTransferException - The zone transfer failed to due a problem with the zone transfer itself.

getBasicHandler

private ZoneTransferIn.BasicHandler getBasicHandler()
                                             throws IllegalArgumentException

Throws:

IllegalArgumentException

isAXFR

public boolean isAXFR()

Returns true if the response is an AXFR-style response (List of Records). This will be true if either an IXFR was performed, an IXFR was performed and the server provided a full zone transfer, or an IXFR failed and fallback to AXFR occurred.

getAXFR

public List<Record> getAXFR()

Gets the AXFR-style response.

Throws:

IllegalArgumentException - The transfer used the callback interface, so the response was not stored.

isIXFR

public boolean isIXFR()

Returns true if the response is an IXFR-style response (List of Deltas). This will be true only if an IXFR was performed and the server provided an incremental zone transfer.

getIXFR

public List<ZoneTransferIn.Delta> getIXFR()

Gets the IXFR-style response.

Throws:

IllegalArgumentException - The transfer used the callback interface, so the response was not stored.

isCurrent

public boolean isCurrent()

Returns true if the response indicates that the zone is up to date. This will be true only if an IXFR was performed.

Throws:

IllegalArgumentException - The transfer used the callback interface, so the response was not stored.