Top Description Fields Constructors Methods
io.vertx.core.dns.impl.decoder

public Class StartOfAuthorityRecord

extends Object
Class Inheritance

Represents an SOA (start of authority) record, which defines global parameters for a zone (domain). There can only be one SOA record per zone.

Field Summary

Modifier and TypeField and Description
private final int
private final long
private final String
private final int
private final String
private final int
private final long

Constructor Summary

AccessConstructor and Description
public
StartOfAuthorityRecord(String
any name server that will respond authoritatively for the domain
primaryNameServer
,
String
e-mail address of person responsible for this zone
responsiblePerson
,
long
a serial number that must be incremented when changes are made. Recommended format is YYYYMMDDnn. For example, if the primary name server is changed on June 19, 2013, then the serial would be 2013061901. If it is changed again on the same day it would be 2013061902
serial
,
int
number of seconds a secondary name server waits, after getting a copy of the zone, before it checks the zone again for changes
refreshTime
,
int
number of seconds to wait after a failed refresh attempt before another attempt to refresh is made
retryTime
,
int
number of seconds secondary name server can hold information before it is considered not authoritative
expireTime
,
long
number of seconds that records in the zone are valid for (if a record has a higher TTL, it overrides this value which is just a minimum)
minimumTtl
)

Constructs an SOA (start of authority) record.

Method Summary

Modifier and TypeMethod and Description
public int
expireTime()

Returns time before information stored in secondary name servers becomes non authoritative.

public long
minimumTtl()

Returns the minimum TTL for records in the zone (if the record has a higher TTL, that value should be used as the TTL).

public String
primaryNameServer()

Returns the primary name server.

public int
refreshTime()

Returns time between refreshes for secondary name servers.

public String
responsiblePerson()

Returns the responsible person's e-mail.

public int
retryTime()

Returns time between retries for failed refresh attempts.

public long
serial()

Returns the zone's serial number, usually in format YYYYMMDDnn.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

expireTimeback to summary
private final int expireTime
minimumTtlback to summary
private final long minimumTtl
primaryNameServerback to summary
private final String primaryNameServer
refreshTimeback to summary
private final int refreshTime
responsiblePersonback to summary
private final String responsiblePerson
retryTimeback to summary
private final int retryTime
serialback to summary
private final long serial

Constructor Detail

StartOfAuthorityRecordback to summary
public StartOfAuthorityRecord(String primaryNameServer, String responsiblePerson, long serial, int refreshTime, int retryTime, int expireTime, long minimumTtl)

Constructs an SOA (start of authority) record.

Parameters
primaryNameServer:String

any name server that will respond authoritatively for the domain

responsiblePerson:String

e-mail address of person responsible for this zone

serial:long

a serial number that must be incremented when changes are made. Recommended format is YYYYMMDDnn. For example, if the primary name server is changed on June 19, 2013, then the serial would be 2013061901. If it is changed again on the same day it would be 2013061902

refreshTime:int

number of seconds a secondary name server waits, after getting a copy of the zone, before it checks the zone again for changes

retryTime:int

number of seconds to wait after a failed refresh attempt before another attempt to refresh is made

expireTime:int

number of seconds secondary name server can hold information before it is considered not authoritative

minimumTtl:long

number of seconds that records in the zone are valid for (if a record has a higher TTL, it overrides this value which is just a minimum)

Method Detail

expireTimeback to summary
public int expireTime()

Returns time before information stored in secondary name servers becomes non authoritative.

minimumTtlback to summary
public long minimumTtl()

Returns the minimum TTL for records in the zone (if the record has a higher TTL, that value should be used as the TTL).

primaryNameServerback to summary
public String primaryNameServer()

Returns the primary name server.

refreshTimeback to summary
public int refreshTime()

Returns time between refreshes for secondary name servers.

responsiblePersonback to summary
public String responsiblePerson()

Returns the responsible person's e-mail.

retryTimeback to summary
public int retryTime()

Returns time between retries for failed refresh attempts.

serialback to summary
public long serial()

Returns the zone's serial number, usually in format YYYYMMDDnn.