IBM 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 sesssion management and all other component all access session managemet through this class.


Constructor Summary
CSSessionHandler()
           
 
Method Summary
static void addApplicationSession(javax.servlet.http.HttpSession aSession, java.lang.String applicationSession, java.io.Serializable aContext)
          Add application session
static void addApplicationSession(java.lang.String aSession, java.lang.String applicationSession, java.io.Serializable aContext)
          Add application session
static void addSession(javax.servlet.http.HttpSession hs, SessionEntry se)
           
static void addSession(javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aContext)
          Add session
static void addSession(javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aContext, java.util.Locale locale)
          Add session
static void addSession(SessionEntry se)
           
static void addSession(java.lang.String aType, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aContext)
          Add session
static void addSession(java.lang.String aType, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aContext, java.util.Locale locale)
          Add session
static void addSession(java.lang.String aType, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aContext, java.lang.String ipAddress, java.lang.Integer port)
          Add session
static void addSession(java.lang.String aSession, java.lang.String aTID, java.io.Serializable aContext, javax.servlet.http.HttpSession aHttpSession)
          Add session
static void addSession(java.lang.String aSession, java.lang.String aTID, java.io.Serializable aContext, java.util.Locale locale, javax.servlet.http.HttpSession aHttpSession)
          Add session
static void addSession(java.lang.String aType, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aContext, javax.servlet.http.HttpSession aHttpSession)
          Add session *
static void addSession(java.lang.String aType, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aContext, java.util.Locale locale, javax.servlet.http.HttpSession aHttpSession)
          Add session
static void addSession(java.lang.String aType, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aContext, java.lang.String ipAddress, java.lang.Integer port, javax.servlet.http.HttpSession aHttpSession)
          Add session
static ApplicationSessionEntry getApplicationSession(javax.servlet.http.HttpSession session, java.lang.String applicationId)
          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)
          get Context using session
static java.io.Serializable getCurrentContextForSession(javax.servlet.http.HttpSession aSession, java.lang.String anApplication)
          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)
          get session
static SessionEntry getSession(java.lang.String aSession)
          get session
static java.lang.String getSessionForTID(java.lang.String tid)
          get session using tid
static java.lang.Object getSessionObjectForSession(javax.servlet.http.HttpSession aSession)
          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)
          get tid using session
static java.lang.String getTIDForSession(java.lang.String aSession)
          get tid using session
static java.lang.String getTypeForSession(javax.servlet.http.HttpSession aSession)
          get session type
static java.lang.String getTypeForSession(java.lang.String aSession)
          get session type
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)
          remove session
static void removeSession(javax.servlet.http.HttpSession aSession, java.lang.String anApplication)
          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)
          retrive session from persistance
static void setCurrentContextForSession(javax.servlet.http.HttpSession aSession, java.io.Serializable aContext)
          set context using session
static void setCurrentContextForSession(javax.servlet.http.HttpSession aSession, java.lang.String anApplication, java.io.Serializable aContext)
          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)
          set session object
static void setSessionObjectForSession(java.lang.String aSession, java.lang.Object aSessionObject)
          set session object
static void setTypeForSession(javax.servlet.http.HttpSession aSession, java.lang.String aType)
          set session type
static void setTypeForSession(java.lang.String aSession, java.lang.String aType)
          set session type
static void storeSession(javax.servlet.http.HttpSession aSession)
          save session into persistance
static void storeSession(java.lang.String aSession)
          save session into persistance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CSSessionHandler

public CSSessionHandler()
Method Detail

getSessionTable

public static SessionTable getSessionTable()
Returns:
sessionTable

addApplicationSession

public static void addApplicationSession(java.lang.String aSession,
                                         java.lang.String applicationSession,
                                         java.io.Serializable aContext)
                                  throws BTTSMException
Add application session

Throws:
BTTSMException

addApplicationSession

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

Throws:
BTTSMException

addSession

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

addSession

public static void addSession(javax.servlet.http.HttpSession hs,
                              SessionEntry se)
                       throws BTTSMException
Parameters:
HttpSession - hs
SessionEntry - se Add the session Entry into httpSession Object It acts persistent=true
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aType,
                              javax.servlet.http.HttpSession aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext)
                       throws BTTSMException
Add session

Parameters:
aType -
aSession -
aTID -
aContext -
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aType,
                              javax.servlet.http.HttpSession aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              java.util.Locale locale)
                       throws BTTSMException
Add session

Parameters:
aType -
aSession -
aTID -
aContext -
locale -
aHttpSession -
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aType,
                              javax.servlet.http.HttpSession aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              java.lang.String ipAddress,
                              java.lang.Integer port)
                       throws BTTSMException
Add session

Parameters:
aType -
aSession -
aTID -
aContext -
ipAddress -
port -
Throws:
BTTSMException

addSession

public static void addSession(javax.servlet.http.HttpSession aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext)
                       throws BTTSMException
Add session

Parameters:
aSession -
aTID -
aContext -
Throws:
BTTSMException

addSession

public static void addSession(javax.servlet.http.HttpSession aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              java.util.Locale locale)
                       throws BTTSMException
Add session

Parameters:
aSession -
aTID -
aContext -
locale -
Throws:
BTTSMException

getApplicationSession

public static ApplicationSessionEntry getApplicationSession(javax.servlet.http.HttpSession session,
                                                            java.lang.String applicationId)
                                                     throws BTTSMException
get Application session

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

getCurrentContextForSession

public static java.io.Serializable getCurrentContextForSession(javax.servlet.http.HttpSession aSession)
                                                        throws BTTSMException
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
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
get session

Parameters:
aSession -
Returns:
SessionEntry try to get sessionEntry from sessiontable, 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
get sessionObject using session

Parameters:
aSession -
Returns:
Object
Throws:
BTTSMException

getTIDForSession

public static java.lang.String getTIDForSession(javax.servlet.http.HttpSession 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
get session type

Parameters:
aSession -
Returns:
Type
Throws:
BTTSMException

removeSession

public static void removeSession(javax.servlet.http.HttpSession aSession)
remove session

Parameters:
aSession -

removeSession

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

Parameters:
aSession -
anApplication -
Throws:
BTTSMException

setCurrentContextForSession

public static void setCurrentContextForSession(javax.servlet.http.HttpSession aSession,
                                               java.io.Serializable aContext)
                                        throws BTTSMException
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
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
set session object

Parameters:
aSession -
aSessionObject -
Throws:
BTTSMException

setTypeForSession

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

Parameters:
aSession -
aType -
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aType,
                              java.lang.String aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              javax.servlet.http.HttpSession aHttpSession)
                       throws BTTSMException
Add session *

Parameters:
aType -
aSession -
aTID -
aContext -
aHttpSession -
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aType,
                              java.lang.String aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              java.util.Locale locale,
                              javax.servlet.http.HttpSession aHttpSession)
                       throws BTTSMException
Add session

Parameters:
aType -
aSession -
aTID -
aContext -
locale -
aHttpSession -
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aType,
                              java.lang.String aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              java.lang.String ipAddress,
                              java.lang.Integer port,
                              javax.servlet.http.HttpSession aHttpSession)
                       throws BTTSMException
Add session

Parameters:
aType -
aSession -
aTID -
aContext -
ipAddress -
port -
aHttpSession -
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              javax.servlet.http.HttpSession aHttpSession)
                       throws BTTSMException
Add session

Parameters:
aSession -
aTID -
aContext -
aHttpSession -
Throws:
BTTSMException

addSession

public static void addSession(java.lang.String aSession,
                              java.lang.String aTID,
                              java.io.Serializable aContext,
                              java.util.Locale locale,
                              javax.servlet.http.HttpSession aHttpSession)
                       throws BTTSMException
Add session

Parameters:
aSession -
aTID -
aContext -
locale -
aHttpSession -
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(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

getSession

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

Parameters:
aSession -
Returns:
SessionEntry try to get sessionEntry from sesstable, if not exists
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

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(java.lang.String aSession)
                                          throws BTTSMException
get session type

Parameters:
aSession -
Returns:
Type
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

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(java.lang.String aSession,
                                              java.lang.Object aSessionObject)
                                       throws BTTSMException
set session object

Parameters:
aSession -
aSessionObject -
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

retrieveSession

public static void retrieveSession(javax.servlet.http.HttpSession aSession)
                            throws BTTSMException
retrive session from persistance

Parameters:
aSession -
Throws:
BTTSMException

storeSession

public static void storeSession(java.lang.String aSession)
                         throws BTTSMException
save session into persistance

Parameters:
aSession -
Throws:
BTTSMException

storeSession

public static void storeSession(javax.servlet.http.HttpSession aSession)
                         throws BTTSMException
save session into persistance

Parameters:
aSession -
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

IBM Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2008