|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.AbstractMap | +--java.util.HashMap | +--com.ibm.retail.AEF.session.SessionParameters
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.
getAvailableSession
,
getSession
,
Serialized FormField 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 |
public SessionParameters()
Method Detail |
public void setTimeout(int timeout)
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));
timeout
- timeout value.public java.lang.String getTimeout()
This method is equivalent to:
parms.get("ready.wait.timeout");
public void setClientID(java.lang.String clientID)
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);
clientID
- The client ID.public java.lang.String getClientID()
This method is equivalent to:
parms.get("client.ID");
public void setDeviceServerHost(java.lang.String host)
This method is equivalent to:
parms.put("device.server.host",host);
host
- host name or ip address of DeviceServerpublic java.lang.String getDeviceServerHost()
This method is equivalent to:
parms.get("device.server.host");
public java.lang.String toString()
toString
in class java.util.AbstractMap
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |