Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Class AOServConnector

java.lang.Object

com.aoindustries.aoserv.client.AOServConnector

All Implemented Interfaces:

SchemaParent

Direct Known Subclasses:

TCPConnector

public abstract class AOServConnector
extends Object
implements SchemaParent

An AOServConnector provides the connection between the object layer and the data. This connection may be persistent over TCP sockets, or it may be request-based like HTTP.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AOServConnector.IdLock
static interface	AOServConnector.ResultRequest<T>	This is the preferred mechanism for providing custom requests that have a return value.
static interface	AOServConnector.UpdateRequest	This is the preferred mechanism for providing custom requests.

Field Summary

Fields

Modifier and Type	Field	Description
protected Identifier	id
protected AOServConnector.IdLock	idLock
static long	MASTER_ENTROPY_POOL_SIZE	The maximum size of the master entropy pool in bytes.
protected String	password

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AOServConnector(HostAddress hostname, InetAddress local_ip, Port port, User.Name connectAs, User.Name authenticateAs, String password, DomainName daemonServer)

Method Summary

Modifier and Type	Method	Description
long	addMasterEntropy(byte[] buff, int numBytes)	Adds some entropy to the master server.
void	clearCaches()	Clears all caches used by this connector.
boolean	equals(Object O)	Uses equivalence equality like Object.equals(java.lang.Object).
String	executeCommand(String[] args)	Executes an aosh command and captures its output into a String.
Schema	getAccount()
Schema	getAccounting()
Schema	getAosh()
Schema	getBackup()
Schema	getBilling()
protected abstract AOServConnection	getConnection(int maxConnections)	Allocates a connection to the server.
static AOServConnector	getConnector()	Gets the default AOServConnector as defined in the com/aoindustries/aoserv/client/aoserv-client.properties resource.
static AOServConnector	getConnector(User.Name connectAs, User.Name authenticateAs, String password, DomainName daemonServer)	Gets the AOServConnector with the provided authentication information.
static AOServConnector	getConnector(User.Name username, String password)	Gets the AOServConnector with the provided authentication information.
Identifier	getConnectorId()	Each connector is assigned a unique identifier, which the server uses to not send events originating from this connector back to connections of this connector.
Administrator	getCurrentAdministrator()	Gets the Administrator who is logged in using this AOServConnector.
Schema	getDistribution()
Schema	getDistribution_management()
Schema	getDns()
Schema	getEmail()
static Random	getFastRandom()
Schema	getFtp()
HostAddress	getHostname()	Gets the hostname of the server that is connected to.
Schema	getInfrastructure()
Schema	getLinux()
InetAddress	getLocalIp()	Gets the optional local IP address that connections are made from.
protected Logger	getLogger()	Gets the logger for this connector.
Schema	getMaster()
int	getMasterEntropy(byte[] buff, int numBytes)	Gets some entropy from the master server, returns the number of bytes actually obtained.
long	getMasterEntropyNeeded()	Gets the amount of entropy needed by the master server in bytes.
Schema	getMysql()
Schema	getNet()
Schema	getPayment()
Schema	getPki()
Port	getPort()	Gets the server port that is connected to.
Schema	getPostgresql()
abstract String	getProtocol()	Gets the communication protocol being used.
Schema	getReseller()
Schema	getSchema()
List<? extends Schema>	getSchemas()	Gets an unmodifiable list of all of the top-level schemas in the system.
Schema	getScm()
static SecureRandom	getSecureRandom()
Schema	getSignup()
SimpleAOClient	getSimpleAOClient()
AOServTable<?,?>	getTable(int tableID)	Each table has a unique ID, as found in SchemaTable.
List<? extends AOServTable<?,?>>	getTables()	Gets an unmodifiable list of all of the tables in the system.
Schema	getTicket()
Schema	getWeb()
Schema	getWeb_jboss()
Schema	getWeb_tomcat()
int	hashCode()	Uses equivalence hashCode like Object.hashCode().
void	invalidateTable(int tableID, int server)	Manually invalidates the system caches.
abstract boolean	isSecure()	Determines if the connections made by this protocol are secure.
int	ping()	Times how long it takes to make one request with the server.
abstract void	printConnectionStatsHTML(Appendable out, boolean isXhtml)
static IntList	readInvalidateList(StreamableInput in)
protected abstract void	release(AOServConnection connection)	Releases a connection to the server.
void	removeFromAllTables(TableListener listener)
boolean	requestBooleanQuery(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
boolean	requestBooleanQueryIL(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
int	requestIntQuery(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
int	requestIntQueryIL(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
long	requestLongQuery(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
String	requestLongStringQuery(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)	Performs a query returning a String of any length (not limited to size <= 64k like requestStringQuery).
String	requestNullLongStringQuery(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)	Performs a query returning a String of any length (not limited to size <= 64k like requestStringQuery) or null.
<T> T	requestResult(boolean allowRetry, AoservProtocol.CommandID commID, AOServConnector.ResultRequest<T> resultRequest)
short	requestShortQuery(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
short	requestShortQueryIL(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
String	requestStringQuery(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
void	requestUpdate(boolean allowRetry, AoservProtocol.CommandID commID, AOServConnector.UpdateRequest updateRequest)
void	requestUpdate(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
void	requestUpdateIL(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
<K,T extends AOServObject<K,T>> void	sort(ComparisonSortAlgorithm<? super T> sortAlgorithm, List<T> list, SQLExpression[] sortExpressions, boolean[] sortOrders)
<K,T extends AOServObject<K,T>> void	sort(ComparisonSortAlgorithm<? super T> sortAlgorithm, T[] list, SQLExpression[] sortExpressions, boolean[] sortOrders)
abstract AOServConnector	switchUsers(User.Name username)
void	tablesUpdated(IntList invalidateList)
void	testConnect()	Tests the connectivity to the server.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MASTER_ENTROPY_POOL_SIZE

public static final long MASTER_ENTROPY_POOL_SIZE

The maximum size of the master entropy pool in bytes.

See Also:

Constant Field Values

idLock

protected final AOServConnector.IdLock idLock

id

protected Identifier id

password

protected final String password

Constructor Detail

AOServConnector

protected AOServConnector(HostAddress hostname,
                          InetAddress local_ip,
                          Port port,
                          User.Name connectAs,
                          User.Name authenticateAs,
                          String password,
                          DomainName daemonServer)

Method Detail

getAccount

public Schema getAccount()

getAccounting

public Schema getAccounting()

getAosh

public Schema getAosh()

getBackup

public Schema getBackup()

getBilling

public Schema getBilling()

getDistribution

public Schema getDistribution()

getDistribution_management

public Schema getDistribution_management()

getDns

public Schema getDns()

getEmail

public Schema getEmail()

getFtp

public Schema getFtp()

getInfrastructure

public Schema getInfrastructure()

getLinux

public Schema getLinux()

getMaster

public Schema getMaster()

getMysql

public Schema getMysql()

getNet

public Schema getNet()

getPayment

public Schema getPayment()

getPki

public Schema getPki()

getPostgresql

public Schema getPostgresql()

getReseller

public Schema getReseller()

getSchema

public Schema getSchema()

getScm

public Schema getScm()

getSignup

public Schema getSignup()

getTicket

public Schema getTicket()

getWeb

public Schema getWeb()

getWeb_jboss

public Schema getWeb_jboss()

getWeb_tomcat

public Schema getWeb_tomcat()

getSimpleAOClient

public SimpleAOClient getSimpleAOClient()

equals

public final boolean equals(Object O)

Uses equivalence equality like Object.equals(java.lang.Object). Two connectors are considered equal only if they refer to the same object.

Overrides:

equals in class Object

hashCode

public final int hashCode()

Uses equivalence hashCode like Object.hashCode().

Overrides:

hashCode in class Object

clearCaches

public void clearCaches()

Clears all caches used by this connector.

executeCommand

public String executeCommand(String[] args)
                      throws IOException,
                             SQLException

Executes an aosh command and captures its output into a String.

Parameters:

args - the command and arguments to be processed

Returns:

the results of the command wrapped into a String

Throws:

IOException - if unable to access the server

SQLException - if unable to access the database or data integrity checks fail

getLogger

protected final Logger getLogger()

Gets the logger for this connector.

getConnection

protected abstract AOServConnection getConnection(int maxConnections)
                                           throws InterruptedIOException,
                                                  IOException

Allocates a connection to the server. These connections must later be released with the AOServConnection.close() method. Connection pooling is obtained this way. These connections may be over any protocol, so they may only safely be used for one client/server exchange per allocation. Also, if connections are not always released, deadlock will quickly occur. Please use in a try-with-resources or try/finally block to make sure it is always released.

Returns:

the connection to the server

Throws:

InterruptedIOException - if interrupted while connecting

IOException - if unable to connect to the server

See Also:

AOServConnection.close()

getConnector

public static AOServConnector getConnector()
                                    throws ConfigurationException

Gets the default AOServConnector as defined in the com/aoindustries/aoserv/client/aoserv-client.properties resource. Each possible protocol is tried, in order, until a successful connection is made.

Returns:

the first AOServConnector to successfully connect to the server

Throws:

ConfigurationException - if no connection can be established

getConnector

public static AOServConnector getConnector(User.Name username,
                                           String password)
                                    throws ConfigurationException

Gets the AOServConnector with the provided authentication information. The com/aoindustries/aoserv/client/aoserv-client.properties resource determines which protocols will be used. Each possible protocol is tried, in order, until a successful connection is made.

Parameters:

username - the username to connect as

password - the password to connect with

Returns:

the first AOServConnector to successfully connect to the server

Throws:

ConfigurationException - if no connection can be established

getConnector

public static AOServConnector getConnector(User.Name connectAs,
                                           User.Name authenticateAs,
                                           String password,
                                           DomainName daemonServer)
                                    throws ConfigurationException

Gets the AOServConnector with the provided authentication information. The com/aoindustries/aoserv/client/aoserv-client.properties resource determines which protocols will be used. Each possible protocol is tried, in order, until a successful connection is made.

Parameters:

connectAs - the username to connect as

authenticateAs - the username used for authentication, if different than connectAs, this username must have super user privileges

password - the password to connect with

Returns:

the first AOServConnector to successfully connect to the server

Throws:

ConfigurationException - if no connection can be established

getConnectorId

public final Identifier getConnectorId()

Each connector is assigned a unique identifier, which the server uses to not send events originating from this connector back to connections of this connector.

Returns:

the globally unique identifier or null if the identifier has not yet been assigned

getHostname

public final HostAddress getHostname()

Gets the hostname of the server that is connected to.

getLocalIp

public final InetAddress getLocalIp()

Gets the optional local IP address that connections are made from.

getPort

public final Port getPort()

Gets the server port that is connected to.

getProtocol

public abstract String getProtocol()

Gets the communication protocol being used.

getSecureRandom

public static SecureRandom getSecureRandom()

getFastRandom

public static Random getFastRandom()

getSchemas

public final List<? extends Schema> getSchemas()

Gets an unmodifiable list of all of the top-level schemas in the system.

Specified by:

getSchemas in interface SchemaParent

getTable

public final AOServTable<?,?> getTable(int tableID)
                                      throws IllegalArgumentException

Each table has a unique ID, as found in SchemaTable. The actual AOServTable may be obtained given its identifier.

Parameters:

tableID - the unique ID of the table

Returns:

the appropriate subclass of AOServTable

Throws:

IllegalArgumentException - if unable to find the table

See Also:

Table

getTables

public final List<? extends AOServTable<?,?>> getTables()

Gets an unmodifiable list of all of the tables in the system.

Returns:

a List<AOServTable> containing all the tables. Each table is at an index corresponding to its unique ID.

See Also:

getTable(int), Table

getCurrentAdministrator

public final Administrator getCurrentAdministrator()
                                            throws SQLException,
                                                   IOException

Gets the Administrator who is logged in using this AOServConnector. Each username and password pair resolves to an always-accessible Administrator. Details about permissions and capabilities may be obtained from the Administrator.

Returns:

the Administrator who is logged in

Throws:

IOException - if unable to communicate with the server

SQLException - if unable to access the database or the Administrator was not found

invalidateTable

public void invalidateTable(int tableID,
                            int server)
                     throws IOException,
                            SQLException

Manually invalidates the system caches.

Parameters:

tableID - the table ID

server - the pkey of the server or -1 for all servers

Throws:

IOException

SQLException

readInvalidateList

public static IntList readInvalidateList(StreamableInput in)
                                  throws IOException

Throws:

IOException

isSecure

public abstract boolean isSecure()
                          throws IOException

Determines if the connections made by this protocol are secure. A connection is considered secure if it uses end-point to end-point encryption or goes over private lines.

Returns:

true if the connection is secure

Throws:

IOException - if unable to determine if the connection is secure

ping

public final int ping()
               throws IOException,
                      SQLException

Times how long it takes to make one request with the server. This will not retry and will return the first error encountered.

Returns:

the connection latency in milliseconds

Throws:

IOException

SQLException

printConnectionStatsHTML

public abstract void printConnectionStatsHTML(Appendable out,
                                              boolean isXhtml)
                                       throws IOException

Throws:

IOException

release

protected abstract void release(AOServConnection connection)
                         throws IOException

Releases a connection to the server. This will either close the connection or allow another thread to use the connection. Connections may be of any protocol, so each connection must be released after every transaction.

Parameters:

connection - the connection to close or release

Throws:

IOException - if an error occurred while closing or releasing the connection

See Also:

getConnection(int), AOServConnection.close()

removeFromAllTables

public final void removeFromAllTables(TableListener listener)

requestResult

public final <T> T requestResult(boolean allowRetry,
                                 AoservProtocol.CommandID commID,
                                 AOServConnector.ResultRequest<T> resultRequest)
                          throws IOException,
                                 SQLException

Throws:

IOException

SQLException

requestBooleanQuery

public final boolean requestBooleanQuery(boolean allowRetry,
                                         AoservProtocol.CommandID commID,
                                         Object... params)
                                  throws IOException,
                                         SQLException

Throws:

IOException

SQLException

requestBooleanQueryIL

public final boolean requestBooleanQueryIL(boolean allowRetry,
                                           AoservProtocol.CommandID commID,
                                           Object... params)
                                    throws IOException,
                                           SQLException

Throws:

IOException

SQLException

requestIntQuery

public final int requestIntQuery(boolean allowRetry,
                                 AoservProtocol.CommandID commID,
                                 Object... params)
                          throws IOException,
                                 SQLException

Throws:

IOException

SQLException

requestIntQueryIL

public final int requestIntQueryIL(boolean allowRetry,
                                   AoservProtocol.CommandID commID,
                                   Object... params)
                            throws IOException,
                                   SQLException

Throws:

IOException

SQLException

requestLongQuery

public final long requestLongQuery(boolean allowRetry,
                                   AoservProtocol.CommandID commID,
                                   Object... params)
                            throws IOException,
                                   SQLException

Throws:

IOException

SQLException

requestShortQuery

public final short requestShortQuery(boolean allowRetry,
                                     AoservProtocol.CommandID commID,
                                     Object... params)
                              throws IOException,
                                     SQLException

Throws:

IOException

SQLException

requestShortQueryIL

public final short requestShortQueryIL(boolean allowRetry,
                                       AoservProtocol.CommandID commID,
                                       Object... params)
                                throws IOException,
                                       SQLException

Throws:

IOException

SQLException

requestStringQuery

public final String requestStringQuery(boolean allowRetry,
                                       AoservProtocol.CommandID commID,
                                       Object... params)
                                throws IOException,
                                       SQLException

Throws:

IOException

SQLException

requestLongStringQuery

public final String requestLongStringQuery(boolean allowRetry,
                                           AoservProtocol.CommandID commID,
                                           Object... params)
                                    throws IOException,
                                           SQLException

Performs a query returning a String of any length (not limited to size <= 64k like requestStringQuery).

Throws:

IOException

SQLException

requestNullLongStringQuery

public final String requestNullLongStringQuery(boolean allowRetry,
                                               AoservProtocol.CommandID commID,
                                               Object... params)
                                        throws IOException,
                                               SQLException

Performs a query returning a String of any length (not limited to size <= 64k like requestStringQuery) or null. Supports nulls.

Throws:

IOException

SQLException

requestUpdate

public final void requestUpdate(boolean allowRetry,
                                AoservProtocol.CommandID commID,
                                AOServConnector.UpdateRequest updateRequest)
                         throws IOException,
                                SQLException

Throws:

IOException

SQLException

requestUpdate

public final void requestUpdate(boolean allowRetry,
                                AoservProtocol.CommandID commID,
                                Object... params)
                         throws IOException,
                                SQLException

Throws:

IOException

SQLException

requestUpdateIL

public final void requestUpdateIL(boolean allowRetry,
                                  AoservProtocol.CommandID commID,
                                  Object... params)
                           throws IOException,
                                  SQLException

Throws:

IOException

SQLException

switchUsers

public abstract AOServConnector switchUsers(User.Name username)
                                     throws IOException

Throws:

IOException

tablesUpdated

public final void tablesUpdated(IntList invalidateList)

testConnect

public final void testConnect()
                       throws IOException,
                              SQLException

Tests the connectivity to the server. This test is only performed once per server per protocol. Following that, the cached results are used.

Throws:

IOException - if unable to contact the server

SQLException

toString

public final String toString()

Overrides:

toString in class Object

getMasterEntropy

public int getMasterEntropy(byte[] buff,
                            int numBytes)
                     throws IOException,
                            SQLException

Gets some entropy from the master server, returns the number of bytes actually obtained.

Throws:

IOException

SQLException

getMasterEntropyNeeded

public long getMasterEntropyNeeded()
                            throws IOException,
                                   SQLException

Gets the amount of entropy needed by the master server in bytes.

Throws:

IOException

SQLException

addMasterEntropy

public long addMasterEntropy(byte[] buff,
                             int numBytes)
                      throws IOException,
                             SQLException

Adds some entropy to the master server.

Throws:

IOException

SQLException

sort

public <K,T extends AOServObject<K,T>> void sort(ComparisonSortAlgorithm<? super T> sortAlgorithm,
                                                             T[] list,
                                                             SQLExpression[] sortExpressions,
                                                             boolean[] sortOrders)

sort

public <K,T extends AOServObject<K,T>> void sort(ComparisonSortAlgorithm<? super T> sortAlgorithm,
                                                             List<T> list,
                                                             SQLExpression[] sortExpressions,
                                                             boolean[] sortOrders)