Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices
Interface ITarantellaUser


public interface ITarantellaUser

Defines the web services for managing user data.


Method Summary
 java.lang.String getPasswordEntry(java.lang.String sessionCookie, java.lang.String applicationServer)
          Gets a password entry for the given application server
 java.lang.String lookupPrefs(java.lang.String sessionCookie, java.lang.String[] desiredPreferences)
          Looks-up the preferences of the user who owns the user session.
 java.lang.String lookupUser(java.lang.String sessionCookie, java.lang.String[] desiredAttributes)
          Looks-up the attributes of the user who owns the user session.
 java.lang.String modifyPrefs(java.lang.String sessionCookie, Item[] data)
          Modifies the preferences of the user who owns the user session.
 java.lang.String setPasswordEntry(java.lang.String sessionCookie, java.lang.String applicationServer, java.lang.String applicationUsername, java.lang.String applicationPassword)
          Sets a password entry for the given application server
 

Method Detail

lookupPrefs

java.lang.String lookupPrefs(java.lang.String sessionCookie,
                             java.lang.String[] desiredPreferences)
                             throws java.rmi.RemoteException
Looks-up the preferences of the user who owns the user session.

Parameters:
sessionCookie - Identifies the user session owning the preferences.
desiredPreferences - Array of preferences wanted. Reserved for future use.
Returns:
The preferences are returned as attributes of the 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="dg">Name    Ungrouped Content       Collapsed       true    Shown   true</attr>
  <attr name="webtopprefs">eNqVzbEKwjAQgOH53iKjDm0HnQIdpBSnqhB3SZsrRpK7cEkR397S2cUH+P7/YiPCyUVP0HEINmV0MNuQEcyT3wRFFoQB44gCdV03D6TccHu3YqngKpT55IJRXccXTiU3E7Vbz+citngm1TFlDn9XbsKzD6h65wvLD21TCn7aHhswQ6d266k6VMc9aN2TOwsvSesvTJdPZw==</attr>
  <attr name="inflationbuffer">230</attr>
  <attr name="objectclass">container</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

lookupUser

java.lang.String lookupUser(java.lang.String sessionCookie,
                            java.lang.String[] desiredAttributes)
                            throws java.rmi.RemoteException
Looks-up the attributes of the user who owns the user session.

Parameters:
sessionCookie - Identifies the user session owned by the user.
desiredAttributes - Array of attributes wanted in the response. IConstants.LOCAL_ATTRS is a shortcut to get those attributes that can be retrieved cheaply (see sample response).
Returns:
The desired attributes are returned on the 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="sn">root</attr>
  <attr name="scottawebtopcontents">o=applications/cn=Applications</attr>
  <attr name="scottainheritwebtop">0</attr>
  <attr name="scottasharedlogin">0</attr>
  <attr name="scottaaipbandwidth">0</attr>
  <attr name="uid">root</attr>
  <attr name="objectclass">inetorgperson</attr>
  <attr name="objectclass">scottaauxperson</attr>
  <attr name="objectclass">organizationalperson</attr>
  <attr name="objectclass">person</attr>
  <attr name="objectclass">top</attr>
  <attr name="scottaaccountenabled">1</attr>
  <attr name="cn">Administrator</attr>
  <attr name="sunsgdeditprofile">2</attr>
  <attr name="sunsgdclipboardenabled">2</attr>
  <attr name="scottatheme">..</attr>
  <attr name="sunsgdserialportenabled">2</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

modifyPrefs

java.lang.String modifyPrefs(java.lang.String sessionCookie,
                             Item[] data)
                             throws java.rmi.RemoteException
Modifies the preferences of the user who owns the user session. This makes a permanent change to the datastore.

Parameters:
sessionCookie - Identifies the user session owning the preferences.
data - Array of preferences to be changed.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

getPasswordEntry

java.lang.String getPasswordEntry(java.lang.String sessionCookie,
                                  java.lang.String applicationServer)
                                  throws java.rmi.RemoteException
Gets a password entry for the given application server

Parameters:
sessionCookie - Identifies the user session owning the preferences.
applicationServer - Identifies the resource for which the password is returned.
Returns:
The username and password on the top-level object.
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.3

setPasswordEntry

java.lang.String setPasswordEntry(java.lang.String sessionCookie,
                                  java.lang.String applicationServer,
                                  java.lang.String applicationUsername,
                                  java.lang.String applicationPassword)
                                  throws java.rmi.RemoteException
Sets a password entry for the given application server

Parameters:
sessionCookie - Identifies the user session owning the preferences.
applicationServer - Identifies the resource for which the password is stored.
applicationUsername - Identifies the username which is stored.
applicationPassword - Identifies the password which is stored.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.3

Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

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