|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
|
static java.lang.String |
_ICI_MESSAGE
|
static java.lang.String |
_ICI_NEWINBOUND_COMMAND_NAME
|
static java.lang.String |
_STR_CreateAdapter
|
static java.lang.String |
_STR_GetData
|
static java.lang.String |
_STR_InitFactory
|
static java.lang.String |
_STR_IsSupportedConfigParameter
|
static java.lang.String |
_STR_PostInvokeCommand
|
static java.lang.String |
_STR_PreInvokeCommand
|
static java.lang.String |
_STR_PreprocessRequest
|
static java.lang.String |
_STR_ProcessErrorResponse
|
static java.lang.String |
_STR_ProcessResponse
|
static java.lang.String |
_STR_SetCommandProperties
|
static java.lang.String |
_STR_ThisClass
|
static java.lang.String |
_STR_ValidateDeviceFormat
|
protected CommandProperty |
commandProperties
|
Fields inherited from class com.ibm.commerce.adapter.AbstractHttpAdapter |
desc, req, reqObj, requestProperties, resp, sessionContext |
Fields inherited from interface com.ibm.commerce.adapter.HttpAdapter |
COPYRIGHT, DEVFMTID_BROWSER, DEVFMTNAME_BROWSER, DEVFMTNAME_IMODE, DEVFMTTYP_BROWSER, DEVFMTTYP_PVCDEVICE, DEVFMTTYP_XMLFMT, DEVFMTTYPID_BROWSER, DEVFMTTYPID_PVC, DEVFMTTYPID_XML |
Fields inherited from interface com.ibm.commerce.adapter.HttpAdapterFactory |
COPYRIGHT |
Constructor Summary | |
HttpProgramAdapterImpl()
HttpProgramAdapterImpl constructor. |
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 device format type Id 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 AdapterFactory 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. |
com.ibm.commerce.programadapter.HttpControllerRequestObject |
preprocessRequest()
This method preprocess a HttpServletRequest and return a HttpControllerRequestObject. |
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 true if the input request can be processed by this adapter. |
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, 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, initFactory, isEnabled |
Field Detail |
public static final java.lang.String _HTTP_CHARSET_CONSTANT
public static final java.lang.String _ICI_MESSAGE
public static final java.lang.String _ICI_NEWINBOUND_COMMAND_NAME
public static final java.lang.String _STR_CreateAdapter
public static final java.lang.String _STR_GetData
public static final java.lang.String _STR_InitFactory
public static final java.lang.String _STR_IsSupportedConfigParameter
public static final java.lang.String _STR_PostInvokeCommand
public static final java.lang.String _STR_PreInvokeCommand
public static final java.lang.String _STR_PreprocessRequest
public static final java.lang.String _STR_ProcessErrorResponse
public static final java.lang.String _STR_ProcessResponse
public static final java.lang.String _STR_SetCommandProperties
public static final java.lang.String _STR_ThisClass
public static final java.lang.String _STR_ValidateDeviceFormat
protected CommandProperty commandProperties
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
- HttpServletRequestresponse
- HttpServletResponseparam
- TypedProperty - request parameters
public 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
public boolean httpsRedirection()
httpsRedirection
in interface HttpAdapter
public void initFactory(org.w3c.dom.Element node) throws java.lang.Exception
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
- CommandContext - the command context associated with the command.ECException
- public com.ibm.commerce.programadapter.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 - commandContext for the requestexception
- Exception - exception caught when executing the request.public boolean processResponse(CommandContext commandContext, TypedProperty respProperty) throws ECException
processResponse
in interface DeviceFormatAdapter
processResponse
in class AbstractHttpAdapter
respProperties
- TypedProperty - response properties returned by the command.public void setCommandProperties(CommandProperty cmdProp)
public CommandProperty validateDeviceFormat(javax.servlet.http.HttpServletRequest req)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |