IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.services.comms
Interface CommunicationsPoolService

All Known Implementing Classes:
CommunicationsPool

public interface CommunicationsPoolService

This class is a pool that manages communications services that implement CommonCommunications interface.


Method Summary
 boolean areAllServicesOffline()
          Returns true is all services are online.
 void closeAll()
          Executes ccClose method of every pool element.
 int getCleanupTime()
          Returns the cleanupTime attribute.
 boolean getIdenticalElements()
          Returns the identicalElements attribute.
 int getMaxPoolSize()
          Returns the maxPoolSize attribute.
 CommonCommunicationsService getPoolService()
          This method returns the first free service of the pool, and in SEND state.
 int getSize()
          Returns the size attribute.
 int getSpare()
          Returns the spare attribute.
 Tag getTag()
          Returns the tag attribute.
 long getTimeBetweenRetries()
          Returns the timeBetweenRetries attribute.
 void insertService(CommonCommunicationsService aService)
          Inserts a service in the pool.
 void openAll()
          Executes ccOpen method of every pool element.
 void releasePoolService(CommonCommunicationsService aService)
          Free service to be reused.
 void removeService(CommonCommunicationsService aService)
          Removes aService from the pool.
 void setCleanupTime(int aTime)
          Sets cleanupTime attribute value.
 void setIdenticalElements(boolean aBoolean)
          Sets identicalElements attribute value.
 void setMaxPoolSize(int aMaxPoolSize)
          Sets maxPoolSize attribute value.
 void setSize(int aSize)
          Sets size attribute value.
 void setSpare(int aSpare)
          Sets spare attribute value.
 void setTag(Tag aTag)
          Sets tag attribute value.
 void setTimeBetweenRetries(int aTime)
          Sets timeBetweenRetries attribute value.
 void terminate()
          This is a housekeeping process for Notifier instances.
 

Method Detail

areAllServicesOffline

boolean areAllServicesOffline()
Returns true is all services are online.


closeAll

void closeAll()
Executes ccClose method of every pool element.


getCleanupTime

int getCleanupTime()
Returns the cleanupTime attribute.


getIdenticalElements

boolean getIdenticalElements()
Returns the identicalElements attribute.


getMaxPoolSize

int getMaxPoolSize()
Returns the maxPoolSize attribute.


getPoolService

CommonCommunicationsService getPoolService()
This method returns the first free service of the pool, and in SEND state. It marks this session 'inUse', to prevent be used by another client. If no free services and the elements are identical, a new instance of the communications service is created.

Returns:
com.ibm.btt.services.comms.CommonCommunicationsService

getSize

int getSize()
Returns the size attribute.


getSpare

int getSpare()
Returns the spare attribute.


getTag

Tag getTag()
Returns the tag attribute.


getTimeBetweenRetries

long getTimeBetweenRetries()
Returns the timeBetweenRetries attribute.


insertService

void insertService(CommonCommunicationsService aService)
Inserts a service in the pool.

Parameters:
aSession - com.ibm.btt.services.comms.CommonCommunicationsService.

openAll

void openAll()
Executes ccOpen method of every pool element.


releasePoolService

void releasePoolService(CommonCommunicationsService aService)
Free service to be reused.

Parameters:
aSession - com.ibm.btt.services.comms.CommonCommunicationsService

removeService

void removeService(CommonCommunicationsService aService)
Removes aService from the pool.

Parameters:
aSession - com.ibm.btt.services.comms.CommonCommunicationsService

setCleanupTime

void setCleanupTime(int aTime)
Sets cleanupTime attribute value.


setIdenticalElements

void setIdenticalElements(boolean aBoolean)
Sets identicalElements attribute value.


setMaxPoolSize

void setMaxPoolSize(int aMaxPoolSize)
Sets maxPoolSize attribute value.


setSize

void setSize(int aSize)
Sets size attribute value.


setSpare

void setSpare(int aSpare)
Sets spare attribute value.


setTag

void setTag(Tag aTag)
Sets tag attribute value.


setTimeBetweenRetries

void setTimeBetweenRetries(int aTime)
Sets timeBetweenRetries attribute value.


terminate

void terminate()
This is a housekeeping process for Notifier instances. This is called either from the application or from the context when it is destroyed or unchained. Releases all the resources acquired by the pool.


IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009