com.ibm.retail.AEF.session
Class SessionParameters

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--com.ibm.retail.AEF.session.SessionParameters
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class SessionParameters
extends java.util.HashMap

A SessionParameters object is a HashMap that contains the input parameters used to construct an AEFSession.

Any session parameter contained in session.properties may be overridden by using the put method to add the property and value to the SessionParameters object. Use the getSession or getAvailableSession method of SessionServer to pass the SessionParameters in for session creation.

See Also:
getAvailableSession, getSession, Serialized Form

Field Summary
 
Fields inherited from class java.util.HashMap
 
Fields inherited from class java.util.AbstractMap
 
Constructor Summary
SessionParameters()
          Constructor
 
Method Summary
 java.lang.String getClientID()
          Get the client ID associated with the session.
 java.lang.String getDeviceServerHost()
          Get the hostname used for remote device access.
 java.lang.String getTimeout()
          Get the timeout value used for session creation.
 void setClientID(java.lang.String clientID)
          Set the client ID which will be associated with the session.
 void setDeviceServerHost(java.lang.String host)
          Set the device server host value used for remote device access.
 void setTimeout(int timeout)
          Set the timeout value used for session creation.
 java.lang.String toString()
          Convert to a string representation
 
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

SessionParameters

public SessionParameters()
Constructor

Method Detail

setTimeout

public void setTimeout(int timeout)
Set the timeout value used for session creation.

This value controls the time to wait for session to be ready for input. A value of -1 will return the session without waiting for a ready event.

This method is equivalent to:

    parms.put("ready.wait.timeout",String.valueOf(timeout));
 

Parameters:
timeout - timeout value.

getTimeout

public java.lang.String getTimeout()
Get the timeout value used for session creation.

This method is equivalent to:

    parms.get("ready.wait.timeout");
 

Returns:
String

setClientID

public void setClientID(java.lang.String clientID)
Set the client ID which will be associated with the session.

This value will be logged by the AEF when the session is returned to the client. This value is used for informational purposes only.

This method is equivalent to:

    parms.put("client.ID",clientID);
 

Parameters:
clientID - The client ID.

getClientID

public java.lang.String getClientID()
Get the client ID associated with the session.

This method is equivalent to:

    parms.get("client.ID");
 

Returns:
String

setDeviceServerHost

public void setDeviceServerHost(java.lang.String host)
Set the device server host value used for remote device access.

This method is equivalent to:

    parms.put("device.server.host",host);
 

Parameters:
host - host name or ip address of DeviceServer

getDeviceServerHost

public java.lang.String getDeviceServerHost()
Get the hostname used for remote device access.

This method is equivalent to:

    parms.get("device.server.host");
 

Returns:
host name or ip address

toString

public java.lang.String toString()
Convert to a string representation

Overrides:
toString in class java.util.AbstractMap
Returns:
parameters in string form


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004