IBM Bank Transformation Toolkit Javadoc

com.ibm.btt.sm
Class SessionEntry

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap
          extended by com.ibm.btt.sm.SessionEntry
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map

public class SessionEntry
extends java.util.HashMap
implements java.io.Serializable

This class only should be used by the CSSessionHandler class.

See Also:
Serialized Form

Constructor Summary
SessionEntry()
          Deprecated. This is the default constructor used to create a SessionEntry object.
SessionEntry(javax.servlet.http.HttpSession aSession)
           
SessionEntry(java.lang.String type, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aCurrentContext)
          This constructor creates a SessionEntry object with the session, TID, and context.
SessionEntry(java.lang.String type, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.util.Locale locale)
          This constructor creates a SessionEntry object with the session, TID, context and locale.
SessionEntry(java.lang.String type, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.lang.Object aSessionObject)
          This constructor creates a SessionEntry object with the session, TID, context and a Session Object.
SessionEntry(java.lang.String type, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.lang.Object aSessionObject, java.util.Locale locale)
          This constructor creates a SessionEntry object with the session, TID, context,Session Object and locale.
SessionEntry(java.lang.String type, javax.servlet.http.HttpSession aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.lang.Object aSessionObject, java.lang.String ipAddress, java.lang.Integer port)
          This constructor creates a SessionEntry object with the session, TID, context, Session Object, ipAddress and port.
SessionEntry(java.lang.String type, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, javax.servlet.http.HttpSession aHttpSession)
          This constructor creates a SessionEntry object with the session, TID, and context.
SessionEntry(java.lang.String type, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.util.Locale locale, javax.servlet.http.HttpSession aHttpSession)
          This constructor creates a SessionEntry object with the session, TID, context and locale.
SessionEntry(java.lang.String type, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.lang.Object aSessionObject, javax.servlet.http.HttpSession aHttpSession)
          This constructor creates a SessionEntry object with the session, TID, context and a Session Object.
SessionEntry(java.lang.String type, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.lang.Object aSessionObject, java.util.Locale locale, javax.servlet.http.HttpSession aHttpSession)
          This constructor creates a SessionEntry object with the session, TID, context,Session Object and locale.
SessionEntry(java.lang.String type, java.lang.String aSession, java.lang.String aTID, java.io.Serializable aCurrentContext, java.lang.Object aSessionObject, java.lang.String ipAddress, java.lang.Integer port, javax.servlet.http.HttpSession aHttpSession)
          This constructor creates a SessionEntry object with the session, TID, context, Session Object, ipAddress and port.
 
Method Summary
 java.lang.Object get(java.lang.String key)
           
 java.io.Serializable getCurrentContext()
          Gets the current context.
 javax.servlet.http.HttpSession getHttpSession()
          Gets the HttpSession.
 java.lang.String getIpAddress()
          Gets the ipAddress.
 java.util.Locale getLocale()
          Gets the locale.
 java.lang.Integer getPort()
          Gets the port.
 java.lang.String getSessionId()
          Gets the sessionId.
 java.lang.Object getSessionObject()
          Gets the sessionObject.
 java.lang.String getTID()
          Gets the TID.
 java.lang.String getType()
          Gets the type.
 java.lang.Object put(java.lang.String key, java.lang.Object value)
           
 void remove()
          Removes the session.
 void retrieve(javax.servlet.http.HttpSession hs)
          load the saved information from httpsession
 void setCurrentContext(java.io.Serializable aContext)
          Sets the port.
 void setCurrentContextForSession(java.lang.String anApplication, java.io.Serializable aContext)
          Sets the port.
 void setHttpSession(javax.servlet.http.HttpSession aHttpSession)
          Sets the TID.
 void setIpAddress(java.lang.String anIpAddress)
          Sets the ipAddress.
 void setLocale(java.util.Locale localeToSet)
          Sets the locale.
 void setPort(java.lang.Integer aPort)
          Sets the port.
 void setSessionId(java.lang.String sessionId)
          Gets the sessionId.
 void setSessionObject(java.lang.Object aSessionObject)
          Sets the session object.
 void setTID(java.lang.String aTID)
          Sets the TID.
 void setType(java.lang.String aType)
          Sets the client type.
 void store()
          Stores the session information to HttpSession Object when persistance is true
 
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

SessionEntry

public SessionEntry(java.lang.String type,
                    javax.servlet.http.HttpSession aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, and context.

Parameters:
type - java.lang.String
aSession - HttpSession
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    javax.servlet.http.HttpSession aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.lang.Object aSessionObject)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context and a Session Object.

Parameters:
type - java.lang.String
aSession - HttpSession
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
aSessionObject - Object
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    javax.servlet.http.HttpSession aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.lang.Object aSessionObject,
                    java.util.Locale locale)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context,Session Object and locale.

Parameters:
type - java.lang.String
aSession - HttpSession
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
aSessionObject - Object
locale - java.util.Locale
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    javax.servlet.http.HttpSession aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.util.Locale locale)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context and locale.

Parameters:
type - java.lang.String
aSession - HttpSession
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
locale - java.util.Locale
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    javax.servlet.http.HttpSession aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.lang.Object aSessionObject,
                    java.lang.String ipAddress,
                    java.lang.Integer port)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context, Session Object, ipAddress and port.

Parameters:
type - java.lang.String
aSession - HttpSession
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
ipAddress - String
port - Integer
Throws:
BTTSMException

SessionEntry

public SessionEntry(javax.servlet.http.HttpSession aSession)
             throws BTTSMException
Parameters:
aSession - retrive all infromation back from httpSession
Throws:
BTTSMException

SessionEntry

public SessionEntry()
Deprecated. This is the default constructor used to create a SessionEntry object.


SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    javax.servlet.http.HttpSession aHttpSession)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, and context.

Parameters:
type - java.lang.String
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
aHttpSession - HttpSession - HttpSession Object associated with the sessionEntry
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.lang.Object aSessionObject,
                    javax.servlet.http.HttpSession aHttpSession)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context and a Session Object.

Parameters:
type - java.lang.String
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
aSessionObject - Object
aHttpSession - HttpSession - HttpSession Object associated with the sessionEntry
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.lang.Object aSessionObject,
                    java.util.Locale locale,
                    javax.servlet.http.HttpSession aHttpSession)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context,Session Object and locale.

Parameters:
type - java.lang.String
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
aSessionObject - Object
locale - java.util.Locale
aHttpSession - HttpSession - HttpSession Object associated with the sessionEntry
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.util.Locale locale,
                    javax.servlet.http.HttpSession aHttpSession)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context and locale.

Parameters:
type - java.lang.String
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
locale - java.util.Locale
aHttpSession - HttpSession - HttpSession Object associated with the sessionEntry
Throws:
BTTSMException

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    java.io.Serializable aCurrentContext,
                    java.lang.Object aSessionObject,
                    java.lang.String ipAddress,
                    java.lang.Integer port,
                    javax.servlet.http.HttpSession aHttpSession)
             throws BTTSMException
This constructor creates a SessionEntry object with the session, TID, context, Session Object, ipAddress and port.

Parameters:
type - java.lang.String
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
ipAddress - String
port - Integer
aHttpSession - HttpSession - HttpSession Object associated with the sessionEntry
Throws:
BTTSMException
Method Detail

getCurrentContext

public java.io.Serializable getCurrentContext()
Gets the current context.

Returns:
Context

getLocale

public java.util.Locale getLocale()
Gets the locale.

Returns:
java.util.Locale

getSessionObject

public java.lang.Object getSessionObject()
Gets the sessionObject.

Returns:
Object

getTID

public java.lang.String getTID()
Gets the TID.

Returns:
java.lang.String

setTID

public void setTID(java.lang.String aTID)
Sets the TID.


getHttpSession

public javax.servlet.http.HttpSession getHttpSession()
Gets the HttpSession.

Returns:
HttpSession

setHttpSession

public void setHttpSession(javax.servlet.http.HttpSession aHttpSession)
                    throws BTTSMException
Sets the TID.

Throws:
BTTSMException

getType

public java.lang.String getType()
Gets the type.

Returns:
java.lang.String

remove

public void remove()
Removes the session.


setLocale

public void setLocale(java.util.Locale localeToSet)
Sets the locale.

Parameters:
localeToSet - java.util.Locale

setSessionObject

public void setSessionObject(java.lang.Object aSessionObject)
Sets the session object.

Parameters:
aSessionObject - Object

setType

public void setType(java.lang.String aType)
Sets the client type.

Parameters:
aType - String

getIpAddress

public java.lang.String getIpAddress()
Gets the ipAddress.

Returns:
java.lang.String

setIpAddress

public void setIpAddress(java.lang.String anIpAddress)
Sets the ipAddress.

Parameters:
anIpAddress - String

getPort

public java.lang.Integer getPort()
Gets the port.

Returns:
java.lang.Integer

setPort

public void setPort(java.lang.Integer aPort)
Sets the port.

Parameters:
aPort - Integer

setCurrentContext

public void setCurrentContext(java.io.Serializable aContext)
Sets the port.

Parameters:
aContext -

setCurrentContextForSession

public void setCurrentContextForSession(java.lang.String anApplication,
                                        java.io.Serializable aContext)
Sets the port.

Parameters:
anApplication -
aContext -

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

get

public java.lang.Object get(java.lang.String key)

store

public void store()
           throws BTTSMException
Stores the session information to HttpSession Object when persistance is true

Throws:
BTTSMException

retrieve

public void retrieve(javax.servlet.http.HttpSession hs)
              throws BTTSMException
load the saved information from httpsession

Throws:
BTTSMException

getSessionId

public java.lang.String getSessionId()
                              throws BTTSMException
Gets the sessionId.

Returns:
java.lang.String
Throws:
BTTSMException

setSessionId

public void setSessionId(java.lang.String sessionId)
                  throws BTTSMException
Gets the sessionId.

Throws:
BTTSMException

IBM Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2008