com.ibm.commerce.pvcadapter
Interface PVCAdapter

All Superinterfaces:
DeviceFormatAdapter, HttpAdapter
All Known Implementing Classes:
PVCAdapterImpl

public interface PVCAdapter
extends HttpAdapter

Interface of pervasive computing(PvC) Adapters


Field Summary
static java.lang.String COPYRIGHT
           
 
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
 
Method Summary
 boolean checkDeviceFormat(javax.servlet.http.HttpServletRequest req, TypedProperty prop)
          Return the terminal id for this device.
 HttpAdapterDesc getAdapterDesc()
          Return the terminal id for this device.
 java.lang.Integer getBufferTimeout()
          Return buffer timeout value applied for PvC devices controled by the adapter
 java.lang.String getDeviceModel()
          Extracts the pvc device model information from the Http request object.
 java.lang.Integer getLogonTimeout()
          Return logon timeout value for PvC devices controled by the adapter
 PVCAdapterDesc getPVCAdapterDesc()
          Return the terminal id for this device.
 PVCDeviceModelAccessBean getPVCDeviceModelAccessBean()
          Return the access bean which contains model information of the device.
 PVCDeviceSpecAccessBean getPVCDeviceSpecAccessBean()
          Return the accessbean which contains spec information of the device.
 PVCSessionAccessBean getPVCSessionAccessBean()
          Return the accessbean which contains session information of the device.
 java.lang.Long getPvcSessionId()
          Return the session ID of the PvC device
 java.lang.String getRegistrationMode()
          Return the registration mode of the adapter in XML configuration file
 java.lang.String getTerminalId()
          Return the terminal ID sent by the wireless carrier.
 boolean isExcludeCommand(java.lang.String value)
          Checks if the command is not executable for the adapter.
 boolean isRelogonCommand(java.lang.String value)
          Checks if the command is protected command for the adapter.
 void setAdapterDesc(HttpAdapterDesc val)
          Sets description of the HttpAdapter.
 void setDeviceModel(java.lang.String val)
          Sets model name of the device.
 void setPVCAdapterDesc(PVCAdapterDesc val)
          Sets description of the PVCAdapter.
 void setPvcSessionId(java.lang.Long newPvcSessionId)
          Sets session ID used for session control used by the adapter.
 void setStoreId(java.lang.Integer storeId)
          Sets store ID to the adapter.
 void setTerminalId(java.lang.String val)
          Sets the terminal id for this device.
 boolean userHasTimedout()
          Checks if logon has timed out.
 
Methods inherited from interface com.ibm.commerce.adapter.HttpAdapter
getRequest, getRequestName, getRequestProperties, getResponse, httpsRedirection, preprocessRequest, processRequest, setRequest, setRequestProperties, setResponse
 
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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

checkDeviceFormat

public boolean checkDeviceFormat(javax.servlet.http.HttpServletRequest req,
                                 TypedProperty prop)
Return the terminal id for this device.
Parameters:
javax.servlet.http.HttpServletRequest - Servlet request
com.ibm.commerce.datatype.TypedProperty - Request properties
Returns:
true if the session can be handled by the adapter; false otherwise

getAdapterDesc

public HttpAdapterDesc getAdapterDesc()
Return the terminal id for this device.
Specified by:
getAdapterDesc in interface HttpAdapter
Returns:
Description of the http adapter

getBufferTimeout

public java.lang.Integer getBufferTimeout()
Return buffer timeout value applied for PvC devices controled by the adapter
Returns:
Buffer timeout value

getDeviceModel

public java.lang.String getDeviceModel()
Extracts the pvc device model information from the Http request object.
Parameters:
req - javax.servlet.http.HttpServletRequest
prop - com.ibm.commerce.datatype.TypedProperty
Returns:
java.lang.String

getLogonTimeout

public java.lang.Integer getLogonTimeout()
Return logon timeout value for PvC devices controled by the adapter
Returns:
Logon timeout value

getPVCAdapterDesc

public PVCAdapterDesc getPVCAdapterDesc()
Return the terminal id for this device.
Returns:
Desciption of the PVC adapter

getPVCDeviceModelAccessBean

public PVCDeviceModelAccessBean getPVCDeviceModelAccessBean()
Return the access bean which contains model information of the device.
Returns:
Model information of the device

getPVCDeviceSpecAccessBean

public PVCDeviceSpecAccessBean getPVCDeviceSpecAccessBean()
Return the accessbean which contains spec information of the device.
Returns:
Specification of the device

getPVCSessionAccessBean

public PVCSessionAccessBean getPVCSessionAccessBean()
Return the accessbean which contains session information of the device.
Returns:
Session infomation of the device

getPvcSessionId

public java.lang.Long getPvcSessionId()
Return the session ID of the PvC device
Returns:
PVC session ID

getRegistrationMode

public java.lang.String getRegistrationMode()
Return the registration mode of the adapter in XML configuration file
Returns:
Registration mode

getTerminalId

public java.lang.String getTerminalId()
Return the terminal ID sent by the wireless carrier.
Returns:
terminal ID

isExcludeCommand

public boolean isExcludeCommand(java.lang.String value)
Checks if the command is not executable for the adapter.
Returns:
true if the command is executable for the adapter; false otherwise

isRelogonCommand

public boolean isRelogonCommand(java.lang.String value)
                         throws ECException
Checks if the command is protected command for the adapter. If the command is protected registered users are required to reenter their password to execute the command.
Returns:
true if the command is password protected; false otherwise

setAdapterDesc

public void setAdapterDesc(HttpAdapterDesc val)
Sets description of the HttpAdapter.
Specified by:
setAdapterDesc in interface HttpAdapter
Parameters:
val - desciption of the HttpAdapter

setDeviceModel

public void setDeviceModel(java.lang.String val)
Sets model name of the device.
Parameters:
val - Model name

setPVCAdapterDesc

public void setPVCAdapterDesc(PVCAdapterDesc val)
Sets description of the PVCAdapter.
Parameters:
val - desciption of the PVCAdapter

setPvcSessionId

public void setPvcSessionId(java.lang.Long newPvcSessionId)
Sets session ID used for session control used by the adapter.
Parameters:
newPvcSessionId - Session ID used

setStoreId

public void setStoreId(java.lang.Integer storeId)
Sets store ID to the adapter.
Parameters:
storeId - Store ID

setTerminalId

public void setTerminalId(java.lang.String val)
Sets the terminal id for this device.
Parameters:
val - Terminal id

userHasTimedout

public boolean userHasTimedout()
Checks if logon has timed out.
Returns:
true if logon has timed out; false otherwise