|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An AEFSession
provides an object encapsulation of a POS terminal session.
The AEFSession
provides access to the data and function provided by the
POS application.
An instance of an AEFSession is distinguished by the terminal number
associated with the session. Each session is identified by a unique terminal
number.
A session runs in either in "real" terminal mode (i.e., in a POS Terminal with
real devices) or in a "virtual" terminal mode (i.e., in a server environment
with emulated devices.
To perform an action on an AEFSession
(e.g., logon(), addItem()),
use the
POSAutomationProvider
interface.
To access data and monitor events associated with an AEFSession, use the
use the POSDataProvider
interface.
Accessing the POSDataProvider
,
Accessing the POSAutomationProvider
Method Summary | |
---|---|
void |
addSessionStatusListener(com.ibm.retail.AEF.session.SessionStatusListener listener)
Add a listener for SessionStatus events. |
void |
addSessionTraceSocketHandler(java.lang.String host,
int port)
Add a socket handler to the session trace. |
void |
addToEventQueue(com.ibm.retail.AEF.util.AEFEventQueueRunnable obj)
Add a runnable object to the sessions event queue. |
void |
dumpSessionTrace()
Dump the session trace buffer to the trace file. |
com.ibm.retail.AEF.data.ApplicationDataConnector |
getApplicationDataConnector()
Get the ApplicationDataConnector for this terminal session.
|
java.net.InetSocketAddress |
getHealthServerAddress()
Get the address of the AEF Health Server for this session. |
com.ibm.retail.AEF.automation.POSAutomationProvider |
getPOSAutomationProvider()
Get the POSAutomationProvider (automation API) for this terminal session.
|
com.ibm.retail.AEF.data.POSDataProvider |
getPOSDataProvider()
Get the POSDataProvider associated with this terminal session.
|
int |
getSessionTraceLevel()
Returns the current trace level for the session. |
java.lang.String |
getTerminalNumber()
Get the terminal number for this terminal session. |
java.lang.String[] |
getTraceBuffer()
Returns a String array of the trace buffer. |
com.ibm.retail.AEF.workstation.Workstation |
getWorkstation()
Returns the Workstation object for this session. |
boolean |
isApplicationActive()
Is the terminal sales application active? |
boolean |
isAutoDumpSessionTrace()
Indicates if the session trace buffer auto dumps for AEF exceptions. |
boolean |
isAvailable()
Indicate if this session is available. |
boolean |
isReady()
Indicate if this session ready for client actions. |
boolean |
isReserved()
Indicate if this session is reserved. |
boolean |
isSessionTraceEnabled(int level)
Indicates if session trace is enabled for this session for a specified log level. |
boolean |
isTSSSession()
Indicates if this a virtual session object. |
boolean |
isVirtualSession()
Indicates if this a virtual session object. |
void |
reference()
Increment the client reference count for this session. |
void |
release()
Decrement the client reference count for this session. |
void |
removeSessionStatusListener(com.ibm.retail.AEF.session.SessionStatusListener listener)
Remove a listener for SessionStatus events. |
void |
removeSessionTraceSocketHandler()
Remove the session trace socket handler. |
void |
sessionTrace(int level,
java.lang.String msg)
Write to the session trace buffer with the specified level. |
void |
setSessionTraceLevel(int level)
Set the trace level for the session. |
void |
startApplication()
Start the terminal sales application. |
void |
stopApplication()
Stop the terminal sales application. |
void |
terminate()
Cause the session to perform any cleanup required before it is terminated. |
void |
waitForPendingEvents()
Wait for events currently pending on the session event queue to complete. |
boolean |
waitUntilReady(int timeout)
Wait until this session is ready for processing. |
Method Detail |
public com.ibm.retail.AEF.data.POSDataProvider getPOSDataProvider() throws java.rmi.RemoteException
POSDataProvider
associated with this terminal session.
java.rmi.RemoteException
public com.ibm.retail.AEF.automation.POSAutomationProvider getPOSAutomationProvider() throws java.rmi.RemoteException
POSAutomationProvider
(automation API) for this terminal session.
java.rmi.RemoteException
public com.ibm.retail.AEF.data.ApplicationDataConnector getApplicationDataConnector() throws java.rmi.RemoteException
ApplicationDataConnector
for this terminal session.
java.rmi.RemoteException
public java.lang.String getTerminalNumber() throws java.rmi.RemoteException
java.rmi.RemoteException
public boolean isAvailable() throws java.rmi.RemoteException
java.rmi.RemoteException
Referencing a session
,
Obtaining an available session
public boolean isReserved() throws java.rmi.RemoteException
SessionServer.getAvailableSession()
. Sessions that are
reserved can only be obtained through SessionServer.getSession()
.
java.rmi.RemoteException
Obtaining an available session
,
Obtaining a specific session
public boolean isReady() throws java.rmi.RemoteException
java.rmi.RemoteException
waitUntilReady
public boolean waitUntilReady(int timeout) throws java.rmi.RemoteException
timeout
- timeout value in milliseconds
java.rmi.RemoteException
isReady
public void reference() throws java.rmi.RemoteException
release()
method to return it to
the pool of available sessions.
java.rmi.RemoteException
release
public void release() throws java.rmi.RemoteException, AEFException
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
Reference a session
public boolean isVirtualSession() throws java.rmi.RemoteException
java.rmi.RemoteException
public boolean isTSSSession() throws java.rmi.RemoteException
java.rmi.RemoteException
public void addToEventQueue(com.ibm.retail.AEF.util.AEFEventQueueRunnable obj) throws java.rmi.RemoteException
obj
- object to be enqueued
java.rmi.RemoteException
public void waitForPendingEvents() throws java.rmi.RemoteException
java.rmi.RemoteException
public com.ibm.retail.AEF.workstation.Workstation getWorkstation() throws java.rmi.RemoteException
java.rmi.RemoteException
public boolean isSessionTraceEnabled(int level) throws java.rmi.RemoteException
level
- level of messages to be logged
java.rmi.RemoteException
public void sessionTrace(int level, java.lang.String msg) throws java.rmi.RemoteException
SessionTrace.DUMP = Write an error message SessionTrace.COARSE = Low tracing message SessionTrace.MEDIUM = Medium tracing message SessionTrace.FINE = High tracing message
level
- level of messagemsg
- message to be written to the session trace buffer
java.rmi.RemoteException
public void setSessionTraceLevel(int level) throws java.rmi.RemoteException
SessionTrace.OFF = Turn the session trace off SessionTrace.DUMP = Write to trace on error only SessionTrace.COARSE = Low tracing SessionTrace.MEDIUM = Medium tracing SessionTrace.FINE = High tracing
level
- level of message
java.rmi.RemoteException
public int getSessionTraceLevel() throws java.rmi.RemoteException
java.rmi.RemoteException
public void dumpSessionTrace() throws java.rmi.RemoteException
config.properties
using the property trace.file.pattern
.
java.rmi.RemoteException
public boolean isAutoDumpSessionTrace() throws java.rmi.RemoteException
java.rmi.RemoteException
public java.lang.String[] getTraceBuffer() throws java.rmi.RemoteException
java.rmi.RemoteException
public void addSessionTraceSocketHandler(java.lang.String host, int port) throws java.rmi.RemoteException, java.io.IOException
host
- hostnameport
- port number
java.rmi.RemoteException
java.io.IOException
public void removeSessionTraceSocketHandler() throws java.rmi.RemoteException
java.rmi.RemoteException
public void addSessionStatusListener(com.ibm.retail.AEF.session.SessionStatusListener listener) throws java.rmi.RemoteException
listener
- SessionStatusListener to be added
java.rmi.RemoteException
public void removeSessionStatusListener(com.ibm.retail.AEF.session.SessionStatusListener listener) throws java.rmi.RemoteException
listener
- SessionStatusListener to be removed
java.rmi.RemoteException
public void startApplication() throws java.rmi.RemoteException, AEFException
session.properties
property:
start.pos.sales.application=false
pos.sales.application=R::h0:/adx_ipgm/EAMTS10L.286
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void stopApplication() throws java.rmi.RemoteException, AEFException
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void terminate() throws java.rmi.RemoteException, AEFException
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public boolean isApplicationActive() throws java.rmi.RemoteException
java.rmi.RemoteException
public java.net.InetSocketAddress getHealthServerAddress() throws java.rmi.RemoteException, AEFException
java.rmi.RemoteException
AEFException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |