Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class MajordomoServer

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.MajordomoServer

All Implemented Interfaces:

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

public final class MajordomoServer
extends CachedObjectIntegerKey<MajordomoServer>
implements Removable

A MajordomoServer provides Majordomo functionality for a EmailDomain. Once the MajordomoServer is established, any number of MajordomoLists may be added to it.

Author:

AO Industries, Inc.

See Also:

• Domain
• MajordomoList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAJORDOMO_ADDRESS	The username part of the email address used to directly email majordomo.
static final String	MAJORDOMO_OWNER_ADDRESS	The username part of the email address used to directly email the majordomo owner.
static final PosixPath	MAJORDOMO_SERVER_DIRECTORY	The directory that stores the majordomo servers.
static final String	OWNER_MAJORDOMO_ADDRESS	The username part of the email address used to directly email the majordomo owner.

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
MajordomoServer()	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	addMajordomoList(String listName)
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
Domain	getDomain()
UserServer	getLinuxServerAccount()
int	getLinuxServerAccount_pkey()
GroupServer	getLinuxServerGroup()
int	getLinuxServerGroup_pkey()
MajordomoList	getMajordomoList(String listName)
List<MajordomoList>	getMajordomoLists()
Address	getMajordomoOwnerAddress()
int	getMajordomoOwnerAddress_id()
PipeAddress	getMajordomoPipeAddress()
Address	getOwnerMajordomoAddress()
int	getOwnerMajordomoAddress_id()
Table.TableId	getTableId()
MajordomoVersion	getVersion()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
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

MAJORDOMO_SERVER_DIRECTORY

public static final PosixPath MAJORDOMO_SERVER_DIRECTORY

The directory that stores the majordomo servers.

MAJORDOMO_ADDRESS

public static final String MAJORDOMO_ADDRESS

The username part of the email address used to directly email majordomo.

See Also:

• Constant Field Values

OWNER_MAJORDOMO_ADDRESS

public static final String OWNER_MAJORDOMO_ADDRESS

The username part of the email address used to directly email the majordomo owner.

See Also:

• Constant Field Values

MAJORDOMO_OWNER_ADDRESS

public static final String MAJORDOMO_OWNER_ADDRESS

The username part of the email address used to directly email the majordomo owner.

See Also:

• Constant Field Values

Constructor Details

MajordomoServer

@Deprecated(forRemoval=true)
public MajordomoServer()

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

addMajordomoList

public int addMajordomoList(String listName)
                     throws SQLException,
IOException

Throws:

SQLException

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

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,MajordomoServer>

getDomain

public Domain getDomain()
                 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

getMajordomoPipeAddress

public PipeAddress getMajordomoPipeAddress()
                                    throws SQLException,
IOException

Throws:

SQLException

IOException

getMajordomoList

public MajordomoList getMajordomoList(String listName)
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getMajordomoLists

public List<MajordomoList> getMajordomoLists()
                                      throws IOException,
SQLException

Throws:

IOException

SQLException

getMajordomoOwnerAddress_id

public int getMajordomoOwnerAddress_id()

getMajordomoOwnerAddress

public Address getMajordomoOwnerAddress()
                                 throws SQLException,
IOException

Throws:

SQLException

IOException

getOwnerMajordomoAddress_id

public int getOwnerMajordomoAddress_id()

getOwnerMajordomoAddress

public Address getOwnerMajordomoAddress()
                                 throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,MajordomoServer>

getVersion

public MajordomoVersion getVersion()
                            throws SQLException,
IOException

Throws:

SQLException

IOException

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

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

Throws:

IOException

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

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

Throws:

IOException