IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.sm
Class CSSessionHandler

java.lang.Object
  extended by com.ibm.btt.sm.CSSessionHandler

public class CSSessionHandler
extends java.lang.Object

This class is main class of session management and all other component all access session management through this class.


Field Summary
static java.lang.String MODE
           
static java.lang.String MODE_J2EE
           
static java.lang.String MODE_REWRITING
           
static java.lang.String MODE_STANDALONE
           
protected static java.lang.String sessionMode
           
 
Constructor Summary
CSSessionHandler()
           
 
Method Summary
static void addApplicationSession(javax.servlet.http.HttpSession aSession, java.lang.String applicationSession, java.io.Serializable aContext)
          Deprecated. suggest using session id as parameter Add application session
static void addApplicationSession(java.lang.String aSession, java.lang.String applicationSession, java.io.Serializable aContext)
           
static void addSession(SessionEntry se)
           
static ApplicationSessionEntry getApplicationSession(javax.servlet.http.HttpSession session, java.lang.String applicationId)
          Deprecated. suggest using session id as parameter get Application session
static ApplicationSessionEntry getApplicationSession(java.lang.String sessionId, java.lang.String applicationId)
          get Application session
static java.io.Serializable getCurrentContextForSession(javax.servlet.http.HttpSession aSession)
          Deprecated. suggest using session id as parameter get Context using session
static java.io.Serializable getCurrentContextForSession(javax.servlet.http.HttpSession aSession, java.lang.String anApplication)
          Deprecated. suggest using session id as parameter get Context using session and application session
static java.io.Serializable getCurrentContextForSession(java.lang.String aSession)
          get Context using session
static java.io.Serializable getCurrentContextForSession(java.lang.String aSession, java.lang.String anApplication)
          get Context using session and application session
static java.util.Vector getIpAddressAndPortForTID(java.lang.String tid)
          get IP and port using tid
static SessionEntry getSession(javax.servlet.http.HttpSession aSession)
          Deprecated. suggest using session id as parameter get session
static SessionEntry getSession(java.lang.String aSession)
          get session
static java.lang.String getSessionForTID(java.lang.String tid)
          get session using tid
protected static java.lang.String getSessionMode()
           
static java.lang.Object getSessionObjectForSession(javax.servlet.http.HttpSession aSession)
          Deprecated. suggest using session id as parameter get sessionObject using session
static java.lang.Object getSessionObjectForSession(java.lang.String aSession)
          get sessionObject using session
static SessionTable getSessionTable()
           
static java.lang.String getTIDForSession(javax.servlet.http.HttpSession aSession)
          Deprecated. suggest using session id as parameter get tid using session
static java.lang.String getTIDForSession(java.lang.String aSession)
          get tid using session
static java.lang.Long getTimeStamp(SessionEntry se)
          Deprecated. API for migration Please use HttpSession API to do this.
static java.lang.String getTypeForSession(javax.servlet.http.HttpSession aSession)
          Deprecated. suggest using session id as parameter get session type
static java.lang.String getTypeForSession(java.lang.String aSession)
          get session type
static boolean isBTTRewritingEnabled()
          Justify if using BTT URL rewriting session control
static boolean isBTTSessionEnabled()
          Justify if using BTT self managed session control
static boolean isJ2EESessionEnabled()
          Justify if using J2EE standard session control
static void markSessionExpired(javax.servlet.http.HttpSession aSession)
          Mark the session as expired and the session will be removed at the end of current operation
static void removeSession(javax.servlet.http.HttpSession aSession)
          Deprecated. suggest using session id as parameter remove session
static void removeSession(javax.servlet.http.HttpSession aSession, java.lang.String anApplication)
          Deprecated. suggest using session id as parameter remove application session
static void removeSession(java.lang.String aSession)
          remove session
static void removeSession(java.lang.String aSession, java.lang.String anApplication)
          remove application session
static void retrieveSession(javax.servlet.http.HttpSession aSession)
          Deprecated. for BTT5.1 usage BTT6.x will auto-rebuild the info retrive session from persistance,
static void setCurrentContextForSession(javax.servlet.http.HttpSession aSession, java.io.Serializable aContext)
          Deprecated. suggest using session id as parameter set context using session
static void setCurrentContextForSession(javax.servlet.http.HttpSession aSession, java.lang.String anApplication, java.io.Serializable aContext)
          Deprecated. suggest using session id as parameter set context using session and applicationID
static void setCurrentContextForSession(java.lang.String aSession, java.io.Serializable aContext)
          set context using session
static void setCurrentContextForSession(java.lang.String aSession, java.lang.String anApplication, java.io.Serializable aContext)
          set context using session and applicationID
static void setSessionObjectForSession(javax.servlet.http.HttpSession aSession, java.lang.Object aSessionObject)
          Deprecated. suggest using session id as parameter set session object
static void setSessionObjectForSession(java.lang.String aSession, java.lang.Object aSessionObject)
          set session object
static void setTimeStampForSession(java.lang.String sessionId, java.lang.Long timestamp)
          Deprecated. API for migration Please use HttpSession API to do this.
static void setTypeForSession(javax.servlet.http.HttpSession aSession, java.lang.String aType)
          Deprecated. suggest using session id as parameter set session type
static void setTypeForSession(java.lang.String aSession, java.lang.String aType)
          set session type
static void storeSession(java.lang.String aSession)
          Deprecated. API for BTT5.1 usage BTT6.x will auto-store the info save session into persistance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODE_J2EE

public static final java.lang.String MODE_J2EE
See Also:
Constant Field Values

MODE_REWRITING

public static final java.lang.String MODE_REWRITING
See Also:
Constant Field Values

MODE_STANDALONE

public static final java.lang.String MODE_STANDALONE
See Also:
Constant Field Values

MODE

public static final java.lang.String MODE
See Also:
Constant Field Values

sessionMode

protected static java.lang.String sessionMode
Constructor Detail

CSSessionHandler

public CSSessionHandler()
Method Detail

addApplicationSession

public static void addApplicationSession(javax.servlet.http.HttpSession aSession,
                                         java.lang.String applicationSession,
                                         java.io.Serializable aContext)
                                  throws BTTSMException
Deprecated. suggest using session id as parameter Add application session

Throws:
BTTSMException

addApplicationSession

public static void addApplicationSession(java.lang.String aSession,
                                         java.lang.String applicationSession,
                                         java.io.Serializable aContext)
                                  throws BTTSMException
Throws:
BTTSMException

addSession

public static void addSession(SessionEntry se)
                       throws BTTSMException
Parameters:
se -
Throws:
BTTSMException

getApplicationSession

public static ApplicationSessionEntry getApplicationSession(javax.servlet.http.HttpSession session,
                                                            java.lang.String applicationId)
                                                     throws BTTSMException
Deprecated. suggest using session id as parameter get Application session

Parameters:
session -
applicationId -
Returns:
SessionEntry
Throws:
BTTSMException

getApplicationSession

public static ApplicationSessionEntry getApplicationSession(java.lang.String sessionId,
                                                            java.lang.String applicationId)
                                                     throws BTTSMException
get Application session

Parameters:
sessionId -
applicationId -
Returns:
SessionEntry
Throws:
BTTSMException

getCurrentContextForSession

public static java.io.Serializable getCurrentContextForSession(javax.servlet.http.HttpSession aSession)
                                                        throws BTTSMException
Deprecated. suggest using session id as parameter get Context using session

Parameters:
aSession -
Returns:
Context
Throws:
BTTSMException

getCurrentContextForSession

public static java.io.Serializable getCurrentContextForSession(javax.servlet.http.HttpSession aSession,
                                                               java.lang.String anApplication)
                                                        throws BTTSMException
Deprecated. suggest using session id as parameter get Context using session and application session

Parameters:
aSession -
anApplication -
Returns:
Context
Throws:
BTTSMException

getCurrentContextForSession

public static java.io.Serializable getCurrentContextForSession(java.lang.String aSession)
                                                        throws BTTSMException
get Context using session

Parameters:
aSession -
Returns:
Context
Throws:
BTTSMException

getCurrentContextForSession

public static java.io.Serializable getCurrentContextForSession(java.lang.String aSession,
                                                               java.lang.String anApplication)
                                                        throws BTTSMException
get Context using session and application session

Parameters:
aSession -
anApplication -
Returns:
Context
Throws:
BTTSMException

getIpAddressAndPortForTID

public static java.util.Vector getIpAddressAndPortForTID(java.lang.String tid)
                                                  throws BTTSMException
get IP and port using tid

Parameters:
tid -
Returns:
Vector
Throws:
BTTSMException

getSession

public static SessionEntry getSession(javax.servlet.http.HttpSession aSession)
                               throws BTTSMException
Deprecated. suggest using session id as parameter get session

Parameters:
aSession -
Returns:
SessionEntry try to get sessionEntry from sessiontable, if not exists
Throws:
BTTSMException

getSession

public static SessionEntry getSession(java.lang.String aSession)
                               throws BTTSMException
get session

Parameters:
aSession -
Returns:
SessionEntry try to get sessionEntry from session table, if not exists
Throws:
BTTSMException

getSessionForTID

public static java.lang.String getSessionForTID(java.lang.String tid)
                                         throws BTTSMException
get session using tid

Parameters:
tid -
Throws:
BTTSMException

getSessionObjectForSession

public static java.lang.Object getSessionObjectForSession(javax.servlet.http.HttpSession aSession)
                                                   throws BTTSMException
Deprecated. suggest using session id as parameter get sessionObject using session

Parameters:
aSession -
Returns:
Object
Throws:
BTTSMException

getSessionObjectForSession

public static java.lang.Object getSessionObjectForSession(java.lang.String aSession)
                                                   throws BTTSMException
get sessionObject using session

Parameters:
aSession -
Returns:
Object
Throws:
BTTSMException

getSessionTable

public static SessionTable getSessionTable()
Returns:
sessionTable

getTIDForSession

public static java.lang.String getTIDForSession(javax.servlet.http.HttpSession aSession)
                                         throws BTTSMException
Deprecated. suggest using session id as parameter get tid using session

Parameters:
aSession -
Returns:
TID
Throws:
BTTSMException

getTIDForSession

public static java.lang.String getTIDForSession(java.lang.String aSession)
                                         throws BTTSMException
get tid using session

Parameters:
aSession -
Returns:
TID
Throws:
BTTSMException

getTypeForSession

public static java.lang.String getTypeForSession(javax.servlet.http.HttpSession aSession)
                                          throws BTTSMException
Deprecated. suggest using session id as parameter get session type

Parameters:
aSession -
Returns:
Type
Throws:
BTTSMException

getTypeForSession

public static java.lang.String getTypeForSession(java.lang.String aSession)
                                          throws BTTSMException
get session type

Parameters:
aSession -
Returns:
Type
Throws:
BTTSMException

markSessionExpired

public static void markSessionExpired(javax.servlet.http.HttpSession aSession)
                               throws BTTSMException
Mark the session as expired and the session will be removed at the end of current operation

Parameters:
aSession - the http session object
Throws:
BTTSMException

removeSession

public static void removeSession(javax.servlet.http.HttpSession aSession)
Deprecated. suggest using session id as parameter remove session

Parameters:
aSession -

removeSession

public static void removeSession(javax.servlet.http.HttpSession aSession,
                                 java.lang.String anApplication)
                          throws BTTSMException
Deprecated. suggest using session id as parameter remove application session

Parameters:
aSession -
anApplication -
Throws:
BTTSMException

removeSession

public static void removeSession(java.lang.String aSession)
                          throws BTTSMException
remove session

Parameters:
aSession -
Throws:
BTTSMException

removeSession

public static void removeSession(java.lang.String aSession,
                                 java.lang.String anApplication)
                          throws BTTSMException
remove application session

Parameters:
aSession -
anApplication -
Throws:
BTTSMException

retrieveSession

public static void retrieveSession(javax.servlet.http.HttpSession aSession)
                            throws BTTSMException
Deprecated. for BTT5.1 usage BTT6.x will auto-rebuild the info retrive session from persistance,

Parameters:
aSession -
Throws:
BTTSMException

setCurrentContextForSession

public static void setCurrentContextForSession(javax.servlet.http.HttpSession aSession,
                                               java.io.Serializable aContext)
                                        throws BTTSMException
Deprecated. suggest using session id as parameter set context using session

Parameters:
aSession -
aContext -
Throws:
BTTSMException

setCurrentContextForSession

public static void setCurrentContextForSession(javax.servlet.http.HttpSession aSession,
                                               java.lang.String anApplication,
                                               java.io.Serializable aContext)
                                        throws BTTSMException
Deprecated. suggest using session id as parameter set context using session and applicationID

Parameters:
aSession -
anApplication -
aContext -
Throws:
BTTSMException

setCurrentContextForSession

public static void setCurrentContextForSession(java.lang.String aSession,
                                               java.io.Serializable aContext)
                                        throws BTTSMException
set context using session

Parameters:
aSession -
aContext -
Throws:
BTTSMException

setCurrentContextForSession

public static void setCurrentContextForSession(java.lang.String aSession,
                                               java.lang.String anApplication,
                                               java.io.Serializable aContext)
                                        throws BTTSMException
set context using session and applicationID

Parameters:
aSession -
anApplication -
aContext -
Throws:
BTTSMException

setSessionObjectForSession

public static void setSessionObjectForSession(javax.servlet.http.HttpSession aSession,
                                              java.lang.Object aSessionObject)
                                       throws BTTSMException
Deprecated. suggest using session id as parameter set session object

Parameters:
aSession -
aSessionObject -
Throws:
BTTSMException

setSessionObjectForSession

public static void setSessionObjectForSession(java.lang.String aSession,
                                              java.lang.Object aSessionObject)
                                       throws BTTSMException
set session object

Parameters:
aSession -
aSessionObject -
Throws:
BTTSMException

setTypeForSession

public static void setTypeForSession(javax.servlet.http.HttpSession aSession,
                                     java.lang.String aType)
                              throws BTTSMException
Deprecated. suggest using session id as parameter set session type

Parameters:
aSession -
aType -
Throws:
BTTSMException

setTypeForSession

public static void setTypeForSession(java.lang.String aSession,
                                     java.lang.String aType)
                              throws BTTSMException
set session type

Parameters:
aSession -
aType -
Throws:
BTTSMException

storeSession

public static void storeSession(java.lang.String aSession)
                         throws BTTSMException
Deprecated. API for BTT5.1 usage BTT6.x will auto-store the info save session into persistance

Parameters:
aSession -
Throws:
BTTSMException

setTimeStampForSession

public static void setTimeStampForSession(java.lang.String sessionId,
                                          java.lang.Long timestamp)
                                   throws DSEObjectNotFoundException
Deprecated. API for migration Please use HttpSession API to do this.

Parameters:
sessionId - the session id
timestamp - the timestamp
Throws:
DSEObjectNotFoundException - if session entry isn't found

getTimeStamp

public static java.lang.Long getTimeStamp(SessionEntry se)
Deprecated. API for migration Please use HttpSession API to do this.

Parameters:
se - the session entry
Returns:
the timestamp

isJ2EESessionEnabled

public static boolean isJ2EESessionEnabled()
Justify if using J2EE standard session control

Returns:
true if using J2EE standard session control

isBTTRewritingEnabled

public static boolean isBTTRewritingEnabled()
Justify if using BTT URL rewriting session control

Returns:
true if using BTT URL rewriting session control

isBTTSessionEnabled

public static boolean isBTTSessionEnabled()
Justify if using BTT self managed session control

Returns:
true if using BTT self managed session control

getSessionMode

protected static java.lang.String getSessionMode()

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010