public abstract class PVCAdapterImpl extends com.ibm.commerce.adapter.AbstractHttpAdapter implements PVCAdapter
<!-- All PvC adapter should be listed as a HttpAdapter in HttpAdapters tag --></HttpAdapters>
<HttpAdaptername = "UniqueIdentifier">
deviceFormatId = "DeviceFormatId"
deviceFormatType = "DeviceFormatType"
deviceFormatTypeId = "DeviceFormatTypeId"
factoryClassname="ClassNameOfTheAdapter"
enabled="true"<!-- PvC adapters should provide following information --></HttpAdapter>
<PVCAdapterregistrationMode="RegistrationMode">
preferredLogonTimeout="LogonTimeout"
bufferTimeout="BufferTimeout"<!-- The adapter accepts access from following address--></PVCAdapter>
<IPCheck> <!-- If you don't need address check, do not specify IPCheck tag --><IP type="TypeOfTheAddress" value="Address"/></IPCheck>
...
<IP type="TypeOfTheAddress" value="Address"/><!-- The adapter can excludes listed commands-->
<ExcludeCommands><!-- List commands the adapter should not execute--></ExcludeCommands>
<Command name="CommandName"/>
...
<Command name="CommandName"/><!-- The adapter can request user to reenter password to execute commands -->
<RelogonCommands><!-- List commands the adapter needs password --></RelogonCommands>
<Command name="CommandName"/>
...
<Command name="CommandName"/><HttpAdapter>
... <!-- You can install multiple adapters --></HttpAdapter>
UniqueIdentifier
Unique name to identify each adapters. Value must be shorter than length of the PVCSESSION.SESSIONTYPE column.DeviceFormatId
Specify device format id of the adapter.
The device format needs to be listed in the DEVICEFORMAT
table.
DeviceFormatType
Specify name of the device format.DeviceFormatTypeId
Specify the device format id of an adapter with which the adapter shares entries in the VIEWREG table. If you wish to separate entries in VIEWREG table with PC browser, you can specify same device format ID as PC browser.ClassNameOfTheAdapter
Specify name of the adapter class.RegistrationMode
Specify registration mode from followings.LogonTimeout
0: Unlimited
1: Users need to register device information to login to WebSphere Commerce server using their device
2: Users need to register device information to login to the WebSphere Commerce server using their device. One user can register only one device to login to WebSphere Commerce server.
Time to logon expires. Specify value in minutesBufferTimeout
Time to buffered parameters are revoked. Specify value in minutesTypeOfTheAddress
Type of the address. The value is net or hostCommandName
net: Specified Address is network address
host: Specified Address is host address
Name of a targetable command
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
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.
|
Constructor and Description |
---|
PVCAdapterImpl() |
Modifier and Type | Method and Description |
---|---|
com.ibm.commerce.adapter.HttpAdapter |
createAdapter(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
TypedProperty prop)
Checks to see if the HttpServletRequest data is in this device format.
|
com.ibm.commerce.adapter.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.
|
com.ibm.commerce.adapter.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()
Checks to see if the adapter can support HTTP to HTTPS redirection.
|
void |
initFactory(org.w3c.dom.Element node)
Initialize the Adapter based on the information defined in the node.
|
boolean |
isExcludeCommand(java.lang.String value)
Returns true if the named command is excluded for this adapter.
|
boolean |
isRelogonCommand(java.lang.String value)
Returns true if the named command required a relogon for this adapter.
|
void |
postInvokeCommand(CommandContext commandContext)
Does necessary processes after invoking command.
|
boolean |
preInvokeCommand(CommandContext commandContext)
Does necessary process before invoking command.
|
com.ibm.commerce.webcontroller.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.
|
displayGenericErrorView, getContextPath, getDefaultDeviceFormatId, getDeviceFormatId, getDeviceFormatName, getDeviceFormatType, getDeviceFormatTypeId, getOrigReqName, getRequest, getRequestName, getRequestObject, getRequestProperties, getRequestURI, getResponse, getResponseObject, getUniqueIdentifier, httpRedirection, isDoubleClickHandlerEnabled, isEnabled, preInvokeAjaxCommand, preInvokeCommand, processErrorResponse, processRequest, processRequest, processResponse, setAdapterDesc, setDefaultDeviceFormatId, setDeviceFormatClass, setDeviceFormatId, setDeviceFormatName, setDeviceFormatType, setDeviceFormatTypeId, setOrigReqName, setRequest, setRequestProperties, setResponse
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
checkDeviceFormat, setAdapterDesc
getContextPath, getRequest, getRequestName, getRequestObject, getRequestProperties, getRequestURI, getResponse, getResponseObject, getUniqueIdentifier, isDoubleClickHandlerEnabled, preInvokeAjaxCommand, preInvokeCommand, processRequest, processRequest, setRequest, setRequestProperties, setResponse
getDefaultDeviceFormatId, getDeviceFormatId, getDeviceFormatName, getDeviceFormatType, getDeviceFormatTypeId, processErrorResponse, processResponse, setDefaultDeviceFormatId, setDeviceFormatId, setDeviceFormatName, setDeviceFormatType, setDeviceFormatTypeId
public static final java.lang.String COPYRIGHT
public static final java.lang.Integer STATUS_LOGON
public static final java.lang.Integer STATUS_LOGOFF
public com.ibm.commerce.adapter.HttpAdapter createAdapter(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, TypedProperty prop)
createAdapter
in interface com.ibm.commerce.adapter.HttpAdapterFactory
request
- the HTTP request.response
- the HTTP response.requestProperties
- the request properties.public com.ibm.commerce.adapter.HttpAdapterDesc getAdapterDesc()
getAdapterDesc
in interface com.ibm.commerce.adapter.HttpAdapter
getAdapterDesc
in interface com.ibm.commerce.adapter.HttpAdapterFactory
getAdapterDesc
in interface PVCAdapter
getAdapterDesc
in class com.ibm.commerce.adapter.AbstractHttpAdapter
public java.lang.Integer getBufferTimeout()
getBufferTimeout
in interface PVCAdapter
public abstract java.lang.String getDeviceModel()
getDeviceModel
in interface PVCAdapter
public java.lang.String getDocumentPathName(java.lang.String name)
CONTENTDIR
in the PVCDEVSPEC table
in front of requested document path.getDocumentPathName
in interface com.ibm.commerce.adapter.DeviceFormatAdapter
getDocumentPathName
in class com.ibm.commerce.adapter.AbstractHttpAdapter
base
- the base document name.public java.lang.Integer getLogonTimeout()
getLogonTimeout
in interface PVCAdapter
public final PVCAdapterDesc getPVCAdapterDesc()
getPVCAdapterDesc
in interface PVCAdapter
public PVCDeviceModelAccessBean getPVCDeviceModelAccessBean()
getPVCDeviceModelAccessBean
in interface PVCAdapter
public PVCDeviceSpecAccessBean getPVCDeviceSpecAccessBean()
getPVCDeviceSpecAccessBean
in interface PVCAdapter
public PVCSessionAccessBean getPVCSessionAccessBean()
getPVCSessionAccessBean
in interface PVCAdapter
public java.lang.Long getPvcSessionId()
getPvcSessionId
in interface PVCAdapter
public java.lang.String getRegistrationMode()
getRegistrationMode
in interface PVCAdapter
public com.ibm.commerce.adapter.SessionContext getSessionContext() throws ECException
getSessionContext
in interface com.ibm.commerce.adapter.DeviceFormatAdapter
ECException
- if there is a problem getting the session context.public java.lang.Integer getStoreId()
public abstract java.lang.String getTerminalId()
getTerminalId
in interface PVCAdapter
public UserPVCDeviceAccessBean getUserPVCDeviceAccessBean()
public boolean httpsRedirection()
httpsRedirection
in interface com.ibm.commerce.adapter.HttpAdapter
public void initFactory(org.w3c.dom.Element node) throws java.lang.Exception
initFactory
in interface com.ibm.commerce.adapter.HttpAdapterFactory
initFactory
in class com.ibm.commerce.adapter.AbstractHttpAdapter
node
- the adapter configuration.java.lang.Exception
- if there is a problem initializing.public final boolean isExcludeCommand(java.lang.String value)
isExcludeCommand
in interface PVCAdapter
name
- the name of the commandpublic final boolean isRelogonCommand(java.lang.String value) throws ECException
isRelogonCommand
in interface PVCAdapter
name
- the name of the commandECException
- whether there is a problem validating the logon.public void postInvokeCommand(CommandContext commandContext) throws ECException
postInvokeCommand
in interface com.ibm.commerce.adapter.DeviceFormatAdapter
commandContext
- Context of the commandECException
- will never happen because this method does nothing.public boolean preInvokeCommand(CommandContext commandContext) throws ECException
preInvokeCommand
in interface com.ibm.commerce.adapter.DeviceFormatAdapter
commandContext
- Context of the commandECException
- if there is a problem with the pre-invoke.public com.ibm.commerce.webcontroller.HttpControllerRequestObject preprocessRequest()
preprocessRequest
in interface com.ibm.commerce.adapter.HttpAdapter
preprocessRequest
in class com.ibm.commerce.adapter.AbstractHttpAdapter
public final void setDeviceModel(java.lang.String value)
setDeviceModel
in interface PVCAdapter
value
- the model name.public final void setPVCAdapterDesc(PVCAdapterDesc value)
setPVCAdapterDesc
in interface PVCAdapter
val
- the descriptor of the PVCAdapterpublic void setPvcSessionId(java.lang.Long newPvcSessionId)
setPvcSessionId
in interface PVCAdapter
newPvcSessionId
- the session identifier.public void setStoreId(java.lang.Integer storeId)
setStoreId
in interface PVCAdapter
storeId
- the store identifier.public final void setTerminalId(java.lang.String value)
setTerminalId
in interface PVCAdapter
value
- the terminal identifier.public boolean userHasTimedout()
userHasTimedout
in interface PVCAdapter