net.sf.hajdbc.sql

Class AbstractDatabase<Z>

java.lang.Object

net.sf.hajdbc.sql.AbstractDatabase<Z>

Type Parameters:

Z -

All Implemented Interfaces:

Comparable<Database<Z>>, Database<Z>

Direct Known Subclasses:

CommonDataSourceDatabase, DriverDatabase

public abstract class AbstractDatabase<Z>
extends Object
implements Database<Z>

Author:

Paul Ferraro

Field Summary

Fields inherited from interface net.sf.hajdbc.Database

ID_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractDatabase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertInactive()
protected void	checkDirty(Object oldValue, Object newValue) Set the dirty flag if the new value differs from the old value.
void	clean()
int	compareTo(Database<Z> database)
String	decodePassword(Decoder decoder)
boolean	equals(Object object)
String	getId() Returns the unique idenfier for this database
String	getLocation() Returns the location of this database
String	getPassword()
Map<String,String>	getProperties()
String	getUser()
int	getWeight() Returns the relative "weight" of this cluster node.
int	hashCode()
boolean	isActive()
boolean	isDirty()
boolean	isLocal() Indicates whether or not this database is local to the machine on which the JVM resides.
void	removeProperty(String name)
protected boolean	requiresAuthentication() Helper method to determine whether the connect() method requires authentication.
void	setActive(boolean active)
void	setId(String id)
void	setLocal(boolean local)
void	setLocation(String name)
void	setPassword(String password)
void	setProperty(String name, String value)
void	setUser(String user)
void	setWeight(int weight)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.hajdbc.Database

connect, getConnectionSource

Constructor Detail

AbstractDatabase

public AbstractDatabase()

Method Detail

getId

@ManagedAttribute
@Description(value="Uniquely identifies this database in the cluster")
public String getId()

Returns the unique idenfier for this database

Specified by:

getId in interface Database<Z>

Returns:

a unique identifier

See Also:

Database.getId()

setId

public void setId(String id)

getLocation

@ManagedAttribute
@Description(value="Identifies the location of this database")
public String getLocation()

Returns the location of this database

Specified by:

getLocation in interface Database<Z>

Returns:

a location

See Also:

Database.getLocation()

setLocation

@ManagedAttribute
public void setLocation(String name)

getUser

@ManagedAttribute
@Description(value="User ID for administrative connection authentication")
public String getUser()

setUser

@ManagedAttribute
public void setUser(String user)

getPassword

@ManagedAttribute
@Description(value="Password for administrative connection authentication")
public String getPassword()

setPassword

@ManagedAttribute
public void setPassword(String password)

decodePassword

public String decodePassword(Decoder decoder)
                      throws SQLException

Specified by:

decodePassword in interface Database<Z>

Throws:

SQLException

See Also:

Database.decodePassword(net.sf.hajdbc.codec.Decoder)

getWeight

@ManagedAttribute
@Description(value="Weight used in read request balancing")
public 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.

Specified by:

getWeight in interface Database<Z>

Returns:

a positive integer

See Also:

Database.getWeight()

setWeight

@ManagedAttribute
public void setWeight(int weight)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object object)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

compareTo

public int compareTo(Database<Z> database)

Specified by:

compareTo in interface Comparable<Database<Z>>

See Also:

Comparable.compareTo(Object)

getProperties

@ManagedAttribute
@Description(value="Connection properties")
public Map<String,String> getProperties()

removeProperty

@ManagedOperation
@Description(value="Removes the specified connection property")
public void removeProperty(String name)

setProperty

@ManagedOperation
@Description(value="Creates/updates the specified connection property")
public void setProperty(String name,
                                                 String value)

setLocal

@ManagedAttribute
public void setLocal(boolean local)

isLocal

@ManagedAttribute
@Description(value="Indicates whether this database is local to this JVM")
public boolean isLocal()

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

Specified by:

isLocal in interface Database<Z>

Returns:

true if local, false if remote

See Also:

Database.isLocal()

clean

public void clean()

Specified by:

clean in interface Database<Z>

See Also:

Database.clean()

isDirty

public boolean isDirty()

Specified by:

isDirty in interface Database<Z>

See Also:

Database.isDirty()

isActive

@ManagedAttribute
@Description(value="Indicates whether or not this database is active")
public boolean isActive()

Specified by:

isActive in interface Database<Z>

See Also:

Database.isActive()

setActive

public void setActive(boolean active)

Specified by:

setActive in interface Database<Z>

See Also:

Database.setActive(boolean)

checkDirty

protected void checkDirty(Object oldValue,
              Object newValue)

Set the dirty flag if the new value differs from the old value.

Parameters:

oldValue -

newValue -

requiresAuthentication

protected boolean requiresAuthentication()

Helper method to determine whether the connect() method requires authentication.

Returns:

true, if authentication is required, false otherwise

assertInactive

protected void assertInactive()