org.xbill.DNS

Class OPTRecord

java.lang.Object

org.xbill.DNS.Record

org.xbill.DNS.OPTRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Record>

public class OPTRecord
extends Record

Options - describes Extended DNS (EDNS) properties of a Message. No specific options are defined other than those specified in the header. An OPT should be generated by Resolver.

EDNS is a method to extend the DNS protocol while providing backwards compatibility and not significantly changing the protocol. This implementation of EDNS is mostly complete at level 0.

See Also:

Message, Resolver, RFC 6891: Extension Mechanisms for DNS, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<EDNSOption>	options

Fields inherited from class org.xbill.DNS.Record

dclass, name, ttl, type

Constructor Summary

Constructors

Constructor and Description
OPTRecord()
OPTRecord(int payloadSize, int xrcode, int version) Creates an OPT Record with no data.
OPTRecord(int payloadSize, int xrcode, int version, int flags) Creates an OPT Record with no data.
OPTRecord(int payloadSize, int xrcode, int version, int flags, EDNSOption... options) Creates an OPT Record.
OPTRecord(int payloadSize, int xrcode, int version, int flags, java.util.List<EDNSOption> options) Creates an OPT Record.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object arg) Determines if two OPTRecords are identical.
int	getExtendedRcode() Returns the extended Rcode
int	getFlags() Returns the EDNS flags
java.util.List<EDNSOption>	getOptions() Gets all options in the OPTRecord.
java.util.List<EDNSOption>	getOptions(int code) Gets all options in the OPTRecord with a specific code.
int	getPayloadSize() Returns the maximum allowed payload size.
int	getVersion() Returns the highest supported EDNS version
int	hashCode() Generates a hash code based on the Record's data.
(package private) void	printPseudoSection(java.lang.StringBuilder sb)
protected void	rdataFromString(Tokenizer st, Name origin) Converts the text format of an RR to the internal format - must be overriden
protected void	rrFromWire(DNSInput in) Converts the type-specific RR to wire format - must be overridden
protected java.lang.String	rrToString() Converts rdata to a String
protected void	rrToWire(DNSOutput out, Compression c, boolean canonical) Converts the type-specific RR to wire format - must be overridden.
java.lang.String	toString() Converts this record to a String representation

Methods inherited from class org.xbill.DNS.Record

byteArrayFromString, byteArrayToString, checkByteArrayLength, checkName, checkU16, checkU32, checkU8, cloneRecord, compareTo, fromString, fromString, fromWire, fromWire, fromWire, getAdditionalName, getDClass, getName, getRRsetType, getTTL, getType, newRecord, newRecord, newRecord, newRecord, rdataToString, rdataToWireCanonical, sameRRset, setTTL, toWire, toWire, toWireCanonical, unknownToString, withDClass, withName, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

options

private java.util.List<EDNSOption> options

Constructor Detail

OPTRecord

OPTRecord()

OPTRecord

public OPTRecord(int payloadSize,
                 int xrcode,
                 int version,
                 int flags,
                 EDNSOption... options)

Creates an OPT Record. This is normally called by SimpleResolver, but can also be called by a server.

Parameters:

payloadSize - The size of a packet that can be reassembled on the sending host.

xrcode - The value of the extended rcode field. This is the upper 16 bits of the full rcode.

flags - Additional message flags.

version - The EDNS version that this DNS implementation supports. This should be 0 for dnsjava.

options - The options that comprise the data field.

See Also:

ExtendedFlags

OPTRecord

public OPTRecord(int payloadSize,
                 int xrcode,
                 int version,
                 int flags,
                 java.util.List<EDNSOption> options)

Creates an OPT Record. This is normally called by SimpleResolver, but can also be called by a server.

Parameters:

payloadSize - The size of a packet that can be reassembled on the sending host.

xrcode - The value of the extended rcode field. This is the upper 16 bits of the full rcode.

flags - Additional message flags.

version - The EDNS version that this DNS implementation supports. This should be 0 for dnsjava.

options - The list of options that comprise the data field.

See Also:

ExtendedFlags

OPTRecord

public OPTRecord(int payloadSize,
                 int xrcode,
                 int version,
                 int flags)

Creates an OPT Record with no data. This is normally called by SimpleResolver, but can also be called by a server.

Parameters:

payloadSize - The size of a packet that can be reassembled on the sending host.

xrcode - The value of the extended rcode field. This is the upper 16 bits of the full rcode.

flags - Additional message flags.

version - The EDNS version that this DNS implementation supports. This should be 0 for dnsjava.

See Also:

ExtendedFlags

OPTRecord

public OPTRecord(int payloadSize,
                 int xrcode,
                 int version)

Creates an OPT Record with no data. This is normally called by SimpleResolver, but can also be called by a server.

Method Detail

rrFromWire

protected void rrFromWire(DNSInput in)
                   throws java.io.IOException

Description copied from class: Record

Converts the type-specific RR to wire format - must be overridden

Specified by:

rrFromWire in class Record

Throws:

java.io.IOException

rdataFromString

protected void rdataFromString(Tokenizer st,
                               Name origin)
                        throws java.io.IOException

Description copied from class: Record

Converts the text format of an RR to the internal format - must be overriden

Specified by:

rdataFromString in class Record

Throws:

java.io.IOException

rrToString

protected java.lang.String rrToString()

Converts rdata to a String

Specified by:

rrToString in class Record

toString

public java.lang.String toString()

Converts this record to a String representation

Overrides:

toString in class Record

printPseudoSection

void printPseudoSection(java.lang.StringBuilder sb)

getPayloadSize

public int getPayloadSize()

Returns the maximum allowed payload size.

getExtendedRcode

public int getExtendedRcode()

Returns the extended Rcode

See Also:

Rcode

getVersion

public int getVersion()

Returns the highest supported EDNS version

getFlags

public int getFlags()

Returns the EDNS flags

rrToWire

protected void rrToWire(DNSOutput out,
                        Compression c,
                        boolean canonical)

Description copied from class: Record

Converts the type-specific RR to wire format - must be overridden.

Specified by:

rrToWire in class Record

getOptions

public java.util.List<EDNSOption> getOptions()

Gets all options in the OPTRecord. This returns a list of EDNSOptions.

getOptions

public java.util.List<EDNSOption> getOptions(int code)

Gets all options in the OPTRecord with a specific code. This returns a list of EDNSOptions.

equals

public boolean equals(java.lang.Object arg)

Determines if two OPTRecords are identical. This compares the name, type, class, and rdata (with names canonicalized). Additionally, because TTLs are relevant for OPT records, the TTLs are compared.

Overrides:

equals in class Record

Parameters:

arg - The record to compare to

Returns:

true if the records are equal, false otherwise.

hashCode

public int hashCode()

Description copied from class: Record

Generates a hash code based on the Record's data.

Overrides:

hashCode in class Record