com.ibm.commerce.pvcadapter
Interface PVCAdapter

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

public interface PVCAdapter
extends HttpAdapter

Interface for pervasive computing (PvC) Adapters.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
 
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 identifier 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 identifier 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 identifier.
 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 the descriptor of the HTTP adapter.
 void setDeviceModel(java.lang.String val)
          Sets the model name of the device.
 void setPVCAdapterDesc( PVCAdapterDesc val)
          Sets the description of the PvC adapter.
 void setPvcSessionId(java.lang.Long newPvcSessionId)
          Sets the session identifier used for session control used by the adapter.
 void setStoreId(java.lang.Integer storeId)
          Sets the store identifier to the adapter.
 void setTerminalId(java.lang.String val)
          Sets the terminal identifier for this device.
 boolean userHasTimedout()
          Checks if logon has timed out.
 
Methods inherited from interface com.ibm.commerce.adapter. HttpAdapter
getRequest, getRequestName, getRequestProperties, getResponse, getUniqueIdentifier, httpsRedirection, isDoubleClickHandlerEnabled, 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
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values
Method Detail

checkDeviceFormat

public boolean checkDeviceFormat(javax.servlet.http.HttpServletRequest req,
TypedProperty prop)
Return the terminal identifier for this device.
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:
the buffer timeout value.

getDeviceModel

public java.lang.String getDeviceModel()
Extracts the PvC device model information from the HTTP request object.
Returns:
The device model of the request.

getLogonTimeout

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

getPVCAdapterDesc

public PVCAdapterDesc getPVCAdapterDesc()
Return the terminal ID for this device.
Returns:
The desciption of the PvC adapter.

getPVCDeviceModelAccessBean

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

getPVCDeviceSpecAccessBean

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

getPVCSessionAccessBean

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

getPvcSessionId

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

getRegistrationMode

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

getTerminalId

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

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.
Throws:
ECException - whether there is a problem validating the logon.

setAdapterDesc

public void setAdapterDesc(HttpAdapterDesc val)
Sets the descriptor of the HTTP adapter.
Specified by:
setAdapterDesc in interface HttpAdapter
Parameters:
val - the descriptor of the HttpAdapter.

setDeviceModel

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

setPVCAdapterDesc

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

setPvcSessionId

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

setStoreId

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

setTerminalId

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

userHasTimedout

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