|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
dkPool: An interface for database connection pool. A dkPool object is a factory for database Connection objects
Method Summary | |
void |
destroy()
Destroy this dkPool object including all connections in both free pool and used pool |
java.lang.String |
getConfigurationString()
Gets the configuration string which supplies the specific initialization parameters for connection. |
DKHandle |
getConnection(java.lang.String userId,
java.lang.String passwd)
Gets a connection from the pool |
int |
getConnTimeOut()
Gets the number of seconds that an application waits for a connection from the pool before time out and throwing exception. |
int |
getIdleTimeOut()
Gets the number of seconds that a connection should remain unused in the pool. |
int |
getMaxPoolSize()
Gets the maximum number of connections that the pool should contain. |
int |
getMinPoolSize()
Gets the minimum number of connections that the pool should keep when all the connections are idle. |
int |
getOrphanTimeOut()
Gets the number of seconds that an application is allowed to hold an inactive connection. |
java.lang.String |
getServerName()
Gets the name of the data source's server name. |
void |
initConnections(java.lang.String userid,
java.lang.String passwd,
int initSize)
Initialize number of connections and store them in the pool. |
java.lang.String |
poolConnectType()
Gets the pool connect type for this connection pool For ICM in java, this will be "JDBC_DB2" or "WAS" |
void |
returnConnection(DKHandle handle)
Returns a connection to the pool |
void |
setConfigurationString(java.lang.String configString)
Sets the configuration string which supplies the specific initialization parameters for connection. |
void |
setConnTimeOut(int connTime)
Sets the number of seconds that an application waits for a connection from the pool before time out and throwing exception. |
void |
setIdleTimeOut(int idleTime)
Sets the number of seconds that a connection should remain unused in the pool before the connection is disconnect & destroyed. |
void |
setMaxPoolSize(int poolSize)
Sets the maximum number of connections that the pool should contain. |
void |
setMinPoolSize(int poolSize)
Sets the minimum number of connections that the pool should keep when all connections are idle. |
void |
setOrphanTimeOut(int orphanTime)
Sets the number of seconds that an application is allowed to hold an inactive connection. |
void |
setServerName(java.lang.String aDSName)
Sets the name of the data source's server name. |
Method Detail |
public java.lang.String getServerName()
public void setServerName(java.lang.String aDSName) throws DKException, java.lang.Exception
aDSName
- the name for creating connectionpublic java.lang.String getConfigurationString()
public void setConfigurationString(java.lang.String configString) throws DKException, java.lang.Exception
Once the connection has been created, you can not set this to a different configuration string
configString
- info about connection driverpublic int getMaxPoolSize()
public void setMaxPoolSize(int poolSize) throws DKException, java.lang.Exception
poolSize
- the maximum number of connection pool size
(this is not implemented for WAS. Use WebSphere Adm. Console to configure this.public int getMinPoolSize()
public void setMinPoolSize(int poolSize) throws DKException, java.lang.Exception
poolSize
- the minimum number of connection pool size
(this is not implemented for WAS. Use WebSphere Adm. Console to configure this.public int getIdleTimeOut()
public void setIdleTimeOut(int idleTime) throws DKException, java.lang.Exception
idleTime
- the number of seconds
(this is not implemented for WAS. Use WebSphere Adm. Console to configure this.public int getConnTimeOut()
public void setConnTimeOut(int connTime) throws DKException, java.lang.Exception
connTime
- the number of seconds
(this is not implemented for WAS. Use WebSphere Adm. Console to configure this.public int getOrphanTimeOut()
public void setOrphanTimeOut(int orphanTime) throws DKException, java.lang.Exception
orphanTime
- the number of seconds
(this is not implemented for WAS. Use WebSphere Adm. Console to configure this.public void initConnections(java.lang.String userid, java.lang.String passwd, int initSize) throws DKException, java.lang.Exception
userId
- the user Id used for connectionpasswd
- the password used for connectioninitSize
- the number of connection to be createdpublic DKHandle getConnection(java.lang.String userId, java.lang.String passwd) throws DKException, java.lang.Exception
userId
- the user name used for connectionpasswd
- the password used for connectionto obtain the true Connection object call like: Connection con = (Connection)aDKHandle.handle();
public void returnConnection(DKHandle handle) throws DKException, java.lang.Exception
handle
- a DKHandle that contains the Connection objectpublic java.lang.String poolConnectType() throws java.lang.Exception
public void destroy() throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |