com.ibm.commerce.pvcadapter
Class PVCAdapterDesc

java.lang.Object
  |
  +--com.ibm.commerce.adapter.DeviceFormatAdapterDesc
        |
        +--com.ibm.commerce.adapter.HttpAdapterDesc
              |
              +--com.ibm.commerce.pvcadapter.PVCAdapterDesc

public class PVCAdapterDesc
extends HttpAdapterDesc

This class contains the basic attributes that describes a pervasive computing (PvC) Adapter. These attributes are extracted from the config file.


Field Summary
static java.lang.String BUFFER_TIMEOUT
          Name of the element in XML configuration file which defines timeout value of buffered parameters.
protected  java.lang.Integer bufferTimeout
           
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
protected  java.util.Vector ips
           
static java.lang.String LOGON_TIMEOUT
          Name of the element in XML configuration file which defines logon timeout.
protected  java.lang.Integer logonTimeout
           
protected  java.lang.String regMode
           
static java.lang.String REGMODE
          Name of the element in XML configuration file which defines PvC registration mode.
protected  java.util.Hashtable specialCommands
           
 
Fields inherited from class com.ibm.commerce.adapter. DeviceFormatAdapterDesc
DEVFMT_ENABLED, DEVFMT_FACTORYCLASSNAME, DEVFMT_ID, DEVFMT_NAME, DEVFMT_TYPE, DEVFMT_TYPEID, devfmtClass, devfmtId, devfmtName, devfmtType, devfmtTypeId, isEnabled
 
Constructor Summary
PVCAdapterDesc()
           
 
Method Summary
 boolean checkGatewayIP(java.lang.String ip)
          Compares specified IP address with possible client addresses listed in XML configuration file.
 java.lang.Integer getBufferTimeout()
          Gets buffer timeout value for the adapter.
 java.util.Vector getIps()
          Gets elements of IPCheck tag for the adapter in the XML configuration file.
 java.lang.Integer getLogonTimeout()
          Gets logon timeout value of the adapter.
 java.lang.String getRegMode()
          Gets registration mode of the adapter in the XML configuraiton file.
 void init(org.w3c.dom.Element node)
          Loads adapter configuration from HTTPAdapter tag in the XML configuration file.
 void initialize(org.w3c.dom.Element adapterNode)
          Loads PvC adapter description from specified node.
 boolean isExcludeCommand(java.lang.String name)
          Returns true if the named command is excluded for for this adapater.
 boolean isRelogonCommand(java.lang.String name)
          Returns true if the named command required a relogon for this adapater.
 void setBufferTimeout(java.lang.Integer newBufferTimeout)
          Sets the timeout value for buffered parameters.
 void setIps(java.util.Vector value)
          Sets the list of possible client address.
 void setLogonTimeout(java.lang.Integer newLogonTimeout)
          Sets the logon timeout value.
 void setRegMode(java.lang.String newRegMode)
          Sets the registration mode of the adapter.
 
Methods inherited from class com.ibm.commerce.adapter. DeviceFormatAdapterDesc
getDeviceFormatClass, getDeviceFormatId, getDeviceFormatName, getDeviceFormatType, getDeviceFormatTypeId, isEnabled, setDeviceFormatClass, setDeviceFormatId, setDeviceFormatName, setDeviceFormatType, setDeviceFormatTypeId, setIsEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

REGMODE

public static final java.lang.String REGMODE
Name of the element in XML configuration file which defines PvC registration mode.
See Also:
Constant Field Values

LOGON_TIMEOUT

public static final java.lang.String LOGON_TIMEOUT
Name of the element in XML configuration file which defines logon timeout.
See Also:
Constant Field Values

BUFFER_TIMEOUT

public static final java.lang.String BUFFER_TIMEOUT
Name of the element in XML configuration file which defines timeout value of buffered parameters.
See Also:
Constant Field Values

ips

protected java.util.Vector ips

specialCommands

protected java.util.Hashtable specialCommands

regMode

protected java.lang.String regMode

bufferTimeout

protected java.lang.Integer bufferTimeout

logonTimeout

protected java.lang.Integer logonTimeout
Constructor Detail

PVCAdapterDesc

public PVCAdapterDesc()
Method Detail

checkGatewayIP

public boolean checkGatewayIP(java.lang.String ip)
Compares specified IP address with possible client addresses listed in XML configuration file.
Parameters:
ip - the specified IP address to compare.
Returns:
true if the address is valued address; false otherwise.

getBufferTimeout

public java.lang.Integer getBufferTimeout()
Gets buffer timeout value for the adapter.
Returns:
The buffer timeout value.

getIps

public java.util.Vector getIps()
Gets elements of IPCheck tag for the adapter in the XML configuration file.
Returns:
The list of IP address.

getLogonTimeout

public java.lang.Integer getLogonTimeout()
Gets logon timeout value of the adapter.
Returns:
The logon timeout value.

getRegMode

public java.lang.String getRegMode()
Gets registration mode of the adapter in the XML configuraiton file.
Returns:
The registration mode.

init

public void init(org.w3c.dom.Element node)
          throws java.lang.Exception
Loads adapter configuration from HTTPAdapter tag in the XML configuration file.
Overrides:
init in class DeviceFormatAdapterDesc
Parameters:
node - Node which contains adapter information
Throws:
java.lang.Exception - if there is a problem initializing.

initialize

public void initialize(org.w3c.dom.Element adapterNode)
                throws java.lang.Exception
Loads PvC adapter description from specified node. This method loads following elements from PVCAdapter node.
Parameters:
adapterNode - the adapter configuration.
Throws:
java.lang.Exception - if there is a problem with initialization.

isExcludeCommand

public boolean isExcludeCommand(java.lang.String name)
Returns true if the named command is excluded for for this adapater.
Parameters:
name - the name of the command.
Returns:
true if this commmand is excluded; false if this command is not excluded.

isRelogonCommand

public boolean isRelogonCommand(java.lang.String name)
Returns true if the named command required a relogon for this adapater.
Parameters:
name - the name of the command.
Returns:
true if this commmand requires a relogon; false if this command does not requires a relogon.

setBufferTimeout

public void setBufferTimeout(java.lang.Integer newBufferTimeout)
Sets the timeout value for buffered parameters.
Parameters:
newBufferTimeout - the buffer timeout value.

setIps

public final void setIps(java.util.Vector value)
Sets the list of possible client address.

setLogonTimeout

public void setLogonTimeout(java.lang.Integer newLogonTimeout)
Sets the logon timeout value.
Parameters:
newLogonTimeout - the logon timeout value.

setRegMode

public void setRegMode(java.lang.String newRegMode)
Sets the registration mode of the adapter.
Parameters:
newRegMode - the registration mode.