DBManager (Maximo API)

java.lang.Object
- psdi.server.DBManager

All Implemented Interfaces:

FixedLoggerNames, FixedLoggers

Direct Known Subclasses:

OracleProxyDBManager
```
public class DBManager
extends java.lang.Object
implements FixedLoggers
```
This is a java.util.Vector of java.sql.Connections. In addition, it has a name, and a set of values required to establish the connection.

See Also:

DBManager, MXServer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class DBManager.Lock

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DBManager.Lock`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map`	`connectionKeyMap`
`protected psdi.server.DBManager.ConnectionPoolThread`	`connectionPoolThread`
`protected static double`	`db2Version`
`protected static int`	`dbPlatform` Database platform
`protected java.lang.String`	`dbProductName`
`protected java.lang.String`	`dbProductVersion`
`protected java.lang.String`	`dbProductVersionMajMin`
`protected static java.lang.String`	`dbPropPrefix` The property prefix for db
`protected static int`	`dbSqlServerDriver`
`protected static java.lang.String`	`defaultSchemaOwner`
`protected static boolean`	`disableServerCursor`
`protected java.sql.Driver`	`driver` driver for database connection.
`protected boolean`	`driverInfoShown`
`protected java.lang.String`	`driverString` String for selecting the JDBC driver for this Pool of connections
`static int`	`FASTFORWARD`
`protected static int`	`fetchSize`
`protected static boolean`	`fetchUse`
`static int`	`FORWARDONLY`
`protected java.util.List`	`free` Collections of connections, the Connections on the free list are avaialable for use, the connections on the used list are currently assigned.
`protected boolean`	`initialized` Defaults to false.
`protected static boolean`	`isRAC`
`protected java.lang.String`	`jdbcCollection` DB2 jdbcCollection; defaults to null.
`protected int`	`MAX_PING_REQUESTS`
`protected int`	`MAX_PING_TIMEOUT_MILLISECONDS`
`protected int`	`maxFreeConnections`
`protected int`	`minFreeConnections`
`protected java.lang.String`	`name` The Datasource name, this is label users specify to get a connection from this pool.
`protected int`	`newConnectionCount`
`protected java.util.HashMap`	`pingapiconn`
`java.lang.ref.ReferenceQueue`	`refQue`
`protected static int`	`resultSetType`
`protected java.lang.String`	`schemaOwner` Schema owner of the database tables.
`static int`	`SCROLLINSENSITIVE`
`static int`	`SCROLLSENSITIVE`
`static int`	`SCROLLSENSITIVEONE`
`protected ConRef`	`sequenceConnection`
`protected java.lang.String`	`sslConnection`
`protected java.lang.String`	`sslTrustStoreLocation`
`protected java.lang.String`	`sslTrustStorePassword`
`boolean`	`ssPropLoaded`
`java.util.concurrent.ConcurrentLinkedQueue`	`stmtQueue`
`protected ConRef`	`systemConnection`
`protected java.lang.String`	`urlString` Url of the database to connect to
`protected java.util.HashMap`	`used` Hashtable mapping "object references" to connections.

Fields inherited from interface psdi.util.logging.FixedLoggers
APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Constructor Summary

Constructors
Constructor and Description

DBManager()
Constructs an empty Pool

Constructors
Constructor and Description
`DBManager()` Constructs an empty Pool

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`apiPingConnExists(java.net.InetAddress inetAddress)`
`void`	`cleanupStatementQueue()` Continuesly clean up the statement queue.
`void`	`configure(java.util.Properties properties)` configure the DBManager based on the information in the properties file read in.
`void`	`destroy()` Closes database connections, set's both the used and free vectors to null
`void`	`finalization()` Continuesly clean up the phantom references for the clean up system resources.
`void`	`finalization(int timeMilli)` Engage in the clean up of the objects in the phantom reference queue for the specified amount of time.
`void`	`flushFreeConnections()`
`void`	`forceFreeConnection(ConnectionKeyLight conKey)`
`void`	`freeConnection(ConnectionKey conKey)`
`void`	`freeConnection(ConnectionKeyLight conKey)`
`java.sql.Connection`	`getConnection(ConnectionKey conKey)`
`DBCredentialHandler`	`getCredentialHandler()`
`java.lang.String`	`getDatabaseProductName()` Returns the database product name.
`java.lang.String`	`getDatabaseProductSimpleVersion()` Returns the database product version Major.Minor.
`java.lang.String`	`getDatabaseProductVersion()` Returns the database product version string.
`static double`	`getDB2Version()` If this is a DB2 database, returns the DB2 version, else returns 0.
`int`	`getDBAuthenticationType()` Return the authentication type.
`int`	`getDBConnFree()`
`int`	`getDBConnTotal()`
`int`	`getDBConnUsed()`
`static int`	`getDBPlatform()` Returns the database platform as an integer.
`static int`	`getDbSqlServerDriver()` Returns constant for SqlServer driver.
`DBManager.Lock`	`getLock(java.lang.Object connectionKey)`
`java.lang.String`	`getName()` Name of the pool a.k.a.
`java.util.Properties`	`getProperties()` properties are the ones handed in to this Pool at construction time.
`java.lang.ref.ReferenceQueue`	`getReferenceQueue()` get the refrence quque.
`java.lang.String`	`getSchemaOwner()` Returns the database schema owner.
`java.sql.Connection`	`getSequenceConnection()` Returns the connection used for generating sequence for sqlserver This should not be used by any application services or business objects.
`static java.lang.String`	`getSPID(java.sql.Connection connection)` Get the SPID from database for each connection.Don't use this method directly.
`static long`	`getSQLTimeLimit()`
`static int`	`getSSCursorType()` Returns cursor type for Sql server.
`static boolean`	`getSSDisableCursor()` Returns if server cursor is disabled or not for Sql server.
`static int`	`getSSFetchSize()` Returns fetch size for Sql server.
`static boolean`	`getSSFetchUse()` Returns if fetch size can be used or not for Sql server.
`ConnectionKey`	`getSystemConnectionKey()` Returns SystemConnectionKey object to use to get System connection.
`java.util.HashMap`	`getTenantUsedConnCount(UserInfo ui, java.util.List allTenants)`
`boolean`	`init()` Loads a driver, and establishes a series of connections with the specified database.
`static java.lang.StringBuffer`	`logSQLPlan(java.sql.Connection conn, java.lang.String sqlStatement)`
`static boolean`	`needToLogSQLOnTimeLimit()`
`static boolean`	`needToLogSQLPlan()` Identifies whether we need to log Sql plan (property mxe.db.logSQLPlan).
`static void`	`printStackTraceNoMsg(java.lang.Throwable e)` print out stacktrace of an exception to std err without using maxmessage to avoid deadlock or infinit loop
`static void`	`readSQLTimeLimit()`
`void`	`reloadDBRefCount()`
`void`	`reloadDBRowCount()`
`static void`	`reloadLogSQLPlan()` Reload the cached value we have for property mxe.db.logSQLPlan when the value of that property has changed.
`void`	`reloadProperties(java.util.Properties props)` This is called from MaxPropCache when reloading properties from maximo.properties file when WAS fine-grained application update has been used.
`static void`	`reloadSQLScanExclude()`
`static void`	`reloadSQLTimeLimit()`
`void`	`removeApiPingConn(ConRef conref)`
`boolean`	`setApiPingConn(java.net.InetAddress inetAddress, ConnectionKey conKey)`
`protected void`	`setUseStoredOutline(java.sql.Connection connection)`
`static java.util.Vector`	`sqlTableScanExclude()`

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

- Field Detail
  - dbPropPrefix
```
protected static final java.lang.String dbPropPrefix
```
    The property prefix for db
    
    See Also:
    
    Constant Field Values
  - defaultSchemaOwner
```
protected static final java.lang.String defaultSchemaOwner
```
    See Also:
    
    Constant Field Values
  - name
```
protected java.lang.String name
```
    The Datasource name, this is label users specify to get a connection from this pool.
  - urlString
```
protected java.lang.String urlString
```
    Url of the database to connect to
  - free
```
protected volatile java.util.List free
```
    Collections of connections, the Connections on the free list are avaialable for use, the connections on the used list are currently assigned.
  - used
```
protected java.util.HashMap used
```
    Hashtable mapping "object references" to connections.
  - pingapiconn
```
protected java.util.HashMap pingapiconn
```
  - MAX_PING_REQUESTS
```
protected int MAX_PING_REQUESTS
```
  - MAX_PING_TIMEOUT_MILLISECONDS
```
protected int MAX_PING_TIMEOUT_MILLISECONDS
```
  - driverString
```
protected java.lang.String driverString
```
    String for selecting the JDBC driver for this Pool of connections
  - driver
```
protected java.sql.Driver driver
```
    driver for database connection.
  - jdbcCollection
```
protected java.lang.String jdbcCollection
```
    DB2 jdbcCollection; defaults to null.
  - initialized
```
protected boolean initialized
```
    Defaults to false. Set to true once "this" has been initialized.
  - dbProductName
```
protected java.lang.String dbProductName
```
  - dbProductVersionMajMin
```
protected java.lang.String dbProductVersionMajMin
```
  - dbProductVersion
```
protected java.lang.String dbProductVersion
```
  - disableServerCursor
```
protected static boolean disableServerCursor
```
  - fetchUse
```
protected static boolean fetchUse
```
  - fetchSize
```
protected static int fetchSize
```
  - resultSetType
```
protected static int resultSetType
```
  - FORWARDONLY
```
public static final int FORWARDONLY
```
    See Also:
    
    Constant Field Values
  - SCROLLINSENSITIVE
```
public static final int SCROLLINSENSITIVE
```
    See Also:
    
    Constant Field Values
  - SCROLLSENSITIVE
```
public static final int SCROLLSENSITIVE
```
    See Also:
    
    Constant Field Values
  - SCROLLSENSITIVEONE
```
public static final int SCROLLSENSITIVEONE
```
    See Also:
    
    Constant Field Values
  - FASTFORWARD
```
public static final int FASTFORWARD
```
    See Also:
    
    Constant Field Values
  - ssPropLoaded
```
public boolean ssPropLoaded
```
  - dbPlatform
```
protected static int dbPlatform
```
    Database platform
    
    See Also:
    
    UpgConstants
  - isRAC
```
protected static boolean isRAC
```
  - db2Version
```
protected static double db2Version
```
  - dbSqlServerDriver
```
protected static int dbSqlServerDriver
```
  - driverInfoShown
```
protected boolean driverInfoShown
```
  - schemaOwner
```
protected java.lang.String schemaOwner
```
    Schema owner of the database tables. Default is "MAXIMO". Can be set from the properties file mxe.db.schemaowner=maximo
  - maxFreeConnections
```
protected int maxFreeConnections
```
  - minFreeConnections
```
protected int minFreeConnections
```
  - newConnectionCount
```
protected int newConnectionCount
```
  - sslConnection
```
protected java.lang.String sslConnection
```
  - sslTrustStoreLocation
```
protected java.lang.String sslTrustStoreLocation
```
  - sslTrustStorePassword
```
protected java.lang.String sslTrustStorePassword
```
  - systemConnection
```
protected ConRef systemConnection
```
  - sequenceConnection
```
protected ConRef sequenceConnection
```
  - connectionPoolThread
```
protected psdi.server.DBManager.ConnectionPoolThread connectionPoolThread
```
  - connectionKeyMap
```
protected java.util.Map connectionKeyMap
```
  - refQue
```
public java.lang.ref.ReferenceQueue refQue
```
  - stmtQueue
```
public java.util.concurrent.ConcurrentLinkedQueue stmtQueue
```
- Constructor Detail
  - DBManager
```
public DBManager()
```
    Constructs an empty Pool
    
    Parameters:
    
    name - the name of this DBManager
- Method Detail
  - getLock
```
public DBManager.Lock getLock(java.lang.Object connectionKey)
```
  - configure
```
public void configure(java.util.Properties properties)
```
    configure the DBManager based on the information in the properties file read in.
  - getSchemaOwner
```
public java.lang.String getSchemaOwner()
```
    Returns the database schema owner.
  - getProperties
```
public java.util.Properties getProperties()
```
    properties are the ones handed in to this Pool at construction time.
  - getName
```
public java.lang.String getName()
```
    Name of the pool a.k.a. DataSource
  - setUseStoredOutline
```
protected void setUseStoredOutline(java.sql.Connection connection)
                            throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getDatabaseProductName
```
public java.lang.String getDatabaseProductName()
```
    Returns the database product name.
  - getDatabaseProductSimpleVersion
```
public java.lang.String getDatabaseProductSimpleVersion()
```
    Returns the database product version Major.Minor.
  - getDatabaseProductVersion
```
public java.lang.String getDatabaseProductVersion()
```
    Returns the database product version string.
  - getSSDisableCursor
```
public static boolean getSSDisableCursor()
```
    Returns if server cursor is disabled or not for Sql server.
  - getSSFetchUse
```
public static boolean getSSFetchUse()
```
    Returns if fetch size can be used or not for Sql server.
  - getSSFetchSize
```
public static int getSSFetchSize()
```
    Returns fetch size for Sql server.
  - getSSCursorType
```
public static int getSSCursorType()
```
    Returns cursor type for Sql server.
  - getDbSqlServerDriver
```
public static int getDbSqlServerDriver()
```
    Returns constant for SqlServer driver.
  - getDBPlatform
```
public static int getDBPlatform()
```
    Returns the database platform as an integer.
    
    See Also:
    
    UpgConstants
  - getDB2Version
```
public static double getDB2Version()
```
    If this is a DB2 database, returns the DB2 version, else returns 0.
  - init
```
public boolean init()
```
    Loads a driver, and establishes a series of connections with the specified database.
    
    Returns:
    
    true if connections succeed, false otherwise.
  - destroy
```
public void destroy()
```
    Closes database connections, set's both the used and free vectors to null
  - getConnection
```
public java.sql.Connection getConnection(ConnectionKey conKey)
```
  - printStackTraceNoMsg
```
public static void printStackTraceNoMsg(java.lang.Throwable e)
```
    print out stacktrace of an exception to std err without using maxmessage to avoid deadlock or infinit loop
  - setApiPingConn
```
public boolean setApiPingConn(java.net.InetAddress inetAddress,
                              ConnectionKey conKey)
```
  - apiPingConnExists
```
public boolean apiPingConnExists(java.net.InetAddress inetAddress)
```
  - removeApiPingConn
```
public void removeApiPingConn(ConRef conref)
```
  - freeConnection
```
public void freeConnection(ConnectionKey conKey)
```
  - freeConnection
```
public void freeConnection(ConnectionKeyLight conKey)
```
  - forceFreeConnection
```
public void forceFreeConnection(ConnectionKeyLight conKey)
```
  - getSystemConnectionKey
```
public ConnectionKey getSystemConnectionKey()
```
    Returns SystemConnectionKey object to use to get System connection.
    
    Returns:
  - getSequenceConnection
```
public java.sql.Connection getSequenceConnection()
```
    Returns the connection used for generating sequence for sqlserver This should not be used by any application services or business objects.
  - getDBConnTotal
```
public int getDBConnTotal()
```
  - getDBConnUsed
```
public int getDBConnUsed()
```
  - getDBConnFree
```
public int getDBConnFree()
```
  - getDBAuthenticationType
```
public int getDBAuthenticationType()
```
    Return the authentication type. 0 means no proxy authentication involved. This method should be overwritten by inherited db managers to return the correct value.
  - getCredentialHandler
```
public DBCredentialHandler getCredentialHandler()
```
  - getSQLTimeLimit
```
public static long getSQLTimeLimit()
```
  - needToLogSQLOnTimeLimit
```
public static boolean needToLogSQLOnTimeLimit()
```
  - reloadSQLTimeLimit
```
public static void reloadSQLTimeLimit()
```
  - needToLogSQLPlan
```
public static boolean needToLogSQLPlan()
```
    Identifies whether we need to log Sql plan (property mxe.db.logSQLPlan).
    
    See Also:
    
    DBManager.readLogSQLPlan, DBManager.logSQLPlan
  - reloadLogSQLPlan
```
public static void reloadLogSQLPlan()
```
    Reload the cached value we have for property mxe.db.logSQLPlan when the value of that property has changed.
    
    See Also:
    
    DBManager.readLogSQLPlan
  - reloadSQLScanExclude
```
public static void reloadSQLScanExclude()
```
  - reloadDBRowCount
```
public void reloadDBRowCount()
```
  - reloadDBRefCount
```
public void reloadDBRefCount()
```
  - reloadProperties
```
public void reloadProperties(java.util.Properties props)
                      throws MXException
```
    This is called from MaxPropCache when reloading properties from maximo.properties file when WAS fine-grained application update has been used.
    
    Throws:
    
    MXException
  - readSQLTimeLimit
```
public static void readSQLTimeLimit()
```
  - sqlTableScanExclude
```
public static java.util.Vector sqlTableScanExclude()
```
  - logSQLPlan
```
public static java.lang.StringBuffer logSQLPlan(java.sql.Connection conn,
                                                java.lang.String sqlStatement)
```
  - getSPID
```
public static java.lang.String getSPID(java.sql.Connection connection)
```
    Get the SPID from database for each connection.Don't use this method directly. Use Conref.getSPID() if connection is a conref.
    
    Parameters:
    
    connection -
    
    Throws:
    
    java.lang.Exception
  - flushFreeConnections
```
public void flushFreeConnections()
                          throws java.rmi.RemoteException
```
    Throws:
    
    java.rmi.RemoteException
  - getTenantUsedConnCount
```
public java.util.HashMap getTenantUsedConnCount(UserInfo ui,
                                                java.util.List allTenants)
                                         throws MXException
```
    Throws:
    
    MXException
  - finalization
```
public void finalization()
                  throws java.lang.InterruptedException
```
    Continuesly clean up the phantom references for the clean up system resources. This method is blocking on the queue of the reference and anc contitue forever.
    
    Throws:
    
    java.lang.InterruptedException
  - finalization
```
public void finalization(int timeMilli)
                  throws java.lang.InterruptedException
```
    Engage in the clean up of the objects in the phantom reference queue for the specified amount of time. During the execution, if error happens, the exception will be logged, but the process will continue.
    
    Parameters:
    
    max -
    
    Throws:
    
    java.lang.InterruptedException
  - cleanupStatementQueue
```
public void cleanupStatementQueue()
                           throws java.lang.InterruptedException
```
    Continuesly clean up the statement queue.
    
    Throws:
    
    java.lang.InterruptedException
  - getReferenceQueue
```
public java.lang.ref.ReferenceQueue getReferenceQueue()
```
    get the refrence quque.
    
    Returns:

Fields inherited from interface psdi.util.logging.FixedLoggers

Fields inherited from interface psdi.util.logging.FixedLoggerNames

Methods inherited from class java.lang.Object

dbPropPrefix

defaultSchemaOwner

name

urlString

free

used

pingapiconn

MAX_PING_REQUESTS

MAX_PING_TIMEOUT_MILLISECONDS

driverString

driver

jdbcCollection

initialized

dbProductName

dbProductVersionMajMin

dbProductVersion

disableServerCursor

fetchUse

fetchSize

resultSetType

FORWARDONLY

SCROLLINSENSITIVE

SCROLLSENSITIVE

SCROLLSENSITIVEONE

FASTFORWARD

ssPropLoaded

dbPlatform

isRAC

db2Version

dbSqlServerDriver

driverInfoShown

schemaOwner

maxFreeConnections

minFreeConnections

newConnectionCount

sslConnection

sslTrustStoreLocation

sslTrustStorePassword

systemConnection

sequenceConnection

connectionPoolThread

connectionKeyMap

refQue

stmtQueue

DBManager

getLock

configure

getSchemaOwner

getProperties

getName

setUseStoredOutline

getDatabaseProductName

getDatabaseProductSimpleVersion

getDatabaseProductVersion

getSSDisableCursor

getSSFetchUse

getSSFetchSize

getSSCursorType

getDbSqlServerDriver

getDBPlatform

getDB2Version

init

destroy

getConnection

printStackTraceNoMsg

setApiPingConn

apiPingConnExists

removeApiPingConn

freeConnection

freeConnection

forceFreeConnection

getSystemConnectionKey

getSequenceConnection

getDBConnTotal

getDBConnUsed

getDBConnFree

getDBAuthenticationType