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

Deprecated.
Only required for implementation, do not use directly.
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 Details
- HISTORY_DAYS
  
  public static final int HISTORY_DAYS
  
  Keep the SMTP relay history for three months (92 days).
  See Also:
  
  Constant Field Values
Constructor Details
- SmtpRelay
  
  @Deprecated public SmtpRelay()
  
  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
- 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

Class SmtpRelay

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Details

HISTORY_DAYS

Constructor Details

SmtpRelay

Method Details

addSpamEmailMessage

canDisable

canEnable

disable

enable

getColumnImpl

getCreated

isDisabled

getDisableLog

getExpiration

getHost

getType

getLastRefreshed

getPackage_name

getPackage

getRefreshCount

getLinuxServer_host_id

getLinuxServer

getSpamEmailMessages

getTableId

init

read

refresh

getCannotRemoveReasons

remove

toStringImpl

write