IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.base
Class SessionEntry

java.lang.Object
  extended bycom.ibm.dse.base.DataElement
      extended bycom.ibm.dse.base.DataCollection
          extended bycom.ibm.dse.base.KeyedCollection
              extended bycom.ibm.dse.base.SessionEntry
All Implemented Interfaces:
java.lang.Cloneable, DSECloneable, Externalizable, java.io.Externalizable, java.io.Serializable, TypedData

public class SessionEntry
extends KeyedCollection

This class only should be used by the Context class.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.dse.base.KeyedCollection
elements, nestedElements, nextItem, order
 
Fields inherited from class com.ibm.dse.base.DataElement
description, externalizer, name, parameters, state
 
Constructor Summary
SessionEntry()
          This is the default constructor used to create a SessionEntry object.
SessionEntry(java.lang.String aName)
          This constructor creates a SessionEntry object with the specifed name.
SessionEntry(java.lang.String type, java.lang.Long timeStamp, java.lang.String aSession, java.lang.String aTID, Context aCurrentContext)
          This constructor creates a SessionEntry object with the session, TID, and context.
SessionEntry(java.lang.String type, java.lang.Long timeStamp, java.lang.String aSession, java.lang.String aTID, Context aCurrentContext, java.util.Locale locale)
          This constructor creates a SessionEntry object with the session, TID, context and locale.
SessionEntry(java.lang.String type, java.lang.Long timeStamp, java.lang.String aSession, java.lang.String aTID, Context 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, java.lang.Long timeStamp, java.lang.String aSession, java.lang.String aTID, Context 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, java.lang.Long timeStamp, java.lang.String aSession, java.lang.String aTID, Context 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.
 
Method Summary
 Context getCurrentContext()
          Gets the current context.
 boolean getExpired()
          Gets the expired value.
 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.Long getTimeStamp()
          Gets the timeStamp.
 java.lang.String getType()
          Gets the type.
 void remove()
          Removes the session.
 void setExpired(boolean isExpired)
          Sets the expired value.
 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 setSessionObject(java.lang.Object aSessionObject)
          Sets the session object.
 void setTimeStamp(java.lang.Long aTimeStamp)
          Sets the timeStamp.
 void setType(java.lang.String aType)
          Sets the client type.
 
Methods inherited from class com.ibm.dse.base.KeyedCollection
addElement, addElement, calculeNestedElements, calculeNestedQualifiedElements, clone, getDynamic, getElementAt, getElementAt, getElementAtAnyLevel, getElementAtFirstLevel, getElements, getEnumeration, getIndexOf, getIndexOf, getNestedElements, getOrder, getOrderVector, getValue, initializeFrom, isDynamic, readExternal, removeAll, removeElementAt, removeElementAt, removeElementAtFirstLevel, reorderElements, setDynamic, setDynamic, setElements, setOrder, setOrder, setValue, setValueAt, setValueAt, size, stringValueOf, toString, toStrings, tryGetElementAt, tryGetElementAtAnyLevel, tryGetElementAtFirstLevel, tryGetValueAt, trySetValueAt, writeExternal
 
Methods inherited from class com.ibm.dse.base.DataCollection
getValueAt, nestedElements, nestedElements, nestedFields, nestedKeyedCollections, nestedQualifiedElements, validate
 
Methods inherited from class com.ibm.dse.base.DataElement
externalizer, getDescription, getDescriptor, getErrorInfo, getExternalizer, getKey, getName, getParameter, getParameters, getState, getTagName, isAmended, readExternal, readObject, removeExternal, setAmended, setDescription, setDescriptor, setErrorInfo, setExternalizer, setName, setParameter, setParameters, setState, toTags, validate, validateObject, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SessionEntry

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


SessionEntry

public SessionEntry(java.lang.String aName)
             throws java.io.IOException
This constructor creates a SessionEntry object with the specifed name.

Parameters:
aName - java.lang.String

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.Long timeStamp,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    Context aCurrentContext)
This constructor creates a SessionEntry object with the session, TID, and context.

Parameters:
type - java.lang.String
timeStamp - java.lang.Long
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.Long timeStamp,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    Context aCurrentContext,
                    java.lang.Object aSessionObject)
This constructor creates a SessionEntry object with the session, TID, context and a Session Object.

Parameters:
type - java.lang.String
timeStamp - java.lang.Long
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
aSessionObject - Object

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.Long timeStamp,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    Context aCurrentContext,
                    java.lang.Object aSessionObject,
                    java.util.Locale locale)
This constructor creates a SessionEntry object with the session, TID, context,Session Object and locale.

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

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.Long timeStamp,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    Context aCurrentContext,
                    java.util.Locale locale)
This constructor creates a SessionEntry object with the session, TID, context and locale.

Parameters:
type - java.lang.String
timeStamp - java.lang.Long
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
locale - java.util.Locale

SessionEntry

public SessionEntry(java.lang.String type,
                    java.lang.Long timeStamp,
                    java.lang.String aSession,
                    java.lang.String aTID,
                    Context 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.

Parameters:
type - java.lang.String
timeStamp - java.lang.Long
aSession - java.lang.String
aTID - java.lang.String
aCurrentContext - com.ibm.dse.base.Context
ipAddress - String
port - Integer
Method Detail

getCurrentContext

public Context getCurrentContext()
                          throws DSEInvalidRequestException
Gets the current context.

Returns:
com.ibm.dse.base.Context
Throws:
DSEInvalidRequestException

getExpired

public boolean getExpired()
                   throws DSEInvalidRequestException
Gets the expired value.

Returns:
boolean - True if the session has expired
Throws:
DSEInvalidRequestException

getLocale

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

Returns:
java.util.Locale
Throws:
DSEInvalidRequestException

getSessionId

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

Returns:
java.lang.String
Throws:
DSEInvalidRequestException

getSessionObject

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

Returns:
Object
Throws:
DSEInvalidRequestException

getTID

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

Returns:
java.lang.String
Throws:
DSEInvalidRequestException

getTimeStamp

public java.lang.Long getTimeStamp()
                            throws DSEInvalidRequestException
Gets the timeStamp.

Returns:
java.lang.Long
Throws:
DSEInvalidRequestException

getType

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

Returns:
java.lang.String
Throws:
DSEInvalidRequestException

remove

public void remove()
            throws DSEInvalidArgumentException
Removes the session.

Throws:
DSEInvalidArgumentException

setExpired

public void setExpired(boolean isExpired)
                throws DSEInvalidArgumentException
Sets the expired value.

Parameters:
isExpired - boolean - True if the session is expired
Throws:
DSEInvalidArgumentException

setLocale

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

Throws:
DSEInvalidArgumentException

setSessionObject

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

Throws:
DSEInvalidArgumentException

setTimeStamp

public void setTimeStamp(java.lang.Long aTimeStamp)
                  throws DSEInvalidArgumentException
Sets the timeStamp.

Parameters:
aTimeStamp - Long
Throws:
DSEInvalidArgumentException

setType

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

Parameters:
aType - String
Throws:
DSEInvalidArgumentException

getIpAddress

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

Returns:
java.lang.String
Throws:
DSEInvalidRequestException

setIpAddress

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

Parameters:
anIpAddress - String
Throws:
DSEInvalidArgumentException

getPort

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

Returns:
java.lang.Integer
Throws:
DSEInvalidRequestException

setPort

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

Parameters:
aPort - Integer
Throws:
DSEInvalidArgumentException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005