|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.commerce.adapter.AbstractHttpAdapter
This class provides an abstract base implementation of an Http device format adapter. It implements both the HttpAdapter interface and the HttpAdapterFactory interface.
Field Summary | |
protected HttpAdapterDesc |
desc
|
protected com.ibm.commerce.adapter.HttpServletRequest |
req
|
protected com.ibm.commerce.adapter.HttpControllerRequestObject |
reqObj
|
protected TypedProperty |
requestProperties
|
protected com.ibm.commerce.adapter.HttpServletResponse |
resp
|
protected SessionContext |
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 | |
AbstractHttpAdapter()
AbstractHttpAdapter constructor. |
Method Summary | |
void |
displayGenericErrorView(com.ibm.commerce.adapter.ServletContext servletContext,
java.lang.String docName)
This method displays a GenericSystemError.jsp. |
HttpAdapterDesc |
getAdapterDesc()
Return the descripter that describes this Http adapter. |
java.lang.Integer |
getDefaultDeviceFormatId()
Returns the default device format identifier for this adapter |
java.lang.Integer |
getDeviceFormatId()
Gets the device format Id for this adapter. |
java.lang.String |
getDeviceFormatName()
Gets the device format name for this adapter. |
java.lang.String |
getDeviceFormatType()
Gets the device format type name for this adapter. |
java.lang.Integer |
getDeviceFormatTypeId()
Gets the device format type Id for this adapter. |
java.lang.String |
getDocumentPathName(java.lang.String name)
gets the actual output document name based on a base document name. |
com.ibm.commerce.adapter.HttpServletRequest |
getRequest()
Gets the HttpServetRequest object. |
java.lang.String |
getRequestName()
Gets the request name . |
TypedProperty |
getRequestProperties()
Gets the request properties assoiciated with this request. |
com.ibm.commerce.adapter.HttpServletResponse |
getResponse()
Gets the HttpServetResponse object. |
boolean |
httpRedirection()
Returns true if Https redirection is required. |
void |
initFactory(com.ibm.commerce.adapter.Element node)
initialize the AdapterFactory based on the informtion defined in the node |
boolean |
isEnabled()
Returns true if this adapter is enabled. |
com.ibm.commerce.adapter.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. |
void |
processRequest(com.ibm.commerce.adapter.ServletContext servletContext,
java.lang.String encoding,
boolean storeCommand)
This method is responsible for invoking the web controller to process the incoming request. |
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 |
setAdapterDesc(HttpAdapterDesc value)
Sets the http device format adapter descriptor. |
void |
setDefaultDeviceFormatId(java.lang.Integer value)
Sets the device format Id. |
void |
setDeviceFormatClass(java.lang.Class value)
Sets the device format clas for this adapter. |
void |
setDeviceFormatId(java.lang.Integer value)
Sets the device format Id for this adapter. |
void |
setDeviceFormatName(java.lang.String value)
Sets the device format name for this adapter. |
void |
setDeviceFormatType(java.lang.String value)
Sets the device format type name for this adapter. |
void |
setDeviceFormatTypeId(java.lang.Integer value)
Sets the device format type Id for this adapter. |
void |
setRequest(com.ibm.commerce.adapter.HttpServletRequest value)
Sets the HttpServletRequest object. |
void |
setRequestProperties(TypedProperty val)
Sets the request properties assoiciated with this request. |
void |
setResponse(com.ibm.commerce.adapter.HttpServletResponse value)
Sets the HttpServletResponse object. |
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 |
httpsRedirection |
Methods inherited from interface com.ibm.commerce.adapter.DeviceFormatAdapter |
getSessionContext, postInvokeCommand, preInvokeCommand |
Methods inherited from interface com.ibm.commerce.adapter.HttpAdapterFactory |
checkDeviceFormat, createAdapter |
Field Detail |
protected HttpAdapterDesc desc
protected com.ibm.commerce.adapter.HttpServletRequest req
protected com.ibm.commerce.adapter.HttpControllerRequestObject reqObj
protected TypedProperty requestProperties
protected com.ibm.commerce.adapter.HttpServletResponse resp
protected SessionContext sessionContext
Constructor Detail |
public AbstractHttpAdapter()
Method Detail |
public void displayGenericErrorView(com.ibm.commerce.adapter.ServletContext servletContext, java.lang.String docName)
servletContext
- ServletContextdocname
- String - the error page name (GenericSystemError.jsp)public HttpAdapterDesc getAdapterDesc()
getAdapterDesc
in interface HttpAdapter
public java.lang.Integer getDefaultDeviceFormatId()
getDefaultDeviceFormatId
in interface DeviceFormatAdapter
public final java.lang.Integer getDeviceFormatId()
getDeviceFormatId
in interface DeviceFormatAdapter
public final java.lang.String getDeviceFormatName()
getDeviceFormatName
in interface DeviceFormatAdapter
public final java.lang.String getDeviceFormatType()
getDeviceFormatType
in interface DeviceFormatAdapter
public java.lang.Integer getDeviceFormatTypeId()
getDeviceFormatTypeId
in interface DeviceFormatAdapter
public java.lang.String getDocumentPathName(java.lang.String name)
getDocumentPathName
in interface DeviceFormatAdapter
public final com.ibm.commerce.adapter.HttpServletRequest getRequest()
getRequest
in interface HttpAdapter
public final java.lang.String getRequestName()
getRequestName
in interface HttpAdapter
public TypedProperty getRequestProperties()
getRequestProperties
in interface HttpAdapter
public final com.ibm.commerce.adapter.HttpServletResponse getResponse()
getResponse
in interface HttpAdapter
public boolean httpRedirection()
public void initFactory(com.ibm.commerce.adapter.Element node) throws java.lang.Exception
initFactory
in interface HttpAdapterFactory
public final boolean isEnabled()
isEnabled
in interface HttpAdapterFactory
com.ibm.commerce.adapter.HttpAdapterFactory
public com.ibm.commerce.adapter.HttpControllerRequestObject preprocessRequest()
preprocessRequest
in interface HttpAdapter
public boolean processErrorResponse(CommandContext commandContext, java.lang.Exception e) throws ECException
processErrorResponse
in interface DeviceFormatAdapter
commandContext
- CommandContext - commandContext for the requestexception
- Exception - exception caught when executing the request.public final void processRequest(com.ibm.commerce.adapter.ServletContext servletContext, java.lang.String encoding, boolean storeCommand) throws ECException
processRequest
in interface HttpAdapter
servletContext
- ServletContext - the servlet context associated with this requestencoding
- String - the encoding used for the incoming parametersstoreCommand
- boolean - true if this is a store commandpublic boolean processResponse(CommandContext commandContext, TypedProperty respProperty) throws ECException
processResponse
in interface DeviceFormatAdapter
respProperties
- TypedProperty - response properties returned by the command.public final void setAdapterDesc(HttpAdapterDesc value)
setAdapterDesc
in interface HttpAdapter
value
- HttpAdapterDesc - Http adapter descriptorpublic void setDefaultDeviceFormatId(java.lang.Integer value)
setDefaultDeviceFormatId
in interface DeviceFormatAdapter
value
- java.lang.Integerpublic final void setDeviceFormatClass(java.lang.Class value)
value
- Class - the class object associated with this adapterpublic final void setDeviceFormatId(java.lang.Integer value)
setDeviceFormatId
in interface DeviceFormatAdapter
value
- Integer - the device format idpublic final void setDeviceFormatName(java.lang.String value)
setDeviceFormatName
in interface DeviceFormatAdapter
value
- String - the device format namepublic final void setDeviceFormatType(java.lang.String value)
setDeviceFormatType
in interface DeviceFormatAdapter
value
- String - the device format type namepublic final void setDeviceFormatTypeId(java.lang.Integer value)
setDeviceFormatTypeId
in interface DeviceFormatAdapter
value
- Integer - the device format type idpublic final void setRequest(com.ibm.commerce.adapter.HttpServletRequest value)
setRequest
in interface HttpAdapter
request
- HttpServletRequestpublic final void setRequestProperties(TypedProperty val)
setRequestProperties
in interface HttpAdapter
requestProperties
- TypedPropertypublic final void setResponse(com.ibm.commerce.adapter.HttpServletResponse value)
setResponse
in interface HttpAdapter
response
- HttpServletResponse
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |