Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class Domain

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.Domain

All Implemented Interfaces:

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

public final class Domain
extends CachedObjectIntegerKey<Domain>
implements Removable

A EmailDomain is one hostname/domain of email addresses hosted on a Server. Multiple, unique email addresses may be hosted within the EmailDomain. In order for mail to be routed to the Server, a DNSRecord entry of type MX must point to the Server.

Author:

AO Industries, Inc.

See Also:

• Address
• Record
• RecordType.MX
• Server

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

Method Summary

Modifier and Type	Method	Description
int	addEmailAddress(String address)
void	addMajordomoServer(UserServer linuxServerAccount, GroupServer linuxServerGroup, MajordomoVersion majordomoVersion)
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DomainName	getDomain()
Address	getEmailAddress(String address)
List<Address>	getEmailAddresses()
Server	getLinuxServer()
int	getLinuxServer_host_id()
MajordomoServer	getMajordomoServer()
Package	getPackage()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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

equals, getKey, getPkey, 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

Constructor Details

Domain

@Deprecated
public Domain()

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

addEmailAddress

public int addEmailAddress(String address)
                    throws SQLException,
IOException

Throws:

SQLException

IOException

addMajordomoServer

public void addMajordomoServer(UserServer linuxServerAccount,
 GroupServer linuxServerGroup,
 MajordomoVersion majordomoVersion)
                        throws IOException,
SQLException

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Domain>

getDomain

public DomainName getDomain()

getEmailAddress

public Address getEmailAddress(String address)
                        throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailAddresses

public List<Address> getEmailAddresses()
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getMajordomoServer

public MajordomoServer getMajordomoServer()
                                   throws IOException,
SQLException

Throws:

IOException

SQLException

getPackage

public Package getPackage()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getLinuxServer_host_id

public int getLinuxServer_host_id()

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Domain>

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

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

Throws:

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<?>> getCannotRemoveReasons()
                                                   throws SQLException,
IOException

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

Throws:

SQLException

IOException

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

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

Throws:

IOException