Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.dns

Class Zone

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<String,Zone>

com.aoindustries.aoserv.client.CachedObject<String,Zone>

com.aoindustries.aoserv.client.CachedObjectStringKey<Zone>

com.aoindustries.aoserv.client.dns.Zone

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Dumpable, Removable, SingleTableObject<String,Zone>

public final class Zone
extends CachedObjectStringKey<Zone>
implements Removable, Dumpable

A DNSZone is one domain hosted in the name servers. It can have any number of DNSRecords. Please see DNSTLD for domain restrictions.

Author:

AO Industries, Inc.

See Also:

• TopLevelDomain
• Record

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_ZONE	The zone that is in charge of the API.
static final short	DEFAULT_CAA_FLAG	The default flag for new CAA records.
static final String	DEFAULT_CAA_TAG	The default tag for new CAA records.
static final String	DEFAULT_CAA_VALUE	The default value for new CAA records.
static final String	DEFAULT_HOSTMASTER	The hostmaster that is placed in a newly created DNSZone.
static final int	DEFAULT_MX_PRIORITY	The default priority for new MX records.
static final int	DEFAULT_TTL
static final int	MAX_LINE_LENGTH	The maximum number of characters allowed in a line.

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectStringKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
Zone()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	addDnsRecord(String domain, RecordType type, int priority, int weight, int port, short flag, String tag, String destination, int ttl)
void	dump(PrintWriter out)	Dumps the contents of this object into a PrintWriter.
RecordType[]	getAllowedTypes()
static String	getArpaZoneForIpAddress(InetAddress ip, String netmask)
List<CannotRemoveReason<Zone>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
static long	getCurrentSerial()
String	getFile()
String	getHostmaster()
Package	getPackage()
List<Record>	getRecords()
List<Record>	getRecords(String domain, RecordType type)
long	getSerial()
Table.TableId	getTableId()
int	getTtl()
String	getZone()
String	getZoneFile()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isArpa()
void	printZoneFile(PrintWriter out)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setTtl(int ttl)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectStringKey

equals, getKey, hashCode, toStringImpl

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TTL

public static final int DEFAULT_TTL

See Also:

• Constant Field Values

MAX_LINE_LENGTH

public static final int MAX_LINE_LENGTH

The maximum number of characters allowed in a line.

See Also:

• Constant Field Values

API_ZONE

public static final String API_ZONE

The zone that is in charge of the API.

See Also:

• Constant Field Values

DEFAULT_HOSTMASTER

public static final String DEFAULT_HOSTMASTER

The hostmaster that is placed in a newly created DNSZone.

See Also:

• Constant Field Values

DEFAULT_MX_PRIORITY

public static final int DEFAULT_MX_PRIORITY

The default priority for new MX records.

See Also:

• Constant Field Values

DEFAULT_CAA_FLAG

public static final short DEFAULT_CAA_FLAG

The default flag for new CAA records.

See Also:

• Constant Field Values

DEFAULT_CAA_TAG

public static final String DEFAULT_CAA_TAG

The default tag for new CAA records.

See Also:

• Constant Field Values

DEFAULT_CAA_VALUE

public static final String DEFAULT_CAA_VALUE

The default value for new CAA records.

See Also:

• Constant Field Values

Constructor Details

Zone

@Deprecated(forRemoval=true)
public Zone()

Deprecated, for removal: This API element is subject to removal in a future version.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

addDnsRecord

public int addDnsRecord(String domain,
 RecordType type,
 int priority,
 int weight,
 int port,
 short flag,
 String tag,
 String destination,
 int ttl)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

dump

public void dump(PrintWriter out)
          throws SQLException,
IOException

Description copied from interface: Dumpable

Dumps the contents of this object into a PrintWriter.

Specified by:

dump in interface Dumpable

Throws:

SQLException

IOException

getAllowedTypes

public RecordType[] getAllowedTypes()
                             throws IOException,
SQLException

Throws:

IOException

SQLException

getArpaZoneForIpAddress

public static String getArpaZoneForIpAddress(InetAddress ip,
 String netmask)
                                      throws IllegalArgumentException

Throws:

IllegalArgumentException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<String,Zone>

getCurrentSerial

public static long getCurrentSerial()

getRecords

public List<Record> getRecords()
                        throws IOException,
SQLException

Throws:

IOException

SQLException

getRecords

public List<Record> getRecords(String domain,
 RecordType type)
                        throws IOException,
SQLException

Throws:

IOException

SQLException

getFile

public String getFile()

getHostmaster

public String getHostmaster()

getPackage

public Package getPackage()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getSerial

public long getSerial()

getTtl

public int getTtl()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<String,Zone>

getZone

public String getZone()

getZoneFile

public String getZoneFile()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<String,Zone>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

isArpa

public boolean isArpa()

printZoneFile

public void printZoneFile(PrintWriter out)
                   throws SQLException,
IOException

Throws:

SQLException

IOException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<String,Zone>

Throws:

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<Zone>> getCannotRemoveReasons()

Description copied from interface: Removable

Lists the reasons an object may not be removed.

Specified by:

getCannotRemoveReasons in interface Removable

Returns:

an empty List<CannotRemoveReason> if this object may be removed, or a list of descriptions

remove

public void remove()
            throws IOException,
SQLException

Description copied from interface: Removable

Removes this object, and all dependant objects, from the system.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

setTtl

public void setTtl(int ttl)
            throws IOException,
SQLException

Throws:

IOException

SQLException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<String,Zone>

Throws:

IOException