com.bmc.arsys.apitransport.connection

Class ApiCMTProxyPool

java.lang.Object

com.bmc.arsys.apitransport.connection.ApiCMTProxyPool

public class ApiCMTProxyPool
extends Object

This pool contains proxies that assigned to client management DB transaction, which needs to be set to the same server. Once proxy in this pool is assigned, it can not be used for other transactions. We need to accomplish a few things: Once a transaction is started on a connection, that connection should only be used for calls in the same transaction Once a transaction is started on a connection, only that connection should be used for the transaction If multiple clients use the same transaction, they must use the same connection serially If no API call is made within a transaction within a defined period of time, the transaction is ended and the connection should be usable outside of the transaction

Method Summary

Modifier and Type	Method and Description
void	addCMTProxyInCMTPool(String mTransactionHandle, ApiProxyI apiProxyI, ApiUserContextI apiUserContextI, String arProxyName, String cmd, ApiProxyType proxyType) add the proxy that handles the client managed transaction in it's pool this method should only be called in beginClientManagedTransaction before releaseProxy().
void	cleanUpTimeoutCMTFromCMTPool() Clean up timeout CMT.
ApiProxyI	getCMTProxyFromCMTPool(String mTransactionHandle, ApiUserContextI apiUserContextI, String arProxyName, String cmd, ApiProxyType proxyType) If multiple clients use the same transaction, they must use the same connection serially getClientManagedTransactionInPool will lock the key, releaseClientManagedTransactionInPool will release the key
boolean	releaseCMTProxyBackInCMTPool(String mTransactionHandle, ApiProxyI apiProxyI, ApiUserContextI apiUserContextI, String arProxyName, String cmd, ApiProxyType proxyType) release the proxy that handles the client managed transaction back into it's pool 1.
boolean	removeCMTProxyFromCMTPool(String mTransactionHandle, ApiProxyI apiProxyI, ApiUserContextI apiUserContextI, String arProxyName, String cmd, ApiProxyType proxyType) this method should only be called in endClientManagedTransaction before releaseProxy().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addCMTProxyInCMTPool

public void addCMTProxyInCMTPool(String mTransactionHandle,
                                 ApiProxyI apiProxyI,
                                 ApiUserContextI apiUserContextI,
                                 String arProxyName,
                                 String cmd,
                                 ApiProxyType proxyType)
                          throws ARException

add the proxy that handles the client managed transaction in it's pool this method should only be called in beginClientManagedTransaction before releaseProxy().

Parameters:

mTransactionHandle -

apiProxyI -

sharedSocket -

apiUserContextI -

arProxyName -

cmd -

proxyType -

Throws:

ARException

removeCMTProxyFromCMTPool

public boolean removeCMTProxyFromCMTPool(String mTransactionHandle,
                                         ApiProxyI apiProxyI,
                                         ApiUserContextI apiUserContextI,
                                         String arProxyName,
                                         String cmd,
                                         ApiProxyType proxyType)
                                  throws ARException

this method should only be called in endClientManagedTransaction before releaseProxy().

Parameters:

mTransactionHandle -

apiProxyI -

apiUserContextI -

arProxyName -

cmd -

proxyType -

Throws:

ARException

getCMTProxyFromCMTPool

public ApiProxyI getCMTProxyFromCMTPool(String mTransactionHandle,
                                        ApiUserContextI apiUserContextI,
                                        String arProxyName,
                                        String cmd,
                                        ApiProxyType proxyType)
                                 throws ARException

If multiple clients use the same transaction, they must use the same connection serially getClientManagedTransactionInPool will lock the key, releaseClientManagedTransactionInPool will release the key

Parameters:

mTransactionHandle -

apiUserContextI -

apiProxyI -

arProxyName -

cmd -

proxyType -

Returns:

Throws:

ARException

releaseCMTProxyBackInCMTPool

public boolean releaseCMTProxyBackInCMTPool(String mTransactionHandle,
                                            ApiProxyI apiProxyI,
                                            ApiUserContextI apiUserContextI,
                                            String arProxyName,
                                            String cmd,
                                            ApiProxyType proxyType)

release the proxy that handles the client managed transaction back into it's pool 1. if this proxy rpcType is the one saved in CMTpool, do not release it. 2. if the proxy rpcType is not the one saved in CMTpool, swap back the socket from the one parked in CMTpoo. and release it

Parameters:

mTransactionHandle -

apiProxyI -

apiUserContextI -

arProxyName -

cmd -

proxyType -

Throws:

ARException

cleanUpTimeoutCMTFromCMTPool

public void cleanUpTimeoutCMTFromCMTPool()

Clean up timeout CMT. return unused proxy back to normal pool.