Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class List

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.List

All Implemented Interfaces:

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

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

Any incoming email addressed to a List is immediately forwarded on to all addresses contained in the list.

Author:

AO Industries, Inc.

See Also:

• Address

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_DIRECTORY	The directory that email lists are normally contained in.
static final int	MAX_NAME_LENGTH	The maximum length of an email list name.

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
List()	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	addEmailAddress(Address address)
boolean	canDisable()
boolean	canEnable()
void	disable(DisableLog dl)
void	enable()
String	getAddressList()	Gets the list of addresses that email will be sent to, one address per line.
int	getAddressListCount()	Gets the number of addresses in an address list.
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
List<Address>	getEmailAddresses()
List<ListAddress>	getEmailListAddresses()
UserServer	getLinuxServerAccount()
int	getLinuxServerAccount_pkey()
GroupServer	getLinuxServerGroup()
int	getLinuxServerGroup_pkey()
static PosixPath	getListPath(String name, int osv)	Gets the full path that should be used for normal email lists.
MajordomoList	getMajordomoList()
PosixPath	getPath()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
static boolean	isValidRegularPath(PosixPath path, int osv)	Checks the validity of a list name.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setAddressList(String addresses)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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

equals, getKey, getPkey, hashCode, toStringImpl

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

LIST_DIRECTORY

public static final String LIST_DIRECTORY

The directory that email lists are normally contained in.

See Also:

• Constant Field Values

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

The maximum length of an email list name.

See Also:

• Constant Field Values

Constructor Details

List

@Deprecated(forRemoval=true)
public List()

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

addEmailAddress

public int addEmailAddress(Address address)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

canDisable

public boolean canDisable()

Specified by:

canDisable in interface Disablable

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

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

getAddressList

public String getAddressList()
                      throws IOException,
SQLException

Gets the list of addresses that email will be sent to, one address per line. The list is obtained from a file on the server that hosts the list.

Throws:

IOException

SQLException

getAddressListCount

public int getAddressListCount()
                        throws IOException,
SQLException

Gets the number of addresses in an address list. The number of addresses is equal to the number of non-blank lines.

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,List>

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 SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

getEmailAddresses

public List<Address> getEmailAddresses()
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailListAddresses

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

Throws:

IOException

SQLException

getLinuxServerAccount_pkey

public int getLinuxServerAccount_pkey()

getLinuxServerAccount

public UserServer getLinuxServerAccount()
                                 throws SQLException,
IOException

Throws:

SQLException

IOException

getLinuxServerGroup_pkey

public int getLinuxServerGroup_pkey()

getLinuxServerGroup

public GroupServer getLinuxServerGroup()
                                throws SQLException,
IOException

Throws:

SQLException

IOException

getListPath

public static PosixPath getListPath(String name,
 int osv)
                             throws ValidationException

Gets the full path that should be used for normal email lists.

Throws:

ValidationException

See Also:

• OperatingSystemVersion.getEmailListPath(java.lang.String)

getMajordomoList

public MajordomoList getMajordomoList()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getPath

public PosixPath getPath()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,List>

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

Parameters:

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

Throws:

SQLException

isValidRegularPath

public static boolean isValidRegularPath(PosixPath path,
 int osv)

Checks the validity of a list name.

TODO: Self-validating type

See Also:

• OperatingSystemVersion.isValidEmailListRegularPath(com.aoindustries.aoserv.client.linux.PosixPath)

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

Throws:

IOException

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

setAddressList

public void setAddressList(String addresses)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

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

Throws:

IOException