Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class SmtpRelay

java.lang.Object

com.aoindustries.aoserv.client.AOServObject<K,T>

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

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

com.aoindustries.aoserv.client.email.SmtpRelay

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AOServReadable, AOServStreamable, AOServWritable, Disablable, Removable, SingleTableObject<Integer,SmtpRelay>

public final class SmtpRelay
extends CachedObjectIntegerKey<SmtpRelay>
implements Removable, Disablable

When a user successfully logs into either the POP3 or IMAP mail systems, access from their host is granted to the SMTP server via a EmailSmtpRelay.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static int	HISTORY_DAYS	Keep the SMTP relay history for three months (92 days).

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
SmtpRelay()

Method Summary

Modifier and Type	Method	Description
int	addSpamEmailMessage(String message)
boolean	canDisable()
boolean	canEnable()
void	disable(DisableLog dl)
void	enable()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
UnmodifiableTimestamp	getCreated()
DisableLog	getDisableLog()
UnmodifiableTimestamp	getExpiration()
HostAddress	getHost()
UnmodifiableTimestamp	getLastRefreshed()
Server	getLinuxServer()
Integer	getLinuxServer_host_id()
Package	getPackage()
Account.Name	getPackage_name()
int	getRefreshCount()
List<SpamMessage>	getSpamEmailMessages()
Table.TableID	getTableID()
SmtpRelayType	getType()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	refresh(long minDuration)
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 Detail

HISTORY_DAYS

public static final int HISTORY_DAYS

Keep the SMTP relay history for three months (92 days).

See Also:

Constant Field Values

Constructor Detail

SmtpRelay

public SmtpRelay()

Method Detail

addSpamEmailMessage

public int addSpamEmailMessage(String message)
                        throws IOException,
                               SQLException

Throws:

IOException

SQLException

canDisable

public boolean canDisable()

Specified by:

canDisable in interface Disablable

canEnable

public boolean canEnable()
                  throws IOException,
                         SQLException

Specified by:

canEnable in interface Disablable

Throws:

IOException

SQLException

disable

public void disable(DisableLog dl)
             throws IOException,
                    SQLException

Specified by:

disable in interface Disablable

Throws:

IOException

SQLException

enable

public void enable()
            throws IOException,
                   SQLException

Specified by:

enable in interface Disablable

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AOServObject<Integer,SmtpRelay>

getCreated

public UnmodifiableTimestamp getCreated()

isDisabled

public boolean isDisabled()

Description copied from interface: Disablable

Checks if this object is disabled. This should execute very quickly (not incur any round-trip to any database) and thus does not throw any checked exceptions.

Specified by:

isDisabled in interface Disablable

getDisableLog

public DisableLog getDisableLog()
                         throws IOException,
                                SQLException

Specified by:

getDisableLog in interface Disablable

Throws:

IOException

SQLException

getExpiration

public UnmodifiableTimestamp getExpiration()

getHost

public HostAddress getHost()

getType

public SmtpRelayType getType()
                      throws SQLException,
                             IOException

Throws:

SQLException

IOException

getLastRefreshed

public UnmodifiableTimestamp getLastRefreshed()

getPackage_name

public Account.Name getPackage_name()

getPackage

public Package getPackage()
                   throws IOException,
                          SQLException

Throws:

IOException

SQLException

getRefreshCount

public int getRefreshCount()

getLinuxServer_host_id

public Integer getLinuxServer_host_id()

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
                             IOException

Throws:

SQLException

IOException

getSpamEmailMessages

public List<SpamMessage> getSpamEmailMessages()
                                       throws IOException,
                                              SQLException

Throws:

IOException

SQLException

getTableID

public Table.TableID getTableID()

Specified by:

getTableID in class AOServObject<Integer,SmtpRelay>

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

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

Throws:

IOException

refresh

public void refresh(long minDuration)
             throws IOException,
                    SQLException

Throws:

IOException

SQLException

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()
                    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<SmtpRelay>

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

Throws:

IOException