Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class CyrusImapdServer

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.CyrusImapdServer

All Implemented Interfaces:

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

public final class CyrusImapdServer
extends CachedObjectIntegerKey<CyrusImapdServer>

An CyrusImapdServer represents one running instance of Cyrus IMAPD.

Author:

AO Industries, Inc.

See Also:

• CyrusImapdBind

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CyrusImapdServer.TimeUnit

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ALLOW_PLAINTEXT_AUTH	Default value for cyrus_imapd_servers.allow_plaintext_auth
static final float	DEFAULT_DELETE_DURATION	Default value for cyrus_imapd_servers.delete_duration
static final CyrusImapdServer.TimeUnit	DEFAULT_DELETE_DURATION_UNIT	Default value for cyrus_imapd_servers.delete_duration_unit
static final float	DEFAULT_EXPIRE_DURATION	Default value for cyrus_imapd_servers.expire_duration
static final CyrusImapdServer.TimeUnit	DEFAULT_EXPIRE_DURATION_UNIT	Default value for cyrus_imapd_servers.expire_duration_unit
static final float	DEFAULT_EXPUNGE_DURATION	Default value for cyrus_imapd_servers.expunge_duration
static final CyrusImapdServer.TimeUnit	DEFAULT_EXPUNGE_DURATION_UNIT	Default value for cyrus_imapd_servers.expunge_duration_unit

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
CyrusImapdServer()	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
boolean	getAllowPlaintextAuth()	Allows plaintext authentication (PLAIN/LOGIN) on non-TLS links.
Certificate	getCertificate()	Gets the SSL certificate for this server.
protected Object	getColumnImpl(int i)
List<CyrusImapdBind>	getCyrusImapdBinds()
float	getDeleteDuration()	Gets the duration after which delayed delete folders are removed.
CyrusImapdServer.TimeUnit	getDeleteDurationUnit()	Gets the time unit for getDeleteDuration().
float	getExpireDuration()	Prune the duplicate database of entries older than expire-duration.
CyrusImapdServer.TimeUnit	getExpireDurationUnit()	Gets the time unit for getExpireDuration().
float	getExpungeDuration()	Gets the duration after which delayed expunge messages are removed.
CyrusImapdServer.TimeUnit	getExpungeDurationUnit()	Gets the time unit for getExpungeDuration().
Server	getLinuxServer()
DomainName	getServername()	The fully qualified hostname for servername.
Bind	getSieveNetBind()
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 cyrus_imapd_servers.allow_plaintext_auth

See Also:

• Constant Field Values

DEFAULT_DELETE_DURATION

public static final float DEFAULT_DELETE_DURATION

Default value for cyrus_imapd_servers.delete_duration

See Also:

• Constant Field Values

DEFAULT_DELETE_DURATION_UNIT

public static final CyrusImapdServer.TimeUnit DEFAULT_DELETE_DURATION_UNIT

Default value for cyrus_imapd_servers.delete_duration_unit

DEFAULT_EXPIRE_DURATION

public static final float DEFAULT_EXPIRE_DURATION

Default value for cyrus_imapd_servers.expire_duration

See Also:

• Constant Field Values

DEFAULT_EXPIRE_DURATION_UNIT

public static final CyrusImapdServer.TimeUnit DEFAULT_EXPIRE_DURATION_UNIT

Default value for cyrus_imapd_servers.expire_duration_unit

DEFAULT_EXPUNGE_DURATION

public static final float DEFAULT_EXPUNGE_DURATION

Default value for cyrus_imapd_servers.expunge_duration

See Also:

• Constant Field Values

DEFAULT_EXPUNGE_DURATION_UNIT

public static final CyrusImapdServer.TimeUnit DEFAULT_EXPUNGE_DURATION_UNIT

Default value for cyrus_imapd_servers.expunge_duration_unit

Constructor Details

CyrusImapdServer

@Deprecated(forRemoval=true)
public CyrusImapdServer()

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

toStringImpl

public String toStringImpl()
                    throws IOException,
SQLException

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

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,CyrusImapdServer>

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,CyrusImapdServer>

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

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

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

Throws:

IOException

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getSieveNetBind

public Bind getSieveNetBind()
                     throws IOException,
SQLException

Throws:

IOException

SQLException

getServername

public DomainName getServername()

The fully qualified hostname for servername.

When null, defaults to Server.getHostname().

getCertificate

public Certificate getCertificate()
                           throws SQLException,
IOException

Gets the SSL certificate for this server.

Returns:

the SSL certificate or null when filtered

Throws:

SQLException

IOException

getAllowPlaintextAuth

public boolean getAllowPlaintextAuth()

Allows plaintext authentication (PLAIN/LOGIN) on non-TLS links.

getDeleteDuration

public float getDeleteDuration()

Gets the duration after which delayed delete folders are removed. Enables delete_mode: delayed

Returns:

the duration or Float.NaN when not set

See Also:

• getDeleteDurationUnit()

getDeleteDurationUnit

public CyrusImapdServer.TimeUnit getDeleteDurationUnit()

Gets the time unit for getDeleteDuration(). When not set, the duration represents days.

Returns:

the unit or null when not set

getExpireDuration

public float getExpireDuration()

Prune the duplicate database of entries older than expire-duration.

Returns:

the duration (never Float.NaN)

See Also:

• getExpireDurationUnit()

getExpireDurationUnit

public CyrusImapdServer.TimeUnit getExpireDurationUnit()

Gets the time unit for getExpireDuration(). When not set, the duration represents days.

Returns:

the unit or null when not set

getExpungeDuration

public float getExpungeDuration()

Gets the duration after which delayed expunge messages are removed. Enables expunge_mode: delayed

Returns:

the duration or Float.NaN when not set

See Also:

• getExpungeDurationUnit()

getExpungeDurationUnit

public CyrusImapdServer.TimeUnit getExpungeDurationUnit()

Gets the time unit for getExpungeDuration(). When not set, the duration represents days.

Returns:

the unit or null when not set

getCyrusImapdBinds

public List<CyrusImapdBind> getCyrusImapdBinds()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException