Module com.aoindustries.aoserv.master

Package com.aoindustries.aoserv.master

Class AoservMaster

java.lang.Object

com.aoindustries.aoserv.master.AoservMaster

Direct Known Subclasses:

TcpServer

public abstract class AoservMaster
extends Object

The AOServServer accepts connections from an AoservConnector. Once the connection is accepted and authenticated, the server carries out all actions requested by the client while providing the necessary security checks and data filters.

This server is completely threaded to handle multiple, simultaneous clients.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final ExecutorService	executorService	An unbounded executor for master-wide tasks.
protected final String	serverBind	The address that this server will bind to.
protected final int	serverPort	The port that this server will listen on.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AoservMaster(String serverBind, int serverPort)	Creates a new, running AOServServer.

Method Summary

Modifier and Type	Method	Description
static String	authenticate(DatabaseAccess db, String remoteHost, User.Name connectAs, User.Name authenticateAs, UnprotectedPassword password)
static void	checkAccessHostname(DatabaseConnection conn, RequestSource source, String action, String hostname)
static void	checkAccessHostname(DatabaseConnection conn, RequestSource source, String action, String hostname, List<DomainName> tlds)	Determines if this hostname may be used by the source.
final String	getBindAddress()	Gets the interface address this server is listening on.
static Random	getFastRandom()	A fast pseudo-random number generator for non-cryptographic purposes.
static Identifier	getNextConnectorId(AoservProtocol.Version protocolVersion)
final int	getPort()	Gets the interface port this server is listening on.
abstract String	getProtocol()
static int	getRequestConcurrency()
static long	getRequestConnections()
static int	getRequestMaxConcurrency()
static long	getRequestTotalTime()
static long	getRequestTransactions()
static SecureRandom	getSecureRandom()	A single random number generator is shared by all master resources.
static <T> T	getService(Class<T> clazz)	Gets a started service of the given class or interface.
static <T> List<T>	getServices(Class<T> clazz)	Gets all services of the given class or interface.
static <T> List<T>	getStartedServices(Class<T> clazz)	Gets all started services of the given class or interface.
static long	getStartTime()
static User	getUser(DatabaseAccess db, User.Name name)
static UserHost[]	getUserHosts(DatabaseAccess db, User.Name user)
static Map<User.Name,User>	getUsers(DatabaseAccess db)
protected static void	incConnectionCount()
static void	invalidateTable(Table.TableId tableId)
static void	invalidateTables(DatabaseAccess db, InvalidateList invalidateList, RequestSource invalidateSource)	Invalidates a table by notifying all connected clients, except the client that initiated this request.
static boolean	isHostAllowed(DatabaseAccess db, User.Name user, String host)	Gets the hosts that are allowed for the provided username.
static void	main(String[] args)	Loads and starts all MasterService.
static void	updateAoservProtocolLastUsed(DatabaseAccess db, AoservProtocol.Version protocolVersion)
static void	writeObject(DatabaseConnection conn, RequestSource source, StreamableOutput out, AoservObject<?,?> obj, String sql, Object... params)	Writes a single object, possibly null if there is no row, from a query.
static long	writeObjects(DatabaseConnection conn, RequestSource source, StreamableOutput out, boolean provideProgress, CursorMode cursorMode, AoservObject<?,?> obj, String sql, Object... params)	Performs a query and writes all rows of the result set.
static long	writeObjects(RequestSource source, StreamableOutput out, boolean provideProgress, Collection<? extends AoservWritable> objs)	Writes all rows of a results set.
static <T extends AoservObject<?, ?>> long	writeObjects(RequestSource source, StreamableOutput out, boolean provideProgress, T obj, ResultSet results)	Writes all rows of a results set.
static long	writeObjectsSynced(RequestSource source, StreamableOutput out, boolean provideProgress, Collection<? extends AoservWritable> objs)	Writes all rows of a results set while synchronizing on each object.
static void	writePenniesCheckBusiness(DatabaseConnection conn, RequestSource source, String action, Account.Name account, StreamableOutput out, String sql, String param1, String param2)	The query must result in precisely one row.
static void	writePenniesCheckBusiness(DatabaseConnection conn, RequestSource source, String action, Account.Name account, StreamableOutput out, String sql, String param1, String param2, Timestamp param3)	The query must result in precisely one row.

Methods inherited from class java.lang.Object

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

Field Details

executorService

public static final ExecutorService executorService

An unbounded executor for master-wide tasks.

serverBind

protected final String serverBind

The address that this server will bind to.

serverPort

protected final int serverPort

The port that this server will listen on.

Constructor Details

AoservMaster

protected AoservMaster(String serverBind,
 int serverPort)

Creates a new, running AOServServer.

Method Details

getBindAddress

public final String getBindAddress()

Gets the interface address this server is listening on.

getNextConnectorId

public static Identifier getNextConnectorId(AoservProtocol.Version protocolVersion)

getPort

public final int getPort()

Gets the interface port this server is listening on.

getProtocol

public abstract String getProtocol()

getSecureRandom

public static SecureRandom getSecureRandom()

A single random number generator is shared by all master resources.

Note: This is not a strong instance to avoid blocking.

getFastRandom

public static Random getFastRandom()

A fast pseudo-random number generator for non-cryptographic purposes.

getRequestConcurrency

public static int getRequestConcurrency()

incConnectionCount

protected static void incConnectionCount()

getRequestConnections

public static long getRequestConnections()

getRequestMaxConcurrency

public static int getRequestMaxConcurrency()

getRequestTotalTime

public static long getRequestTotalTime()

getRequestTransactions

public static long getRequestTransactions()

getStartTime

public static long getStartTime()

invalidateTables

public static void invalidateTables(DatabaseAccess db,
 InvalidateList invalidateList,
 RequestSource invalidateSource)
                             throws IOException,
SQLException

Invalidates a table by notifying all connected clients, except the client that initiated this request.

TODO: We need a way to convert invalidations of current tables to old table mappings. This would be the counterpart to TableHandler.getOldTable(com.aoapps.dbc.DatabaseConnection, com.aoindustries.aoserv.master.RequestSource, com.aoapps.hodgepodge.io.stream.StreamableOutput, boolean, java.lang.String).

Throws:

IOException

SQLException

getService

public static <T> T getService(Class<T> clazz)
                        throws MasterServiceException

Gets a started service of the given class or interface. If more than one started service is of the given class, there is no guarantee which is returned. TODO: round-robin from the registry.

Throws:

NoServiceException - when no services are of the given class

ServiceNotStartedException - when no services of the given class are started

MasterServiceException

getStartedServices

public static <T> List<T> getStartedServices(Class<T> clazz)

Gets all started services of the given class or interface.

Returns:

The list of services or an empty list when none found

getServices

public static <T> List<T> getServices(Class<T> clazz)
                               throws ServiceNotStartedException

Gets all services of the given class or interface.

Returns:

The list of services or an empty list when none found

Throws:

ServiceNotStartedException - when a matching service is not started

main

public static void main(String[] args)

Loads and starts all MasterService. Runs all of the configured protocols of AoservMaster processes as configured in com/aoindustries/aoserv/master/aoserv-master.properties.

writeObjects

public static <T extends AoservObject<?,
?>> long writeObjects(RequestSource source,
 StreamableOutput out,
 boolean provideProgress,
 T obj,
 ResultSet results)
                                                        throws IOException,
SQLException

Writes all rows of a results set.

Returns:

The number of rows written

Throws:

IOException

SQLException

writeObjects

public static long writeObjects(RequestSource source,
 StreamableOutput out,
 boolean provideProgress,
 Collection<? extends AoservWritable> objs)
                         throws IOException

Writes all rows of a results set.

Returns:

The number of rows written

Throws:

IOException

writeObjectsSynced

public static long writeObjectsSynced(RequestSource source,
 StreamableOutput out,
 boolean provideProgress,
 Collection<? extends AoservWritable> objs)
                               throws IOException

Writes all rows of a results set while synchronizing on each object.

Returns:

The number of rows written

Throws:

IOException

authenticate

public static String authenticate(DatabaseAccess db,
 String remoteHost,
 User.Name connectAs,
 User.Name authenticateAs,
 UnprotectedPassword password)
                           throws IOException,
SQLException

Parameters:

password - Is destroyed before this method returns. If the original password is needed, pass a clone to this method.

Throws:

IOException

SQLException

checkAccessHostname

public static void checkAccessHostname(DatabaseConnection conn,
 RequestSource source,
 String action,
 String hostname)
                                throws IOException,
SQLException

Throws:

IOException

SQLException

See Also:

• checkAccessHostname(com.aoapps.dbc.DatabaseConnection, com.aoindustries.aoserv.master.RequestSource, java.lang.String, java.lang.String, java.util.List)

checkAccessHostname

public static void checkAccessHostname(DatabaseConnection conn,
 RequestSource source,
 String action,
 String hostname,
 List<DomainName> tlds)
                                throws IOException,
SQLException

Determines if this hostname may be used by the source. The dns.ForbiddenZone, dns.Zone, web.VirtualHostName, and email.Domain tables are searched, in this order, for a match. If a match is found with an owner of this source, then access is granted. If the source is not restricted by either server or business, then access is granted and the previous checks are avoided.

TODO: What about ending '.' on zones vs DomainName objects here?

Throws:

IOException

SQLException

getUserHosts

public static UserHost[] getUserHosts(DatabaseAccess db,
 User.Name user)
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getUsers

public static Map<User.Name,User> getUsers(DatabaseAccess db)
                                    throws IOException,
SQLException

Throws:

IOException

SQLException

getUser

public static User getUser(DatabaseAccess db,
 User.Name name)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

isHostAllowed

public static boolean isHostAllowed(DatabaseAccess db,
 User.Name user,
 String host)
                             throws IOException,
SQLException

Gets the hosts that are allowed for the provided username.

Throws:

IOException

SQLException

writeObject

public static void writeObject(DatabaseConnection conn,
 RequestSource source,
 StreamableOutput out,
 AoservObject<?,?> obj,
 String sql,
 Object... params)
                        throws IOException,
SQLException

Writes a single object, possibly null if there is no row, from a query. The query must result in either zero or one row. If zero, null is written. If more than one row, an SQLException is thrown.

Throws:

SQLException - when more than one row is in the result set

IOException

writeObjects

public static long writeObjects(DatabaseConnection conn,
 RequestSource source,
 StreamableOutput out,
 boolean provideProgress,
 CursorMode cursorMode,
 AoservObject<?,?> obj,
 String sql,
 Object... params)
                         throws IOException,
SQLException

Performs a query and writes all rows of the result set. Calls either selectObjects or fetchObjects based on the CursorMode.

In particular, implements the CursorMode.AUTO mode for cursor selection.

Returns:

The number of rows written

Throws:

IOException

SQLException

See Also:

• CursorMode.AUTO
• selectObjects(com.aoapps.dbc.DatabaseConnection, com.aoindustries.aoserv.master.RequestSource, com.aoapps.hodgepodge.io.stream.StreamableOutput, boolean, com.aoindustries.aoserv.client.AoservObject, java.lang.String, java.lang.Object...)
• fetchObjects(com.aoapps.dbc.DatabaseConnection, com.aoindustries.aoserv.master.RequestSource, com.aoapps.hodgepodge.io.stream.StreamableOutput, boolean, com.aoindustries.aoserv.client.AoservObject, java.lang.String, java.lang.Object...)

writePenniesCheckBusiness

public static void writePenniesCheckBusiness(DatabaseConnection conn,
 RequestSource source,
 String action,
 Account.Name account,
 StreamableOutput out,
 String sql,
 String param1,
 String param2,
 Timestamp param3)
                                      throws IOException,
NoRowException,
SQLException

The query must result in precisely one row. If zero rows, NoRowException is thrown. If more than one row, an SQLException is thrown.

Throws:

NoRowException - when no rows are in the result set

SQLException - when more than one row is in the result set

IOException

writePenniesCheckBusiness

public static void writePenniesCheckBusiness(DatabaseConnection conn,
 RequestSource source,
 String action,
 Account.Name account,
 StreamableOutput out,
 String sql,
 String param1,
 String param2)
                                      throws IOException,
NoRowException,
SQLException

The query must result in precisely one row. If zero rows, NoRowException is thrown. If more than one row, an SQLException is thrown.

Throws:

NoRowException - when no rows are in the result set

SQLException - when more than one row is in the result set

IOException

invalidateTable

public static void invalidateTable(Table.TableId tableId)

updateAoservProtocolLastUsed

public static void updateAoservProtocolLastUsed(DatabaseAccess db,
 AoservProtocol.Version protocolVersion)
                                         throws IOException,
SQLException

Throws:

IOException

SQLException