com.tarantella.tta.webservices.client.views
Class EventsView

java.lang.Object
  com.tarantella.tta.webservices.client.views.EventsView

All Implemented Interfaces:

java.io.Serializable

public class EventsView
extends java.lang.Object
implements java.io.Serializable

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.

See Also:

Serialized Form

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

deregisterAllEventListeners

public java.lang.String deregisterAllEventListeners()
                                             throws java.rmi.RemoteException

Deregisters all event listeners for a user session.

Returns:

See ITarantellaEvent.deregisterAllEventListeners(String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

deregisterEventListeners

public java.lang.String deregisterEventListeners(java.lang.String[] eventListenerIds)
                                          throws java.rmi.RemoteException

Deregisters named events for a user session.

Parameters:

eventListenerIds - Array of listeners to be deregistered.

Returns:

See ITarantellaEvent.deregisterEventListeners(String, String[]).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

deregisterNamedEventListeners

public java.lang.String deregisterNamedEventListeners(java.lang.String[] eventNames)
                                               throws java.rmi.RemoteException

Deregisters events by name for a user session.

Parameters:

eventNames - Array of names of listeners to be deregistered.

Returns:

See ITarantellaEvent.deregisterNamedEventListeners(String, String[]).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

fireEvent

public java.lang.String fireEvent(java.lang.String eventName,
                                  java.lang.String eventData)
                           throws java.rmi.RemoteException

Fires a named event.

Parameters:

eventName - Name of the registered event.

eventData - Data for the event.

Returns:

See ITarantellaEvent.fireEvent(String, String, String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

listEventListeners

public java.lang.String listEventListeners()
                                    throws java.rmi.RemoteException

Lists event listeners registered to a user session.

Returns:

See ITarantellaEvent.listEventListeners(String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

registerClientSideEventListener

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

Registers a client-side listener.

Parameters:

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.

Returns:

See ITarantellaEvent.registerClientSideEventListener(String, String, String, String, String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

registerServerSideEventListener

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

Registers a server-side listener.

Parameters:

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).

Returns:

See ITarantellaEvent.registerServerSideEventListener(String, String, String, String, String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

registerTCCEventListener

public java.lang.String registerTCCEventListener(java.lang.String eventName)
                                          throws java.rmi.RemoteException

Registers a listener in the SGD Client.

Parameters:

eventName - Name of the event.

Returns:

See ITarantellaEvent.registerTCCEventListener(String, String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

sendClientSideMessage

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

Sends a message to a client-side listener.

Parameters:

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.

Returns:

See ITarantellaEvent.sendClientSideMessage(String, String, String, String, String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

sendServerSideMessage

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

Sends a message to a server-side listener.

Parameters:

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.

Returns:

See ITarantellaEvent.sendServerSideMessage(String, String, String, String, String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

startClientSideListener

public java.lang.String startClientSideListener(java.lang.String listenerId)
                                         throws java.rmi.RemoteException

Starts a client-side listener.

Parameters:

listenerId - Name of the event listener.

Returns:

See ITarantellaEvent.startClientSideListener(String, String).

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

getStartedEventListenerIds

public 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.

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.

Returns:

An enumeration of started, client-side event listener.

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

getRegisteredEventListeners

public java.util.Enumeration getRegisteredEventListeners()

Gets an enumeration of registered event listeners.

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.

Returns:

An enumeration of registered event listeners.

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

getRegisteredEventListenersSize

public int getRegisteredEventListenersSize()

Gets the number of event listeners registered.

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.

Returns:

The number of registered event listener.

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

getRegisteredEventListener

public IResponse getRegisteredEventListener(java.lang.String eventListenerId)

Gets the event listener. The event listener ID is returned in the IAttributeNames.EVENTLISTENERID attribute upon event listener registration.

Parameters:

eventListenerId - The event listener ID.

Returns:

The event listener.

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

batchRegister

public java.lang.String batchRegister(RequestObject[] requests)
                               throws java.rmi.RemoteException

Registers several listeners in a single call. The API uses ITarantellaUtility.sendBatchRequest(String, RequestObject[]) and parses the responses.

Parameters:

requests - Request objects.

Returns:

The XML for the last registered listener.

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0