DatabaseConnectionManager (ontimize-core 5.6.0 API)

java.lang.Object
- com.ontimize.db.DatabaseConnectionManager

Direct Known Subclasses:

MSAccessConnectionManager
```
public class DatabaseConnectionManager
extends Object
```
Allows to create and manage a database connection pool. Parameters of 'database.properties' are parsed here.

Author:

Imatia Innovation

See Also:
DatabaseConnectionManager(boolean, boolean, URL, URL, boolean)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DatabaseConnectionManager.CheckConnectionThread`
`protected class`	`DatabaseConnectionManager.ReleaseThread`
`protected class`	`DatabaseConnectionManager.ReserveCancellationThread`

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`AUTOCOMMIT_ON_UNLOCK`
`static String`	`AUTONUMERICAL_PROPERTIES`
`static String`	`CHECK_CYCLE`
`protected DatabaseConnectionManager.CheckConnectionThread`	`checkConnectionThread`
`protected int`	`checkupCicle`
`static String`	`CONNECTION_INFO`
`static String`	`CONNECTION_REQUEST_TIME`
`static String`	`CONNECTION_WAIT_TIME`
`protected int`	`connectionRequestTime`
`protected Vector`	`connections`
`protected int`	`connectionWaitTime`
`static String`	`CREATE_INITIAL_CONNECTIONS`
`static String`	`DATABASE`
`protected String`	`databaseId`
`protected Object`	`dataSource`
`protected String`	`dataSourceName`
`static String`	`DATASOURCENAME`
`static boolean`	`DEBUG`
`static String`	`defaultPasswordValue`
`static String`	`defaultUserValue`
`protected String`	`driver`
`static String`	`DRIVER`
`static String`	`E64PASSWORD`
`static String`	`EPASSWORD`
`protected boolean`	`forceDisconnection`
`static String`	`INCREASE_CONNECTIONS`
`protected int`	`increment`
`static String`	`LOCKED_TIMEOUT`
`protected Vector`	`lockTime`
`protected long`	`lockTimeout`
`protected int`	`maximum`
`static String`	`MAXIMUM_CONNECTIONS`
`protected double`	`maxlocktime`
`protected int`	`maxReserveTime`
`protected int`	`minimum`
`static String`	`MINIMUM_CONNECTIONS`
`static int`	`offset`
`static String`	`offsetString`
`protected String`	`password`
`static String`	`PASSWORD`
`static String`	`RELEASE_CYCLE`
`protected long`	`releaseCicleThread`
`protected DatabaseConnectionManager.ReleaseThread`	`releaseThread`
`protected DatabaseConnectionManager.ReserveCancellationThread`	`reserveCancellationThread`
`protected int`	`reserveCicle`
`protected String`	`schema`
`static String`	`SCHEMA`
`static String`	`TEST_TABLE`
`protected String`	`testTable`
`protected long`	`timeout`
`static String`	`TIMEOUT`
`static String`	`UPDATE_CYCLE`
`protected long`	`updateCicleThread`
`static String`	`URL`
`protected String`	`urlDB`
`protected boolean`	`useJ2EEConnection`
`static String`	`USEJ2EECONNECTIONS`
`protected String`	`user`
`static String`	`USER`

Constructor Summary

Constructors
Constructor and Description
`DatabaseConnectionManager(boolean statisticViewer, boolean connectionsInfoToFile, URL urlPropDB, URL urlAutonumerical)` Class constructor.
`DatabaseConnectionManager(boolean statisticViewer, boolean connectionsInfoToFile, URL urlPropDB, URL urlAutonumerical, boolean createInitialConnections)` Constructor that gets parameters related to database.
`DatabaseConnectionManager(Hashtable parameters)`
`DatabaseConnectionManager(URL urlDBProp, URL urlAutonumerical, int minConnections, int maxConnections, int connectionIncrement, long timeoutBlockConnection, long timeoutConnection, boolean statisticViewer)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activeForceDisconnection()` Close all the connections.
`void`	`closeConnections()`
`void`	`closeLockedConnections()`
`Connection`	`createConnection()`
`protected OntimizeConnection`	`createConnection(String driver, String uRLBD, String user, String password)`
`protected Object`	`createDataSource(String dataSourceName, Properties prop)`
`void`	`deactivateForceDisconnection()`
`protected void`	`finalize()`
`Autonumerical`	`getAutonumerialReference()`
`Autonumerical`	`getAutonumerical()`
`int`	`getAutonumericalValue()`
`int`	`getAutonumericalValue(String table)`
`double`	`getAverageLockTime()`
`int`	`getConnectionRequestTime()`
`int`	`getConnectionWaitTime()`
`String`	`getDatabase()`
`int`	`getLockedOntimizeConnectionNumber()`
`double`	`getMaximumLockTime()`
`OntimizeConnection`	`getOntimizeConnection()` Returns an available connection and locks it.
`OntimizeConnection`	`getOntimizeConnection(int id)` Search an unlocked connection reserved with the specified id.
`int`	`getOntimizeConnectionNumber()`
`String`	`getSchema()`
`long`	`getUpdateCicleTime()`
`boolean`	`isForceDisconnectionEnabled()`
`void`	`setAutonumerical(Autonumerical auto)`
`void`	`setAutonumerical(String oPropAutonumerical)`
`void`	`setAutonumerical(URL oURLAutonumerical)`
`void`	`setCheckupCicle(int checkupCicle)`
`void`	`setConnectionRequestTime(int connectionRequestTime)`
`void`	`setConnectionWaitTime(int connectionWaitTime)`
`void`	`setDatabaseId(String databaseId)`
`void`	`setDriver(String driver)`
`void`	`setIncrementConnections(int increment)`
`void`	`setLockTimeout(long lockTimeout)`
`void`	`setMaximumConnections(int maximum)`
`void`	`setMinimumConnections(int minimum)`
`void`	`setPassword(String password)`
`void`	`setReleaseCicle(long releaseCicle)`
`void`	`setSaveConnectionsInfo(boolean connectionInfo)`
`void`	`setSchema(String schema)`
`void`	`setTestTable(String testTable)`
`void`	`setTimeout(long timeout)`
`void`	`setUpdateCicle(long updateCicle)`
`void`	`setUrlDB(String urlDB)`
`void`	`setUser(String user)`
`String`	`toString()`
`void`	`unLock(OntimizeConnection ontimizeConnection)` Unlock the connection

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

defaultUserValue
```
public static String defaultUserValue
```

defaultPasswordValue

public static String defaultPasswordValue

TIMEOUT
```
public static final String TIMEOUT
```
See Also:
Constant Field Values

LOCKED_TIMEOUT

public static final String LOCKED_TIMEOUT

See Also:: Constant Field Values

INCREASE_CONNECTIONS

public static final String INCREASE_CONNECTIONS

See Also:: Constant Field Values

CONNECTION_WAIT_TIME

public static final String CONNECTION_WAIT_TIME

See Also:: Constant Field Values

CONNECTION_REQUEST_TIME

public static final String CONNECTION_REQUEST_TIME

See Also:: Constant Field Values

MAXIMUM_CONNECTIONS

public static final String MAXIMUM_CONNECTIONS

See Also:: Constant Field Values

MINIMUM_CONNECTIONS

public static final String MINIMUM_CONNECTIONS

See Also:: Constant Field Values

EPASSWORD
```
public static final String EPASSWORD
```
See Also:
Constant Field Values

E64PASSWORD
```
public static final String E64PASSWORD
```
See Also:
Constant Field Values

SCHEMA
```
public static final String SCHEMA
```
See Also:
Constant Field Values

PASSWORD
```
public static final String PASSWORD
```
See Also:
Constant Field Values

USER
```
public static final String USER
```
See Also:
Constant Field Values

TEST_TABLE
```
public static final String TEST_TABLE
```
See Also:
Constant Field Values

CHECK_CYCLE
```
public static final String CHECK_CYCLE
```
See Also:
Constant Field Values

RELEASE_CYCLE

public static final String RELEASE_CYCLE

See Also:: Constant Field Values

UPDATE_CYCLE

public static final String UPDATE_CYCLE

See Also:: Constant Field Values

URL
```
public static final String URL
```
See Also:
Constant Field Values

DRIVER
```
public static final String DRIVER
```
See Also:
Constant Field Values

DATABASE
```
public static final String DATABASE
```
See Also:
Constant Field Values

USEJ2EECONNECTIONS

public static final String USEJ2EECONNECTIONS

See Also:: Constant Field Values

DATASOURCENAME

public static final String DATASOURCENAME

See Also:: Constant Field Values

CONNECTION_INFO

public static final String CONNECTION_INFO

See Also:: Constant Field Values

CREATE_INITIAL_CONNECTIONS

public static final String CREATE_INITIAL_CONNECTIONS

See Also:: Constant Field Values

AUTONUMERICAL_PROPERTIES

public static final String AUTONUMERICAL_PROPERTIES

See Also:: Constant Field Values

DEBUG
```
public static boolean DEBUG
```

AUTOCOMMIT_ON_UNLOCK
```
public static final boolean AUTOCOMMIT_ON_UNLOCK
```
See Also:
Constant Field Values

minimum
```
protected int minimum
```

maximum
```
protected int maximum
```

connectionWaitTime
```
protected int connectionWaitTime
```

connectionRequestTime
```
protected int connectionRequestTime
```

increment
```
protected int increment
```

lockTimeout
```
protected long lockTimeout
```

timeout
```
protected long timeout
```

offset
```
public static int offset
```

offsetString
```
public static String offsetString
```

reserveCancellationThread

protected DatabaseConnectionManager.ReserveCancellationThread reserveCancellationThread

checkConnectionThread

protected DatabaseConnectionManager.CheckConnectionThread checkConnectionThread

maxReserveTime
```
protected int maxReserveTime
```

reserveCicle
```
protected int reserveCicle
```

checkupCicle
```
protected int checkupCicle
```

testTable
```
protected String testTable
```

useJ2EEConnection
```
protected boolean useJ2EEConnection
```

dataSourceName
```
protected String dataSourceName
```

dataSource
```
protected Object dataSource
```

connections
```
protected Vector connections
```

driver
```
protected String driver
```

urlDB
```
protected String urlDB
```

databaseId
```
protected String databaseId
```

user
```
protected String user
```

password
```
protected String password
```

releaseThread

protected DatabaseConnectionManager.ReleaseThread releaseThread

releaseCicleThread
```
protected long releaseCicleThread
```

schema
```
protected String schema
```

updateCicleThread
```
protected long updateCicleThread
```

lockTime
```
protected Vector lockTime
```

maxlocktime
```
protected double maxlocktime
```

forceDisconnection
```
protected boolean forceDisconnection
```

Constructor Detail

DatabaseConnectionManager
```
public DatabaseConnectionManager(URL urlDBProp,
                         URL urlAutonumerical,
                         int minConnections,
                         int maxConnections,
                         int connectionIncrement,
                         long timeoutBlockConnection,
                         long timeoutConnection,
                         boolean statisticViewer)
                          throws Exception
```
Parameters:
urlDBProp - URI of the database properties file path
One of the parameters of this file is 'usej2eeconnections' with values 'yes' or 'no' (default value is 'no') to indicate is j2ee connections are used (DataSource). When 'usej2eeconnections'='yes' the file must contains the DataSource name ('datasourcename').
urlAutonumerical -
minConnections -
maxConnections -
connectionIncrement -
timeoutBlockConnection -
timeoutConnection -
statisticViewer -

Throws:

Exception

DatabaseConnectionManager
```
public DatabaseConnectionManager(boolean statisticViewer,
                         boolean connectionsInfoToFile,
                         URL urlPropDB,
                         URL urlAutonumerical)
```
Class constructor.
Parameters:
statisticViewer - condition to show the statisticViewer
connectionsInfoToFile - conditions to write connections info to file
urlPropDB - URL to database properties (Relative to classpath):
- usej2eeconnections: When DataSource connections are allowed. Values 'yes' or 'no'
- datasourcename: The name of data source when usej2eeconnections=yes.
- ...
urlAutonumerical - URL to autonumerical properties

DatabaseConnectionManager

public DatabaseConnectionManager(boolean statisticViewer,
                         boolean connectionsInfoToFile,
                         URL urlPropDB,
                         URL urlAutonumerical,
                         boolean createInitialConnections)

Constructor that gets parameters related to database. Typically this parameters are specified in database.properties.

Parameters:

statisticViewer - Not used

connectionsInfoToFile - Indicates whether information of connections is written to a file

urlPropDB - complete path to database.properties file

urlAutonumerical - complete path to autonumerical.properties file

createInitialConnections - Indicates whether connections are created on startup

Parameters for database.properties

attribute	values	default	required	meaning
URL			yes	The URL where database is stored. For example, with HSQLD engine: jdbc:hsqldb:db/myDatabase
Driver			yes	Driver for database. For example, with jdbc connection in HSQLD engine: org.hsqldb.jdbcDriver
Database	default/Postgres/SQLServer/Oracle/HSQLDB/Access	default	no	Indicates the handler used to manage operations with database. There are many available handlers.
User			yes	User to connect with database
Password			yes	Password to connect with database. When password in database.properties is stored encrypted, parameter `Password` must be replaced by this one.
E64Password			no	This parameter is used instead of `Password` when user wants to store database password encrypted in database.properties.
TestTable			no (but strongly recommended)	This parameter checks automatically that connection with database is OK and try to reconnect (transparently for user) when an communication error is produced among server and database.
CheckCycle		20000 ms	no	Timer for thread where Ontimize connection pool checks database connections
ReleaseCycle		5000 ms	no	Timer for thread where Ontimize connection pool checks to release blocked connections.
UpdateCycle		500 ms	no	Time between captures of the Server Monitor where info of conections is showed
MinimumConnections		0	yes	Minimum connection number that the connection pool will open in the start up
MaximumConnections		10	no	Maximum connection number the the connection pool will handle
IncreaseConnections		5	no	Connection number to be open when all the connections are being used.
LockedTimeout		Long.MAX_VALUE	no	Max time the connection can be blocked.
Timeout		Long.MAX_VALUE	no	Max time of inactivity to close a connection.
ConnectionWaitTime		4000	no	Configures the max time should wait to get a connection.
ConnectionRequestTime		500	no	Configures the time between retries to get a connection.
usej2eeconnections	yes/no	no	no	Indicates when application is using J2EE DataSource for connections
datasourcename			no (required when `usej2eeconnections` is set to 'yes'	The name of datasource. It is the name used to do 'lookup' operation from context.

DatabaseConnectionManager

public DatabaseConnectionManager(Hashtable parameters)
                          throws Exception

Throws:: Exception

Method Detail

getOntimizeConnection
```
public OntimizeConnection getOntimizeConnection()
                                         throws Exception
```
Returns an available connection and locks it. Ontimize tries to return a non-locked and non-reserved connection. When it is not possible, the oldest connection non-locked and reserved is returned. When neither non-locked nor non-reserved connections are available, Ontimize tries to increase the number connections, if it is not possible returns null.

Returns:
a connection available or null

Throws:

Exception - when Exception occurs

getOntimizeConnection
```
public OntimizeConnection getOntimizeConnection(int id)
                                         throws Exception
```
Search an unlocked connection reserved with the specified id. If the connection does not exist then uses the getConnection method

Parameters:
id - Reservation identifier

Returns:

Throws:

Exception

createConnection

protected OntimizeConnection createConnection(String driver,
                                  String uRLBD,
                                  String user,
                                  String password)
                                       throws Exception

Throws:: Exception

createConnection

public Connection createConnection()
                            throws SQLException

Throws:: SQLException

unLock
```
public void unLock(OntimizeConnection ontimizeConnection)
```
Unlock the connection

Parameters:
ontimizeConnection - Connection to unlock

setAutonumerical

public void setAutonumerical(URL oURLAutonumerical)

setAutonumerical

public void setAutonumerical(String oPropAutonumerical)

setAutonumerical

public void setAutonumerical(Autonumerical auto)

getAutonumericalValue
```
public int getAutonumericalValue()
```

getAutonumerical

public Autonumerical getAutonumerical()

getAutonumericalValue

public int getAutonumericalValue(String table)

closeConnections
```
public void closeConnections()
```

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable

getOntimizeConnectionNumber

public int getOntimizeConnectionNumber()

getLockedOntimizeConnectionNumber

public int getLockedOntimizeConnectionNumber()

closeLockedConnections
```
public void closeLockedConnections()
```

getAverageLockTime
```
public double getAverageLockTime()
```

getMaximumLockTime
```
public double getMaximumLockTime()
```

getUpdateCicleTime
```
public long getUpdateCicleTime()
```

getSchema
```
public String getSchema()
```

setSchema
```
public void setSchema(String schema)
```

activeForceDisconnection
```
public void activeForceDisconnection()
                              throws Exception
```
Close all the connections. This method can only be used when the JEE connections mode is not enabled.

Throws:

Exception

deactivateForceDisconnection

public void deactivateForceDisconnection()
                                  throws Exception

Throws:: Exception

isForceDisconnectionEnabled

public boolean isForceDisconnectionEnabled()

getAutonumerialReference

public Autonumerical getAutonumerialReference()

createDataSource

protected Object createDataSource(String dataSourceName,
                      Properties prop)
                           throws Exception

Throws:: Exception

getDatabase
```
public String getDatabase()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

setDriver
```
public void setDriver(String driver)
```

setUrlDB
```
public void setUrlDB(String urlDB)
```

setUser
```
public void setUser(String user)
```

setPassword

public void setPassword(String password)

setMinimumConnections

public void setMinimumConnections(int minimum)

setMaximumConnections

public void setMaximumConnections(int maximum)

getConnectionWaitTime
```
public int getConnectionWaitTime()
```

setConnectionWaitTime

public void setConnectionWaitTime(int connectionWaitTime)

getConnectionRequestTime
```
public int getConnectionRequestTime()
```

setConnectionRequestTime

public void setConnectionRequestTime(int connectionRequestTime)

setIncrementConnections

public void setIncrementConnections(int increment)

setDatabaseId

public void setDatabaseId(String databaseId)

setLockTimeout

public void setLockTimeout(long lockTimeout)

setTimeout
```
public void setTimeout(long timeout)
```

setCheckupCicle

public void setCheckupCicle(int checkupCicle)

setReleaseCicle

public void setReleaseCicle(long releaseCicle)

setUpdateCicle

public void setUpdateCicle(long updateCicle)

setTestTable

public void setTestTable(String testTable)

setSaveConnectionsInfo

public void setSaveConnectionsInfo(boolean connectionInfo)

Class DatabaseConnectionManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultUserValue

defaultPasswordValue

TIMEOUT

LOCKED_TIMEOUT

INCREASE_CONNECTIONS

CONNECTION_WAIT_TIME

CONNECTION_REQUEST_TIME

MAXIMUM_CONNECTIONS

MINIMUM_CONNECTIONS

EPASSWORD

E64PASSWORD

SCHEMA

PASSWORD

USER

TEST_TABLE

CHECK_CYCLE

RELEASE_CYCLE

UPDATE_CYCLE

URL

DRIVER

DATABASE

USEJ2EECONNECTIONS

DATASOURCENAME

CONNECTION_INFO

CREATE_INITIAL_CONNECTIONS

AUTONUMERICAL_PROPERTIES

DEBUG

AUTOCOMMIT_ON_UNLOCK

minimum

maximum

connectionWaitTime

connectionRequestTime

increment

lockTimeout

timeout

offset

offsetString

reserveCancellationThread

checkConnectionThread

maxReserveTime

reserveCicle

checkupCicle

testTable

useJ2EEConnection

dataSourceName

dataSource

connections

driver

urlDB

databaseId

user

password

releaseThread

releaseCicleThread

schema

updateCicleThread

lockTime

maxlocktime

forceDisconnection

Constructor Detail

DatabaseConnectionManager

DatabaseConnectionManager

DatabaseConnectionManager

DatabaseConnectionManager

Method Detail

getOntimizeConnection

getOntimizeConnection

createConnection

createConnection

unLock

setAutonumerical

setAutonumerical

setAutonumerical