Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Class TcpConnector

java.lang.Object

com.aoindustries.aoserv.client.AoservConnector

com.aoindustries.aoserv.client.TcpConnector

All Implemented Interfaces:

SchemaParent

Direct Known Subclasses:

SslConnector

public class TcpConnector
extends AoservConnector

A TcpConnector provides the connection between the object layer and the data over a pool of un-secured sockets.

Author:

AO Industries, Inc.

See Also:

• SocketConnection

Nested Class Summary

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

AoservConnector.IdLock, AoservConnector.ResultRequest<T>, AoservConnector.UpdateRequest, AoservConnector.UpdateRequestInvalidating

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TCP_PROTOCOL	The protocol of this type of connector.

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

id, idLock, MASTER_ENTROPY_POOL_SIZE, password

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TcpConnector(HostAddress hostname, InetAddress localIp, Port port, User.Name connectAs, User.Name authenticateAs, String password, DomainName daemonServer, int poolSize, long maxConnectionAge)

Method Summary

Modifier and Type	Method	Description
protected final SocketConnection	getConnection(int maxConnections)	Allocates a connection to the server.
String	getProtocol()	Gets the communication protocol being used.
static TcpConnector	getTcpConnector(HostAddress hostname, InetAddress localIp, Port port, User.Name connectAs, User.Name authenticateAs, String password, DomainName daemonServer, int poolSize, long maxConnectionAge)
boolean	isSecure()	Determines if the connections made by this protocol are secure.
final void	printConnectionStatsHtml(Appendable out, boolean isXhtml)
protected final void	release(AoservConnection conn)	Releases a connection to the server.
AoservConnector	switchUsers(User.Name username)

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

addMasterEntropy, clearCaches, equals, executeCommand, getAccount, getAccounting, getAosh, getBackup, getBilling, getConnector, getConnector, getConnector, getConnectorId, getCurrentAdministrator, getDistribution, getDistribution_management, getDns, getEmail, getFastRandom, getFtp, getHostname, getInfrastructure, getLinux, getLocalIp, getLogger, getMaster, getMasterEntropy, getMasterEntropyNeeded, getMysql, getNet, getPayment, getPki, getPort, getPostgresql, getReseller, getSchema, getSchemas, getScm, getSecureRandom, getSignup, getSimpleClient, getTable, getTables, getTicket, getWeb, getWeb_jboss, getWeb_tomcat, hashCode, invalidateTable, ping, readInvalidateList, removeFromAllTables, requestBooleanQuery, requestBooleanQueryInvalidating, requestIntQuery, requestIntQueryInvalidating, requestLongQuery, requestLongStringQuery, requestNullLongStringQuery, requestResult, requestShortQuery, requestShortQueryInvalidating, requestStringQuery, requestUpdate, requestUpdate, requestUpdateInvalidating, sort, sort, tablesUpdated, testConnect, toString

Methods inherited from class java.lang.Object

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

Field Details

TCP_PROTOCOL

public static final String TCP_PROTOCOL

The protocol of this type of connector.

See Also:

• Constant Field Values

Constructor Details

TcpConnector

protected TcpConnector(HostAddress hostname,
 InetAddress localIp,
 Port port,
 User.Name connectAs,
 User.Name authenticateAs,
 String password,
 DomainName daemonServer,
 int poolSize,
 long maxConnectionAge)

Method Details

getConnection

protected final SocketConnection getConnection(int maxConnections)
                                        throws InterruptedIOException,
IOException

Description copied from class: AoservConnector

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.

Specified by:

getConnection in class AoservConnector

Returns:

the connection to the server

Throws:

InterruptedIOException - if interrupted while connecting

IOException - if unable to connect to the server

See Also:

• AoservConnection.close()

getProtocol

public String getProtocol()

Description copied from class: AoservConnector

Gets the communication protocol being used.

Specified by:

getProtocol in class AoservConnector

getTcpConnector

public static TcpConnector getTcpConnector(HostAddress hostname,
 InetAddress localIp,
 Port port,
 User.Name connectAs,
 User.Name authenticateAs,
 String password,
 DomainName daemonServer,
 int poolSize,
 long maxConnectionAge)

isSecure

public boolean isSecure()
                 throws UnknownHostException,
IOException

Description copied from class: AoservConnector

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.

Specified by:

isSecure in class AoservConnector

Returns:

true if the connection is secure

Throws:

IOException - if unable to determine if the connection is secure

UnknownHostException

printConnectionStatsHtml

public final void printConnectionStatsHtml(Appendable out,
 boolean isXhtml)
                                    throws IOException

Specified by:

printConnectionStatsHtml in class AoservConnector

Throws:

IOException

release

protected final void release(AoservConnection conn)
                      throws IOException

Description copied from class: AoservConnector

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.

Specified by:

release in class AoservConnector

Parameters:

conn - the connection to close or release

Throws:

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

See Also:

• AoservConnector.getConnection(int)
• AoservConnection.close()

switchUsers

public AoservConnector switchUsers(User.Name username)
                            throws IOException

Specified by:

switchUsers in class AoservConnector

Throws:

IOException