Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBConnectionSessionListener

java.lang.Object
  |
  +--com.ibm.mm.beans.CMBConnectionSessionListener
All Implemented Interfaces:
CMBBaseConstant, java.util.EventListener, javax.servlet.http.HttpSessionBindingListener, java.io.Serializable

public class CMBConnectionSessionListener
extends java.lang.Object
implements javax.servlet.http.HttpSessionBindingListener, java.io.Serializable, CMBBaseConstant

The CMBConnectionSessionListener bean is to be used with servlet development. This class imports the javax.servlet.http package. The CMBConnectionSessionListener bean provides the termination of the CMBConnection when the session terminates due to a timeout .

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.beans.CMBBaseConstant
ANNOTATION_MIME_TYPE, CMB_CLASS_ICM_DOC_MODEL, CMB_CLASS_ICM_DOC_PART, CMB_CLASS_ITEM, CMB_CLASS_RESOURCE_ITEM, CMB_CLASS_UNDEFINED, CMB_CONNTYPE_DYNAMIC, CMB_CONNTYPE_LOCAL, CMB_CONNTYPE_REMOTE, CMB_CONTENT_ATTRONLY, CMB_CONTENT_CHILDREN, CMB_CONTENT_ITEMTREE, CMB_CONTENT_LINKS_INBOUND, CMB_CONTENT_LINKS_OUTBOUND, CMB_CONTENT_YES, CMB_DATATYPE_COLLECTION, CMB_DATATYPE_COLLECTION_DDO, CMB_DATATYPE_COLLECTION_XDO, CMB_DATATYPE_DATAOBJECTBASE, CMB_DATATYPE_DATE, CMB_DATATYPE_DECIMAL, CMB_DATATYPE_DOUBLE, CMB_DATATYPE_FLOAT, CMB_DATATYPE_FSTRING, CMB_DATATYPE_ITEM, CMB_DATATYPE_ITEM_COLLECTION, CMB_DATATYPE_LONG, CMB_DATATYPE_OBJECT, CMB_DATATYPE_OBJECT_COLLECTION, CMB_DATATYPE_SHORT, CMB_DATATYPE_TIME, CMB_DATATYPE_TIMESTAMP, CMB_DATATYPE_UNDEFINED, CMB_DATATYPE_VSTRING, CMB_DSTYPE_CM, CMB_DSTYPE_DB2, CMB_DSTYPE_DES, CMB_DSTYPE_DJ, CMB_DSTYPE_DL, CMB_DSTYPE_DOMDOC, CMB_DSTYPE_FED, CMB_DSTYPE_FN, CMB_DSTYPE_IC, CMB_DSTYPE_ICM, CMB_DSTYPE_IP390, CMB_DSTYPE_JDBC, CMB_DSTYPE_OD, CMB_DSTYPE_VI400, CMB_EIP_LOGOUT, CMB_OBJTYPE_CMBITEM, CMB_OBJTYPE_CMBOBJECT, CMB_OP_AND, CMB_OP_BETWEEN, CMB_OP_CONTAINS_TEXT, CMB_OP_CONTAINS_TEXT_IN_CONTENT, CMB_OP_EQUAL, CMB_OP_GREATER, CMB_OP_GREATER_EQUAL, CMB_OP_IN, CMB_OP_LESS, CMB_OP_LESS_EQUAL, CMB_OP_LIKE, CMB_OP_NOT, CMB_OP_NOT_BETWEEN, CMB_OP_NOT_EQUAL, CMB_OP_NOT_IN, CMB_OP_NOT_LIKE, CMB_OP_OR, CMB_OP_UNDEFINED, CMB_QS_TYPE_COMBINED, CMB_QS_TYPE_DES, CMB_QS_TYPE_FEDERATED, CMB_QS_TYPE_IMAGE, CMB_QS_TYPE_PARAMETRIC, CMB_QS_TYPE_SQL, CMB_QS_TYPE_TEMPLATE, CMB_QS_TYPE_TEXT, CMB_QS_TYPE_UNKNOWN, CMB_QS_TYPE_XPATH, CMB_ST_SKIP_ALWAYS, CMB_ST_SKIP_NEVER, CMB_ST_SKIP_WITH_PROMPT, CMB_STATUS_FAILED, CMB_STATUS_OK, CMB_STATUS_RESULT_END, CMB_STATUS_RESULT_MORE, CMB_STATUS_RESULT_NEW, CMB_TIMESTAMP_UNDEFINED, CMB_TYPE_DOCUMENT, CMB_TYPE_FOLDER, CMB_TYPE_ITEM, CMB_TYPE_UNKNOWN, CMB_USERID_UNDEFINED, CMB_VERSION_CONTROL_ALWAYS_NEW, CMB_VERSION_CONTROL_BY_APP, CMB_VERSION_CONTROL_NEVER, CMB_VERSION_KEYWORD, CMB_VERSION_LATEST, CMB_VERSION_NEW, PROP_CACHE_ENABLED, PROP_CC2MIME_URL, PROP_CONNECTION, PROP_CONNECTION_TYPE, PROP_DATA_MANAGEMENT_ENABLED, PROP_DSTYPE, PROP_LOCAL_SERVER, PROP_NAME, PROP_NEW_PASSWORD, PROP_PASSWORD, PROP_PORT_NUMBER, PROP_QUERY_CALLBACK_THRESHOLD, PROP_QUERY_MAX_RESULTS, PROP_RESULT_PAGESIZE, PROP_RMI_HOSTNAME, PROP_SCHEMA_MANAGEMENT_ENABLED, PROP_SEARCH_ASYNCH, PROP_SEARCH_MULTI_CHARS_WILDCARD, PROP_SEARCH_PARAMETRIC_WILDCARD, PROP_SEARCH_SINGLE_CHAR_WILDCARD, PROP_SEARCH_SKIP_SERVER, PROP_SEARCH_TIMEOUT, PROP_SERVER_NAME, PROP_SV_CONNECTION_TYPE, PROP_SV_PORT_NUMBER, PROP_SV_RMI_HOSTNAME, PROP_TRACE_ENABLED, PROP_USERID
 
Constructor Summary
CMBConnectionSessionListener()
           
CMBConnectionSessionListener(CMBConnection connection, CMBConnectionPool connectionPool, int traceLevel, java.lang.String sessionId)
           
 
Method Summary
 CMBConnection getConnection()
          Gets the connection property value
 CMBConnectionPool getConnectionPool()
          Gets the connectionPool property value
 java.lang.String getSessionId()
          Gets the unique identifier assigned to this session.
 int getTrace()
          Gets the traceLevel property value
 void setConnection(CMBConnection connection)
          Sets connection property value.
 void setConnectionPool(CMBConnectionPool connectionPool)
          Sets connectionPool property value.
 void setSessionID(java.lang.String sessionId)
          Sets a string containing the unique identifier assigned to this session.
 void setTrace(int traceLevel)
          Sets traceLevel property value.
 void valueBound(javax.servlet.http.HttpSessionBindingEvent ev)
           
 void valueUnbound(javax.servlet.http.HttpSessionBindingEvent ev)
          When a timeout occurs this method will be called.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBConnectionSessionListener

public CMBConnectionSessionListener()

CMBConnectionSessionListener

public CMBConnectionSessionListener(CMBConnection connection,
                                    CMBConnectionPool connectionPool,
                                    int traceLevel,
                                    java.lang.String sessionId)
Method Detail

setConnection

public void setConnection(CMBConnection connection)
Sets connection property value.
Parameters:
connection -  

getConnection

public CMBConnection getConnection()
Gets the connection property value
Returns:
connection a null is returned if connection has not been set.

setConnectionPool

public void setConnectionPool(CMBConnectionPool connectionPool)
Sets connectionPool property value.
Parameters:
connectionPool -  

getConnectionPool

public CMBConnectionPool getConnectionPool()
Gets the connectionPool property value
Returns:
connectionPool a null is returned if connectionPool has not been set.

setSessionID

public void setSessionID(java.lang.String sessionId)
Sets a string containing the unique identifier assigned to this session.
The sessionId property is used for debug purposes only. If there is an error in the method valueUnbound the sessionId will be included in the error log.

getSessionId

public java.lang.String getSessionId()
Gets the unique identifier assigned to this session.
The sessionId property is used for debug purposes only. If there is an error in the method valueUnbound the sessionId will be included in the error log.

setTrace

public void setTrace(int traceLevel)
Sets traceLevel property value.
Parameters:
traceLevel - the default is 0

getTrace

public int getTrace()
Gets the traceLevel property value
Returns:
traceLevel

valueBound

public void valueBound(javax.servlet.http.HttpSessionBindingEvent ev)
Specified by:
valueBound in interface javax.servlet.http.HttpSessionBindingListener

valueUnbound

public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent ev)
When a timeout occurs this method will be called. When this method is called due to a timeout, this method will call the connectionPool.freeConnection and connection.disconect methods.
If this method is called with an event name equal to CMBBaseConstant.CMB_EIP_LOGOUT then the property values for connection, connectionPool, traceLevel, and sessionIdId are set to the default values.
Specified by:
valueUnbound in interface javax.servlet.http.HttpSessionBindingListener

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.