com.ibm.commerce.adapter
Interface HttpAdapter

All Superinterfaces:
DeviceFormatAdapter
All Known Subinterfaces:
PVCAdapter
All Known Implementing Classes:
AbstractHttpAdapter, HttpProgramAdapterImpl, PVCAdapterImpl

public interface HttpAdapter
extends DeviceFormatAdapter

Reserved for IBM internal use. Defines the device format interface that is required for all adapters that handles HTTP servlet requests.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
static java.lang.Integer DEVFMTID_BROWSER
          The device format identifier for a HTTP Browser (Web Browser) adapter.
static java.lang.String DEVFMTNAME_BROWSER
          The device name for a HTTP Browser (Web Browser) adapter.
static java.lang.String DEVFMTNAME_IMODE
          The device name for a I-Mode Browser adapter.
static java.lang.String DEVFMTTYP_BROWSER
          The device format type name of a HTTP Browser (Web Browser) device.
static java.lang.String DEVFMTTYP_PVCDEVICE
          The device format type name of a PvC device.
static java.lang.String DEVFMTTYP_XMLFMT
          The device format type name of a XML device.
static java.lang.Integer DEVFMTTYPID_BROWSER
          The device format type identifier for a HTTP Browswer (Web Browser) adapter.
static java.lang.Integer DEVFMTTYPID_PVC
          The device format type identifier for a PvC adapter.
static java.lang.Integer DEVFMTTYPID_XML
          The device format type identifier for a XML adapter.
 
Method Summary
  HttpAdapterDesc getAdapterDesc()
          Reserved for IBM internal use.
 HttpServletRequest getRequest()
          Reserved for IBM internal use.
 java.lang.String getRequestName()
          Reserved for IBM internal use.
  TypedProperty getRequestProperties()
          Reserved for IBM internal use.
 HttpServletResponse getResponse()
          Reserved for IBM internal use.
 java.lang.String getUniqueIdentifier()
          Reserved for IBM internal use.
 boolean httpsRedirection()
          Reserved for IBM internal use.
 boolean isDoubleClickHandlerEnabled()
          Reserved for IBM internal use.
 HttpControllerRequestObject preprocessRequest()
          Reserved for IBM internal use.
 void processRequest(ServletContext servletContext, java.lang.String encoding, boolean storeCommand)
          Reserved for IBM internal use.
 void setAdapterDesc( HttpAdapterDesc val)
          Reserved for IBM internal use.
 void setRequest(HttpServletRequest req)
          Reserved for IBM internal use.
 void setRequestProperties( TypedProperty val)
          Reserved for IBM internal use.
 void setResponse(HttpServletResponse resp)
          Reserved for IBM internal use.
 
Methods inherited from interface com.ibm.commerce.adapter. DeviceFormatAdapter
getDefaultDeviceFormatId, getDeviceFormatId, getDeviceFormatName, getDeviceFormatType, getDeviceFormatTypeId, getDocumentPathName, getSessionContext, postInvokeCommand, preInvokeCommand, processErrorResponse, processResponse, setDefaultDeviceFormatId, setDeviceFormatId, setDeviceFormatName, setDeviceFormatType, setDeviceFormatTypeId
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values

DEVFMTNAME_BROWSER

public static final java.lang.String DEVFMTNAME_BROWSER
The device name for a HTTP Browser (Web Browser) adapter. The current value is "Browser".
See Also:
Constant Field Values

DEVFMTNAME_IMODE

public static final java.lang.String DEVFMTNAME_IMODE
The device name for a I-Mode Browser adapter. The current value is "Imode".
See Also:
Constant Field Values

DEVFMTID_BROWSER

public static final java.lang.Integer DEVFMTID_BROWSER
The device format identifier for a HTTP Browser (Web Browser) adapter. The current value is -1.

DEVFMTTYPID_BROWSER

public static final java.lang.Integer DEVFMTTYPID_BROWSER
The device format type identifier for a HTTP Browswer (Web Browser) adapter. The current value is -1.

DEVFMTTYPID_PVC

public static final java.lang.Integer DEVFMTTYPID_PVC
The device format type identifier for a PvC adapter. The current value is -2.

DEVFMTTYPID_XML

public static final java.lang.Integer DEVFMTTYPID_XML
The device format type identifier for a XML adapter. The current value is -3 however this constant should not be used to represent a XML over HTTP adapter.

DEVFMTTYP_PVCDEVICE

public static final java.lang.String DEVFMTTYP_PVCDEVICE
The device format type name of a PvC device. The current value is "PVCDevice".
See Also:
Constant Field Values

DEVFMTTYP_XMLFMT

public static final java.lang.String DEVFMTTYP_XMLFMT
The device format type name of a XML device. The current value is "XMLFormat".
See Also:
Constant Field Values

DEVFMTTYP_BROWSER

public static final java.lang.String DEVFMTTYP_BROWSER
The device format type name of a HTTP Browser (Web Browser) device. The current value is "Browser".
See Also:
Constant Field Values
Method Detail

getAdapterDesc

public HttpAdapterDesc getAdapterDesc()
Reserved for IBM internal use. Return the descriptor that describes this Http adapter.
Returns:
The adapter's descriptor.

getRequest

public HttpServletRequest getRequest()
Reserved for IBM internal use. Gets the HTTP request object.
Returns:
The HTTP request object.

getRequestName

public java.lang.String getRequestName()
Reserved for IBM internal use. Gets the request name. This will be the command that will be executed.
Returns:
The requested command name.

getResponse

public HttpServletResponse getResponse()
Reserved for IBM internal use. Gets the HTTP servlet response object.
Returns:
The HTTP response object to write the needed output to.

httpsRedirection

public boolean httpsRedirection()
Reserved for IBM internal use. Returns true if HTTPS redirection is required. That is, if a requests comes in as HTTP but the command requires HTTPS, the request will be redirected to HTTPS.
Returns:
Whether the request must be made via HTTPS.

preprocessRequest

public HttpControllerRequestObject preprocessRequest()
Reserved for IBM internal use. Preprocess a HTTP request and return a controller request object.

processRequest

public void processRequest(ServletContext servletContext,
                           java.lang.String encoding,
                           boolean storeCommand)
                    throws ECException
Reserved for IBM internal use. Invokes the web controller to process the incoming request. It will invoke processErrorView() if it detected an error in the preprocessing of the request. It will invoke processView() to handle a view such as relogin It will invoke processRequest() to handle a requler request which can be a controller command, a view command, or just a jsp page.
Parameters:
servletContext - the servlet context associated with this request.
encoding - the encoding used for the incoming parameters.
storeCommand - if this is a store command.
ECException

setAdapterDesc

public void setAdapterDesc(HttpAdapterDesc val)
Reserved for IBM internal use. Sets the adapter descriptor.

setRequest

public void setRequest(HttpServletRequest req)
Reserved for IBM internal use. Sets the HTTP request object.

setRequestProperties

public void setRequestProperties(TypedProperty val)
Reserved for IBM internal use. Sets the request properties assoiciated with this request.

setResponse

public void setResponse(HttpServletResponse resp)
Reserved for IBM internal use. Sets the HTTP response object.

getRequestProperties

public TypedProperty getRequestProperties()
Reserved for IBM internal use. Gets the request properties assoiciated with this request.
Specified by:
getRequestProperties in interface DeviceFormatAdapter
Returns:
TypedProperty - request properties

isDoubleClickHandlerEnabled

public boolean isDoubleClickHandlerEnabled()
Reserved for IBM internal use. Returns true if double click handler is enabled for this adapter type. Returns false otherwise. The abstract class returns false indicating that double click is not supported. Individual adapters can overwrite this method if it can support double click check by providing a getUniqueIdentifier mehtod.
Returns:
returns double click enabled flag.

getUniqueIdentifier

public java.lang.String getUniqueIdentifier()
Reserved for IBM internal use. Gets an id that uniquely identifies a client session within the Commerce Server. This method is required to enable double click support. The abstract class do not support double click and returns a null string by default.
Returns:
Returns a string that uniquely identifies a client session within the Commerce Server.