Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.linux

Class UserServer

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.linux.UserServer

All Implemented Interfaces:

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

public final class UserServer
extends CachedObjectIntegerKey<UserServer>
implements Removable, PasswordProtected, Disablable

A LinuxServerAccount grants a LinuxAccount access to a Server.

Author:

AO Industries, Inc.

See Also:

• User
• Server

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_AO_SERVER_name
static final String	COLUMN_USERNAME_name
static final int	DEFAULT_JUNK_EMAIL_RETENTION	The default number of days email messages will be kept in the "Junk" folder.
static final int	DEFAULT_SPAM_ASSASSIN_DISCARD_SCORE	The default SpamAssassin discard score.
static final float	DEFAULT_SPAM_ASSASSIN_REQUIRED_SCORE	The default SpamAssassin required score.
static final int	DEFAULT_TRASH_EMAIL_RETENTION	The default number of days email messages will be kept in the "Trash" folder.
static final int	ROOT_UID	The UID of the root user.

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

Fields inherited from interface com.aoindustries.aoserv.client.password.PasswordProtected

ALL, NONE, SOME

Constructor Summary

Constructors

Constructor	Description
UserServer()	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)
int	arePasswordsSet()
boolean	canDisable()
boolean	canEnable()
boolean	canSetPassword()
List<PasswordChecker.Result>	checkPassword(String password)
long	copyHomeDirectory(Server toServer)
void	copyPassword(UserServer other)
void	disable(DisableLog dl)
void	enable()
int	getAoServer_server_id()
String	getAutoresponderContent()
InboxAddress	getAutoresponderFrom()
String	getAutoresponderPath()
String	getAutoresponderSubject()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
UnmodifiableTimestamp	getCreated()
String	getCronTable()
List<CvsRepository>	getCvsRepositories()
static PosixPath	getDefaultHomeDirectory(User.Name username)	Gets the default non-hashed home directory of /home/username.
DisableLog	getDisableLog()
List<Address>	getEmailAddresses()
List<AttachmentBlock>	getEmailAttachmentBlocks()
List<List>	getEmailLists()
SpamAssassinMode	getEmailSpamAssassinIntegrationMode()
static PosixPath	getHashedHomeDirectory(User.Name username)	Gets the optional hashed home directory of /home/u/username.
PosixPath	getHome()
List<SharedTomcat>	getHttpdSharedTomcats()
List<Site>	getHttpdSites()
long[]	getImapFolderSizes(String[] folderNames)
InboxAttributes	getInboxAttributes()
int	getJunkEmailRetention()	Gets the age of junk that will be auto-deleted, in days, or -1 to not auto-delete.
List<InboxAddress>	getLinuxAccAddresses()
User	getLinuxAccount()
User.Name	getLinuxAccount_username_id()
String	getPredisablePassword()
GroupServer	getPrimaryLinuxServerGroup()	Gets the primary GroupUser for this UserServer.
Server	getServer()
int	getSpamAssassinDiscardScore()	Gets the minimum score where spam assassin should discard email or -1 if this feature is disabled.
float	getSpamAssassinRequiredScore()
String	getSudo()	Gets the sudo setting for this user or null when no sudo allowed.
Table.TableId	getTableId()
int	getTrashEmailRetention()	Gets the age of trash that will be auto-deleted, in days, or -1 to not auto-delete.
LinuxId	getUid()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isAutoresponderEnabled()
boolean	isDisabled()	Checks if this object is disabled.
int	isProcmailManual()
boolean	passwordMatches(String password)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setAutoresponder(InboxAddress from, String subject, String content, boolean enabled)
void	setCronTable(String cronTable)
void	setEmailSpamAssassinIntegrationMode(SpamAssassinMode mode)
void	setJunkEmailRetention(int days)
void	setPassword(String password)
void	setPredisablePassword(String password)
void	setSpamAssassinDiscardScore(int discardScore)
void	setSpamAssassinRequiredScore(float requiredScore)
void	setTrashEmailRetention(int days)
void	setUseInbox(boolean useInbox)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
boolean	useInbox()
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

ROOT_UID

public static final int ROOT_UID

The UID of the root user.

Note: Copied from PosixFile.java to avoid interproject dependency.

See Also:

• Constant Field Values

COLUMN_USERNAME_name

public static final String COLUMN_USERNAME_name

See Also:

• Constant Field Values

COLUMN_AO_SERVER_name

public static final String COLUMN_AO_SERVER_name

See Also:

• Constant Field Values

DEFAULT_TRASH_EMAIL_RETENTION

public static final int DEFAULT_TRASH_EMAIL_RETENTION

The default number of days email messages will be kept in the "Trash" folder.

See Also:

• Constant Field Values

DEFAULT_JUNK_EMAIL_RETENTION

public static final int DEFAULT_JUNK_EMAIL_RETENTION

The default number of days email messages will be kept in the "Junk" folder.

See Also:

• Constant Field Values

DEFAULT_SPAM_ASSASSIN_REQUIRED_SCORE

public static final float DEFAULT_SPAM_ASSASSIN_REQUIRED_SCORE

The default SpamAssassin required score.

See Also:

• Constant Field Values

DEFAULT_SPAM_ASSASSIN_DISCARD_SCORE

public static final int DEFAULT_SPAM_ASSASSIN_DISCARD_SCORE

The default SpamAssassin discard score.

See Also:

• Constant Field Values

Constructor Details

UserServer

@Deprecated(forRemoval=true)
public UserServer()

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

canDisable

public boolean canDisable()
                   throws IOException,
SQLException

Specified by:

canDisable in interface Disablable

Throws:

IOException

SQLException

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

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

checkPassword

public List<PasswordChecker.Result> checkPassword(String password)
                                           throws SQLException,
IOException

Specified by:

checkPassword in interface PasswordProtected

Throws:

SQLException

IOException

copyHomeDirectory

public long copyHomeDirectory(Server toServer)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

copyPassword

public void copyPassword(UserServer other)
                  throws IOException,
SQLException

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

getCvsRepositories

public List<CvsRepository> getCvsRepositories()
                                       throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailAttachmentBlocks

public List<AttachmentBlock> getEmailAttachmentBlocks()
                                               throws IOException,
SQLException

Throws:

IOException

SQLException

getAutoresponderContent

public String getAutoresponderContent()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getAutoresponderFrom

public InboxAddress getAutoresponderFrom()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getAutoresponderSubject

public String getAutoresponderSubject()

getAutoresponderPath

public String getAutoresponderPath()

isAutoresponderEnabled

public boolean isAutoresponderEnabled()

getCronTable

public String getCronTable()
                    throws IOException,
SQLException

Throws:

IOException

SQLException

getDefaultHomeDirectory

public static PosixPath getDefaultHomeDirectory(User.Name username)

Gets the default non-hashed home directory of /home/username.

getHashedHomeDirectory

public static PosixPath getHashedHomeDirectory(User.Name username)

Gets the optional hashed home directory of /home/u/username.

getDisableLog

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

getEmailAddresses

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

Throws:

SQLException

IOException

getHttpdSharedTomcats

public List<SharedTomcat> getHttpdSharedTomcats()
                                         throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSites

public List<Site> getHttpdSites()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getInboxAttributes

public InboxAttributes getInboxAttributes()
                                   throws IOException,
SQLException

Throws:

IOException

SQLException

getImapFolderSizes

public long[] getImapFolderSizes(String[] folderNames)
                          throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxAccAddresses

public List<InboxAddress> getLinuxAccAddresses()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getHome

public PosixPath getHome()

getLinuxAccount_username_id

public User.Name getLinuxAccount_username_id()

getLinuxAccount

public User getLinuxAccount()
                     throws SQLException,
IOException

Throws:

SQLException

IOException

getPredisablePassword

public String getPredisablePassword()

getCreated

public UnmodifiableTimestamp getCreated()

useInbox

public boolean useInbox()

getTrashEmailRetention

public int getTrashEmailRetention()

Gets the age of trash that will be auto-deleted, in days, or -1 to not auto-delete.

getJunkEmailRetention

public int getJunkEmailRetention()

Gets the age of junk that will be auto-deleted, in days, or -1 to not auto-delete.

getEmailSpamAssassinIntegrationMode

public SpamAssassinMode getEmailSpamAssassinIntegrationMode()
                                                     throws SQLException,
IOException

Throws:

SQLException

IOException

getSpamAssassinRequiredScore

public float getSpamAssassinRequiredScore()

getSpamAssassinDiscardScore

public int getSpamAssassinDiscardScore()

Gets the minimum score where spam assassin should discard email or -1 if this feature is disabled.

getSudo

public String getSudo()

Gets the sudo setting for this user or null when no sudo allowed.

getPrimaryLinuxServerGroup

public GroupServer getPrimaryLinuxServerGroup()
                                       throws SQLException,
IOException

Gets the primary GroupUser for this UserServer.

Throws:

SQLException - if the primary group is not found or two or more groups are marked as primary or the primary group does not exist on the same server

IOException

getAoServer_server_id

public int getAoServer_server_id()

getServer

public Server getServer()
                 throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,UserServer>

getUid

public LinuxId getUid()

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

Parameters:

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

Throws:

SQLException

isProcmailManual

public int isProcmailManual()
                     throws IOException,
SQLException

Throws:

IOException

SQLException

arePasswordsSet

public int arePasswordsSet()
                    throws IOException,
SQLException

Specified by:

arePasswordsSet in interface PasswordProtected

Throws:

IOException

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

Throws:

IOException

getEmailLists

public List<List> getEmailLists()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getCannotRemoveReasons

public List<CannotRemoveReason<?>> getCannotRemoveReasons()
                                                   throws SQLException,
IOException

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

Throws:

SQLException

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

setCronTable

public void setCronTable(String cronTable)
                  throws IOException,
SQLException

Throws:

IOException

SQLException

setPassword

public void setPassword(String password)
                 throws IOException,
SQLException

Specified by:

setPassword in interface PasswordProtected

Throws:

IOException

SQLException

setAutoresponder

public void setAutoresponder(InboxAddress from,
 String subject,
 String content,
 boolean enabled)
                      throws IOException,
SQLException

Throws:

IOException

SQLException

setTrashEmailRetention

public void setTrashEmailRetention(int days)
                            throws IOException,
SQLException

Throws:

IOException

SQLException

setJunkEmailRetention

public void setJunkEmailRetention(int days)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

setEmailSpamAssassinIntegrationMode

public void setEmailSpamAssassinIntegrationMode(SpamAssassinMode mode)
                                         throws IOException,
SQLException

Throws:

IOException

SQLException

setSpamAssassinRequiredScore

public void setSpamAssassinRequiredScore(float requiredScore)
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

setSpamAssassinDiscardScore

public void setSpamAssassinDiscardScore(int discardScore)
                                 throws IOException,
SQLException

Throws:

IOException

SQLException

setUseInbox

public void setUseInbox(boolean useInbox)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

setPredisablePassword

public void setPredisablePassword(String password)
                           throws IOException,
SQLException

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

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

Throws:

IOException

canSetPassword

public boolean canSetPassword()
                       throws IOException,
SQLException

Specified by:

canSetPassword in interface PasswordProtected

Throws:

IOException

SQLException

passwordMatches

public boolean passwordMatches(String password)
                        throws IOException,
SQLException

Throws:

IOException

SQLException

addEmailAddress

public int addEmailAddress(Address address)
                    throws IOException,
SQLException

Throws:

IOException

SQLException