com.tarantella.tta.webservices
Interface ITarantellaWebtopContent

public interface ITarantellaWebtopContent

Defines the web services for managing Secure Global Desktop (SGD) assigned applications.

Assigned applications are applications published to a user. The applications can be returned in a form matching the hierarchy in the SGD datastore or, alternatively, it can be flattened to a single level.

Method Summary

java.lang.String	lookupWebtopItems(java.lang.String sessionCookie, java.lang.String[] objectNames, java.lang.String[] desiredAttributes) Looks-up the details of assigned applications.
java.lang.String	searchWebtopContent(java.lang.String sessionCookie, java.lang.String searchSpec, java.lang.String[] desiredAttributes) Searches for aasigned applications, removing the hierarchy defined in the datastore structure.
java.lang.String	searchWebtopContentHierarchy(java.lang.String sessionCookie, java.lang.String searchSpec, java.lang.String[] desiredAttributes, java.lang.String[] groups) Searches for assigned applications, preserving datastore hierarchy.

Method Detail

lookupWebtopItems

java.lang.String lookupWebtopItems(java.lang.String sessionCookie,
                                   java.lang.String[] objectNames,
                                   java.lang.String[] desiredAttributes)
                                   throws java.rmi.RemoteException

Looks-up the details of assigned applications.

Parameters:

sessionCookie - Identifies the user session owning the application.

objectNames - Array of names of assigned applications.

desiredAttributes - Array of attributes wanted.

Returns:

The attributes are returned in children of the top-level object. The children representing applications or documents are named IConstantsXML.NAME_WEBTOPITEM and those representing groups are named IConstantsXML.NAME_WEBTOPGROUP. Each child object contains the desired attributes.

See searchWebtopContent(String, String, String[]) and searchWebtopContentHierarchy(String, String, String[], String[]) for details.

Throws:

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

Since:

1.0

searchWebtopContent

java.lang.String searchWebtopContent(java.lang.String sessionCookie,
                                     java.lang.String searchSpec,
                                     java.lang.String[] desiredAttributes)
                                     throws java.rmi.RemoteException

Searches for aasigned applications, removing the hierarchy defined in the datastore structure.

Parameters:

sessionCookie - Identifies the user session owning the applications.

searchSpec - RFC 2254 search specification to select matching assigned applications.

desiredAttributes - Array of attributes wanted. The shortcut IConstants.LOCAL_ATTRS can be used to obtain the attributes that are interesting and can be retrieved quickly (see sample response).

Returns:

The attributes are returned in children of the top-level object. The children representing applications or documents and are named IConstantsXML.NAME_WEBTOPITEM. Each child object contains the desired attributes.

For a web application, the more interesting attributes are:

ISchemaNames.APP_TYPE	The type of the application (character, document, X, etc).
ISchemaNames.WEBTOP_ITEM_NAME	The fully qualified name of the application.
ISchemaNames.APP_NAME	The short application name.
ISchemaNames.APPLICATION_PLACEMENT	The application display mode.
ISchemaNames.SUSPEND	The resumability of the application.
ISchemaNames.ICON	The icon repesenting the application.
ISchemaNames.MAX_INSTANCES	The maximum permitted number of instances of the application.
ISchemaNames.RUNNING_INSTANCES	The number of instances of the application currently running.
ISchemaNames.FULL_SCREEN	Flag indicating that the application should run full-screen.

 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <obj name="webtopitem">
   <attr name="scottaappletheight">480</attr>
   <attr name="scottawebtopobjectname">.../_ens/o=applications/cn=Mozilla (server)</attr>
   <attr name="objectclass">scottaxapplication</attr>
   <attr name="scottaapplicationplacement">multiplewindows</attr>
   <attr name="scottasuspend">session</attr>
   <attr name="cn">Mozilla (server)</attr>
   <attr name="scottawebtopobjectclass">scottaxapplication</attr>
   <attr name="scottascalable">0</attr>
   <attr name="scottafilepath">/usr/sfw/bin/mozilla</attr>
   <attr name="scottaappletwidth">640</attr>
   <attr name="scottaicon">firefox.gif</attr>
   <attr name="scottadisplayenginepage">xde.html</attr>
   <attr name="scottamaxinstances">3</attr>
   <attr name="scottafullscreen">0</attr>
   <attr name="scottarunninginstances">0</attr>
  </obj>
  <obj name="webtopitem">
   <attr name="scottalocation">/sgdadmin</attr>
   <attr name="scottawebtopobjectclass">scottahtmldocument</attr>
   <attr name="scottaicon">world.gif</attr>
   <attr name="objectclass">scottahtmldocument</attr>
   <attr name="scottawebtopobjectname">.../_ens/o=Tarantella System Objects/cn=Administration Console</attr>
   <attr name="scottaoutofplace">1</attr>
   <attr name="cn">Administration Console</attr>
   <attr name="scottarunninginstances">0</attr>
  </obj>
  <obj name="webtopitem">
   <attr name="scottaappletheight">480</attr>
   <attr name="scottawebtopobjectname">.../_ens/o=applications/cn=VT420 (server)</attr>
   <attr name="objectclass">scottacharacterapplication</attr>
   <attr name="scottaapplicationplacement">awtwindow</attr>
   <attr name="scottasuspend">session</attr>
   <attr name="cn">VT420 (server)</attr>
   <attr name="scottawebtopobjectclass">scottacharacterapplication</attr>
   <attr name="scottafilepath">/opt/tarantella/bin/scripts/shell</attr>
   <attr name="scottaappletwidth">640</attr>
   <attr name="scottaicon">vt420.gif</attr>
   <attr name="scottadisplayenginepage">tde.html</attr>
   <attr name="scottamaxinstances">3</attr>
   <attr name="scottafullscreen">0</attr>
   <attr name="scottarunninginstances">0</attr>
  </obj>
 </tta:response>
 

Throws:

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

Since:

1.0

searchWebtopContentHierarchy

java.lang.String searchWebtopContentHierarchy(java.lang.String sessionCookie,
                                              java.lang.String searchSpec,
                                              java.lang.String[] desiredAttributes,
                                              java.lang.String[] groups)
                                              throws java.rmi.RemoteException

Searches for assigned applications, preserving datastore hierarchy.

Parameters:

sessionCookie - Identifies the user session owning the applications.

searchSpec - RFC 2254 search specification to select matching assigned applications.

desiredAttributes - Array of attributes wanted. The shortcut IConstants.LOCAL_ATTRS can be used to obtain the attributes that are interesting and can be retrieved quickly (see sample response).

groups - Array of organisational units that should be opened.

Returns:

The attributes are returned in children of the top-level object. The children representing applications or documents are named IConstantsXML.NAME_WEBTOPITEM and those representing groups are named IConstantsXML.NAME_WEBTOPGROUP. Each child object contains the desired attributes.

 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <obj name="webtopgroup" groupname=".../_ens/o=applications/cn=Applications">
   <obj name="webtopitem">
    See searchWebtopContent(String, String, String[]) for details.
   </obj>
  </obj>
 </tta:response>
 

Throws:

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

Since:

1.0