com.aspc.DBObj

Class MasterDB

java.lang.Object

com.aspc.DBObj.MasterDB

All Implemented Interfaces:

ShutdownListener

public final class MasterDB
extends java.lang.Object
implements ShutdownListener

The master database for this system. The Master DB is the yellow pages of the tmpLayers within the system
THREAD MODE: MULTI-THREADED

Since:

August 1, 2002, 5:54 PM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_SERIES The app series
static java.lang.String	ASPC_BUILD_DT The date of this build
static java.lang.String	ASPC_GIT_COMMIT The git commit of this build
static java.lang.String	BRANCH The build/branch of this build
static java.lang.String	COLUMN_CONNECT_PROPERTIES the connection properties
static java.lang.String	COLUMN_REDIRECT_URL redirect URL
static java.lang.String	DB_VERSION The current Database version number
static java.lang.String	ENCRYPTION_KEY The encryption holder
MasterMessageServer	jms The raw JMS Client
static org.apache.commons.logging.Log	LOGGER_TIMINGS_QUERY Handle for the query logger.
static java.lang.String	PROPERTY_EMAIL_LIMIT EMAIL_LIMIT property program name, property name will be the layer id
static java.lang.String	PROPERTY_PRIVATE_DB_DIR private database directory
static java.lang.String	PROPERTY_PRIVATE_DB_LAYERS force use of a private database
static java.lang.String	PROPERTY_RECIPIENTS_LIMIT RECIPIENTS_LIMIT property program name, property name will be the layer id
static long	STARTUP_TIME When the server started

Method Summary

Modifier and Type	Method and Description
void	clearDefaultDB() clear the cache of the default DB
static void	closeAllDatabases() Close all databases
void	closeDatabases() shutdown the database
VirtualDB	createDB(java.lang.String signature, java.lang.String parentSignature, java.lang.String ownerFirstName, java.lang.String ownerLastName, java.lang.String ownerLogin, java.lang.String ownerPassword, java.lang.String phoneNumber, java.lang.String email, java.util.Date suspends) Creates a new VirtualDB
VirtualDB	createDB(java.lang.String signature, java.lang.String parentSignature, java.lang.String ownerFirstName, java.lang.String ownerLastName, java.lang.String ownerLogin, java.lang.String ownerPassword, java.lang.String phoneNumber, java.lang.String email, java.util.Date suspends, long id, java.lang.String requiredName) Creates a new VirtualDB
static MasterDB	currentMasterDB() get the current master
DataBase	findLayerDB(int id) The physical database for the layer
static MasterDB	findMasterDB(java.lang.String connectUrl, java.lang.String name, java.lang.String connectType, java.lang.String connectUser, java.lang.String connectPass) find the master DB
java.lang.String	getDefaultDB(java.lang.String host) The default layer for this host
java.lang.String	getProgramProperty(java.lang.String programName, java.lang.String property) Get the property stored in the database
DataBase	getRawDB() The physical Database for this master.
java.lang.String	getRedirectURL(int id) Should we redirect somewhere else.
static boolean	isShuttingDown() Are we shutting down ?
boolean	knownHost(java.lang.String host) Is this a know host ?
int[]	listDataLayers() The active tmpLayers
int[]	listLayers() Returns a list of layer ids
int[]	listLiveLayers() The active tmpLayers
java.lang.String[]	listSignatures(int id) Returns the signatures that match the database id
static java.lang.String	parseServerURL(java.lang.String url) Resolves properties enclosed by a $ in the server URL
static void	sendClearCache()
static void	setCurrentDBAsMasterDB() set the current master
MasterDB	setMainLayer(java.lang.String signature) Override of the main layer.
MasterDB	setProgramProperty(java.lang.String programName, java.lang.String property, java.lang.String value) Permanently store a property for a program into the database
MasterDB	setRedirectURL(int id, java.lang.String url) set redirect_url
void	shutdown() shutdown
static void	shutdownAllDatabases() Shutdown all databases
static void	shutdownAllJMS() Close all JMS subscribers
void	shutdownDatabases() shutdown the database

Methods inherited from class java.lang.Object

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

Field Detail

DB_VERSION

public static final java.lang.String DB_VERSION

The current Database version number

See Also:

Constant Field Values

APP_SERIES

public static final int APP_SERIES

The app series

See Also:

Constant Field Values

BRANCH

public static final java.lang.String BRANCH

The build/branch of this build

See Also:

Constant Field Values

ASPC_BUILD_DT

public static final java.lang.String ASPC_BUILD_DT

The date of this build

See Also:

Constant Field Values

ASPC_GIT_COMMIT

public static final java.lang.String ASPC_GIT_COMMIT

The git commit of this build

See Also:

Constant Field Values

STARTUP_TIME

public static final long STARTUP_TIME

When the server started

LOGGER_TIMINGS_QUERY

public static final org.apache.commons.logging.Log LOGGER_TIMINGS_QUERY

Handle for the query logger.

ENCRYPTION_KEY

public static final java.lang.String ENCRYPTION_KEY

The encryption holder

See Also:

Constant Field Values

COLUMN_CONNECT_PROPERTIES

public static final java.lang.String COLUMN_CONNECT_PROPERTIES

the connection properties

See Also:

Constant Field Values

COLUMN_REDIRECT_URL

public static final java.lang.String COLUMN_REDIRECT_URL

redirect URL

See Also:

Constant Field Values

PROPERTY_PRIVATE_DB_LAYERS

public static final java.lang.String PROPERTY_PRIVATE_DB_LAYERS

force use of a private database

See Also:

Constant Field Values

PROPERTY_PRIVATE_DB_DIR

public static final java.lang.String PROPERTY_PRIVATE_DB_DIR

private database directory

See Also:

Constant Field Values

PROPERTY_RECIPIENTS_LIMIT

public static final java.lang.String PROPERTY_RECIPIENTS_LIMIT

RECIPIENTS_LIMIT property program name, property name will be the layer id

See Also:

Constant Field Values

PROPERTY_EMAIL_LIMIT

public static final java.lang.String PROPERTY_EMAIL_LIMIT

EMAIL_LIMIT property program name, property name will be the layer id

See Also:

Constant Field Values

jms

public final MasterMessageServer jms

The raw JMS Client

Method Detail

getRawDB

@CheckReturnValue
 @Nonnull
public DataBase getRawDB()

The physical Database for this master.

Returns:

The database

setMainLayer

@Nonnull
public MasterDB setMainLayer(@Nonnull
                                      java.lang.String signature)

Override of the main layer.

Parameters:

signature -

Returns:

this

setProgramProperty

@Nonnull
public MasterDB setProgramProperty(@Nonnull
                                            java.lang.String programName,
                                            @Nonnull
                                            java.lang.String property,
                                            @Nonnull
                                            java.lang.String value)
                                     throws java.lang.Exception

Permanently store a property for a program into the database

Parameters:

programName - The program name

property - The property

value - The value

Returns:

this

Throws:

java.lang.Exception - A serious problem

getProgramProperty

@CheckReturnValue
 @Nonnull
public java.lang.String getProgramProperty(@Nonnull
                                                                       java.lang.String programName,
                                                                       @Nonnull
                                                                       java.lang.String property)

Get the property stored in the database

Parameters:

programName - The program name or name space

property - The code

Returns:

The value

listLayers

@CheckReturnValue
 @Nonnull
public int[] listLayers()
                                             throws java.lang.Exception

Returns a list of layer ids

Returns:

The tmpLayers

Throws:

java.lang.Exception - A serious problem

listDataLayers

@CheckReturnValue
 @Nonnull
public int[] listDataLayers()
                                                 throws java.lang.Exception

The active tmpLayers

Returns:

The list of active tmpLayers

Throws:

java.lang.Exception - A serious problem

listLiveLayers

@CheckReturnValue
 @Nonnull
public int[] listLiveLayers()
                                                 throws java.lang.Exception

The active tmpLayers

Returns:

The list of active tmpLayers

Throws:

java.lang.Exception - A serious problem

getRedirectURL

@CheckReturnValue
 @Nonnull
public java.lang.String getRedirectURL(int id)
                                                            throws java.sql.SQLException

Should we redirect somewhere else.

Parameters:

id - virtual ID

Returns:

the value

Throws:

java.sql.SQLException - if a database-access error occurs.

setRedirectURL

@Nonnull
public MasterDB setRedirectURL(@Nonnegative
                                        int id,
                                        @Nullable
                                        java.lang.String url)
                                 throws java.lang.Exception

set redirect_url

Parameters:

id - layer id

url - redirect url

Returns:

this

Throws:

java.lang.Exception - a serious problem.

findLayerDB

@CheckReturnValue
 @Nonnull
public DataBase findLayerDB(@Nonnegative
                                                        int id)
                                                 throws java.sql.SQLException

The physical database for the layer

Parameters:

id - The id

Returns:

The raw database

Throws:

java.sql.SQLException - A serious problem

createDB

@Nonnull
public VirtualDB createDB(java.lang.String signature,
                                   java.lang.String parentSignature,
                                   java.lang.String ownerFirstName,
                                   java.lang.String ownerLastName,
                                   java.lang.String ownerLogin,
                                   java.lang.String ownerPassword,
                                   java.lang.String phoneNumber,
                                   java.lang.String email,
                                   java.util.Date suspends)

Creates a new VirtualDB

Parameters:

suspends - when suspended

signature - The signature for the new VirtualDB

parentSignature - The signature of the VirtualDB this VirtualDB extends

ownerFirstName - The first name of the owner

ownerLastName - The last name of the owner

ownerLogin - The login for the owner

ownerPassword - The password for the owner

phoneNumber - The phone number for the owner

email - The email for the owner

Returns:

The created VirtualDB

createDB

@Nonnull
public VirtualDB createDB(java.lang.String signature,
                                   java.lang.String parentSignature,
                                   java.lang.String ownerFirstName,
                                   java.lang.String ownerLastName,
                                   java.lang.String ownerLogin,
                                   java.lang.String ownerPassword,
                                   java.lang.String phoneNumber,
                                   java.lang.String email,
                                   java.util.Date suspends,
                                   long id,
                                   java.lang.String requiredName)

Creates a new VirtualDB

Parameters:

id - the id

requiredName - the database name

suspends - when suspended

signature - The signature for the new VirtualDB

parentSignature - The signature of the VirtualDB this VirtualDB extends

ownerFirstName - The first name of the owner

ownerLastName - The last name of the owner

ownerLogin - The login for the owner

ownerPassword - The password for the owner

phoneNumber - The phone number for the owner

email - The email for the owner

Returns:

The created VirtualDB

listSignatures

@CheckReturnValue
 @Nonnull
public java.lang.String[] listSignatures(int id)
                                                              throws java.lang.Exception

Returns the signatures that match the database id

Parameters:

id - the id to search

Returns:

The list of signatures for a database id

Throws:

java.lang.Exception - A serious problem

currentMasterDB

@CheckReturnValue
 @Nonnull
public static MasterDB currentMasterDB()
                                                            throws java.lang.Exception

get the current master

Returns:

The master

Throws:

java.lang.Exception - A serious problem

setCurrentDBAsMasterDB

public static void setCurrentDBAsMasterDB()
                                   throws java.lang.Exception

set the current master

Throws:

java.lang.Exception - A serious problem

shutdownAllJMS

public static void shutdownAllJMS()

Close all JMS subscribers

shutdownAllDatabases

public static void shutdownAllDatabases()

Shutdown all databases

shutdownDatabases

public void shutdownDatabases()

shutdown the database

closeAllDatabases

public static void closeAllDatabases()

Close all databases

closeDatabases

public void closeDatabases()

shutdown the database

findMasterDB

@CheckReturnValue
 @Nonnull
public static MasterDB findMasterDB(java.lang.String connectUrl,
                                                                java.lang.String name,
                                                                java.lang.String connectType,
                                                                java.lang.String connectUser,
                                                                java.lang.String connectPass)
                                                         throws java.lang.Exception

find the master DB

Parameters:

connectUrl - the connection URL

name - the name

connectType - the type

connectUser - connection user

connectPass - connection password.

Returns:

The master DB

Throws:

java.lang.Exception - A serious problem

sendClearCache

public static void sendClearCache()
                           throws java.lang.Exception

Throws:

java.lang.Exception

clearDefaultDB

public void clearDefaultDB()

clear the cache of the default DB

knownHost

@CheckReturnValue
public boolean knownHost(@Nonnull
                                           java.lang.String host)

Is this a know host ?

Parameters:

host - the host

Returns:

true if known

getDefaultDB

@CheckReturnValue
 @Nonnull
public java.lang.String getDefaultDB(@Nullable
                                                                 java.lang.String host)

The default layer for this host

Parameters:

host - the host

Returns:

The layer

shutdown

public void shutdown()

shutdown

Specified by:

shutdown in interface ShutdownListener

isShuttingDown

@CheckReturnValue
public static boolean isShuttingDown()

Are we shutting down ?

Returns:

true if shutting down.

parseServerURL

@CheckReturnValue
 @Nonnull
public static java.lang.String parseServerURL(@Nonnull
                                                                          java.lang.String url)

Resolves properties enclosed by a $ in the server URL

Parameters:

url -

Returns: