com.ibm.dse.base
Class SessionEntry

java.lang.Object
  |
  +--com.ibm.dse.base.DataElement
        |
        +--com.ibm.dse.base.DataCollection
              |
              +--com.ibm.dse.base.KeyedCollection
                    |
                    +--com.ibm.dse.base.SessionEntry

public class SessionEntry
extends KeyedCollection

This class only should be used by the Context class.

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.base.DataElement
description, name, 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.lang.Object aSessionObject)
          This constructor creates a SessionEntry object with the session, TID, context and a Session Object.
 
Method Summary
 Context getCurrentContext()
          Gets the current context.
 boolean getExpired()
          Gets the expired value.
 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 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, getValue, initializeFrom, isDynamic, readExternal, removeAll, removeElementAt, removeElementAt, removeElementAtFirstLevel, reorderElements, setDynamic, setElements, setOrder, setValue, setValueAt, setValueAt, size, toString, toStrings, validate, writeExternal
 
Methods inherited from class com.ibm.dse.base.DataCollection
getValueAt, nestedElements, nestedElements, nestedFields, nestedKeyedCollections, nestedQualifiedElements
 
Methods inherited from class com.ibm.dse.base.DataElement
externalizer, getDescription, getDescriptor, getErrorInfo, getExternalizer, getKey, getName, getState, getTagName, readExternal, readObject, removeExternal, setDescription, setDescriptor, setErrorInfo, setExternalizer, setName, setState, toTags, 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
Method Detail

getCurrentContext

public Context getCurrentContext()
                          throws DSEInvalidRequestException
Gets the current context.
Returns:
com.ibm.dse.base.Context

getExpired

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

getSessionId

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

getSessionObject

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

getTID

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

getTimeStamp

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

getType

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

remove

public void remove()
            throws DSEInvalidArgumentException
Removes the session.

setExpired

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

setSessionObject

public void setSessionObject(java.lang.Object aSessionObject)
                      throws DSEInvalidArgumentException
Sets the session object.
Parameters:
aType - String

setTimeStamp

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

setType

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