com.ibm.commerce.adapter
Interface SessionContext

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

public interface SessionContext

SessionContext defines the interface that needs to be implemented for a SessionContext.


Method Summary
 void commit()
          Commits the session data.
 java.lang.Object getExtendedSessionData(java.lang.String strParamName)
          Gets an extended session data.
 SessionData getSessionData()
          Gets the base session data.
 java.lang.String getUniqueSessionTag()
          Gets the unique session tag.
 java.lang.Long getValidUserId()
          Gets the validated user Id.
 void rollback()
          Rollback previously set session data.
 void setExtendedSessionData(java.lang.String strParamName, java.lang.Object strParamVal)
          Sets an extended session data.
 void setSessionData(SessionData sessionData)
          Sets the base session data.
 void setUniqueSessionTag(java.lang.String strSessionTag)
          Sets the unique session tag.
 

Method Detail

commit

public void commit()
            throws ECSystemException
Commits the session data.

Throws:
ECSystemException -  

getExtendedSessionData

public java.lang.Object getExtendedSessionData(java.lang.String strParamName)
Gets an extended session data.

Parameters:
strParamName - String - name of extended session data
Returns:
String - value of extended session data

getSessionData

public SessionData getSessionData()
Gets the base session data.

Returns:
SessionData

getUniqueSessionTag

public java.lang.String getUniqueSessionTag()
Gets the unique session tag.

Returns:
String - session tag

getValidUserId

public java.lang.Long getValidUserId()
                              throws ECSystemException
Gets the validated user Id.

Returns:
Long - the user Id
Throws:
ECSystemException -  

rollback

public void rollback()
              throws ECSystemException
Rollback previously set session data.

Throws:
ECSystemException -  

setExtendedSessionData

public void setExtendedSessionData(java.lang.String strParamName,
                                   java.lang.Object strParamVal)
                            throws ECException
Sets an extended session data.

Parameters:
strParamName - String - session data name
oParamValue - Object - session data value
Throws:
ECException -  

setSessionData

public void setSessionData(SessionData sessionData)
                    throws ECSystemException
Sets the base session data.

Throws:
ECSystemException -  

setUniqueSessionTag

public void setUniqueSessionTag(java.lang.String strSessionTag)
                         throws ECException
Sets the unique session tag.

Parameters:
strSessionTag - String - session specific tag
Throws:
ECException -