net.sf.hajdbc.sql

Class AbstractDatabaseCluster<D>

java.lang.Object

net.sf.hajdbc.sql.AbstractDatabaseCluster<D>

Type Parameters:

D - either java.sql.Driver or javax.sql.DataSource

All Implemented Interfaces:

javax.management.MBeanRegistration, DatabaseCluster<D>, DatabaseClusterMBean, Lifecycle

Direct Known Subclasses:

CommonDataSourceDatabaseCluster, DriverDatabaseCluster

public abstract class AbstractDatabaseCluster<D>
extends java.lang.Object
implements DatabaseCluster<D>, DatabaseClusterMBean, javax.management.MBeanRegistration

Since:

1.0

Author:

Paul Ferraro

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDatabaseCluster(java.lang.String id, java.net.URL url)

Method Summary

Modifier and Type	Method and Description
boolean	activate(Database<D> database, StateManager manager) Activates the specified database
void	activate(java.lang.String databaseId) Synchronizes, using the default strategy, and reactivates the specified database.
void	activate(java.lang.String databaseId, java.lang.String strategyId) Synchronizes, using the specified strategy, and reactivates the specified database.
protected void	add(Database<D> database)
void	addActivationListener(DatabaseActivationListener listener)
void	addDeactivationListener(DatabaseDeactivationListener listener)
void	addSynchronizationListener(SynchronizationListener listener)
protected void	addSynchronizationStrategyBuilder(SynchronizationStrategyBuilder builder)
boolean	deactivate(Database<D> database, StateManager manager) Deactivates the specified database
void	deactivate(java.lang.String databaseId) Deactivates the specified database.
boolean	equals(java.lang.Object object)
void	flushMetaDataCache() Flushes this cluster's cache of DatabaseMetaData.
java.util.Set<java.lang.String>	getActiveDatabases() Returns a collection of active databases in this cluster.
java.util.Map<java.lang.Boolean,java.util.List<Database<D>>>	getAliveMap(java.util.Collection<Database<D>> databases) Determines whether the specified databases are alive.
Balancer<D>	getBalancer() Returns the Balancer implementation used by this database cluster.
Database<D>	getDatabase(java.lang.String id) Returns the database identified by the specified id
DatabaseMetaDataCache	getDatabaseMetaDataCache() Returns a DatabaseMetaData cache.
protected java.util.Iterator<Database<D>>	getDatabases()
protected DatabaseClusterDecorator	getDecorator()
java.lang.String	getDefaultSynchronizationStrategy() Returns the default synchronization strategy used by this cluster.
Dialect	getDialect() Returns a dialect capable of returning database vendor specific values.
java.lang.String	getId() Returns the identifier of this cluster.
java.util.Set<java.lang.String>	getInactiveDatabases() Returns a collection of inactive databases in this cluster.
LockManager	getLockManager() Returns a LockManager capable of acquiring named read/write locks on the specific objects in this database cluster.
java.util.concurrent.ExecutorService	getNonTransactionalExecutor() Returns an executor service used to execute non-transactional database writes.
StateManager	getStateManager() Returns a StateManager for persisting database cluster state.
java.util.Set<java.lang.String>	getSynchronizationStrategies() Returns the set of synchronization strategies available to this cluster.
protected java.util.Iterator<SynchronizationStrategyBuilder>	getSynchronizationStrategyBuilders()
java.util.concurrent.ExecutorService	getTransactionalExecutor() Returns an executor service used to execute transactional database writes.
java.net.URL	getUrl() Returns the URL of the configuration file for this cluster.
java.lang.String	getVersion() Return the current HA-JDBC version
int	hashCode()
boolean	isActive() Indicates whether or not this cluster is active, i.e.
boolean	isAlive(java.lang.String id) Determines whether or not the specified database is responsive
boolean	isCurrentDateEvaluationEnabled() Indicates whether or not non-deterministic CURRENT_DATE SQL functions will be evaluated to deterministic static values.
boolean	isCurrentTimeEvaluationEnabled() Indicates whether or not non-deterministic CURRENT_TIME functions will be evaluated to deterministic static values.
boolean	isCurrentTimestampEvaluationEnabled() Indicates whether or not non-deterministic CURRENT_TIMESTAMP functions will be evaluated to deterministic static values.
boolean	isIdentityColumnDetectionEnabled() Indicates whether or not identity column detection is enabled for this cluster.
boolean	isRandEvaluationEnabled() Indicates whether or not non-deterministic RAND() functions will be replaced by evaluated to static values.
boolean	isSequenceDetectionEnabled() Indicates whether or not sequence detection is enabled for this cluster.
void	postDeregister()
void	postRegister(java.lang.Boolean registered)
void	preDeregister()
javax.management.ObjectName	preRegister(javax.management.MBeanServer server, javax.management.ObjectName name)
protected void	register(Database<D> database, javax.management.DynamicMBean mbean)
void	remove(java.lang.String id) Removes the specified database/DataSource from the cluster.
void	removeActivationListener(DatabaseActivationListener listener)
void	removeDeactivationListener(DatabaseDeactivationListener listener)
void	removeSynchronizationListener(SynchronizationListener listener)
protected void	setDecorator(DatabaseClusterDecorator decorator)
void	setLockManager(LockManager lockManager) Sets the LockManager implementation capable of acquiring named read/write locks on the specific objects in this database cluster.
void	setStateManager(StateManager stateManager) Sets the StateManager implementation for persisting database cluster state.
void	start() Called upon database cluster start.
void	stop() Called when database cluster is stopped.
java.lang.String	toString() Provided so that mbean proxies will use mbean toString() implementation

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDatabaseCluster

protected AbstractDatabaseCluster(java.lang.String id,
                                  java.net.URL url)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: DatabaseCluster

Returns the identifier of this cluster.

Specified by:

getId in interface DatabaseCluster<D>

Returns:

an identifier

See Also:

DatabaseCluster.getId()

getVersion

public java.lang.String getVersion()

Description copied from interface: DatabaseClusterMBean

Return the current HA-JDBC version

Specified by:

getVersion in interface DatabaseClusterMBean

Returns:

the current version

See Also:

DatabaseClusterMBean.getVersion()

getAliveMap

public java.util.Map<java.lang.Boolean,java.util.List<Database<D>>> getAliveMap(java.util.Collection<Database<D>> databases)

Description copied from interface: DatabaseCluster

Determines whether the specified databases are alive.

Specified by:

getAliveMap in interface DatabaseCluster<D>

Parameters:

databases - a collection of database descriptors

Returns:

a map of alive status to set of database descriptors

See Also:

DatabaseCluster.getAliveMap(java.util.Collection)

deactivate

public boolean deactivate(Database<D> database,
                          StateManager manager)

Description copied from interface: DatabaseCluster

Deactivates the specified database

Specified by:

deactivate in interface DatabaseCluster<D>

Parameters:

database - a database descriptor

manager - a state manager

Returns:

true, if the database was deactivated, false it was already inactive

See Also:

DatabaseCluster.deactivate(net.sf.hajdbc.Database, net.sf.hajdbc.StateManager)

activate

public boolean activate(Database<D> database,
                        StateManager manager)

Description copied from interface: DatabaseCluster

Activates the specified database

Specified by:

activate in interface DatabaseCluster<D>

Parameters:

database - a database descriptor

manager - a state manager

Returns:

true, if the database was activated, false it was already active

See Also:

DatabaseCluster.activate(net.sf.hajdbc.Database, net.sf.hajdbc.StateManager)

getActiveDatabases

public java.util.Set<java.lang.String> getActiveDatabases()

Description copied from interface: DatabaseClusterMBean

Returns a collection of active databases in this cluster.

Specified by:

getActiveDatabases in interface DatabaseClusterMBean

Returns:

a list of database identifiers

See Also:

DatabaseClusterMBean.getActiveDatabases()

getInactiveDatabases

public java.util.Set<java.lang.String> getInactiveDatabases()

Description copied from interface: DatabaseClusterMBean

Returns a collection of inactive databases in this cluster.

Specified by:

getInactiveDatabases in interface DatabaseClusterMBean

Returns:

a collection of database identifiers

See Also:

DatabaseClusterMBean.getInactiveDatabases()

getDatabase

public Database<D> getDatabase(java.lang.String id)

Description copied from interface: DatabaseCluster

Returns the database identified by the specified id

Specified by:

getDatabase in interface DatabaseCluster<D>

Parameters:

id - a database identifier

Returns:

a database descriptor

See Also:

DatabaseCluster.getDatabase(java.lang.String)

getDefaultSynchronizationStrategy

public java.lang.String getDefaultSynchronizationStrategy()

Description copied from interface: DatabaseClusterMBean

Returns the default synchronization strategy used by this cluster.

Specified by:

getDefaultSynchronizationStrategy in interface DatabaseClusterMBean

Returns:

a synchronization strategy identifier

See Also:

DatabaseClusterMBean.getDefaultSynchronizationStrategy()

getSynchronizationStrategies

public java.util.Set<java.lang.String> getSynchronizationStrategies()

Description copied from interface: DatabaseClusterMBean

Returns the set of synchronization strategies available to this cluster.

Specified by:

getSynchronizationStrategies in interface DatabaseClusterMBean

Returns:

a set of synchronization strategy identifiers

See Also:

DatabaseClusterMBean.getSynchronizationStrategies()

getBalancer

public Balancer<D> getBalancer()

Description copied from interface: DatabaseCluster

Returns the Balancer implementation used by this database cluster.

Specified by:

getBalancer in interface DatabaseCluster<D>

Returns:

an implementation of Balancer

See Also:

DatabaseCluster.getBalancer()

getTransactionalExecutor

public java.util.concurrent.ExecutorService getTransactionalExecutor()

Description copied from interface: DatabaseCluster

Returns an executor service used to execute transactional database writes.

Specified by:

getTransactionalExecutor in interface DatabaseCluster<D>

Returns:

an implementation of ExecutorService

See Also:

DatabaseCluster.getTransactionalExecutor()

getNonTransactionalExecutor

public java.util.concurrent.ExecutorService getNonTransactionalExecutor()

Description copied from interface: DatabaseCluster

Returns an executor service used to execute non-transactional database writes.

Specified by:

getNonTransactionalExecutor in interface DatabaseCluster<D>

Returns:

an implementation of ExecutorService

See Also:

DatabaseCluster.getNonTransactionalExecutor()

getDialect

public Dialect getDialect()

Description copied from interface: DatabaseCluster

Returns a dialect capable of returning database vendor specific values.

Specified by:

getDialect in interface DatabaseCluster<D>

Returns:

an implementation of Dialect

See Also:

DatabaseCluster.getDialect()

getDatabaseMetaDataCache

public DatabaseMetaDataCache getDatabaseMetaDataCache()

Description copied from interface: DatabaseCluster

Returns a DatabaseMetaData cache.

Specified by:

getDatabaseMetaDataCache in interface DatabaseCluster<D>

Returns:

a DatabaseMetaDataCache implementation

See Also:

DatabaseCluster.getDatabaseMetaDataCache()

getLockManager

public LockManager getLockManager()

Description copied from interface: DatabaseCluster

Returns a LockManager capable of acquiring named read/write locks on the specific objects in this database cluster.

Specified by:

getLockManager in interface DatabaseCluster<D>

Returns:

a LockManager implementation

See Also:

DatabaseCluster.getLockManager()

isAlive

public boolean isAlive(java.lang.String id)

Description copied from interface: DatabaseClusterMBean

Determines whether or not the specified database is responsive

Specified by:

isAlive in interface DatabaseClusterMBean

Parameters:

id - a database identifier

Returns:

true, if the database is alive, false otherwise

See Also:

DatabaseClusterMBean.isAlive(java.lang.String)

deactivate

public void deactivate(java.lang.String databaseId)

Description copied from interface: DatabaseClusterMBean

Deactivates the specified database.

Specified by:

deactivate in interface DatabaseClusterMBean

Parameters:

databaseId - a database identifier

See Also:

DatabaseClusterMBean.deactivate(java.lang.String)

activate

public void activate(java.lang.String databaseId)

Description copied from interface: DatabaseClusterMBean

Synchronizes, using the default strategy, and reactivates the specified database.

Specified by:

activate in interface DatabaseClusterMBean

Parameters:

databaseId - a database identifier

See Also:

DatabaseClusterMBean.activate(java.lang.String)

activate

public void activate(java.lang.String databaseId,
                     java.lang.String strategyId)

Description copied from interface: DatabaseClusterMBean

Synchronizes, using the specified strategy, and reactivates the specified database.

Specified by:

activate in interface DatabaseClusterMBean

Parameters:

databaseId - a database identifier

strategyId - the class name of a synchronization strategy

See Also:

DatabaseClusterMBean.activate(java.lang.String, java.lang.String)

register

protected void register(Database<D> database,
                        javax.management.DynamicMBean mbean)

remove

public void remove(java.lang.String id)

Description copied from interface: DatabaseClusterMBean

Removes the specified database/DataSource from the cluster.

Specified by:

remove in interface DatabaseClusterMBean

Parameters:

id - a database identifier

See Also:

DatabaseClusterMBean.remove(java.lang.String)

isActive

public boolean isActive()

Description copied from interface: DatabaseCluster

Indicates whether or not this cluster is active, i.e. started, but not yet stopped.

Specified by:

isActive in interface DatabaseCluster<D>

Returns:

true, if this cluster is active, false otherwise.

See Also:

DatabaseCluster.isActive()

start

public void start()
           throws java.lang.Exception

Description copied from interface: Lifecycle

Called upon database cluster start.

Specified by:

start in interface Lifecycle

Throws:

java.lang.Exception - if this service fails to start.

See Also:

Lifecycle.start()

stop

public void stop()

Description copied from interface: Lifecycle

Called when database cluster is stopped.

Specified by:

stop in interface Lifecycle

See Also:

Lifecycle.stop()

flushMetaDataCache

public void flushMetaDataCache()

Description copied from interface: DatabaseClusterMBean

Flushes this cluster's cache of DatabaseMetaData.

Specified by:

flushMetaDataCache in interface DatabaseClusterMBean

See Also:

DatabaseClusterMBean.flushMetaDataCache()

isIdentityColumnDetectionEnabled

public boolean isIdentityColumnDetectionEnabled()

Description copied from interface: DatabaseCluster

Indicates whether or not identity column detection is enabled for this cluster.

Specified by:

isIdentityColumnDetectionEnabled in interface DatabaseCluster<D>

Returns:

true, if identity column detection is enabled, false otherwise.

See Also:

DatabaseCluster.isIdentityColumnDetectionEnabled()

isSequenceDetectionEnabled

public boolean isSequenceDetectionEnabled()

Description copied from interface: DatabaseCluster

Indicates whether or not sequence detection is enabled for this cluster.

Specified by:

isSequenceDetectionEnabled in interface DatabaseCluster<D>

Returns:

true, if sequence detection is enabled, false otherwise.

See Also:

DatabaseCluster.isSequenceDetectionEnabled()

isCurrentDateEvaluationEnabled

public boolean isCurrentDateEvaluationEnabled()

Description copied from interface: DatabaseCluster

Indicates whether or not non-deterministic CURRENT_DATE SQL functions will be evaluated to deterministic static values.

Specified by:

isCurrentDateEvaluationEnabled in interface DatabaseCluster<D>

Returns:

true, if temporal SQL replacement is enabled, false otherwise.

See Also:

DatabaseCluster.isCurrentDateEvaluationEnabled()

isCurrentTimeEvaluationEnabled

public boolean isCurrentTimeEvaluationEnabled()

Description copied from interface: DatabaseCluster

Indicates whether or not non-deterministic CURRENT_TIME functions will be evaluated to deterministic static values.

Specified by:

isCurrentTimeEvaluationEnabled in interface DatabaseCluster<D>

Returns:

true, if temporal SQL replacement is enabled, false otherwise.

See Also:

DatabaseCluster.isCurrentTimeEvaluationEnabled()

isCurrentTimestampEvaluationEnabled

public boolean isCurrentTimestampEvaluationEnabled()

Description copied from interface: DatabaseCluster

Indicates whether or not non-deterministic CURRENT_TIMESTAMP functions will be evaluated to deterministic static values.

Specified by:

isCurrentTimestampEvaluationEnabled in interface DatabaseCluster<D>

Returns:

true, if temporal SQL replacement is enabled, false otherwise.

See Also:

DatabaseCluster.isCurrentTimestampEvaluationEnabled()

isRandEvaluationEnabled

public boolean isRandEvaluationEnabled()

Description copied from interface: DatabaseCluster

Indicates whether or not non-deterministic RAND() functions will be replaced by evaluated to static values.

Specified by:

isRandEvaluationEnabled in interface DatabaseCluster<D>

Returns:

true, if temporal SQL replacement is enabled, false otherwise.

See Also:

DatabaseCluster.isRandEvaluationEnabled()

toString

public java.lang.String toString()

Description copied from interface: DatabaseClusterMBean

Provided so that mbean proxies will use mbean toString() implementation

Specified by:

toString in interface DatabaseClusterMBean

Overrides:

toString in class java.lang.Object

Returns:

string representation of this cluster

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

getDecorator

protected DatabaseClusterDecorator getDecorator()

setDecorator

protected void setDecorator(DatabaseClusterDecorator decorator)

add

protected void add(Database<D> database)

getDatabases

protected java.util.Iterator<Database<D>> getDatabases()

getStateManager

public StateManager getStateManager()

Description copied from interface: DatabaseCluster

Returns a StateManager for persisting database cluster state.

Specified by:

getStateManager in interface DatabaseCluster<D>

Returns:

a StateManager implementation

See Also:

DatabaseCluster.getStateManager()

setStateManager

public void setStateManager(StateManager stateManager)

Description copied from interface: DatabaseCluster

Sets the StateManager implementation for persisting database cluster state.

Specified by:

setStateManager in interface DatabaseCluster<D>

Parameters:

stateManager - a state manager

See Also:

DatabaseCluster.setStateManager(net.sf.hajdbc.StateManager)

setLockManager

public void setLockManager(LockManager lockManager)

Description copied from interface: DatabaseCluster

Sets the LockManager implementation capable of acquiring named read/write locks on the specific objects in this database cluster.

Specified by:

setLockManager in interface DatabaseCluster<D>

Parameters:

lockManager - a lock manager

See Also:

DatabaseCluster.setLockManager(net.sf.hajdbc.LockManager)

getUrl

public java.net.URL getUrl()

Description copied from interface: DatabaseClusterMBean

Returns the URL of the configuration file for this cluster.

Specified by:

getUrl in interface DatabaseClusterMBean

Returns:

a URL

See Also:

DatabaseClusterMBean.getUrl()

postDeregister

public void postDeregister()

Specified by:

postDeregister in interface javax.management.MBeanRegistration

See Also:

MBeanRegistration.postDeregister()

postRegister

public void postRegister(java.lang.Boolean registered)

Specified by:

postRegister in interface javax.management.MBeanRegistration

See Also:

MBeanRegistration.postRegister(java.lang.Boolean)

preDeregister

public void preDeregister()
                   throws java.lang.Exception

Specified by:

preDeregister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

See Also:

MBeanRegistration.preDeregister()

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception

Specified by:

preRegister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

See Also:

MBeanRegistration.preRegister(javax.management.MBeanServer, javax.management.ObjectName)

addSynchronizationStrategyBuilder

protected void addSynchronizationStrategyBuilder(SynchronizationStrategyBuilder builder)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getSynchronizationStrategyBuilders

protected java.util.Iterator<SynchronizationStrategyBuilder> getSynchronizationStrategyBuilders()
                                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

addActivationListener

public void addActivationListener(DatabaseActivationListener listener)

Specified by:

addActivationListener in interface DatabaseClusterMBean

See Also:

DatabaseClusterMBean.addActivationListener(net.sf.hajdbc.DatabaseActivationListener)

addDeactivationListener

public void addDeactivationListener(DatabaseDeactivationListener listener)

Specified by:

addDeactivationListener in interface DatabaseClusterMBean

See Also:

DatabaseClusterMBean.addDeactivationListener(net.sf.hajdbc.DatabaseDeactivationListener)

addSynchronizationListener

public void addSynchronizationListener(SynchronizationListener listener)

Specified by:

addSynchronizationListener in interface DatabaseClusterMBean

See Also:

DatabaseClusterMBean.addSynchronizationListener(net.sf.hajdbc.SynchronizationListener)

removeActivationListener

public void removeActivationListener(DatabaseActivationListener listener)

Specified by:

removeActivationListener in interface DatabaseClusterMBean

See Also:

DatabaseClusterMBean.removeActivationListener(net.sf.hajdbc.DatabaseActivationListener)

removeDeactivationListener

public void removeDeactivationListener(DatabaseDeactivationListener listener)

Specified by:

removeDeactivationListener in interface DatabaseClusterMBean

See Also:

DatabaseClusterMBean.removeDeactivationListener(net.sf.hajdbc.DatabaseDeactivationListener)

removeSynchronizationListener

public void removeSynchronizationListener(SynchronizationListener listener)

Specified by:

removeSynchronizationListener in interface DatabaseClusterMBean

See Also:

DatabaseClusterMBean.removeSynchronizationListener(net.sf.hajdbc.SynchronizationListener)