com.ibm.retail.AEF.client
Class StateChangeListenerProxy

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--com.ibm.retail.AEF.util.AEFRemoteObject
                          |
                          +--com.ibm.retail.AEF.client.AEFEventListenerProxy
                                |
                                +--com.ibm.retail.AEF.client.StateChangeListenerProxy
All Implemented Interfaces:
AEFListenerProxyInterface, POSAppEventListener, java.rmi.Remote, java.io.Serializable, StateChangeListener

public class StateChangeListenerProxy
extends AEFEventListenerProxy
implements AEFListenerProxyInterface, StateChangeListener

StateChangeListenerProxy provides a proxy object for remote listeners to monitor the StateChange events of its associated terminal session.

Remote proxy objects extend the appropriate RMI server classes which handle the RMI duties for the client (so the client does not need to deal with rmi server issues). The proxy objects also perform the role of event dispatching.

By default, the listener proxy object will perform event queuing on an AEF event thread. This relieves the client of any "thread swapping" responsibilities and insures that the AEF event dispatching performance is not affected by client processing. To override this default behavior, use the setDispatchQueue() method. The proxy utilizes the EventDispatcher for queueing event listener notification.

To use a proxy object, the client must implement the listener interface and get the POSDataProvider object from the AEFSession to monitor. The proxy object is then constructed passing a reference to the client and the data provider. The proxy object performs the listener registration and forwards all events from the data provider to the client.

See Also:
Sample Usage, EventDispatcher, Serialized Form

Field Summary
protected  com.ibm.retail.AEF.data.POSDataProvider dataProvider
           
protected  com.ibm.retail.AEF.event.StateChangeListener listener
           
protected static java.lang.reflect.Method listenerMethod
           
 
Fields inherited from class com.ibm.retail.AEF.client.AEFEventListenerProxy
dispatchQueueName, SOCKET_CONNECT_TIMEOUT, SOCKET_READ_TIMEOUT
 
Fields inherited from class com.ibm.retail.AEF.util.AEFRemoteObject
DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Constructor Summary
StateChangeListenerProxy(com.ibm.retail.AEF.data.POSDataProvider dataProvider, com.ibm.retail.AEF.event.StateChangeListener listener)
          Construct a StateChangeListenerProxy This method registers the proxy as a listener with the POSDataProvider and begins event notification to the proxy client listener.
 
Method Summary
(package private) static java.lang.String copyright()
           
 void removeListener()
          Remove the proxy listener from the POSDataProvider.
 void stateChanged(com.ibm.retail.AEF.event.StateChangeEvent evt)
          A state change event occurred on the POS terminal session.
 
Methods inherited from class com.ibm.retail.AEF.client.AEFEventListenerProxy
dispatchEvent, getDispatchQueueName, getListenerMethod, setDispatchQueueName
 
Methods inherited from class com.ibm.retail.AEF.util.AEFRemoteObject
getClientSocketConnectTimeout, getClientSocketReadTimeout
 
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

listenerMethod

protected static java.lang.reflect.Method listenerMethod

dataProvider

protected com.ibm.retail.AEF.data.POSDataProvider dataProvider

listener

protected com.ibm.retail.AEF.event.StateChangeListener listener
Constructor Detail

StateChangeListenerProxy

public StateChangeListenerProxy(com.ibm.retail.AEF.data.POSDataProvider dataProvider,
                                com.ibm.retail.AEF.event.StateChangeListener listener)
                         throws java.rmi.RemoteException,
                                AEFException
Construct a StateChangeListenerProxy This method registers the proxy as a listener with the POSDataProvider and begins event notification to the proxy client listener.

Parameters:
dataProvider - instance of POSDataProvider which is the source of events
listener - client listener which receives the event notification via this proxy
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT
Method Detail

copyright

static java.lang.String copyright()

removeListener

public void removeListener()
                    throws java.rmi.RemoteException,
                           AEFException
Remove the proxy listener from the POSDataProvider. Ends notification of events.

Specified by:
removeListener in interface AEFListenerProxyInterface
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

stateChanged

public void stateChanged(com.ibm.retail.AEF.event.StateChangeEvent evt)
                  throws java.rmi.RemoteException
A state change event occurred on the POS terminal session. Dispatches event notification to the proxy client listener.

Specified by:
stateChanged in interface StateChangeListener
Parameters:
evt - contains state details
Throws:
java.rmi.RemoteException - if remote access fails


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