Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.dns

Class Record

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,Record>

com.aoindustries.aoserv.client.CachedObject<Integer,Record>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<Record>

com.aoindustries.aoserv.client.dns.Record

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Removable, SingleTableObject<Integer,Record>

public final class Record
extends CachedObjectIntegerKey<Record>
implements Removable

A DNSRecord is one line of a DNSZone (name server zone file).

Author:

AO Industries, Inc.

See Also:

• Zone

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAA_TAG_CONTACTEMAIL
static final String	CAA_TAG_CONTACTPHONE
static final String	CAA_TAG_IODEF
static final String	CAA_TAG_ISSUE
static final String	CAA_TAG_ISSUEWILD
static final short	NO_FLAG
static final int	NO_PORT
static final int	NO_PRIORITY
static final int	NO_TTL
static final int	NO_WEIGHT

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

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
Record()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
String	getAbsoluteDomain()	Gets the domain, but in fully-qualified, absolute path (with trailing period).
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
String	getDestination()
IpAddress	getDhcpAddress()
Integer	getDhcpAddress_id()
String	getDomain()
short	getFlag()
int	getId()
int	getPort()
int	getPriority()
Table.TableId	getTableId()
String	getTag()
int	getTtl()
RecordType	getType()
String	getType_type()
int	getWeight()
Zone	getZone()
String	getZone_zone()
boolean	hasConflict(Record other)	Checks if this record conflicts with the provided record, meaning they may not both exist in a zone file at the same time.
void	init(ResultSet result)	Initializes this object from the raw database contents.
static boolean	isValidFlag(short flag)	Verifies a flag is either NO_FLAG or between 0 and 0xFF.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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

equals, getKey, getPkey, hashCode

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

NO_PRIORITY

public static final int NO_PRIORITY

See Also:

• Constant Field Values

NO_WEIGHT

public static final int NO_WEIGHT

See Also:

• Constant Field Values

NO_PORT

public static final int NO_PORT

See Also:

• Constant Field Values

NO_FLAG

public static final short NO_FLAG

See Also:

• Constant Field Values

NO_TTL

public static final int NO_TTL

See Also:

• Constant Field Values

CAA_TAG_ISSUE

public static final String CAA_TAG_ISSUE

See Also:

• Constant Field Values

CAA_TAG_ISSUEWILD

public static final String CAA_TAG_ISSUEWILD

See Also:

• Constant Field Values

CAA_TAG_IODEF

public static final String CAA_TAG_IODEF

See Also:

• Constant Field Values

CAA_TAG_CONTACTEMAIL

public static final String CAA_TAG_CONTACTEMAIL

See Also:

• Constant Field Values

CAA_TAG_CONTACTPHONE

public static final String CAA_TAG_CONTACTPHONE

See Also:

• Constant Field Values

Constructor Details

Record

@Deprecated
public Record()

Deprecated.

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

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Record>

getId

public int getId()

getZone_zone

public String getZone_zone()

getZone

public Zone getZone()
             throws SQLException,
IOException

Throws:

SQLException

IOException

getDomain

public String getDomain()

getType_type

public String getType_type()

getType

public RecordType getType()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getPriority

public int getPriority()

getWeight

public int getWeight()

getPort

public int getPort()

isValidFlag

public static boolean isValidFlag(short flag)

Verifies a flag is either NO_FLAG or between 0 and 0xFF.

getFlag

public short getFlag()

Returns:

NO_FLAG when none, or a value between 0 and 0xFF.

getTag

public String getTag()

getDestination

public String getDestination()

getDhcpAddress_id

public Integer getDhcpAddress_id()

getDhcpAddress

public IpAddress getDhcpAddress()
                         throws SQLException,
IOException

Throws:

SQLException

IOException

getTtl

public int getTtl()

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<Integer,Record>

Parameters:

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

Throws:

SQLException

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<Integer,Record>

Throws:

IOException

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<Integer,Record>

Throws:

IOException

getAbsoluteDomain

public String getAbsoluteDomain()

Gets the domain, but in fully-qualified, absolute path (with trailing period).

hasConflict

public boolean hasConflict(Record other)

Checks if this record conflicts with the provided record, meaning they may not both exist in a zone file at the same time. The current conflicts checked are:

1. CNAME must exist by itself, and only one CNAME maximum, per domain
2. Multiple TXT entries of "v=spf1", with or without surrounded by quotes, see 4.5. Selecting Records.

Returns:

true if there is a conflict, false if the records may coexist.

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Record>

getCannotRemoveReasons

public List<CannotRemoveReason<?>> 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

toStringImpl

public String toStringImpl()

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<Record>