java.lang.Object | +--com.ibm.commerce.adapter.AbstractHttpAdapter | +--com.ibm.commerce.programadapter.HttpProgramAdapterImpl
The Program Adapter that handles http requests.
Field Summary | |
---|---|
static java.lang.String |
_HTTP_CHARSET_CONSTANT The contanst use to determine the encoding of the request. |
static java.lang.String |
_ICI_MESSAGE The parameter that will have the content of the message. |
static java.lang.String |
_ICI_NEWINBOUND_COMMAND_NAME The name of the command to call if the request does not have a corresponding message mapper that can return a CommandProperty representation of the message. |
static java.lang.String |
_STR_CreateAdapter Contstant representing the method name used for logging. |
static java.lang.String |
_STR_GetData Contstant representing the method name used for logging. |
static java.lang.String |
_STR_InitFactory Contstant representing the method name used for logging. |
static java.lang.String |
_STR_IsSupportedConfigParameter Contstant representing the method name used for logging. |
static java.lang.String |
_STR_PostInvokeCommand Contstant representing the method name used for logging. |
static java.lang.String |
_STR_PreInvokeCommand Contstant representing the method name used for logging. |
static java.lang.String |
_STR_PreprocessRequest Contstant representing the method name used for logging. |
static java.lang.String |
_STR_ProcessErrorResponse Contstant representing the method name used for logging. |
static java.lang.String |
_STR_ProcessResponse Contstant representing the method name used for logging. |
static java.lang.String |
_STR_SetCommandProperties Contstant representing the method name used for logging. |
static java.lang.String |
_STR_ThisClass Contstant representing the class name used for logging. |
static java.lang.String |
_STR_ValidateDeviceFormat Contstant representing the method name used for logging. |
protected
CommandProperty |
commandProperties |
static java.lang.String |
COPYRIGHT IBM Copyright notice field. |
Fields inherited from class com.ibm.commerce.adapter. AbstractHttpAdapter |
desc,
encoding,
req,
reqObj,
requestProperties,
resp,
sessionContext |
Fields inherited from interface com.ibm.commerce.adapter. HttpAdapter |
DEVFMTID_BROWSER,
DEVFMTNAME_BROWSER,
DEVFMTNAME_IMODE,
DEVFMTTYP_BROWSER,
DEVFMTTYP_PVCDEVICE,
DEVFMTTYP_XMLFMT,
DEVFMTTYPID_BROWSER,
DEVFMTTYPID_PVC,
DEVFMTTYPID_XML |
Constructor Summary | |
---|---|
HttpProgramAdapterImpl() Creates an instance of the Program Adapter to handle HTTP requests. |
Method Summary | |
---|---|
boolean |
checkDeviceFormat(javax.servlet.http.HttpServletRequest req,
TypedProperty prop) Return true if the input request can be processed by this adapter. |
HttpAdapter |
createAdapter(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
TypedProperty param) This method returns an instance of this adapter if the request has the format defined by this adapter. |
CommandProperty |
getCommandProperties() Returns the CommandProperty object of the request. |
java.lang.Integer |
getDefaultDeviceFormatId() Returns the default device format identifier for this adapter. |
java.lang.Integer |
getDeviceFormatTypeId() Gets the identifier of the device format type for this adapter. |
SessionContext |
getSessionContext() Gets the session context. |
boolean |
httpsRedirection() Returns true if Https redirection is required. |
void |
initFactory(org.w3c.dom.Element node) Initialize the adapter based on the informtion defined in the node. |
void |
postInvokeCommand(
CommandContext commandContext) This method implements adapter specific function after the execution of a command. |
boolean |
preInvokeCommand(
CommandContext commandContext) This method implements adapter specific function before the execution of a command. |
HttpControllerRequestObject |
preprocessRequest() This method preprocess the request and returns a controller request object. |
boolean |
processErrorResponse(
CommandContext commandContext, java.lang.Exception e) This method is called by the web controller when the execution of a request has failed. |
boolean |
processResponse(
CommandContext commandContext,
TypedProperty respProperty) This method is called by the web controller after it has successfully finished the execution of the request. |
void |
setCommandProperties(
CommandProperty cmdProp) Sets the CommandProperties object. |
CommandProperty |
validateDeviceFormat(javax.servlet.http.HttpServletRequest req) Return a command property if there is a corresponding message mapper that can handle the request. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.adapter. HttpAdapter |
getAdapterDesc,
getRequest,
getRequestName,
getRequestProperties,
getResponse,
getUniqueIdentifier,
isDoubleClickHandlerEnabled,
processRequest,
setAdapterDesc,
setRequest,
setRequestProperties,
setResponse |
Methods inherited from interface com.ibm.commerce.adapter. DeviceFormatAdapter |
getDeviceFormatId,
getDeviceFormatName,
getDeviceFormatType,
getDocumentPathName,
setDefaultDeviceFormatId,
setDeviceFormatId,
setDeviceFormatName,
setDeviceFormatType,
setDeviceFormatTypeId |
Methods inherited from interface com.ibm.commerce.adapter. HttpAdapterFactory |
createAdapter,
getAdapterDesc,
isEnabled |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
protected CommandProperty commandProperties
public static final java.lang.String _ICI_NEWINBOUND_COMMAND_NAME
public static final java.lang.String _ICI_MESSAGE
public static final java.lang.String _HTTP_CHARSET_CONSTANT
public static final java.lang.String _STR_ThisClass
public static final java.lang.String _STR_ValidateDeviceFormat
public static final java.lang.String _STR_SetCommandProperties
public static final java.lang.String _STR_ProcessResponse
public static final java.lang.String _STR_ProcessErrorResponse
public static final java.lang.String _STR_PreprocessRequest
public static final java.lang.String _STR_PreInvokeCommand
public static final java.lang.String _STR_PostInvokeCommand
public static final java.lang.String _STR_IsSupportedConfigParameter
public static final java.lang.String _STR_InitFactory
public static final java.lang.String _STR_CreateAdapter
public static final java.lang.String _STR_GetData
Constructor Detail |
---|
public HttpProgramAdapterImpl()
Method Detail |
---|
public boolean checkDeviceFormat(javax.servlet.http.HttpServletRequest req, TypedProperty prop)
checkDeviceFormat
in interface
HttpAdapterFactory
public HttpAdapter createAdapter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, TypedProperty param)
request
- the HTTP request.response
- the HTTP response.param
- the request parameterspublic CommandProperty getCommandProperties()
public java.lang.Integer getDefaultDeviceFormatId()
getDefaultDeviceFormatId
in interface
DeviceFormatAdapter
getDefaultDeviceFormatId
in class
AbstractHttpAdapter
public java.lang.Integer getDeviceFormatTypeId()
getDeviceFormatTypeId
in interface
DeviceFormatAdapter
getDeviceFormatTypeId
in class
AbstractHttpAdapter
public SessionContext getSessionContext() throws ECException
getSessionContext
in interface
DeviceFormatAdapter
ECException
- if there is a problem obtaining the session context.public boolean httpsRedirection()
httpsRedirection
in interface
HttpAdapter
public void initFactory(org.w3c.dom.Element node) throws java.lang.Exception
initFactory
in interface
HttpAdapterFactory
initFactory
in class
AbstractHttpAdapter
node
- the XML configuration for the adapter.java.lang.Exception
- if there is a problem
initializing.public void postInvokeCommand(CommandContext commandContext) throws ECException
postInvokeCommand
in interface
DeviceFormatAdapter
commandContext
- CommandContext - the command context
associated with the command.ECException
public boolean preInvokeCommand(CommandContext commandContext) throws ECException
preInvokeCommand
in interface
DeviceFormatAdapter
commandContext
- the command context associated with the
command.ECException
- should never happen because the method only
returns true.public HttpControllerRequestObject preprocessRequest()
preprocessRequest
in interface
HttpAdapter
preprocessRequest
in class
AbstractHttpAdapter
public boolean processErrorResponse(CommandContext commandContext, java.lang.Exception e) throws ECException
processErrorResponse
in interface
DeviceFormatAdapter
processErrorResponse
in class
AbstractHttpAdapter
commandContext
- commandContext for the request.ECException
- if there is a problem determining whether a
response is necessary.public boolean processResponse(CommandContext commandContext, TypedProperty respProperty) throws ECException
processResponse
in interface
DeviceFormatAdapter
processResponse
in class
AbstractHttpAdapter
commandContext
- the command context of the command.ECException
- if there is a problem determining whether a
response is necessary.public void setCommandProperties(CommandProperty cmdProp)
public CommandProperty validateDeviceFormat(javax.servlet.http.HttpServletRequest req)