com.ibm.etill.framework.cassette
Class APIRequest

java.lang.Object
  |
  +--com.ibm.etill.framework.cassette.CassetteRequest
        |
        +--com.ibm.etill.framework.cassette.APIRequest
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, Serializable
Direct Known Subclasses:
AdminRequest, BatchRequest, OrderRequest

public class APIRequest
extends CassetteRequest
implements PaymentAPIConstants

APIRequest is the base class for all classes that represent Commerce Payments API commands.

When the Commerce Payments Framework receives an API command from a merchant, it instantiates an object that extends, either directly or indirectly, the APIRequest class. Once the request object is built, the Framework processes the framework information in the request and then forwards the request object to the appropriate Cassette object's service method in order to complete the request.

Currently, the main purpose of the APIRequest class is to add protocol-specific parameters called protocol data to the request hierarchy. Protocol data parameters are passed on the framework Commerce Payments API commands, but are directed to the payment protocol (and therefore, cassette) which will actually handle the request. Since these parameters are only meaningful to the cassette, the Framework can parse them, but cannot interpret or validate them. Therefore, when protocol data is received on an API command, the Framework parses it into a ParameterTable and then passes that ParameterTable to the cassette in the APIRequest for further processing.

See Also:
APIResponse, Cassette.service(com.ibm.etill.framework.cassette.CassetteRequest, com.ibm.etill.framework.cassette.CassetteResponse), Serialized Form

 
Method Summary
 ParameterTable getFrameworkKeywords()
          Returns a ParameterTable containing all of the framework command parameters, keyed by their keywords.
 ParameterTable getProtocolData()
          Returns the set of protocol data parameters specified on this API command.
 
Methods inherited from class com.ibm.etill.framework.cassette.CassetteRequest
getConnection, getToken, obtainLocks, releaseLocks
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFrameworkKeywords

public final ParameterTable getFrameworkKeywords()
Returns a ParameterTable containing all of the framework command parameters, keyed by their keywords.
Returns:
ParameterTable framework command parameters, keyed by their keywords

getProtocolData

public final ParameterTable getProtocolData()
Returns the set of protocol data parameters specified on this API command.
Parameters:
ParameterTable - - containing all of the protocol data parameters. The table keys are the parameter keywords and the associated values are the parameter values.