|
Oracle Secure Global Desktop Web Services API Documentation Release 4.6 E23734-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tarantella.tta.webservices.client.views.EventsView
public class EventsView
The class maintains a view of registered event listeners and started client-side listeners (SGD Client Helpers). It also provides access to the ITarantellaEvent
APIs.
Method Summary | |
---|---|
java.lang.String |
batchRegister(RequestObject[] requests) Registers several listeners in a single call. |
java.lang.String |
deregisterAllEventListeners() Deregisters all event listeners for a user session. |
java.lang.String |
deregisterEventListeners(java.lang.String[] eventListenerIds) Deregisters named events for a user session. |
java.lang.String |
deregisterNamedEventListeners(java.lang.String[] eventNames) Deregisters events by name for a user session. |
java.lang.String |
fireEvent(java.lang.String eventName, java.lang.String eventData) Fires a named event. |
IResponse |
getRegisteredEventListener(java.lang.String eventListenerId) Gets the event listener. |
java.util.Enumeration |
getRegisteredEventListeners() Gets an enumeration of registered event listeners. |
int |
getRegisteredEventListenersSize() Gets the number of event listeners registered. |
java.util.Enumeration |
getStartedEventListenerIds() Gets an enumeration of client-side listeners (SGD Client Helpers) that have been started to listen for client-side events and messages. |
java.lang.String |
listEventListeners() Lists event listeners registered to a user session. |
java.lang.String |
registerClientSideEventListener(java.lang.String eventName, java.lang.String handlerURL, java.lang.String target, java.lang.String listenerId) Registers a client-side listener. |
java.lang.String |
registerServerSideEventListener(java.lang.String eventName, java.lang.String handlerURL, java.lang.String method, java.lang.String connectionType) Registers a server-side listener. |
java.lang.String |
registerTCCEventListener(java.lang.String eventName) Registers a listener in the SGD Client. |
java.lang.String |
sendClientSideMessage(java.lang.String handlerURL, java.lang.String target, java.lang.String listenerId, java.lang.String data) Sends a message to a client-side listener. |
java.lang.String |
sendServerSideMessage(java.lang.String handlerURL, java.lang.String method, java.lang.String connectionType, java.lang.String data) Sends a message to a server-side listener. |
java.lang.String |
startClientSideListener(java.lang.String listenerId) Starts a client-side listener. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.String deregisterAllEventListeners() throws java.rmi.RemoteException
ITarantellaEvent.deregisterAllEventListeners(String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String deregisterEventListeners(java.lang.String[] eventListenerIds) throws java.rmi.RemoteException
eventListenerIds
- Array of listeners to be deregistered.ITarantellaEvent.deregisterEventListeners(String, String[])
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String deregisterNamedEventListeners(java.lang.String[] eventNames) throws java.rmi.RemoteException
eventNames
- Array of names of listeners to be deregistered.ITarantellaEvent.deregisterNamedEventListeners(String, String[])
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String fireEvent(java.lang.String eventName, java.lang.String eventData) throws java.rmi.RemoteException
eventName
- Name of the registered event.eventData
- Data for the event.ITarantellaEvent.fireEvent(String, String, String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String listEventListeners() throws java.rmi.RemoteException
ITarantellaEvent.listEventListeners(String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String registerClientSideEventListener(java.lang.String eventName, java.lang.String handlerURL, java.lang.String target, java.lang.String listenerId) throws java.rmi.RemoteException
eventName
- Name of the event.handlerURL
- URL of the client-side message handler.target
- Output window or frame for the message handler.listenerId
- Name of the event listener.ITarantellaEvent.registerClientSideEventListener(String, String, String, String, String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String registerServerSideEventListener(java.lang.String eventName, java.lang.String handlerURL, java.lang.String method, java.lang.String connectionType) throws java.rmi.RemoteException
eventName
- Name of the event.handlerURL
- URL of the server-side message handler.method
- Name of the SOAP method handling the message.connectionType
- Desired type of the connection to the handler (permanent or transient).ITarantellaEvent.registerServerSideEventListener(String, String, String, String, String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String registerTCCEventListener(java.lang.String eventName) throws java.rmi.RemoteException
eventName
- Name of the event.ITarantellaEvent.registerTCCEventListener(String, String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String sendClientSideMessage(java.lang.String handlerURL, java.lang.String target, java.lang.String listenerId, java.lang.String data) throws java.rmi.RemoteException
handlerURL
- URL of the client-side message handler.target
- Output window or frame for the message handler.listenerId
- Name of the event listener.data
- Data for the message. This is appended to the handler URL.ITarantellaEvent.sendClientSideMessage(String, String, String, String, String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String sendServerSideMessage(java.lang.String handlerURL, java.lang.String method, java.lang.String connectionType, java.lang.String data) throws java.rmi.RemoteException
handlerURL
- URL of the server-side message handler.method
- Name of the SOAP method handling the message.connectionType
- Desired type of the connection to the handler (permanent or transient).data
- Data for the message. This is sent in the SOAP request.ITarantellaEvent.sendServerSideMessage(String, String, String, String, String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String startClientSideListener(java.lang.String listenerId) throws java.rmi.RemoteException
listenerId
- Name of the event listener.ITarantellaEvent.startClientSideListener(String, String)
.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.util.Enumeration getStartedEventListenerIds()
Only SGD Client Helpers started through startClientSideListener(String)
are counted here and there is no guarantee that the client-side listener is still active or, even, if it started successfully.
java.rmi.RemoteException
- On receipt of a SOAP fault.public java.util.Enumeration getRegisteredEventListeners()
Only SGD Client Helpers started through startClientSideListener(String)
are counted here and there is no guarantee that the client-side listener is still active or, even, if it started successfully.
java.rmi.RemoteException
- On receipt of a SOAP fault.public int getRegisteredEventListenersSize()
Only SGD Client Helpers started through startClientSideListener(String)
are counted here and there is no guarantee that the client-side listener is still active or, even, if it started successfully.
java.rmi.RemoteException
- On receipt of a SOAP fault.public IResponse getRegisteredEventListener(java.lang.String eventListenerId)
IAttributeNames.EVENTLISTENERID
attribute upon event listener registration.eventListenerId
- The event listener ID.java.rmi.RemoteException
- On receipt of a SOAP fault.public java.lang.String batchRegister(RequestObject[] requests) throws java.rmi.RemoteException
ITarantellaUtility.sendBatchRequest(String, RequestObject[])
and parses the responses.requests
- Request objects.java.rmi.RemoteException
- On receipt of a SOAP fault.
|
Oracle Secure Global Desktop Web Services API Documentation Release 4.6 E23734-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |