Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class SendmailServer

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.SendmailServer

All Implemented Interfaces:

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

public final class SendmailServer
extends CachedObjectIntegerKey<SendmailServer>

An SendmailServer represents one running instance of Sendmail.

Author:

AO Industries, Inc.

See Also:

• SendmailBind

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ALLOW_PLAINTEXT_AUTH	Default value for sendmail_servers.allow_plaintext_auth
static final int	DEFAULT_BAD_RCPT_THROTTLE	Default value for sendmail_servers.bad_rcpt_throttle
static final int	DEFAULT_CONNECTION_RATE_THROTTLE	Default value for sendmail_servers.connection_rate_throttle
static final int	DEFAULT_DELAY_LA	Default value for sendmail_servers.delay_la
static final int	DEFAULT_MAX_DAEMON_CHILDREN	Default value for sendmail_servers.max_daemon_children
static final int	DEFAULT_MAX_MESSAGE_SIZE	Default value for sendmail_servers.max_message_size
static final int	DEFAULT_MAX_QUEUE_CHILDREN	Default value for sendmail_servers.max_queue_children
static final int	DEFAULT_MIN_FREE_BLOCKS	Default value for sendmail_servers.min_free_blocks
static final int	DEFAULT_NICE_QUEUE_RUN	Default value for sendmail_servers.nice_queue_run
static final int	DEFAULT_QUEUE_LA	Default value for sendmail_servers.queue_la
static final int	DEFAULT_REFUSE_LA	Default value for sendmail_servers.refuse_la

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

Method Summary

Modifier and Type	Method	Description
boolean	getAllowPlaintextAuth()	Allows plaintext authentication (PLAIN/LOGIN) on non-TLS links.
int	getBadRcptThrottle()	The value for confBAD_RCPT_THROTTLE or -1 if not set.
IpAddress	getClientAddrInet()	The Addr for ClientPortOptions with Family=inet or null if not set.
Integer	getClientAddrInet_id()
IpAddress	getClientAddrInet6()	The Addr for ClientPortOptions with Family=inet6 or null if not set.
Integer	getClientAddrInet6_id()
Certificate	getClientCertificate()	Gets the client certificate for this server.
int	getClientCertificate_pkey()
protected Object	getColumnImpl(int i)
int	getConnectionRateThrottle()	The value for confCONNECTION_RATE_THROTTLE or -1 if not set.
int	getDelayLa()	The value for confDELAY_LA or -1 if not set.
DomainName	getHostname()	The fully qualified hostname for Dw, Dm, and Dj.
int	getId()
Server	getLinuxServer()
int	getLinuxServer_server_id()
int	getMaxDaemonChildren()	The value for confMAX_DAEMON_CHILDREN or -1 if not set.
int	getMaxMessageSize()	The value for confMAX_MESSAGE_SIZE or -1 if not set.
int	getMaxQueueChildren()	The value for confMAX_QUEUE_CHILDREN or -1 if not set.
int	getMinFreeBlocks()	The value for confMIN_FREE_BLOCKS or -1 if not set.
String	getName()	Gets the name of the sendmail server instance.
int	getNiceQueueRun()	The value for confNICE_QUEUE_RUN or -1 if not set.
Package	getPackage()
int	getPackage_pkey()
int	getQueueLa()	The value for confQUEUE_LA or -1 if not set.
int	getRefuseLa()	The value for confREFUSE_LA or -1 if not set.
List<SendmailBind>	getSendmailBinds()
Certificate	getServerCertificate()	Gets the server certificate for this server.
int	getServerCertificate_pkey()
String	getSystemdEscapedName()	Gets the systemd-encoded name of the sendmail server instance.
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

Field Details

DEFAULT_ALLOW_PLAINTEXT_AUTH

public static final boolean DEFAULT_ALLOW_PLAINTEXT_AUTH

Default value for sendmail_servers.allow_plaintext_auth

See Also:

• Constant Field Values

DEFAULT_MAX_QUEUE_CHILDREN

public static final int DEFAULT_MAX_QUEUE_CHILDREN

Default value for sendmail_servers.max_queue_children

See Also:

• Constant Field Values

DEFAULT_NICE_QUEUE_RUN

public static final int DEFAULT_NICE_QUEUE_RUN

Default value for sendmail_servers.nice_queue_run

See Also:

• Constant Field Values

DEFAULT_DELAY_LA

public static final int DEFAULT_DELAY_LA

Default value for sendmail_servers.delay_la

See Also:

• Constant Field Values

DEFAULT_QUEUE_LA

public static final int DEFAULT_QUEUE_LA

Default value for sendmail_servers.queue_la

See Also:

• Constant Field Values

DEFAULT_REFUSE_LA

public static final int DEFAULT_REFUSE_LA

Default value for sendmail_servers.refuse_la

See Also:

• Constant Field Values

DEFAULT_MAX_DAEMON_CHILDREN

public static final int DEFAULT_MAX_DAEMON_CHILDREN

Default value for sendmail_servers.max_daemon_children

See Also:

• Constant Field Values

DEFAULT_BAD_RCPT_THROTTLE

public static final int DEFAULT_BAD_RCPT_THROTTLE

Default value for sendmail_servers.bad_rcpt_throttle

See Also:

• Constant Field Values

DEFAULT_CONNECTION_RATE_THROTTLE

public static final int DEFAULT_CONNECTION_RATE_THROTTLE

Default value for sendmail_servers.connection_rate_throttle

See Also:

• Constant Field Values

DEFAULT_MAX_MESSAGE_SIZE

public static final int DEFAULT_MAX_MESSAGE_SIZE

Default value for sendmail_servers.max_message_size

See Also:

• Constant Field Values

DEFAULT_MIN_FREE_BLOCKS

public static final int DEFAULT_MIN_FREE_BLOCKS

Default value for sendmail_servers.min_free_blocks

See Also:

• Constant Field Values

Constructor Details

SendmailServer

@Deprecated
public SendmailServer()

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

toStringImpl

public String toStringImpl()

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

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,SendmailServer>

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,SendmailServer>

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

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

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

Throws:

IOException

getId

public int getId()

getLinuxServer_server_id

public int getLinuxServer_server_id()

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getName

public String getName()

Gets the name of the sendmail server instance. The default instance has a null name. Additional instances will have non-empty names. The name is unique per server, including only one default instance.

See Also:

• getSystemdEscapedName()

getSystemdEscapedName

public String getSystemdEscapedName()

Gets the systemd-encoded name of the sendmail server instance. The default instance has a null name. Additional instances will have non-empty names. The name is unique per server, including only one default instance.

See Also:

• getName()
• SystemdUtil.encode(java.lang.String)

getPackage_pkey

public int getPackage_pkey()

getPackage

public Package getPackage()
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getHostname

public DomainName getHostname()

The fully qualified hostname for Dw, Dm, and Dj.

When null, defaults to Server.getHostname().

getServerCertificate_pkey

public int getServerCertificate_pkey()

getServerCertificate

public Certificate getServerCertificate()
                                 throws SQLException,
IOException

Gets the server certificate for this server.

Returns:

the server SSL certificate or null when filtered

Throws:

SQLException

IOException

getClientCertificate_pkey

public int getClientCertificate_pkey()

getClientCertificate

public Certificate getClientCertificate()
                                 throws SQLException,
IOException

Gets the client certificate for this server.

Returns:

the client SSL certificate or null when filtered

Throws:

SQLException

IOException

getAllowPlaintextAuth

public boolean getAllowPlaintextAuth()

Allows plaintext authentication (PLAIN/LOGIN) on non-TLS links. When enabled, removes "p" from AuthOptions.

getMaxQueueChildren

public int getMaxQueueChildren()

The value for confMAX_QUEUE_CHILDREN or -1 if not set.

getNiceQueueRun

public int getNiceQueueRun()

The value for confNICE_QUEUE_RUN or -1 if not set.

getDelayLa

public int getDelayLa()

The value for confDELAY_LA or -1 if not set.

getQueueLa

public int getQueueLa()

The value for confQUEUE_LA or -1 if not set.

getRefuseLa

public int getRefuseLa()

The value for confREFUSE_LA or -1 if not set.

getMaxDaemonChildren

public int getMaxDaemonChildren()

The value for confMAX_DAEMON_CHILDREN or -1 if not set.

getBadRcptThrottle

public int getBadRcptThrottle()

The value for confBAD_RCPT_THROTTLE or -1 if not set.

getConnectionRateThrottle

public int getConnectionRateThrottle()

The value for confCONNECTION_RATE_THROTTLE or -1 if not set.

getMaxMessageSize

public int getMaxMessageSize()

The value for confMAX_MESSAGE_SIZE or -1 if not set.

getMinFreeBlocks

public int getMinFreeBlocks()

The value for confMIN_FREE_BLOCKS or -1 if not set.

getClientAddrInet_id

public Integer getClientAddrInet_id()

getClientAddrInet

public IpAddress getClientAddrInet()
                            throws IOException,
SQLException

The Addr for ClientPortOptions with Family=inet or null if not set.

Throws:

IOException

SQLException

getClientAddrInet6_id

public Integer getClientAddrInet6_id()

getClientAddrInet6

public IpAddress getClientAddrInet6()
                             throws IOException,
SQLException

The Addr for ClientPortOptions with Family=inet6 or null if not set.

Throws:

IOException

SQLException

getSendmailBinds

public List<SendmailBind> getSendmailBinds()
                                    throws IOException,
SQLException

Throws:

IOException

SQLException