StatelessConnectionPool Class

This class represents a pool of stateless, authenticated connections to the database.

PoolType

BusyOption

DestroyMode

getAnyTaggedConnection()

Returns a pointer to the connection object, without the restriction of a matching tag.

This method works in an environment with enabled database resident connection pooling.

During the execution of this call, the pool is first searched based on the tag provided. If a connection with the specified tag exists, it is returned to the user. If a matching connection is not available, an appropriately authenticated untagged connection (with a NULL tag) is returned. In cases where an undated connection is not free, an appropriately authenticated connection with a different tag is returned.

A getTag() call to the Connection verifies that the connection tag is received.

Connection *getAnyTaggedConnection(
   string &tag="")=0;

Connection* getAnyTaggedConnection(
   const UString &tag)=0; 

Connection *getAnyTaggedConnection(
   const string &userNname,
   const string &password,
   const string &tag="")=0;

Connection* getAnyTaggedConnection(
   const UString &userName, 
   const UString &Password, 
   const UString &tag)=0 ;

userName

password

tag

getAnyTaggedProxyConnection()

Returns a proxy connection from a connection pool.

This method works in an environment with enabled database resident connection pooling.

During the execution of this call, the pool is first searched based on the tag provided. If a connection with the specified tag exists, it is returned to the user. If a matching connection is not available, an appropriately authenticated connection with a different tag is returned. In cases where an undated connection is not free, an appropriately authenticated connection with a different tag is returned.

Restrictions for matching the tag may be removed by passing an empty tag argument parameter.

A getTag() call to the connection verifies the connection tag received.

Connection *getAnyTaggedProxyConnection(
   const string &name,
   string roles[],
   unsigned int numRoles,
   const string tag="",
   Connection::ProxyType 
      proxyType=Connection::PROXY_DEFAULT);

Connection* getAnyTaggedProxyConnection(
   const UString &name,
   string roles[],
   unsigned int numRoles,
   const UString &tag,
   Connection::ProxyType 
      proxyType = Connection::PROXY_DEFAULT);

Connection *getAnyTaggedProxyConnection(
   const string &name,
   const string tag="",
   Connection::ProxyType       proxyType=Connection::PROXY_DEFAULT);

Connection* getAnyTaggedProxyConnection(
   const UString &name,
   const UString &tag,
   Connection::ProxyType 
      proxyType = Connection::PROXY_DEFAULT);

name

roles

numRoles

tag

proxyType

getBusyConnections()

Returns the number of busy connections in the connection pool. When using database resident connection pooling, this is the number of persistent connections to the Connection Broker.

Syntax

unsigned int getBusyConnections() const=0;

getBusyOption()

Returns the behavior of the stateless connection pool when all the connections in the pool are busy, and when the number of connections have reached maximum. The return values are defined for BusyOption in Table 13-40.

Syntax

BusyOption getBusyOption()=0; 
 

getConnection()

Returns a pointer to the connection object of a StatelessConnectionPool.

This method works in an environment with enabled database resident connection pooling.

Connection *getConnection(
   string &tag="")=0;

Connection* getConnection(
   const UString &tag)=0;

Connection *getConnection(
   const string &userName,
   const string &password,
   const string &tag="")=0;

Connection* getConnection(
   const UString &userName,
   const UString &password,
   const UString &tag)=0;

Connection *getConnection(
   const string &connectionClass,
   const Connection::Purity &purity)=0;

Connection* getConnection(
   const UString &connectionClass,
   const Connection::Purity &purity)=0;

Connection *getConnection(
   const string &userName,
   const string &password,
   const string &connectionClass,
   const Connection::Purity &purity)=0;

Connection* getConnection(
   const UString &userName,
   const UString &password,
   const UString &connectionClass,
   const Connection::Purity &purity)=0;

Connection *getConnection(
   const string &connectionClass,
   const Connection::Purity &purity,
   const string &tag)=0;

Connection* getConnection(
   const UString &connectionClass,
   const Connection::Purity &purity,
   const UString &tag)=0;

userName

password

tag

connectionClass

purity

getIncrConnections()

Returns the number of incremental connections in the connection pool. This call is useful only in cases of homogeneous connection pools. When using database resident connection pooling, this is the number of persistent connections to the Connection Broker.

Syntax

unsigned int getIncrConnections() const=0;

getMaxConnections()

Returns the maximum number of connections in the connection pool. When using database resident connection pooling, this is the number of persistent connections to the Connection Broker.

Syntax

unsigned int getMaxConnections() const=0;

getMinConnections()

Returns the minimum number of connections in the connection pool. When using database resident connection pooling, this is the number of persistent connections to the Connection Broker.

Syntax

unsigned int getMinConnections() const=0;

getOpenConnections()

Returns the number of open connections in the connection pool. When using database resident connection pooling, this is the number of persistent connections to the Connection Broker.

Syntax

unsigned int getOpenConnections() const=0;

getPoolName()

Returns the name of the connection pool.

Syntax

string getPoolName() const=0;

getProxyConnection()

Returns a proxy connection from a connection pool.

This method works in an environment with enabled database resident connection pooling.

Connection *getProxyConnection(
   const string &userName,
   string roles[],
   unsigned int numRoles,
   const string& tag="",
   Connection::ProxyType 
      proxyType=Connection::PROXY_DEFAULT)=0;

Connection* getProxyConnection(
   const UString &userName,
   UString roles[], 
   unsigned int numRoles, 
   const UString &tag, 
   Connection::ProxyType 
      proxyType = Connection::PROXY_DEFAULT);

Connection *getProxyConnection(
   const string &userName,
   const string &connectionClass,
   const Connection::Purity &purity)=0;

Connection *getProxyConnection(
   const UString &userName,
   const UString &connectionClass,
   const Connection::Purity &purity)=0;

Connection *getProxyConnection(
   const string &userName,
   string roles[],
   unsigned int numRoles,
   const string &connectionClass,
   const Connection::Purity &purity)=0;

Connection* getProxyConnection(
   const UString &userName,
   UString roles[], 
   unsigned int numRoles, 
   const UString &connectionClass,
   const Connection::Purity &purity)=0;

Connection *getProxyConnection(
   const string &userName,
   const string& tag="",
   Connection::ProxyType 
      proxyType=Connection::PROXY_DEFAULT)=0;

Connection* getProxyConnection(
   const UString &userName,
   const UString &tag,
   Connection::ProxyType 
   proxyType = Connection::PROXY_DEFAULT)

userName

roles

numRoles

tag

proxyType

connectionClass

purity

getStmtCacheSize()

Retrieves the size of the statement cache.

Syntax

unsigned int getStmtCacheSize() const=0;

getTimeOut()

Returns the timeout period of a connection in the connection pool.

Syntax

unsigned int getTimeOut() const=0;

releaseConnection()

Releases the connection back to the pool with an optional tag.

This method works in an environment with enabled database resident connection pooling.

void releaseConnection(
   Connection *connection,
   const string& tag="");

void releaseConnection(
   Connection *connection,
   const UString &tag);

connection

tag

setBusyOption()

Specifies the behavior of the stateless connection pool when all the connections in the pool are busy, and when the number of connections have reached maximum.

Syntax

void setBusyOption( 
   BusyOption busyOption)=0;

busyOption

setPoolSize()

Sets the maximum, minimum, and incremental number of pooled connections for the connection pool.

Syntax

void setPoolSize( 
   unsigned int maxConn=1,
   unsigned int minConn=0,
   unsigned int incrConn=1)=0;

maxConn

minConn

incrConn

setTimeOut()

Sets the time out period of a connection in the connection pool. OCCI will terminate any connections related to this connection pool that have been idle for longer than the time out period specified.

If this attribute is not set, the least recently used connection will be timed out when pool space is required. Oracle only checks for timed out connections when it releases a connection back to the pool.

Syntax

void setTimeOut( 
   unsigned int connTimeOut=0)=0;

connTimeOut

setStmtCacheSize()

Enables or disables statement caching. A nonzero value will enable statement caching, with a cache of specified size. A zero value will disable caching.

If the user changes the cache size of individual connections and subsequently returns the connection back to the pool with a tag, the cache size does not revert to the one set for the pool. If the connection is untagged, the cache size is reset to equal the cache size specified for the pool.

Syntax

void setStmtCacheSize(
   unsigned int cacheSize)=0;

cacheSize

terminateConnection()

Closes the connection and removes it from the pool.

This method works in an environment with enabled database resident connection pooling.

Syntax

void terminateConnection( 
   Connection *connection)=0;

connection