net.sf.btb

Class Connector

java.lang.Object

net.sf.btb.Connector

public class Connector
extends Object

Author:

jpgravel

Constructor Summary

Constructors

Constructor and Description
Connector() The default Connector will use the ConnectionManager to connect to the database.
Connector(String connectionUrl) The Connector wraps the specified connection string.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Commits the current transaction and closes a the current connection if the connection counter has reached 0.
static void	closeConnection() Close the current connection.
static void	disable() Disable the static usage of the Connector.
static void	enable() Enables the static usage of the connector.
Connection	getConnection()
String	getConnectionUrl()
static Connector	getInstance() The singleton connector based on the ConnectionManager using the default connection string.
boolean	isEnabled() Gets if the current connector is enabled.
Connection	open() Open a connection and returns it or increment an internal counter and return the already existing connection.
static Connection	openConnection() Open a connection to the default database.
void	rollback()
static void	rollBack() Rollback all transactions based on the current connection.
void	setEnabled(boolean enabled) Sets the enabled property to true or false.

Methods inherited from class java.lang.Object

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

Constructor Detail

Connector

public Connector()

The default Connector will use the ConnectionManager to connect to the database.

Connector

public Connector(String connectionUrl)

The Connector wraps the specified connection string.

Parameters:

connectionUrl - the connection URL to use.

Method Detail

getInstance

public static Connector getInstance()

The singleton connector based on the ConnectionManager using the default connection string.

Returns:

The newly created connector.

openConnection

public static Connection openConnection()
                                 throws SQLException

Open a connection to the default database.

Returns:

The connection on the default database.

Throws:

SQLException

rollBack

public static void rollBack()

Rollback all transactions based on the current connection.

closeConnection

public static void closeConnection()

Close the current connection.

enable

public static void enable()

Enables the static usage of the connector. By default

disable

public static void disable()

Disable the static usage of the Connector.

isEnabled

public boolean isEnabled()

Gets if the current connector is enabled.

Returns:

true if enabled, false otherwise.

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled property to true or false. A disabled connector will throw an IllegalStateException if any of it's methods (other than isEnabled or setEnebled) is called.

Parameters:

enabled - the state desired.

getConnectionUrl

public String getConnectionUrl()

Returns:

the connection url to the database.

open

public Connection open()
                throws SQLException

Open a connection and returns it or increment an internal counter and return the already existing connection. This method is thread safe.

Returns:

a connection to the database.

Throws:

SQLException

close

public void close()

Commits the current transaction and closes a the current connection if the connection counter has reached 0. Otherwise, decrement the connection counter.

rollback

public void rollback()

getConnection

public Connection getConnection()