Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices
Interface ITarantellaEvent


public interface ITarantellaEvent

Defines the web services for managing events and messages.

The Secure Global Desktop (SGD) system is a source of events. Web applications can register their interest in events, providing handlers that are called when an event is fired.

Events can be sent to three locations:

ClientEvents registered to the client are passed to the browser via the SGD Client and SGD Client Helper
ServerEvents registered to the server are passed to a SOAP web service method
TCCEvents registered to the SGD Client are passed to the SGD Client and processed internally

Event NameDescriptionSupported Registrations
IConstants.WEBTOP_CHANGED_EVT Fired when applications are assigned or removed. Client, Server
IConstants.WEBTOP_STATE_EVT Fired when assigned applications are enabled or disabled. Client, Server
IConstants.SESSION_EVT Fired when application sessions are created or deleted. Client, Server
IConstants.WEBTOPSESSION_EVT Fired when user sessions are created or deleted. Client, Server
IConstants.SESSION_CHANGED_EVT Fired when application sessions changed. Not implemented.  
IConstants.WEBTOPSESSION_CHANGED_EVT Fired when user sessions change. Client, Server
IConstants.PRINT_EVT Fired when print jobs are created or deleted. Client, Server, TCC
IConstants.RESTART_EVT Fired if the SGD server restarts. Client, TCC
IConstants.GRAB_EVT Fired when a user session is grabbed. Client, Server, TCC
IConstants.LOGGED_OUT_EVT Fired when a user session is logged-out. Client, Server, TCC
IConstants.TCC_EVT Fired when the state of the SGD Client connection changes. Server
IConstants.CONNECTION_LOST_EVT Fired when the SGD Client connection is lost. Server
IConstants.PROFILE_EVT Fired when a user's profile is changed. TCC
IConstants.AUTOMATIC_LOGOUT_EVT Fired when the state of the application sessions matches that configured for an automatic logout. TCC

When an event listener is registered, it is given a unique name that can be used to reference it. It is not possible to register identically the same event listener.


Method Summary
 java.lang.String adminBroadcastClientSideMessage(java.lang.String sessionCookie, java.lang.String handlerURL, java.lang.String target, java.lang.String data, java.lang.String searchSpec)
          Sends a message to a client-side listener using the default listenerId.
 java.lang.String adminDeregisterAllEventListeners(java.lang.String sessionCookie, java.lang.String sessionId)
          Deregister alls event listeners for a user session.
 java.lang.String adminDeregisterEventListeners(java.lang.String sessionCookie, java.lang.String sessionId, java.lang.String[] eventListenerIds)
          Deregisters specific event listeners for a user session.
 java.lang.String adminDeregisterNamedEventListeners(java.lang.String sessionCookie, java.lang.String sessionId, java.lang.String[] eventNames)
          Deregisters event listeners by name for a user session.
 java.lang.String adminFireEvent(java.lang.String sessionCookie, java.lang.String eventName, java.lang.String eventData, java.lang.String searchSpec)
          Fires a named event to one or more user sessions.
 java.lang.String adminListEventListeners(java.lang.String sessionCookie, java.lang.String sessionId)
          Lists the event listeners registered by a user session.
 java.lang.String adminSendClientSideMessage(java.lang.String sessionCookie, java.lang.String sessionId, 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 adminSendServerSideMessage(java.lang.String sessionCookie, java.lang.String handlerURL, java.lang.String method, java.lang.String connectionType, java.lang.String data, java.lang.String searchSpec)
          Sends a message to a server-side listener.
 java.lang.String deregisterAllEventListeners(java.lang.String sessionCookie)
          Deregisters all event listeners for a user session.
 java.lang.String deregisterEventListeners(java.lang.String sessionCookie, java.lang.String[] eventListenerIds)
          Deregisters specific event listeners for a user session.
 java.lang.String deregisterNamedEventListeners(java.lang.String sessionCookie, java.lang.String[] eventNames)
          Deregisters event listeners by name for a user session.
 java.lang.String fireEvent(java.lang.String sessionCookie, java.lang.String eventName, java.lang.String eventData)
          Fires a named event.
 java.lang.String listEventListeners(java.lang.String sessionCookie)
          Lists event listeners registered to a user session.
 java.lang.String registerClientSideEventListener(java.lang.String sessionCookie, 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 sessionCookie, 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 sessionCookie, java.lang.String eventName)
          Registers a listener in the SGD Client.
 java.lang.String sendClientSideMessage(java.lang.String sessionCookie, 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 sessionCookie, 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 sessionCookie, java.lang.String listenerId)
          Starts a handler for a client-side event listener (an SGD Client Helper applet).
 

Method Detail

adminBroadcastClientSideMessage

java.lang.String adminBroadcastClientSideMessage(java.lang.String sessionCookie,
                                                 java.lang.String handlerURL,
                                                 java.lang.String target,
                                                 java.lang.String data,
                                                 java.lang.String searchSpec)
                                                 throws java.rmi.RemoteException
Sends a message to a client-side listener using the default listenerId. A web application can register a default listenerId by setting the attribute IAttributeNames.DEFAULT_HELPERID using the API ITarantellaWebtopSession.modifySession(String, Item[], String). For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
handlerURL - URL of the client-side message handler.
target - Output window or frame for the message handler.
data - Data for the message. This is appended to the handler URL.
searchSpec - RFC 2254 search specification to select matching user sessions.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminDeregisterAllEventListeners

java.lang.String adminDeregisterAllEventListeners(java.lang.String sessionCookie,
                                                  java.lang.String sessionId)
                                                  throws java.rmi.RemoteException
Deregister alls event listeners for a user session. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session whose listeners are being deregistered.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminDeregisterEventListeners

java.lang.String adminDeregisterEventListeners(java.lang.String sessionCookie,
                                               java.lang.String sessionId,
                                               java.lang.String[] eventListenerIds)
                                               throws java.rmi.RemoteException
Deregisters specific event listeners for a user session. The event listeners are referenced by their unique identifier, returned upon registration. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session whose listeners are being deregistered.
eventListenerIds - Array of listener IDs to be deregistered.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminDeregisterNamedEventListeners

java.lang.String adminDeregisterNamedEventListeners(java.lang.String sessionCookie,
                                                    java.lang.String sessionId,
                                                    java.lang.String[] eventNames)
                                                    throws java.rmi.RemoteException
Deregisters event listeners by name for a user session. The event listeners are referenced by the names used to register them. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session whose listeners are being deregistered.
eventNames - Array of event names to be deregistered.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminFireEvent

java.lang.String adminFireEvent(java.lang.String sessionCookie,
                                java.lang.String eventName,
                                java.lang.String eventData,
                                java.lang.String searchSpec)
                                throws java.rmi.RemoteException
Fires a named event to one or more user sessions. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
eventName - Name of the registered event.
eventData - Data for the event. This is appended to the handler URL.
searchSpec - RFC 2254 search specification to select matching user sessions.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminListEventListeners

java.lang.String adminListEventListeners(java.lang.String sessionCookie,
                                         java.lang.String sessionId)
                                         throws java.rmi.RemoteException
Lists the event listeners registered by a user session. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session whose listeners are being listed.
Returns:
The attributes are returned in children of the top-level object named IConstantsXML.NAME_EVENTREGISTERED, where each child corresponds to a registered event listener. The attributes returned for all types of event are:
IAttributeNames.EVENTLISTENERID The unique identifier created when the event was registered
ISchemaNames.SESSION_ID The ID of the user session that registered the event.
IAttributeNames.EVENTNAME The name of the registered event.
Client-side event listeners also return:
IAttributeNames.HANDLER The URL that will handle the event.
IAttributeNames.TARGET The target frame for the data from the event handler.
IAttributeNames.LISTENERID The ID of the SGD Client Helper that should handle the event.
Server-side event listeners also return:
IAttributeNames.HANDLER The URL that will handle the event.
IAttributeNames.METHOD The name of the web service method that will handle the event.
IAttributeNames.CONNTYPE The connection type requested at event registration.

 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:WebtopStateChanged:1195141635805</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">WebtopStateChanged</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd/webtops/standard/webtop/webtop.jsp</attr>
   <attr name="target">WebtopFrame</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:WebtopContentChanged:1195141635806</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">WebtopContentChanged</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd/webtops/standard/webtop/webtop.jsp</attr>
   <attr name="target">WebtopFrame</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:Logout:1195141635808</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">Logout</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd/webtops/standard/webtop/logged-out.jsp?ENTRY_URL=/index.jsp</attr>
   <attr name="target">_top</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:ConnectionLost:1195141635811</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">ConnectionLost</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd//index.jsp</attr>
   <attr name="target">_top</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:Tcc:1195141630799</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">Tcc</attr>
   <attr name="handlerurl">http://server.uk.sun.com/axis/services/serverside</attr>
   <attr name="method">status</attr>
   <attr name="connectiontype">permanent</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:Restart:1195141635810</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">Restart</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd/webtops/standard/webtop/restart.jsp</attr>
   <attr name="target">_top</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:Print:1195141635809</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">Print</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd/webtops/standard/webtop/opt.jsp</attr>
   <attr name="target">OptFrame</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:Profile:1195141635812</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">Profile</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:EmulatorSession:1195141635807</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">EmulatorSession</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd/webtops/standard/webtop/webtop.jsp</attr>
   <attr name="target">WebtopFrame</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
  <obj name="eventregistered">
   <attr name="eventlistenerid">server.uk.sun.com:SessionGrabbed:1195141635804</attr>
   <attr name="scottasessionid">server.uk.sun.com:1195141630682:-4305357794897784897</attr>
   <attr name="eventname">SessionGrabbed</attr>
   <attr name="handlerurl">http://server.uk.sun.com/sgd/webtops/standard/webtop/session-grabbed.jsp?ENTRY_URL=/index.jsp</attr>
   <attr name="target">_top</attr>
   <attr name="listenerid">EVL1195141635343</attr>
  </obj>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminSendClientSideMessage

java.lang.String adminSendClientSideMessage(java.lang.String sessionCookie,
                                            java.lang.String sessionId,
                                            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. Unlike events, messages are not registered. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session owning the listener.
handlerURL - URL of the client-side message handler.
target - Output window or frame for the message handler.
listenerId - Name of the client-side event listener. A value of "*" will send the message to all client-side event listeners and a value of IConstants.DEFAULT will send the message to the default listener, if a default listener has been set as attribute IAttributeNames.DEFAULT_HELPERID on the user session (See ITarantellaWebtopSession.modifySession(String, Item[], String)).
data - Data for the message. This is appended to the handler URL.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminSendServerSideMessage

java.lang.String adminSendServerSideMessage(java.lang.String sessionCookie,
                                            java.lang.String handlerURL,
                                            java.lang.String method,
                                            java.lang.String connectionType,
                                            java.lang.String data,
                                            java.lang.String searchSpec)
                                            throws java.rmi.RemoteException
Sends a message to a server-side listener. Unlike events, messages are not registered. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
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 (one of IConstants.PERMANENT or IConstants.TRANSIENT).
data - Data for the message. This is sent in the SOAP request.
searchSpec - Search spec for user session to receive message.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

deregisterAllEventListeners

java.lang.String deregisterAllEventListeners(java.lang.String sessionCookie)
                                             throws java.rmi.RemoteException
Deregisters all event listeners for a user session.

Parameters:
sessionCookie - Identifies the user session whose listeners are being deregistered.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

deregisterEventListeners

java.lang.String deregisterEventListeners(java.lang.String sessionCookie,
                                          java.lang.String[] eventListenerIds)
                                          throws java.rmi.RemoteException
Deregisters specific event listeners for a user session. The event listeners are referenced by the unique name returned upon registration.

Parameters:
sessionCookie - Identifies the user session whose listeners are being deregistered.
eventListenerIds - Array of listeners to be deregistered.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

deregisterNamedEventListeners

java.lang.String deregisterNamedEventListeners(java.lang.String sessionCookie,
                                               java.lang.String[] eventNames)
                                               throws java.rmi.RemoteException
Deregisters event listeners by name for a user session. The event listeners are referenced by the name used to register them.

Parameters:
sessionCookie - Identifies the user session whose listeners are being deregistered.
eventNames - Array of event names to be deregistered.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

fireEvent

java.lang.String fireEvent(java.lang.String sessionCookie,
                           java.lang.String eventName,
                           java.lang.String eventData)
                           throws java.rmi.RemoteException
Fires a named event.

Parameters:
sessionCookie - Identifies the user session receiving the event.
eventName - Name of the registered event.
eventData - Data for the event.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

listEventListeners

java.lang.String listEventListeners(java.lang.String sessionCookie)
                                    throws java.rmi.RemoteException
Lists event listeners registered to a user session.

Parameters:
sessionCookie - Identifies the user session whose listeners are being listed.
Returns:
See adminListEventListeners(String, String).
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

registerClientSideEventListener

java.lang.String registerClientSideEventListener(java.lang.String sessionCookie,
                                                 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:
sessionCookie - Identifies the user session owning the listener.
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 SGD Client Helper that should handle the event.
Returns:
The unique, assigned identifier for the event listener is returned as the attribute IAttributeNames.EVENTLISTENERID in a top-level object.

 Sample response:
 <?xml version="1.0" encoding="UTF-8">
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <attr name="eventlistenerid">server.uk.sun.com:WebtopStateChanged:1195144511803</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

registerServerSideEventListener

java.lang.String registerServerSideEventListener(java.lang.String sessionCookie,
                                                 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:
sessionCookie - Identifies the user session owning the listener.
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 (one of IConstants.PERMANENT or IConstants.TRANSIENT).
Returns:
The unique, assigned identifier for the event listener is returned as the attribute IAttributeNames.EVENTLISTENERID in a top-level object.

 Sample response:
 <?xml version="1.0" encoding="UTF-8">
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <attr name="eventlistenerid">server.uk.sun.com:Tcc:1195144511803</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

registerTCCEventListener

java.lang.String registerTCCEventListener(java.lang.String sessionCookie,
                                          java.lang.String eventName)
                                          throws java.rmi.RemoteException
Registers a listener in the SGD Client.

Parameters:
sessionCookie - Identifies the user session owning the listener.
eventName - Name of the event.
Returns:
The unique, assigned identifier for the event listener is returned as the attribute IAttributeNames.EVENTLISTENERID in a top-level object.

 Sample response:
 <?xml version="1.0" encoding="UTF-8">
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <attr name="eventlistenerid">server.uk.sun.com:Profile:1195144511803</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

sendClientSideMessage

java.lang.String sendClientSideMessage(java.lang.String sessionCookie,
                                       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. Unlike events, messages are not registered.

Parameters:
sessionCookie - Identifies the user session owning the listener.
handlerURL - URL of the client-side message handler.
target - Output window or frame for the message handler.
listenerId - Name of the SGD Client Helper to handle the event.
data - Data for the message. This is appended to the handler URL.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

sendServerSideMessage

java.lang.String sendServerSideMessage(java.lang.String sessionCookie,
                                       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. Unlike events, messages are not registered.

Parameters:
sessionCookie - Identifies the user session owning the listener.
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 (one of IConstants.PERMANENT or IConstants.TRANSIENT).
data - Data for the message. This is sent in the SOAP request.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

startClientSideListener

java.lang.String startClientSideListener(java.lang.String sessionCookie,
                                         java.lang.String listenerId)
                                         throws java.rmi.RemoteException
Starts a handler for a client-side event listener (an SGD Client Helper applet).

Parameters:
sessionCookie - Identifies the user session owning the listener.
listenerId - Name of the handler (SGD Client Helper).
Returns:
See ITarantellaWebtopSession.startTCC(String, String, String, String).
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

Copyright © 2012, 2013, Oracle and/or its affiliates. All rights reserved.