com.ibm.commerce.browseradapter
Class HttpBrowserAdapter

java.lang.Object
  |
  +--com.ibm.commerce.adapter.AbstractHttpAdapter
        |
        +--com.ibm.commerce.browseradapter.HttpBrowserAdapter
All Implemented Interfaces:
DeviceFormatAdapter, HttpAdapter, HttpAdapterFactory

public class HttpBrowserAdapter
extends AbstractHttpAdapter

Reserved for IBM internal use. HttpBrowserAdapter is the device format adapter that is responsible for handling http requests that comes from a browser.


Field Summary
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
HttpBrowserAdapter()
          Reserved for IBM internal use.
 
Method Summary
 boolean checkDeviceFormat(HttpServletRequest req, TypedProperty prop)
          Reserved for IBM internal use.
  HttpAdapter createAdapter(HttpServletRequest _req, HttpServletResponse _resp, TypedProperty _prop)
          Reserved for IBM internal use.
  HttpSessionContext createSessionContext()
          Reserved for IBM internal use.
 java.lang.String getDocumentPathName(java.lang.String name)
          Reserved for IBM internal use.
  SessionContext getSessionContext()
          Reserved for IBM internal use.
 java.lang.String getUniqueIdentifier()
          Reserved for IBM internal use.
protected  HttpControllerRequestObject handleLoginTimeout(HttpControllerRequestObject obj, CommandContext commandContext)
          Reserved for IBM internal use.
protected  HttpControllerRequestObject handlePasswordInvalidation(HttpControllerRequestObject obj)
          Reserved for IBM internal use.
protected  HttpControllerRequestObject handlePasswordRerequestSupport(HttpControllerRequestObject obj)
          Reserved for IBM internal use.
 boolean httpsRedirection()
          Reserved for IBM internal use.
 boolean isDoubleClickHandlerEnabled()
          Reserved for IBM internal use.
 void postInvokeCommand( CommandContext commandContext)
          Reserved for IBM internal use.
 boolean preInvokeCommand( CommandContext commandContext)
          Reserved for IBM internal use.
 HttpControllerRequestObject preprocessRequest()
          Reserved for IBM internal use.
protected  HttpControllerRequestObject processCrossSiteScriptingProtection(HttpControllerRequestObject obj)
          Reserved for IBM internal use.
static  HttpBrowserAdapter singleton()
          Reserved for IBM internal use.
protected  void validatePasswordForPasswordProtectedRequest( CommandContext commandContext)
          Reserved for IBM internal use.
 
Methods inherited from class com.ibm.commerce.adapter. AbstractHttpAdapter
displayGenericErrorView, getAdapterDesc, getDefaultDeviceFormatId, getDeviceFormatId, getDeviceFormatName, getDeviceFormatType, getDeviceFormatTypeId, getRequest, getRequestName, getRequestProperties, getResponse, httpRedirection, initFactory, isEnabled, processErrorResponse, processRequest, processResponse, setAdapterDesc, setDefaultDeviceFormatId, setDeviceFormatClass, setDeviceFormatId, setDeviceFormatName, setDeviceFormatType, setDeviceFormatTypeId, setRequest, setRequestProperties, setResponse
 
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. HttpAdapterFactory
checkDeviceFormat
 

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

HttpBrowserAdapter

public HttpBrowserAdapter()
Reserved for IBM internal use. HttpDeviceBrowser default constructor.
Method Detail

checkDeviceFormat

public boolean checkDeviceFormat(HttpServletRequest req,
TypedProperty prop)
Reserved for IBM internal use. This method checks whether the request can be handled by this adapter. This method always returns true for the HttpBrowserAdapter.
Parameters:
req - HttpServletRequest
prop - TypedProperties
Returns:
boolean - true if the adapter can handle this request - false if the adapter cannot handle this request.

createAdapter

public HttpAdapter createAdapter(HttpServletRequest _req,
                                 HttpServletResponse _resp,
TypedProperty _prop)
Reserved for IBM internal use. This method returns an instance of the adapter if the request has the correct format
Parameters:
_req - the HTTP request object.
_resp - the HTTP response object.
_prop - the request properties.
Returns:
An object that is an instance of HttpAdapter that can handle the request or null.

createSessionContext

public HttpSessionContext createSessionContext()
                                        throws ECException
Reserved for IBM internal use. Creates an HttpSessionContext for the browser.
ECException

getDocumentPathName

public java.lang.String getDocumentPathName(java.lang.String name)
Reserved for IBM internal use. Gets the actual output document name based on a base document name.
Specified by:
getDocumentPathName in interface DeviceFormatAdapter
Overrides:
getDocumentPathName in class AbstractHttpAdapter
Parameters:
name - the base document name.
Returns:
The base document name given.

getSessionContext

public SessionContext getSessionContext()
                                 throws ECException
Reserved for IBM internal use. Gets the session context.
Returns:
SessionContext
Throws:
ECException - if there was a problem retrieving the session context.

httpsRedirection

public boolean httpsRedirection()
Reserved for IBM internal use. Returns true if secure command needs to be run under https. This methd always returns true for HttpBrowserAdapter.
Returns:
Whether the request must be made via HTTPS.

postInvokeCommand

public void postInvokeCommand(CommandContext commandContext)
Reserved for IBM internal use. This method implements adapter specific function after the execution of a command.
Parameters:
commandContext - CommandContext - the command context associated with the command.
Throws:
ECException

preInvokeCommand

public boolean preInvokeCommand(CommandContext commandContext)
Reserved for IBM internal use. This method implements adapter specific function before the execution of a command. Also executes session management security checks.
Parameters:
commandContext - CommandContext - the command context associated with the command.
Returns:
Whether to continue with the execution of the request.
Throws:
ECException

preprocessRequest

public HttpControllerRequestObject preprocessRequest()
Reserved for IBM internal use. Builds up the HttpControllerRequest object based on current HttpRequest and executes some session management specific security checks.
Specified by:
preprocessRequest in interface HttpAdapter
Overrides:
preprocessRequest in class AbstractHttpAdapter
Returns:
A controller request object that represents the HTTP request.

singleton

public static HttpBrowserAdapter singleton()
Reserved for IBM internal use. Returns a singleton instance of this object.

processCrossSiteScriptingProtection

protected HttpControllerRequestObject processCrossSiteScriptingProtection(HttpControllerRequestObject obj)
Reserved for IBM internal use.

handleLoginTimeout

protected HttpControllerRequestObject handleLoginTimeout(HttpControllerRequestObject obj,
CommandContext commandContext)
Reserved for IBM internal use.

handlePasswordRerequestSupport

protected HttpControllerRequestObject handlePasswordRerequestSupport(HttpControllerRequestObject obj)
Reserved for IBM internal use.

validatePasswordForPasswordProtectedRequest

protected void validatePasswordForPasswordProtectedRequest(CommandContext commandContext)
Reserved for IBM internal use.

handlePasswordInvalidation

protected HttpControllerRequestObject handlePasswordInvalidation(HttpControllerRequestObject obj)
Reserved for IBM internal use.

isDoubleClickHandlerEnabled

public boolean isDoubleClickHandlerEnabled()
Reserved for IBM internal use. Returns true if double click handler is enabled for this adapter type. Returns false otherwise.
Specified by:
isDoubleClickHandlerEnabled in interface HttpAdapter
Overrides:
isDoubleClickHandlerEnabled in class AbstractHttpAdapter
Returns:
returns double click enabled flag.

getUniqueIdentifier

public java.lang.String getUniqueIdentifier()
Reserved for IBM internal use.
Specified by:
getUniqueIdentifier in interface HttpAdapter
Overrides:
getUniqueIdentifier in class AbstractHttpAdapter
Returns:
Always will return null.
See Also:
HttpAdapter.getUniqueIdentifier()