Maximo 7.6 API - DBManager

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.

Version:

%I%, %G%

Author:

John Langley

See Also:
DBManager, MXServer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FASTFORWARD`
`static int`	`FORWARDONLY`
`java.lang.ref.ReferenceQueue`	`refQue`
`static int`	`SCROLLINSENSITIVE`
`static int`	`SCROLLSENSITIVE`
`static int`	`SCROLLSENSITIVEONE`
`boolean`	`ssPropLoaded`

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

Methods
Modifier and Type	Method and Description
`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 lean 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`	`freeConnection(ConnectionKey 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.
`psdi.server.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<java.lang.Integer,java.lang.Integer>`	`getTenantUsedConnCount(UserInfo ui, java.util.List<java.lang.Integer> 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`	`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()`
`static java.util.Vector`	`sqlTableScanExclude()`

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

- Field Detail
  - 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
```
  - refQue
```
public java.lang.ref.ReferenceQueue refQue
```
- Constructor Detail
  - DBManager
```
public DBManager()
```
    Constructs an empty Pool
    
    Parameters:
    name - the name of this DBManager
- Method Detail
  - getLock
```
public psdi.server.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
  - 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)
```
  - freeConnection
```
public void freeConnection(ConnectionKey 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:
    readLogSQLPlan, 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:
    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
  - getTenantUsedConnCount
```
public java.util.HashMap<java.lang.Integer,java.lang.Integer> getTenantUsedConnCount(UserInfo ui,
                                                                            java.util.List<java.lang.Integer> allTenants)
                                                                              throws MXException
```
    Throws:
    
    MXException
  - finalization
```
public void finalization()
                  throws java.lang.InterruptedException
```
    Continuesly lean 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
  - getReferenceQueue
```
public java.lang.ref.ReferenceQueue getReferenceQueue()
```
    get the refrence quque.
    
    Returns:

Class DBManager

Field Summary

Fields inherited from interface psdi.util.logging.FixedLoggers

Fields inherited from interface psdi.util.logging.FixedLoggerNames

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORWARDONLY

SCROLLINSENSITIVE

SCROLLSENSITIVE

SCROLLSENSITIVEONE

FASTFORWARD

ssPropLoaded

refQue

Constructor Detail

DBManager

Method Detail

getLock

configure

getSchemaOwner

getProperties

getName

getDatabaseProductName

getDatabaseProductSimpleVersion

getDatabaseProductVersion

getSSDisableCursor

getSSFetchUse

getSSFetchSize

getSSCursorType

getDbSqlServerDriver

getDBPlatform

getDB2Version

init

destroy

getConnection

freeConnection

getSystemConnectionKey

getSequenceConnection

getDBConnTotal

getDBConnUsed

getDBConnFree

getDBAuthenticationType

getCredentialHandler

getSQLTimeLimit

needToLogSQLOnTimeLimit

reloadSQLTimeLimit

needToLogSQLPlan

reloadLogSQLPlan

reloadSQLScanExclude

reloadDBRowCount

reloadDBRefCount

reloadProperties

readSQLTimeLimit

sqlTableScanExclude

logSQLPlan

getSPID

getTenantUsedConnCount

finalization

finalization

getReferenceQueue