net.sf.hajdbc.sql

Class DatabaseClusterImpl<Z,D extends Database<Z>>

java.lang.Object

net.sf.hajdbc.sql.DatabaseClusterImpl<Z,D>

All Implemented Interfaces:

DatabaseCluster<Z,D>, Lifecycle

@MBean
public class DatabaseClusterImpl<Z,D extends Database<Z>>
extends Object
implements DatabaseCluster<Z,D>

Author:

paul

Constructor Summary

Constructors

Constructor and Description
DatabaseClusterImpl(String id, DatabaseClusterConfiguration<Z,D> configuration, DatabaseClusterConfigurationListener<Z,D> listener)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activate(D database, StateManager manager) Activates the specified database
void	activate(String databaseId) Synchronizes, using the default strategy, and reactivates the specified database.
void	activate(String databaseId, String strategyId) Synchronizes, using the specified strategy, and reactivates the specified database.
void	add(String databaseId) Removes the specified database from the cluster.
void	addConfigurationListener(DatabaseClusterConfigurationListener<Z,D> listener)
void	addListener(DatabaseClusterListener listener)
void	addSynchronizationListener(SynchronizationListener listener)
boolean	deactivate(D database, StateManager manager) Deactivates the specified database
void	deactivate(String databaseId) Deactivates the specified database.
void	flushMetaDataCache() Flushes this cluster's cache of DatabaseMetaData.
Set<String>	getActiveDatabases() Returns a collection of active databases in this cluster.
Balancer<Z,D>	getBalancer() Returns the Balancer implementation used by this database cluster.
D	getDatabase(String id) Returns the database identified by the specified id
DatabaseMetaDataCache<Z,D>	getDatabaseMetaDataCache() Returns a DatabaseMetaData cache.
Decoder	getDecoder()
String	getDefaultSynchronizationStrategy() Returns the default synchronization strategy used by this cluster.
Dialect	getDialect() Returns a dialect capable of returning database vendor specific values.
Durability<Z,D>	getDurability()
ExecutorService	getExecutor()
String	getId() Returns the identifier of this cluster.
Set<String>	getInactiveDatabases() Returns a collection of inactive databases in this cluster.
InputSinkStrategy<? extends Object>	getInputSinkStrategy()
LockManager	getLockManager() Returns a LockManager capable of acquiring named read/write locks on the specific objects in this database cluster.
StateManager	getStateManager() Returns a StateManager for persisting database cluster state.
Set<String>	getSynchronizationStrategies() Returns the set of synchronization strategies available to this cluster.
ThreadFactory	getThreadFactory()
TransactionIdentifierFactory<? extends Object>	getTransactionIdentifierFactory()
TransactionMode	getTransactionMode()
String	getVersion() Return the current HA-JDBC version
boolean	isActive() Indicates whether or not this cluster is active, i.e.
boolean	isAlive(String databaseId) 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	remove(String databaseId) Removes the specified database from the cluster.
void	removeConfigurationListener(DatabaseClusterConfigurationListener<Z,D> listener)
void	removeListener(DatabaseClusterListener listener)
void	removeSynchronizationListener(SynchronizationListener listener)
void	start() Called upon database cluster start.
void	stop() Called when database cluster is stopped.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseClusterImpl

public DatabaseClusterImpl(String id,
                   DatabaseClusterConfiguration<Z,D> configuration,
                   DatabaseClusterConfigurationListener<Z,D> listener)

Method Detail

deactivate

@ManagedOperation
public void deactivate(String databaseId)

Deactivates the specified database.

Parameters:

databaseId - a database identifier

Throws:

IllegalArgumentException - if no database exists with the specified identifier.

activate

@ManagedOperation
public void activate(String databaseId)

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

Parameters:

databaseId - a database identifier

Throws:

IllegalArgumentException - if no database exists with the specified identifier.

IllegalStateException - if synchronization fails.

activate

@ManagedOperation
public void activate(String databaseId,
                             String strategyId)

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

Parameters:

databaseId - a database identifier

strategyId - the identifer of a synchronization strategy

Throws:

IllegalArgumentException - if no database exists with the specified identifier, or no synchronization strategy exists with the specified identifier.

IllegalStateException - if synchronization fails.

isAlive

@ManagedOperation
public boolean isAlive(String databaseId)

Determines whether or not the specified database is responsive

Parameters:

databaseId - a database identifier

Returns:

true, if the database is alive, false otherwise

Throws:

IllegalArgumentException - if no database exists with the specified identifier.

getActiveDatabases

@ManagedAttribute
public Set<String> getActiveDatabases()

Returns a collection of active databases in this cluster.

Returns:

a list of database identifiers

getInactiveDatabases

@ManagedAttribute
public Set<String> getInactiveDatabases()

Returns a collection of inactive databases in this cluster.

Returns:

a collection of database identifiers

getVersion

@ManagedAttribute
public String getVersion()

Return the current HA-JDBC version

Returns:

the current version

add

@ManagedOperation
public void add(String databaseId)
         throws JMException

Removes the specified database from the cluster.

Parameters:

databaseId - a database identifier

Throws:

JMException

IllegalArgumentException - if database already exists.

remove

@ManagedOperation
public void remove(String databaseId)

Removes the specified database from the cluster.

Parameters:

databaseId - a database identifier

Throws:

IllegalStateException - if database is still active.

getId

@ManagedAttribute
public String getId()

Returns the identifier of this cluster.

Specified by:

getId in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

an identifier

See Also:

DatabaseCluster.getId()

toString

public String toString()

Overrides:

toString in class Object

isActive

@ManagedAttribute
public boolean isActive()

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

Specified by:

isActive in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

true, if this cluster is active, false otherwise.

See Also:

DatabaseCluster.isActive()

getSynchronizationStrategies

@ManagedAttribute
public Set<String> getSynchronizationStrategies()

Returns the set of synchronization strategies available to this cluster.

Returns:

a set of synchronization strategy identifiers

getDefaultSynchronizationStrategy

@ManagedAttribute
public String getDefaultSynchronizationStrategy()

Returns the default synchronization strategy used by this cluster.

Returns:

a synchronization strategy identifier

flushMetaDataCache

@ManagedOperation
@Description(value="Flushes this cluster\'s cache of database meta data")
public void flushMetaDataCache()

Flushes this cluster's cache of DatabaseMetaData.

addConfigurationListener

@ManagedOperation
public void addConfigurationListener(DatabaseClusterConfigurationListener<Z,D> listener)

Specified by:

addConfigurationListener in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.addConfigurationListener(net.sf.hajdbc.DatabaseClusterConfigurationListener)

addListener

@ManagedOperation
public void addListener(DatabaseClusterListener listener)

Specified by:

addListener in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.addListener(net.sf.hajdbc.DatabaseClusterListener)

addSynchronizationListener

@ManagedOperation
public void addSynchronizationListener(SynchronizationListener listener)

Specified by:

addSynchronizationListener in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

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

removeConfigurationListener

@ManagedOperation
public void removeConfigurationListener(DatabaseClusterConfigurationListener<Z,D> listener)

Specified by:

removeConfigurationListener in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.removeConfigurationListener(net.sf.hajdbc.DatabaseClusterConfigurationListener)

removeListener

@ManagedOperation
public void removeListener(DatabaseClusterListener listener)

Specified by:

removeListener in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.removeListener(net.sf.hajdbc.DatabaseClusterListener)

removeSynchronizationListener

@ManagedOperation
public void removeSynchronizationListener(SynchronizationListener listener)

Specified by:

removeSynchronizationListener in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

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

activate

public boolean activate(D database,
               StateManager manager)

Activates the specified database

Specified by:

activate in interface DatabaseCluster<Z,D extends Database<Z>>

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.state.StateManager)

deactivate

public boolean deactivate(D database,
                 StateManager manager)

Deactivates the specified database

Specified by:

deactivate in interface DatabaseCluster<Z,D extends Database<Z>>

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.state.StateManager)

getBalancer

public Balancer<Z,D> getBalancer()

Returns the Balancer implementation used by this database cluster.

Specified by:

getBalancer in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

an implementation of Balancer

See Also:

DatabaseCluster.getBalancer()

getDatabase

public D getDatabase(String id)

Returns the database identified by the specified id

Specified by:

getDatabase in interface DatabaseCluster<Z,D extends Database<Z>>

Parameters:

id - a database identifier

Returns:

a database descriptor

See Also:

DatabaseCluster.getDatabase(java.lang.String)

getDatabaseMetaDataCache

public DatabaseMetaDataCache<Z,D> getDatabaseMetaDataCache()

Returns a DatabaseMetaData cache.

Specified by:

getDatabaseMetaDataCache in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

a DatabaseMetaDataCache implementation

See Also:

DatabaseCluster.getDatabaseMetaDataCache()

getDialect

public Dialect getDialect()

Returns a dialect capable of returning database vendor specific values.

Specified by:

getDialect in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

an implementation of Dialect

See Also:

DatabaseCluster.getDialect()

getDurability

public Durability<Z,D> getDurability()

Specified by:

getDurability in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.getDurability()

getLockManager

public LockManager getLockManager()

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

Specified by:

getLockManager in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

a LockManager implementation

See Also:

DatabaseCluster.getLockManager()

getExecutor

public ExecutorService getExecutor()

Specified by:

getExecutor in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.getExecutor()

getTransactionMode

public TransactionMode getTransactionMode()

Specified by:

getTransactionMode in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.getTransactionMode()

getStateManager

public StateManager getStateManager()

Returns a StateManager for persisting database cluster state.

Specified by:

getStateManager in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

a StateManager implementation

See Also:

DatabaseCluster.getStateManager()

getThreadFactory

public ThreadFactory getThreadFactory()

Specified by:

getThreadFactory in interface DatabaseCluster<Z,D extends Database<Z>>

getDecoder

public Decoder getDecoder()

Specified by:

getDecoder in interface DatabaseCluster<Z,D extends Database<Z>>

getInputSinkStrategy

public InputSinkStrategy<? extends Object> getInputSinkStrategy()

Specified by:

getInputSinkStrategy in interface DatabaseCluster<Z,D extends Database<Z>>

getTransactionIdentifierFactory

public TransactionIdentifierFactory<? extends Object> getTransactionIdentifierFactory()

Specified by:

getTransactionIdentifierFactory in interface DatabaseCluster<Z,D extends Database<Z>>

See Also:

DatabaseCluster.getTransactionIdentifierFactory()

isCurrentDateEvaluationEnabled

public boolean isCurrentDateEvaluationEnabled()

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

Specified by:

isCurrentDateEvaluationEnabled in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

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

See Also:

DatabaseCluster.isCurrentDateEvaluationEnabled()

isCurrentTimeEvaluationEnabled

public boolean isCurrentTimeEvaluationEnabled()

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

Specified by:

isCurrentTimeEvaluationEnabled in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

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

See Also:

DatabaseCluster.isCurrentTimeEvaluationEnabled()

isCurrentTimestampEvaluationEnabled

public boolean isCurrentTimestampEvaluationEnabled()

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

Specified by:

isCurrentTimestampEvaluationEnabled in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

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

See Also:

DatabaseCluster.isCurrentTimestampEvaluationEnabled()

isIdentityColumnDetectionEnabled

public boolean isIdentityColumnDetectionEnabled()

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

Specified by:

isIdentityColumnDetectionEnabled in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

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

See Also:

DatabaseCluster.isIdentityColumnDetectionEnabled()

isRandEvaluationEnabled

public boolean isRandEvaluationEnabled()

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

Specified by:

isRandEvaluationEnabled in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

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

See Also:

DatabaseCluster.isRandEvaluationEnabled()

isSequenceDetectionEnabled

public boolean isSequenceDetectionEnabled()

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

Specified by:

isSequenceDetectionEnabled in interface DatabaseCluster<Z,D extends Database<Z>>

Returns:

true, if sequence detection is enabled, false otherwise.

See Also:

DatabaseCluster.isSequenceDetectionEnabled()

start

public void start()
           throws Exception

Called upon database cluster start.

Specified by:

start in interface Lifecycle

Throws:

Exception - if this service fails to start.

See Also:

Lifecycle.start()

stop

public void stop()

Called when database cluster is stopped.

Specified by:

stop in interface Lifecycle

See Also:

Lifecycle.stop()