Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class DkimKey

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.DkimKey

All Implemented Interfaces:

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

public final class DkimKey
extends CachedObjectIntegerKey<DkimKey>

Represents one DKIM key with a unique selector for a Domain.

Author:

AO Industries, Inc.

See Also:

• Domain

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DkimKey.Status

Field Summary

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
DkimKey()	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
protected Object	getColumnImpl(int i)
UnmodifiableTimestamp	getCreated()	The time this key was added.
Optional<UnmodifiableTimestamp>	getDnsConfirmed()	The time DNS TXT presence and correctness was confirmed.
Optional<Record>	getDnsRecord()	The DNS record associated with this key.
OptionalInt	getDnsRecord_id()	The DNS record associated with this key.
Domain	getDomain()	The email domain for this key.
int	getDomain_id()	The email domain for this key.
int	getId()	The generated primary key.
DomainLabel	getSelector()	The per-domain unique name.
DkimKey.Status	getStatus()	The current status.
UnmodifiableTimestamp	getStatusTime()	The time at last status change.
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
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

Constructor Details

DkimKey

@Deprecated(forRemoval=true)
public DkimKey()

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

toStringImpl

public String toStringImpl()
                    throws IOException,
SQLException

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<DkimKey>

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,DkimKey>

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,DkimKey>

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,DkimKey>

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,DkimKey>

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,DkimKey>

Throws:

IOException

getId

public int getId()

The generated primary key.

getDomain_id

public int getDomain_id()

The email domain for this key.

getDomain

public Domain getDomain()
                 throws SQLException,
IOException

The email domain for this key.

Throws:

SQLException

IOException

getSelector

public DomainLabel getSelector()

The per-domain unique name.

getCreated

public UnmodifiableTimestamp getCreated()

The time this key was added.

getStatus

public DkimKey.Status getStatus()

The current status. Only one may be DkimKey.Status.SIGNING per domain.

getStatusTime

public UnmodifiableTimestamp getStatusTime()

The time at last status change.

getDnsRecord_id

public OptionalInt getDnsRecord_id()

The DNS record associated with this key. May be null when DNS hosted elsewhere.

getDnsRecord

public Optional<Record> getDnsRecord()
                              throws SQLException,
IOException

The DNS record associated with this key. May be Optional.empty() when DNS hosted elsewhere.

Throws:

SQLException

IOException

getDnsConfirmed

public Optional<UnmodifiableTimestamp> getDnsConfirmed()

The time DNS TXT presence and correctness was confirmed. Required for statuses DkimKey.Status.SIGNING and DkimKey.Status.OLD.