Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.linux

Class UserServerTable

java.lang.Object

com.aoindustries.aoserv.client.AOServTable<K,V>

com.aoindustries.aoserv.client.CachedTable<Integer,V>

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

com.aoindustries.aoserv.client.linux.UserServerTable

All Implemented Interfaces:

Table<UserServer>, Iterable<UserServer>

public final class UserServerTable
extends CachedTableIntegerKey<UserServer>

Author:

AO Industries, Inc.

See Also:

UserServer

Nested Class Summary

Nested classes/interfaces inherited from class com.aoindustries.aoserv.client.AOServTable

AOServTable.OrderBy

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.AOServTable

ASCENDING, connector, DESCENDING

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears the cache, freeing up memory.
UserServer	get(int pkey)
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
UserServer	getLinuxServerAccountFromEmailAddress(String address, DomainName domain, String password)	Finds a LinuxServerAccount by an email address and password combination.
UserServer	getLinuxServerAccountFromUsernamePassword(User.Name username, String password, boolean emailOnly)	Finds a LinuxServerAccount by a username and password combination.
List<UserServer>	getMailAccounts()
Table.TableID	getTableID()	Gets the unique identifier for this table.
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)

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

get

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

getIndexedRows, getRows, getRowsCopy, getUniqueRowImpl, isLoaded

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

addProgressListener, addTableListener, addTableListener, addTableLoadListener, getCachedRowCount, getConnector, getDefaultOrderBySQLExpressions, getIndexedRows, getMap, getNewObject, getObject, getObjects, getObjects, getObjects, getObjectsNoProgress, getObjectsNoProgress, getSize, getSortAlgorithm, getTableName, getTableSchema, getUniqueRow, getUniqueRow, getUniqueRow, getUniqueRow, hasAnyTableListener, hasTableListener, isEmpty, iterator, printTable, removeProgressListener, removeTableListener, removeTableLoadListener, size, sortIfNeeded, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getDefaultOrderBy

protected AOServTable.OrderBy[] getDefaultOrderBy()

Description copied from class: AOServTable

Gets the default sorting for this table.

Specified by:

getDefaultOrderBy in class AOServTable<Integer,UserServer>

Returns:

null if the sorting is performed by the server or the array of column names

clearCache

public void clearCache()

Description copied from class: CachedTable

Clears the cache, freeing up memory. The data will be reloaded upon next use.

Overrides:

clearCache in class CachedTable<Integer,UserServer>

get

public UserServer get(int pkey)
               throws IOException,
                      SQLException

Specified by:

get in class CachedTableIntegerKey<UserServer>

Throws:

IOException

SQLException

See Also:

CachedTableIntegerKey.get(java.lang.Object)

getLinuxServerAccountFromUsernamePassword

public UserServer getLinuxServerAccountFromUsernamePassword(User.Name username,
                                                            String password,
                                                            boolean emailOnly)
                                                     throws LoginException,
                                                            IOException,
                                                            SQLException

Finds a LinuxServerAccount by a username and password combination. It tries to return an account that is not disabled and matches both username and password.

Returns:

the LinuxServerAccount found if a non-disabled username and password are found, or null if no match found

Throws:

LoginException - if a possible account match is found but the account is disabled or has a different password

IOException

SQLException

getLinuxServerAccountFromEmailAddress

public UserServer getLinuxServerAccountFromEmailAddress(String address,
                                                        DomainName domain,
                                                        String password)
                                                 throws LoginException,
                                                        IOException,
                                                        SQLException

Finds a LinuxServerAccount by an email address and password combination. It tries to return an account that is not disabled and matches both email address and password.

Returns:

the LinuxServerAccount found if a non-disabled email address and password are found, or null if no match found

Throws:

LoginException - if a possible account match is found but the account is disabled or has a different password

IOException

SQLException

getMailAccounts

public List<UserServer> getMailAccounts()
                                 throws IOException,
                                        SQLException

Throws:

IOException

SQLException

getTableID

public Table.TableID getTableID()

Description copied from class: AOServTable

Gets the unique identifier for this table. Each table has a unique identifier, as defined in SchemaTable.TableID.

Specified by:

getTableID in class AOServTable<Integer,UserServer>

Returns:

the identifier for this table

See Also:

Table.TableID

handleCommand

public boolean handleCommand(String[] args,
                             Reader in,
                             TerminalWriter out,
                             TerminalWriter err,
                             boolean isInteractive)
                      throws IllegalArgumentException,
                             IOException,
                             SQLException

Overrides:

handleCommand in class AOServTable<Integer,UserServer>

Throws:

IllegalArgumentException

IOException

SQLException