Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class Address

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.Address

All Implemented Interfaces:

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

public final class Address
extends CachedObjectIntegerKey<Address>
implements Removable

An EmailAddress represents a unique email address hosted on an AOServ server. This email address may only go to one destination,

Author:

AO Industries, Inc.

See Also:

• BlackholeAddress
• Forwarding
• ListAddress
• PipeAddress
• InboxAddress

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
Address()	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	addEmailForwarding(Email destination)
String	getAddress()
BlackholeAddress	getBlackholeEmailAddress()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
Domain	getDomain()
Forwarding	getEmailForwarding(Email destination)
List<Forwarding>	getEmailForwardings()
ListAddress	getEmailListAddress(List list)
List<ListAddress>	getEmailListAddresses()
List<List>	getEmailLists()
PipeAddress	getEmailPipeAddress(Pipe pipe)
List<PipeAddress>	getEmailPipeAddresses()
List<Pipe>	getEmailPipes()
List<Forwarding>	getEnabledEmailForwardings()
List<ListAddress>	getEnabledEmailListAddresses()
List<PipeAddress>	getEnabledEmailPipeAddresses()
InboxAddress	getLinuxAccAddress(UserServer lsa)
List<InboxAddress>	getLinuxAccAddresses()
List<UserServer>	getLinuxServerAccounts()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isUsed()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this EmailAddress any any references to it.
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

Address

@Deprecated(forRemoval=true)
public Address()

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

addEmailForwarding

public int addEmailForwarding(Email destination)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getAddress

public String getAddress()

getBlackholeEmailAddress

public BlackholeAddress getBlackholeEmailAddress()
                                          throws IOException,
SQLException

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Address>

getDomain

public Domain getDomain()
                 throws SQLException,
IOException

Throws:

SQLException

IOException

getEmailForwardings

public List<Forwarding> getEmailForwardings()
                                     throws IOException,
SQLException

Throws:

IOException

SQLException

getEnabledEmailForwardings

public List<Forwarding> getEnabledEmailForwardings()
                                            throws SQLException,
IOException

Throws:

SQLException

IOException

getEmailForwarding

public Forwarding getEmailForwarding(Email destination)
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailLists

public List<List> getEmailLists()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailListAddresses

public List<ListAddress> getEmailListAddresses()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getEnabledEmailListAddresses

public List<ListAddress> getEnabledEmailListAddresses()
                                               throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailListAddress

public ListAddress getEmailListAddress(List list)
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailPipes

public List<Pipe> getEmailPipes()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailPipeAddresses

public List<PipeAddress> getEmailPipeAddresses()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getEnabledEmailPipeAddresses

public List<PipeAddress> getEnabledEmailPipeAddresses()
                                               throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailPipeAddress

public PipeAddress getEmailPipeAddress(Pipe pipe)
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxServerAccounts

public List<UserServer> getLinuxServerAccounts()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxAccAddresses

public List<InboxAddress> getLinuxAccAddresses()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxAccAddress

public InboxAddress getLinuxAccAddress(UserServer lsa)
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Address>

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

Parameters:

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

Throws:

SQLException

isUsed

public boolean isUsed()
               throws IOException,
SQLException

Throws:

IOException

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

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

Removes this EmailAddress any any references to it. For example, if this address is sent to a LinuxAccount, the address is disassociated before it is removed. For integrity, this entire operation is handled in a single database transaction.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

toStringImpl

public String toStringImpl()
                    throws SQLException,
IOException

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

Throws:

SQLException

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

Throws:

IOException