net.sf.hajdbc

Interface Database<Z>

Type Parameters:

Z - connection source (e.g. Driver, DataSource, etc.)

All Superinterfaces:

Comparable<Database<Z>>

All Known Implementing Classes:

AbstractDatabase, CommonDataSourceDatabase, ConnectionPoolDataSourceDatabase, DataSourceDatabase, DriverDatabase, XADataSourceDatabase

public interface Database<Z>
extends Comparable<Database<Z>>

Since:

1.0

Version:

$Revision: 1536 $

Author:

Paul Ferraro

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_MAX_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
void	clean()
Connection	connect(Z connectionSource, String password) Connects to the database using the specified connection factory.
String	decodePassword(Decoder decoder)
Z	getConnectionSource() Returns a connection source for this database.
String	getId() Returns the unique idenfier for this database
String	getLocation() Returns the location of this database
int	getWeight() Returns the relative "weight" of this cluster node.
boolean	isActive()
boolean	isDirty()
boolean	isLocal() Indicates whether or not this database is local to the machine on which the JVM resides.
void	setActive(boolean active)

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

ID_MAX_SIZE

static final int ID_MAX_SIZE

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns the unique idenfier for this database

Returns:

a unique identifier

getLocation

String getLocation()

Returns the location of this database

Returns:

a location

getWeight

int getWeight()

Returns the relative "weight" of this cluster node. In general, when choosing a node to service read requests, a cluster will favor the node with the highest weight. A weight of 0 is somewhat special, depending on the type of balancer used by the cluster. In most cases, a weight of 0 means that this node will never service read requests unless it is the only node in the cluster.

Returns:

a positive integer

isLocal

boolean isLocal()

Indicates whether or not this database is local to the machine on which the JVM resides.

Returns:

true if local, false if remote

decodePassword

String decodePassword(Decoder decoder)
                      throws SQLException

Throws:

SQLException

connect

Connection connect(Z connectionSource,
                 String password)
                   throws SQLException

Connects to the database using the specified connection factory.

Parameters:

connectionSource - a factory object for creating connections

password - a decoded password

Returns:

a database connection

Throws:

SQLException - if connection fails

getConnectionSource

Z getConnectionSource()

Returns a connection source for this database.

Returns:

a connection source

Throws:

IllegalArgumentException - if connection source could not be created

isDirty

boolean isDirty()

clean

void clean()

isActive

boolean isActive()

setActive

void setActive(boolean active)