com.ibm.commerce.adapter
Interface SessionContext

All Known Subinterfaces:
ProgramAdapterSessionContext
All Known Implementing Classes:
DummyProgramAdapterSessionContext, DummySessionContext, HttpSessionContext

public interface SessionContext

Reserved for IBM internal use. The structure of an object that is used to maintain session information for one or a set of requests to the Commerce Server.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
 
Method Summary
 void commit()
          Reserved for IBM internal use.
 java.lang.Object getExtendedSessionData(java.lang.String strParamName)
          Reserved for IBM internal use.
  SessionData getSessionData()
          Reserved for IBM internal use.
 java.lang.String getUniqueSessionTag()
          Reserved for IBM internal use.
 java.lang.Long getValidUserId()
          Reserved for IBM internal use.
 void rollback()
          Reserved for IBM internal use.
 void setExtendedSessionData(java.lang.String strParamName, java.lang.Object strParamVal)
          Reserved for IBM internal use.
 void setSessionData( SessionData sessionData)
          Reserved for IBM internal use.
 void setUniqueSessionTag(java.lang.String strSessionTag)           Reserved for IBM internal use.
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values
Method Detail

commit

public void commit()
            throws ECSystemException
Reserved for IBM internal use. Commits the session data.
Throws:
ECSystemException - if there is a problem committing any session data.

getExtendedSessionData

public java.lang.Object getExtendedSessionData(java.lang.String strParamName)
Reserved for IBM internal use. Gets a value stored in the extended session data. If the parameter does not exist, null will be returned.
Returns:
The value of the specified parametered stored in the extended session data.

getSessionData

public SessionData getSessionData()
Reserved for IBM internal use. Gets the session data.
Returns:
The session data.

getUniqueSessionTag

public java.lang.String getUniqueSessionTag()
Reserved for IBM internal use. Gets the unique session tag.
Returns:
The unique session tag.

getValidUserId

public java.lang.Long getValidUserId()
                              throws ECSystemException
Reserved for IBM internal use. Gets the validated user identifier.
Returns:
The user identifier.
Throws:
ECSystemException - if there is a problem resolving the user identifier.

rollback

public void rollback()
              throws ECSystemException
Reserved for IBM internal use. Rollback previously set session data.
Throws:
ECSystemException - if there is a problem rolling back the set session data.

setExtendedSessionData

public void setExtendedSessionData(java.lang.String strParamName,
                                   java.lang.Object strParamVal)
                            throws ECException
Reserved for IBM internal use. Adds values to the extended session data.
Parameters:
strParamName - the name of the extended session data parameter.
Throws:
ECException - if there was a problem setting the extended session parameter.

setSessionData

public void setSessionData(SessionData sessionData)
                    throws ECSystemException
Reserved for IBM internal use. Sets the session data.
Parameters:
sessionData - the session data to set.
Throws:
ECSystemException - if there was a problem setting the session data.

setUniqueSessionTag

public void setUniqueSessionTag(java.lang.String strSessionTag)
                         throws ECException
Reserved for IBM internal use. Sets the unique session tag.
Parameters:
strSessionTag - the session specific tag
Throws:
ECException - if there was a problem setting the unique session tag.