java.lang.Objectcom.ibm.commerce.adapter.AbstractHttpAdapter
com.ibm.commerce.pvcadapter.PVCAdapterImpl
Base implementaion of the pervasive computing (PvC) adapter. Subclasses should implements abstract method provided by PVCAdapterImpl.
To install PvC adapters, insert following tags into XML configuration file. The tag HttpAdapters is located at the end of the configuraiton file.
<!-- The adapter can exculdes listed commands-->
<ExcludeCommands>
<!-- The adapter can request user to reenter password to execute commands -->
<RelogonCommands>
<HttpAdapter>
... <!-- You can install multiple adapters --> </HttpAdapter> </HttpAdapters>UniqueIdentifier
Unique name to identify each adapters. Value must be shorter than length of PVCSESSION.SESSIONTYPE table. DeviceFormatId Specify device format id of the adapter. The device format needs to be listed in DEVICEFORMAT table. DeviceFormatType Specify name of the device format. DeviceFormatTypeId Specify device format id an adapter with which the adapter shares entries in VIEWREG table. If you wish to separate entires in VIEWREG table with PC browser, you can speficy same device format ID as PC browser. ClassNameOfTheAdapter Specify name of the adapter class. RegistrationMode Specify registration mode from followings.Field Summary | |
static java.lang.String | COPYRIGHT IBM Copyright notice field. |
protected static java.lang.String | DEFAULT_MODELNAME |
protected java.lang.String | deviceModel |
protected PVCDeviceModelAccessBean | modelBean |
protected PVCAdapterDesc | pvcdesc |
protected java.lang.Long | pvcSessionId |
protected PVCSessionAccessBean | sessionAccessBean |
protected SessionContext | sessionContext |
protected PVCDeviceSpecAccessBean | specAccessBean |
static java.lang.Integer | STATUS_LOGOFF Value used in PVCSESSION to indicate that the PVC device user is logoff status. |
static java.lang.Integer | STATUS_LOGON Value used in PVCSESSION to indicate that the PVC device user is logon status. |
protected java.lang.Integer | storeId |
protected java.lang.String | terminalId |
protected UserPVCDeviceAccessBean | userDeviceAccessBean |
Fields inherited from class com.ibm.commerce.adapter.AbstractHttpAdapter |
desc, encoding, req, reqObj, requestProperties, resp |
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 | |
PVCAdapterImpl() |
Method Summary | |
HttpAdapter | createAdapter(HttpServletRequest req, HttpServletResponse resp, TypedProperty prop) Checks to see if the HttpServletRequest data is in this device format. |
HttpAdapterDesc | getAdapterDesc() Return the descriptor of the adapter. |
java.lang.Integer | getBufferTimeout() Gets buffer timeout value applied to the adapter from XML configuration file. |
abstract java.lang.String | getDeviceModel() Gets the model name from the request. |
java.lang.String | getDocumentPathName(java.lang.String name) Gets the actual output document name based on a base document name. |
java.lang.Integer | getLogonTimeout() Gets the timeout value applied for the adapter from XML configuration file. |
PVCAdapterDesc | getPVCAdapterDesc() Gets the descriptor of the PvC adapter |
PVCDeviceModelAccessBean | getPVCDeviceModelAccessBean() Returns the access bean which contains model information of the device. |
PVCDeviceSpecAccessBean | getPVCDeviceSpecAccessBean() Returns the access bean which contains spec information of the device. |
PVCSessionAccessBean | getPVCSessionAccessBean() Returns the access bean which contains session information of the device. |
java.lang.Long | getPvcSessionId() Returns session identifier used for session control using the adapter. |
java.lang.String | getRegistrationMode() Returns retgistrationMode of the adapter in XML configuration file. |
SessionContext | getSessionContext() Returns session context necessary for session control. |
java.lang.Integer | getStoreId() Returns the store identifier in the request. |
abstract java.lang.String | getTerminalId() Gets the terminal identifier sent by the wireless gateway. |
UserPVCDeviceAccessBean | getUserPVCDeviceAccessBean() Returns access bean of the client's device information in USERPVCDEV table. |
boolean | httpsRedirection() Check to see if the adapter can support HTTP -> HTTPS redirection |
void | initFactory(org.w3c.dom.Element node) Initialize the Adapter based on the informtion defined in the node. |
boolean | isExcludeCommand(java.lang.String value) Returns true if the named command is excluded for for this adapater. |
boolean | isRelogonCommand(java.lang.String value) Returns true if the named command required a relogon for this adapater. |
void | postInvokeCommand(CommandContext commandContext) Does necessary processes after invoking command. |
boolean | preInvokeCommand(CommandContext commandContext) Does necessary process before invoking command. |
HttpControllerRequestObject | preprocessRequest() This method preprocess the request and return a controller request object. |
void | setDeviceModel(java.lang.String value) Sets the model name of the device. |
void | setPVCAdapterDesc(PVCAdapterDesc value) Sets the descriptor of the PVCAdapter. |
void | setPvcSessionId(java.lang.Long newPvcSessionId) Sets the session identifier necessary for session control using PvC adapter. |
void | setStoreId(java.lang.Integer storeId) Sets the store identifier to the adapter. |
void | setTerminalId(java.lang.String value) Sets the terminal identifier sent by the carrier to the adapter. |
boolean | userHasTimedout() This method checks to see if a PvC user has timed out. |
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.pvcadapter.PVCAdapter |
checkDeviceFormat, setAdapterDesc |
Methods inherited from interface com.ibm.commerce.adapter.HttpAdapter |
getRequest, getRequestName, getRequestProperties, getResponse, getUniqueIdentifier, isDoubleClickHandlerEnabled, processRequest, setRequest, setRequestProperties, setResponse |
Methods inherited from interface com.ibm.commerce.adapter.DeviceFormatAdapter |
getDefaultDeviceFormatId, getDeviceFormatId, getDeviceFormatName, getDeviceFormatType, getDeviceFormatTypeId, processErrorResponse, processResponse, setDefaultDeviceFormatId, setDeviceFormatId, setDeviceFormatName, setDeviceFormatType, setDeviceFormatTypeId |
Methods inherited from interface com.ibm.commerce.adapter.HttpAdapterFactory |
checkDeviceFormat |
Field Detail |
public static final java.lang.String COPYRIGHT
protected PVCAdapterDesc pvcdesc
protected java.lang.String deviceModel
protected java.lang.String terminalId
protected SessionContext sessionContext
protected PVCDeviceModelAccessBean modelBean
protected PVCDeviceSpecAccessBean specAccessBean
protected UserPVCDeviceAccessBean userDeviceAccessBean
protected java.lang.Integer storeId
protected java.lang.Long pvcSessionId
protected PVCSessionAccessBean sessionAccessBean
protected static java.lang.String DEFAULT_MODELNAME
public static final java.lang.Integer STATUS_LOGON
public static final java.lang.Integer STATUS_LOGOFF
Constructor Detail |
public PVCAdapterImpl()
Method Detail |
public HttpAdapter createAdapter(HttpServletRequest req, HttpServletResponse resp, TypedProperty prop)
public HttpAdapterDesc getAdapterDesc()
public java.lang.Integer getBufferTimeout()
public abstract java.lang.String getDeviceModel()
public java.lang.String getDocumentPathName(java.lang.String name)
public java.lang.Integer getLogonTimeout()
public final PVCAdapterDesc getPVCAdapterDesc()
public PVCDeviceModelAccessBean getPVCDeviceModelAccessBean()
public PVCDeviceSpecAccessBean getPVCDeviceSpecAccessBean()
public PVCSessionAccessBean getPVCSessionAccessBean()
public java.lang.Long getPvcSessionId()
public java.lang.String getRegistrationMode()
public SessionContext getSessionContext() throws ECException
public java.lang.Integer getStoreId()
public abstract java.lang.String getTerminalId()
public UserPVCDeviceAccessBean getUserPVCDeviceAccessBean()
public boolean httpsRedirection()
public void initFactory(org.w3c.dom.Element node) throws java.lang.Exception
public final boolean isExcludeCommand(java.lang.String value)
public final boolean isRelogonCommand(java.lang.String value) throws ECException
public void postInvokeCommand(CommandContext commandContext) throws ECException
public boolean preInvokeCommand(CommandContext commandContext) throws ECException
public HttpControllerRequestObject preprocessRequest()
public final void setDeviceModel(java.lang.String value)
public final void setPVCAdapterDesc(PVCAdapterDesc value)
public void setPvcSessionId(java.lang.Long newPvcSessionId)
public void setStoreId(java.lang.Integer storeId)
public final void setTerminalId(java.lang.String value)
public boolean userHasTimedout()
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.