java.lang.Object | +--com.ibm.commerce.adapter.DeviceFormatAdapterDesc | +--com.ibm.commerce.adapter.HttpAdapterDesc | +--com.ibm.commerce.pvcadapter.PVCAdapterDesc
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
public static final java.lang.String REGMODE
public static final java.lang.String LOGON_TIMEOUT
public static final java.lang.String BUFFER_TIMEOUT
protected java.util.Vector ips
protected java.util.Hashtable specialCommands
protected java.lang.String regMode
protected java.lang.Integer bufferTimeout
protected java.lang.Integer logonTimeout
Constructor Detail |
---|
public PVCAdapterDesc()
Method Detail |
---|
public boolean checkGatewayIP(java.lang.String ip)
ip
- the specified IP address to compare.public java.lang.Integer getBufferTimeout()
public java.util.Vector getIps()
public java.lang.Integer getLogonTimeout()
public java.lang.String getRegMode()
public void init(org.w3c.dom.Element node) throws java.lang.Exception
init
in class
DeviceFormatAdapterDesc
node
- Node which contains adapter informationjava.lang.Exception
- if there is a problem
initializing.public void initialize(org.w3c.dom.Element adapterNode) throws java.lang.Exception
adapterNode
- the adapter configuration.java.lang.Exception
- if there is a problem with
initialization.public boolean isExcludeCommand(java.lang.String name)
name
- the name of the command.public boolean isRelogonCommand(java.lang.String name)
name
- the name of the command.public void setBufferTimeout(java.lang.Integer newBufferTimeout)
newBufferTimeout
- the buffer timeout
value.public final void setIps(java.util.Vector value)
public void setLogonTimeout(java.lang.Integer newLogonTimeout)
newLogonTimeout
- the logon timeout value.public void setRegMode(java.lang.String newRegMode)
newRegMode
- the registration mode.