Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.net

Class HostTable

java.lang.Object

com.aoindustries.aoserv.client.AoservTable<Integer,Host>

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

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

com.aoindustries.aoserv.client.net.HostTable

All Implemented Interfaces:

Table<Host>, Iterable<Host>

public final class HostTable
extends CachedTableIntegerKey<Host>

Author:

AO Industries, Inc.

See Also:

• Host

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
int	addBackupHost(String hostname, ServerFarm farm, Package owner, String description, int backupHour, OperatingSystemVersion osVersion, User.Name username, String password, String contactPhone, String contactEmail)
Host	get(int pkey)
Host	get(Object pkey)	Deprecated. Always try to lookup by specific keys; the compiler will help you more when types change.
Host	get(String server)	Gets a Server based on its hostname, package/name, or pkey.
protected AoservTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
Host	getHost(Package pk, String name)
List<Host>	getServers(Package pk)
Table.TableId	getTableId()	Gets the unique identifier for this table.
boolean	handleCommand(String[] rawArgs, String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)

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

clearCache, 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 Details

getDefaultOrderBy

protected AoservTable.OrderBy[] getDefaultOrderBy()

Description copied from class: AoservTable

Gets the default sorting for this table.

Specified by:

getDefaultOrderBy in class AoservTable<Integer,Host>

Returns:

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

addBackupHost

public int addBackupHost(String hostname,
 ServerFarm farm,
 Package owner,
 String description,
 int backupHour,
 OperatingSystemVersion osVersion,
 User.Name username,
 String password,
 String contactPhone,
 String contactEmail)
                  throws IOException,
SQLException

Throws:

IOException

SQLException

get

@Deprecated
public Host get(Object pkey)
         throws IOException,
SQLException

Deprecated.

Always try to lookup by specific keys; the compiler will help you more when types change.

Supports both Integer (pkey) and String (server) keys.

Overrides:

get in class CachedTableIntegerKey<Host>

Parameters:

pkey - when null, will always return null

Throws:

IOException

SQLException

get

public Host get(String server)
         throws SQLException,
IOException

Gets a Server based on its hostname, package/name, or pkey. If unambiguous, just "name" may be used without the package. This is compatible with the output of Server.toString(). Accepts either a hostname (for ao_servers), package/name, or pkey.

Returns:

the Server or null if not found

Throws:

SQLException

IOException

See Also:

• AoservObject.toString()
• get(java.lang.Object)

get

public Host get(int pkey)
         throws IOException,
SQLException

Specified by:

get in class CachedTableIntegerKey<Host>

Throws:

IOException

SQLException

See Also:

• get(java.lang.Object)

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

Returns:

the identifier for this table

See Also:

• Table.TableId

getHost

public Host getHost(Package pk,
 String name)
             throws IOException,
SQLException

Throws:

IOException

SQLException

getServers

public List<Host> getServers(Package pk)
                      throws IOException,
SQLException

Throws:

IOException

SQLException

handleCommand

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

Overrides:

handleCommand in class AoservTable<Integer,Host>

Throws:

IllegalArgumentException

IOException

SQLException