Field Detail

• COPYRIGHT

  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
  

  The list of IP addresses.

• specialCommands

  protected java.util.Hashtable specialCommands
  

  Commands to exclude when made from this adapter.

• regMode

  protected java.lang.String regMode
  

  The registration mode.

• bufferTimeout

  protected java.lang.Integer bufferTimeout
  

  The buffer timeout.

• logonTimeout

  protected java.lang.Integer logonTimeout
  

  The logon timeout.

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 configuration 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 com.ibm.commerce.adapter.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.

  • registrationMode
  • preferedLogonTimeout
  • bufferTimeout
  • IPCheck
  • ExculdeCommands
  • RelogonCommands

  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 this adapter.

  Parameters:

  name - the name of the command.

  Returns:

  true if this command 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 adapter.

  Parameters:

  name - the name of the command.

  Returns:

  true if this command 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.

  Parameters:

  address - list of valid client IP addresses.

• 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.