com.ibm.commerce.programadapter.security
Class DummyProgramAdapterSessionContext

java.lang.Object
  |
  +--com.ibm.commerce.programadapter.security.DummyProgramAdapterSessionContext
All Implemented Interfaces:
ProgramAdapterSessionContext, SessionContext

public class DummyProgramAdapterSessionContext
extends java.lang.Object
implements ProgramAdapterSessionContext

Dummy Implementation of the com.ibm.commerce.programadapter.security.ProgramAdapterSessionContext interface.


Constructor Summary
DummyProgramAdapterSessionContext()
          DummyProgramAdapterSessionContext Constructor.
 
Method Summary
 void commit()
          Dummy method to commit the session data.
 boolean didErrorOccur()
          Indicates whether an error occured and the Program Adapter should indicate this.
 CommandProperty getCommandProperty()
          Returns the CommandProperty.
 com.ibm.commerce.server.WCSCookie getCookie()
          Sets an extended 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 setCommandProperty(CommandProperty propertyCommand)
          Sets the CommandProperty
 void setConfiguration(TypedProperty config)
          Sets the configuration for the ProgramAdapterSessionContext.
 void setExtendedSessionData(java.lang.String strParamName, java.lang.Object strParamVal)
          Sets an extended session data.
 void setRequest(java.lang.Object request)
          Sets the Request Object.
 void setResponse(java.lang.Object response)
          Sets the Response Object
 void setSessionData(SessionData sessionData)
          Sets the base session data.
 void setUniqueSessionTag(java.lang.String strSessionTag)
          Sets the unique session tag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DummyProgramAdapterSessionContext

public DummyProgramAdapterSessionContext()
DummyProgramAdapterSessionContext Constructor.
Method Detail

commit

public void commit()
            throws ECSystemException
Dummy method to commit the session data.

Specified by:
commit in interface SessionContext
Throws:
ECSystemException -  

didErrorOccur

public boolean didErrorOccur()
Indicates whether an error occured and the Program Adapter should indicate this. This will be called when the response is processed.
Specified by:
didErrorOccur in interface ProgramAdapterSessionContext

getCommandProperty

public CommandProperty getCommandProperty()
Returns the CommandProperty.
Specified by:
getCommandProperty in interface ProgramAdapterSessionContext

getCookie

public com.ibm.commerce.server.WCSCookie getCookie()
Sets an extended session data.

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

getExtendedSessionData

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

Specified by:
getExtendedSessionData in interface SessionContext
Parameters:
strParamName - String - name of extended session data
Returns:
String - value of extended session data

getSessionData

public SessionData getSessionData()
Gets the base session data.

Specified by:
getSessionData in interface SessionContext
Returns:
SessionData

getUniqueSessionTag

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

Specified by:
getUniqueSessionTag in interface SessionContext
Returns:
String - session tag

getValidUserId

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

Specified by:
getValidUserId in interface SessionContext
Returns:
Long - the user Id
Throws:
ECSystemException -  

rollback

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

Specified by:
rollback in interface SessionContext
Throws:
ECSystemException -  

setCommandProperty

public void setCommandProperty(CommandProperty propertyCommand)
Sets the CommandProperty
Specified by:
setCommandProperty in interface ProgramAdapterSessionContext

setConfiguration

public void setConfiguration(TypedProperty config)
Sets the configuration for the ProgramAdapterSessionContext.
Specified by:
setConfiguration in interface ProgramAdapterSessionContext

setExtendedSessionData

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

Specified by:
setExtendedSessionData in interface SessionContext
Parameters:
strParamName - String - session data name
oParamValue - Object - session data value
Throws:
ECException -  

setRequest

public void setRequest(java.lang.Object request)
Sets the Request Object.
Specified by:
setRequest in interface ProgramAdapterSessionContext

setResponse

public void setResponse(java.lang.Object response)
Sets the Response Object
Specified by:
setResponse in interface ProgramAdapterSessionContext

setSessionData

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

Specified by:
setSessionData in interface SessionContext
Throws:
ECSystemException -  

setUniqueSessionTag

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

Specified by:
setUniqueSessionTag in interface SessionContext
Parameters:
strSessionTag - String - session specific tag
Throws:
ECException -