Module com.aoindustries.aoserv.master

Package com.aoindustries.aoserv.master

Class TableHandler

java.lang.Object

com.aoindustries.aoserv.master.TableHandler

public final class TableHandler
extends Object

The TableHandler handles all the accesses to the AOServ tables.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TableHandler.GetObjectHandler
static interface	TableHandler.GetTableHandler
static class	TableHandler.GetTableHandlerByRole
static class	TableHandler.GetTableHandlerPermission
static class	TableHandler.GetTableHandlerPermissionByRole
static class	TableHandler.GetTableHandlerPublic

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BATCH_COMMIT_INTERVAL	The number of updates that will typically be done before the changes are committed.
static final String	BU1_PARENTS_JOIN	The joins used for the business tree.
static final String	BU1_PARENTS_JOIN_NO_COMMA	The joins used for the business tree.
static final String	BU2_PARENTS_JOIN	The joins used for the business tree.
static final String	PK_BU1_PARENTS_WHERE	The where clauses that accompany the joins.
static final String	PK1_BU1_PARENTS_OR_WHERE	The where clauses that accompany the joins.
static final String	PK1_BU1_PARENTS_WHERE	The where clauses that accompany the joins.
static final String	PK3_BU2_PARENTS_OR_WHERE	The where clauses that accompany the joins.
static final String	PK3_BU2_PARENTS_WHERE	The where clauses that accompany the joins.
static final int	UPDATE_BATCH_SIZE	The number of rows statements that should typically be used per update/insert/delete batch.

Method Summary

Modifier and Type	Method	Description
static int	addGetObjectHandler(TableHandler.GetObjectHandler handler)	This is available, but recommend registering via ServiceLoader.
static int	addGetTableHandler(TableHandler.GetTableHandler handler)	This is available, but recommend registering via ServiceLoader.
static void	checkInvalidator(DatabaseConnection conn, RequestSource source, String action)
static int	convertClientTableIdToDbTableId(DatabaseAccess db, AoservProtocol.Version version, int clientTableId)	Converts a specific AoservProtocol version table ID to the number used in the database storage.
static int	convertDbTableIdToClientTableId(DatabaseAccess db, AoservProtocol.Version version, int tableId)
static Table.TableId	convertFromClientTableId(DatabaseConnection conn, RequestSource source, int clientTableId)	Converts the client's AoservProtocol-version-specific table ID to the version used by the master's AoservProtocol version.
static int	convertToClientTableId(DatabaseAccess db, RequestSource source, Table.TableId tableId)	Converts a local (Master AoservProtocol) table ID to a client-version matched table ID.
static int	getCachedRowCount(DatabaseConnection conn, RequestSource source, Table.TableId tableId)
static void	getObject(DatabaseConnection conn, RequestSource source, StreamableInput in, StreamableOutput out, Table.TableId tableId)	Gets one object from a table.
static void	getOldTable(DatabaseConnection conn, RequestSource source, StreamableOutput out, boolean provideProgress, String tableName)	Gets an old table given its table name.
static IntList	getOperatingSystemVersions(DatabaseConnection conn, RequestSource source)
static int	getRowCount(DatabaseConnection conn, RequestSource source, Table.TableId tableId)	Gets the number of accessible rows in a table.
static void	getTable(DatabaseConnection conn, RequestSource source, StreamableOutput out, boolean provideProgress, Table.TableId tableId)	Gets an entire table.
static String	getTableName(DatabaseAccess db, Table.TableId tableId)	Gets the table name, with schema prefixed.
static String	getTableNameForDbTableId(DatabaseAccess db, Integer dbTableId)	Gets the table name, with schema prefixed.
static void	invalidate(DatabaseConnection conn, RequestSource source, InvalidateList invalidateList, Table.TableId tableId, int host)
static void	invalidateTable(Table.TableId tableId)
static boolean	isInvalidator(DatabaseConnection conn, RequestSource source)
static void	start()

Methods inherited from class java.lang.Object

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

Field Details

UPDATE_BATCH_SIZE

public static final int UPDATE_BATCH_SIZE

The number of rows statements that should typically be used per update/insert/delete batch.

See Also:

• Constant Field Values

BATCH_COMMIT_INTERVAL

public static final int BATCH_COMMIT_INTERVAL

The number of updates that will typically be done before the changes are committed.

See Also:

• Constant Field Values

BU1_PARENTS_JOIN

public static final String BU1_PARENTS_JOIN

The joins used for the business tree.

See Also:

• Constant Field Values

BU1_PARENTS_JOIN_NO_COMMA

public static final String BU1_PARENTS_JOIN_NO_COMMA

The joins used for the business tree.

See Also:

• Constant Field Values

BU2_PARENTS_JOIN

public static final String BU2_PARENTS_JOIN

The joins used for the business tree.

See Also:

• Constant Field Values

PK_BU1_PARENTS_WHERE

public static final String PK_BU1_PARENTS_WHERE

The where clauses that accompany the joins.

See Also:

• Constant Field Values

PK1_BU1_PARENTS_OR_WHERE

public static final String PK1_BU1_PARENTS_OR_WHERE

The where clauses that accompany the joins.

See Also:

• Constant Field Values

PK1_BU1_PARENTS_WHERE

public static final String PK1_BU1_PARENTS_WHERE

The where clauses that accompany the joins.

See Also:

• Constant Field Values

PK3_BU2_PARENTS_OR_WHERE

public static final String PK3_BU2_PARENTS_OR_WHERE

The where clauses that accompany the joins.

See Also:

• Constant Field Values

PK3_BU2_PARENTS_WHERE

public static final String PK3_BU2_PARENTS_WHERE

The where clauses that accompany the joins.

See Also:

• Constant Field Values

Method Details

start

public static void start()

addGetObjectHandler

public static int addGetObjectHandler(TableHandler.GetObjectHandler handler)

This is available, but recommend registering via ServiceLoader.

getObject

public static void getObject(DatabaseConnection conn,
 RequestSource source,
 StreamableInput in,
 StreamableOutput out,
 Table.TableId tableId)
                      throws IOException,
SQLException

Gets one object from a table.

Throws:

IOException

SQLException

getCachedRowCount

public static int getCachedRowCount(DatabaseConnection conn,
 RequestSource source,
 Table.TableId tableId)
                             throws IOException,
SQLException

Throws:

IOException

SQLException

getRowCount

public static int getRowCount(DatabaseConnection conn,
 RequestSource source,
 Table.TableId tableId)
                       throws IOException,
SQLException

Gets the number of accessible rows in a table.

Throws:

IOException

SQLException

addGetTableHandler

public static int addGetTableHandler(TableHandler.GetTableHandler handler)

This is available, but recommend registering via ServiceLoader.

getTable

public static void getTable(DatabaseConnection conn,
 RequestSource source,
 StreamableOutput out,
 boolean provideProgress,
 Table.TableId tableId)
                     throws IOException,
SQLException

Gets an entire table.

Throws:

IOException

SQLException

getOldTable

public static void getOldTable(DatabaseConnection conn,
 RequestSource source,
 StreamableOutput out,
 boolean provideProgress,
 String tableName)
                        throws IOException,
SQLException

Gets an old table given its table name. This is used for backwards compatibility to provide data for tables that no longer exist.

Throws:

IOException

SQLException

invalidate

public static void invalidate(DatabaseConnection conn,
 RequestSource source,
 InvalidateList invalidateList,
 Table.TableId tableId,
 int host)
                       throws SQLException,
IOException

Throws:

SQLException

IOException

checkInvalidator

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

Throws:

IOException

SQLException

isInvalidator

public static boolean isInvalidator(DatabaseConnection conn,
 RequestSource source)
                             throws IOException,
SQLException

Throws:

IOException

SQLException

getTableNameForDbTableId

public static String getTableNameForDbTableId(DatabaseAccess db,
 Integer dbTableId)
                                       throws SQLException

Gets the table name, with schema prefixed.

Throws:

SQLException

See Also:

• getTableName(com.aoapps.dbc.DatabaseAccess, com.aoindustries.aoserv.client.Table.TableId)

getTableName

public static String getTableName(DatabaseAccess db,
 Table.TableId tableId)
                           throws IOException,
SQLException

Gets the table name, with schema prefixed.

Throws:

IOException

SQLException

See Also:

• getTableNameForDbTableId(com.aoapps.dbc.DatabaseAccess, java.lang.Integer)

convertClientTableIdToDbTableId

public static int convertClientTableIdToDbTableId(DatabaseAccess db,
 AoservProtocol.Version version,
 int clientTableId)
                                           throws IOException,
SQLException

Converts a specific AoservProtocol version table ID to the number used in the database storage.

Returns:

the id used in the database or -1 if unknown

Throws:

IOException

SQLException

convertDbTableIdToClientTableId

public static int convertDbTableIdToClientTableId(DatabaseAccess db,
 AoservProtocol.Version version,
 int tableId)
                                           throws IOException,
SQLException

Throws:

IOException

SQLException

convertFromClientTableId

public static Table.TableId convertFromClientTableId(DatabaseConnection conn,
 RequestSource source,
 int clientTableId)
                                              throws IOException,
SQLException

Converts the client's AoservProtocol-version-specific table ID to the version used by the master's AoservProtocol version.

Returns:

The Table.TableId or null if no match.

Throws:

IOException

SQLException

convertToClientTableId

public static int convertToClientTableId(DatabaseAccess db,
 RequestSource source,
 Table.TableId tableId)
                                  throws IOException,
SQLException

Converts a local (Master AoservProtocol) table ID to a client-version matched table ID.

Throws:

IOException

SQLException

invalidateTable

public static void invalidateTable(Table.TableId tableId)

getOperatingSystemVersions

public static IntList getOperatingSystemVersions(DatabaseConnection conn,
 RequestSource source)
                                          throws IOException,
SQLException

Throws:

IOException

SQLException