Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices
Interface ITarantellaWebtopSession


public interface ITarantellaWebtopSession

Defines the web services for managing user sessions.

A Secure Global Desktop (SGD) user session represents a user's interaction with SGD. It is the essential interface for building web service applications. A typical web service application will make the following initialisation calls before delivering its specific functionality:

authenticate(String, String, String, String) Authenticates and creates a session. The response contains, amongst other data, the session cookie. This must be supplied in all other API calls.
setTCCConfiguration(String, String, String, String, String) Tells the server about the client device and web server to enable it to generate suitable HTML to launch the SGD Client
startTCC(String, String, String, String) Generates the HTML and parameters needed to launch the SGD Client.

Some of the APIs return an "empty top-level object". The XML for this is:


  <?xml version="1.0" encoding="UTF-8"?><tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd"/>
  


Method Summary
 java.lang.String adminCount(java.lang.String sessionCookie, java.lang.String searchSpec)
          Counts the number of matching user sessions a search would return.
 java.lang.String adminEndSession(java.lang.String sessionCookie, java.lang.String sessionId, boolean logout)
          Ends another user's user session.
 java.lang.String adminEndSessions(java.lang.String sessionCookie, java.lang.String[] sessionIds, boolean logout)
          Ends other users' user sessions.
 java.lang.String adminGetSessionPEInfo(java.lang.String sessionCookie, java.lang.String sessionId)
          Gets the latest protocol engine (PE) activity data.
 java.lang.String adminLookupSession(java.lang.String sessionCookie, java.lang.String sessionId, java.lang.String[] desiredAttributes)
          Looks-up another user's user session.
 java.lang.String adminSearchEnd(java.lang.String sessionCookie, java.lang.String searchId)
          Cleans-up resources in the server for a given search.
 java.lang.String adminSearchNext(java.lang.String sessionCookie, java.lang.String searchId, int noOfResults)
          Retrieves the next subset of search results.
 java.lang.String adminSearchSession(java.lang.String sessionCookie, java.lang.String searchSpec, java.lang.String[] desiredAttributes)
          Searches for user sessions.
 java.lang.String adminSearchStart(java.lang.String sessionCookie, java.lang.String searchSpec, java.lang.String[] desiredAttributes, int noOfResults, java.lang.String searchType)
          Starts a search, returning a maximum number of results.
 java.lang.String associateTCC(java.lang.String sessionCookie, java.lang.String id)
          Associates a user session with an existing SGD Client connection.
 java.lang.String authenticate(java.lang.String username, java.lang.String password, java.lang.String clientId, java.lang.String locale)
          Authenticates and creates a user session.
 java.lang.String authenticateExt(java.lang.String username, java.lang.String password, java.lang.String clientId, java.lang.String locale, Item[] additionalCreds, Item[] featureList)
          Authenticates a user session, providing additional information to identify the user, for example, a PIN code or e-mail address.
 java.lang.String createView(java.lang.String sessionCookie, boolean endView)
          Creates a new view on an existing session.
 java.lang.String endMultiViewSession(java.lang.String sessionCookie)
          Ends a user session.
 java.lang.String endSession(java.lang.String sessionCookie, boolean logout)
          Ends a user session.
 java.lang.String getSessionCookie(java.lang.String sessionToken)
          Returns an identifier for the user session based on supplied session token.
 java.lang.String getSessionToken(java.lang.String sessionCookie)
          Generates a one-time session token that can be used to look-up the session cookie.
 java.lang.String lookupSession(java.lang.String sessionCookie, java.lang.String[] desiredAttributes)
          Looks-up a user session.
 java.lang.String modifySession(java.lang.String sessionCookie, Item[] data, java.lang.String mode)
          Modifies a user session.
 java.lang.String refreshClientInfo(java.lang.String sessionCookie)
          Requests an update of client information from the SGD Client.
 java.lang.String refreshClientInfoEx(java.lang.String sessionCookie, java.lang.String[] required)
          Requests an update of a sub-set of the client information from the SGD Client.
 java.lang.String restart(java.lang.String sessionCookie, java.lang.String reconnectToken)
          Requests that a user session is linked to an SGD Client connection after an SGD server restart.
 java.lang.String setTCCConfiguration(java.lang.String sessionCookie, java.lang.String userAgent, java.lang.String baseUrl, java.lang.String version, java.lang.String type)
          Sets the configuration needed to select an appropriate SGD Client.
 java.lang.String setTCCConfigurationOverrides(java.lang.String sessionCookie, java.lang.String userAgent, java.lang.String baseUrl, java.lang.String version, java.lang.String type, Item[] overrides)
          Sets the configuration needed to select an appropriate SGD Client.
 java.lang.String startTCC(java.lang.String sessionCookie, java.lang.String helperId, java.lang.String handlerURL, java.lang.String target)
          Gets the information necessary to start the SGD Client.
 

Method Detail

adminCount

java.lang.String adminCount(java.lang.String sessionCookie,
                            java.lang.String searchSpec)
                            throws java.rmi.RemoteException
Counts the number of matching user sessions a search would return. For use by Administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
searchSpec - RFC 2254 search specification for selecting matching user sessions.
Returns:
The number of matching objects is returned as attribute IAttributeNames.TOTAL in 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="total">2</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminEndSession

java.lang.String adminEndSession(java.lang.String sessionCookie,
                                 java.lang.String sessionId,
                                 boolean logout)
                                 throws java.rmi.RemoteException
Ends another user's user session. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session to be ended.
logout - Flag indicating if the user session is to be logged-out (true) or just ended (false).
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminEndSessions

java.lang.String adminEndSessions(java.lang.String sessionCookie,
                                  java.lang.String[] sessionIds,
                                  boolean logout)
                                  throws java.rmi.RemoteException
Ends other users' user sessions. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionIds - Identifies the user sessions to be ended.
logout - Flag indicating if the user sessions are to be logged-out (true) or just ended (false).
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminGetSessionPEInfo

java.lang.String adminGetSessionPEInfo(java.lang.String sessionCookie,
                                       java.lang.String sessionId)
                                       throws java.rmi.RemoteException
Gets the latest protocol engine (PE) activity data.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session whose PE activity data is to be returned.
Returns:
The protocol engine activity information is returned as attributes of the top-level object. Values are in seconds. The attributes are:
ISchemaNames.LAST_ACTIVITY_CDMLast drive mapping activity
ISchemaNames.LAST_ACTIVITY_EMLast application session activity (mouse, keyboard)
ISchemaNames.LAST_ACTIVITY_PRINTLast print activity

 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <attr name="scottaemulatorsessionlastactivity">13249</attr>
  <attr name="scottacdmlastactivity">15453</attr>
  <attr name="scottaprintlastactivity">15453</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminLookupSession

java.lang.String adminLookupSession(java.lang.String sessionCookie,
                                    java.lang.String sessionId,
                                    java.lang.String[] desiredAttributes)
                                    throws java.rmi.RemoteException
Looks-up another user's user session. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
sessionId - Identifies the user session to be looked-up.
desiredAttributes - Array of attributes wanted in the response. See lookupSession(String, String[]) for details.
Returns:
The attributes are returned in a child of the top-level object named, IConstantsXML.NAME_WEBTOPSESSION. See lookupSession(String, String[]) for details.
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminSearchEnd

java.lang.String adminSearchEnd(java.lang.String sessionCookie,
                                java.lang.String searchId)
                                throws java.rmi.RemoteException
Cleans-up resources in the server for a given search. See adminSearchStart(String, String, String[], int, String).

Parameters:
sessionCookie - Identifies the user session performing the operation.
searchId - Identifies the search to clean-up.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminSearchNext

java.lang.String adminSearchNext(java.lang.String sessionCookie,
                                 java.lang.String searchId,
                                 int noOfResults)
                                 throws java.rmi.RemoteException
Retrieves the next subset of search results. See adminSearchStart(String, String, String[], int, String).

Parameters:
sessionCookie - Identifies the user session performing the operation.
searchId - Identifies the search to use.
noOfResults - The maximum number of results to return from the search. If noOfResults <= 0, all results are returned.
Returns:
See adminSearchStart(String, String, String[], int, String).
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminSearchSession

java.lang.String adminSearchSession(java.lang.String sessionCookie,
                                    java.lang.String searchSpec,
                                    java.lang.String[] desiredAttributes)
                                    throws java.rmi.RemoteException
Searches for user sessions. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
searchSpec - RFC 2254 search specification to select matching user sessions.
desiredAttributes - Array of attributes wanted in the response. See lookupSession(String, String[]) for details.
Returns:
The search results from each member of the array are stored in children of the top-level object. These objects have the special tag src and carry the name of the SGD server. Each user session is a child of the src object and the children are named IConstantsXML.NAME_WEBTOPSESSION. Each child corresponds to an SGD user session and for each user session, the attributes are in children representing the different sources. See lookupSession(String, String[]) for details.

 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <src name="server.uk.sun.com">
   <obj name="webtopsession">
    See lookupSession(String, String[]) for details
   </obj>
   <obj name="webtopsession">
    See lookupSession(String, String[]) for details
   </obj>
  </src>
 </tta:response>
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

adminSearchStart

java.lang.String adminSearchStart(java.lang.String sessionCookie,
                                  java.lang.String searchSpec,
                                  java.lang.String[] desiredAttributes,
                                  int noOfResults,
                                  java.lang.String searchType)
                                  throws java.rmi.RemoteException
Starts a search, returning a maximum number of results. If the search finds more results than noOfResults, the results are cached on the server and subsequent sets can be retrieved by calling adminSearchNext(String, String, int). If not all of the results are retrieved and the search is no longer needed, adminSearchEnd(String, String) should be called. For use by administrators only.

Parameters:
sessionCookie - Identifies the user session performing the operation.
searchSpec - RFC 2254 search specfication to select matching user sessions.
desiredAttributes - Array of attributes wanted in the response. See lookupSession(String, String[]) for details of attributes.
noOfResults - The maximum number of results to return from this search. If noOfResults <= 0 all results are returned.
searchType - Reserved for future use. An empty string should be provided.
Returns:
The IConstantsXML.NAME_SEARCHID attribute that identifies the search is returned in the top-level object. If this attribute has a non-empty value, then the search found more results than allowed by noOfResults. Subsequent results can be obtained by calling adminSearchNext(String, String, int) until that API returns an empty IConstantsXML.NAME_SEARCHID value, indicating that there are no more results.

If the search is abandoned before the attribute name IConstantsXML.NAME_SEARCHID is empty, then the search should be ended by calling adminSearchEnd(String, String). Failure to do so will consume server resources.

The results for the user sessions are returned in the children of the top-level object. See adminSearchSession(String, String, String[]) for details.


 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <src name="server.uk.sun.com">
   See adminSearchSession(String, String, String[]) for details
  </src>
  <src name="server1.uk.sun.com">
   See adminSearchSession(String, String, String[]) for details
  </src>
  <attr name="searchId">server.uk.sun.com:1194952979813:4596222405879589000:WS-1194967684089</attr>
 </tta:response>
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

associateTCC

java.lang.String associateTCC(java.lang.String sessionCookie,
                              java.lang.String id)
                              throws java.rmi.RemoteException
Associates a user session with an existing SGD Client connection. This API allows a new view to use an SGD Client that has been started by a different view.

Parameters:
sessionCookie - Identifies the user session performing the operation.
id - Identifies the view which owns the SGD Client connection
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

authenticate

java.lang.String authenticate(java.lang.String username,
                              java.lang.String password,
                              java.lang.String clientId,
                              java.lang.String locale)
                              throws java.rmi.RemoteException
Authenticates and creates a user session.

Parameters:
username - Username credential.
password - Password credential.
clientId - Arbitrary identifier for the client device. This parameter determines whether the SGD server joins or grabs any existing session belonging to the user.
locale - Preferred locale of the user.
Returns:
Key attributes for the user session are returned on the top-level object. These are:

ISchemaNames.SESSIONCOOKIEA cookie that uniquely identies the user session. This value should be supplied as the first parameter to all other web service API calls. It is important to handle this value securely to prevent mis-use of the user session.
ISchemaNames.THEME Theme. Deprecated
IAttributeNames.IS_ADMINFlag indicating that the user is an SGD administrator.
ISchemaNames.COMMON_NAMEThe name of the user.
arrayMemberThe array member hosting the session. Deprecated

There are also attributes in a sub-object, named IConstantsXML.NAME_SERVER_ATTRS,

ISchemaNames.SESSION_IDThe session ID. This is the public identifier of the user session. Unlike ISchemaNames.SESSIONCOOKIE, this value does not have to be kept secret.
ISchemaNames.ENSEQUIVNAMEThe owner of the session configuration. In many cases, this will be the same value as ISchemaNames.SESSION_OWNER, but it is not always. For example, a user who authenticates through the UNIX authentication mechanism will have the authentication mechanism as its ISchemaNames.ENSEQUIVNAME, but a unique ISchemaNames.SESSION_OWNER.
ISchemaNames.SESSION_OWNERThe owner of the session.

There is another child of the top-level object returned when the call to the API creates a new view on a user session, that is, when the user session joins an existing session rather than grabs it. Sessions are joined when the credentials map to the same user and the clientIds used to authenticate the sessions are the same.

The IConstantsXML.NAME_VIEWS child of the top-level object contains children for each view that exists, named IConstantsXML.NAME_VIEW. Each IConstantsXML.NAME_VIEW object has the attributes:

IAttributeNames.VIEW_ID Identifies the view.
IAttributeNames.TCCCONNECTION Whether the view has a connected SGD Client.


 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <attr name="scottasessioncookie">-012345678901234567:server.uk.sun.com:0123456789012:-0123456789012345678:2</attr>
  <attr name="scottatheme">sco/tta/standard</attr>
  <attr name="isadministrator">false</attr>
  <attr name="cn">auser</attr>
  <attr name="arrayMember">server.sun.com</attr>
  <obj name="serverattributes">
   <attr name="scottasessionid">server.uk.sun.com:0123456789012:-0123456789012345678</attr>
   <attr name="scottasessiontemplateowner">">.../_ens/o=Tarantella System Objects/cn=UNIX User Profilelt;/attr>
   <attr name="scottasessionowner">.../_user/auser</attr>
  </obj>
  <obj name="views">
   <obj name="view">
    <attr name="viewid">1</attr>
    <attr name="tccconnection">true</attr>
   </obj>
  </obj>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

authenticateExt

java.lang.String authenticateExt(java.lang.String username,
                                 java.lang.String password,
                                 java.lang.String clientId,
                                 java.lang.String locale,
                                 Item[] additionalCreds,
                                 Item[] featureList)
                                 throws java.rmi.RemoteException
Authenticates a user session, providing additional information to identify the user, for example, a PIN code or e-mail address.

Parameters:
username - Username credential.
password - Password credential.
clientId - Arbitrary identifier for the client device. This parameter determines whether the SGD server joins or grabs any existing session belonging to the user.
locale - preferred local of the user
additionalCreds - Array of additional credentials.
featureList - Context of the multi-stage login. This will have been returned in the SOAP fault from a previous authentication request.
Returns:
See authenticate(String, String, String, String)
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

createView

java.lang.String createView(java.lang.String sessionCookie,
                            boolean endView)
                            throws java.rmi.RemoteException
Creates a new view on an existing session.

Parameters:
sessionCookie - Identifies the user session performing the operation.
endView - Indicates whether the new view should be automatically ended when the view used for creation is destroyed.
Returns:
See authenticate(String, String, String, String) for details.
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

endSession

java.lang.String endSession(java.lang.String sessionCookie,
                            boolean logout)
                            throws java.rmi.RemoteException
Ends a user session. If the session is multi-viewed, only the view identified in the sessionCookie is ended.

Parameters:
sessionCookie - Identifies the user session performing the operation.
logout - Flag indicating if the user session is to be logged-out (true) or just ended (false).
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

endMultiViewSession

java.lang.String endMultiViewSession(java.lang.String sessionCookie)
                                     throws java.rmi.RemoteException
Ends a user session. If the session is multi-viewed, all views are ended.

Parameters:
sessionCookie - Identifies the user session performing the operation.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.2

getSessionCookie

java.lang.String getSessionCookie(java.lang.String sessionToken)
                                  throws java.rmi.RemoteException
Returns an identifier for the user session based on supplied session token. See getSessionToken(String).

Parameters:
sessionToken - One-time token whose session cookie should be returned.
Returns:
The user session cookie, as an attribute 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="scottasessioncookie">5004750199374938363:server.uk.sun.com:1194952979813:4596222405879589000:1</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

getSessionToken

java.lang.String getSessionToken(java.lang.String sessionCookie)
                                 throws java.rmi.RemoteException
Generates a one-time session token that can be used to look-up the session cookie. See getSessionCookie(String). The method can be used to avoid exposing the valuable session cookie.

Parameters:
sessionCookie - Identifies the user session performing the operation.
Returns:
The session token, as an attribute of the top-level object.

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

lookupSession

java.lang.String lookupSession(java.lang.String sessionCookie,
                               java.lang.String[] desiredAttributes)
                               throws java.rmi.RemoteException
Looks-up a user session.

Parameters:
sessionCookie - Identifies the user session performing the operation.
desiredAttributes - Array of attributes wanted in the response. User session attributes are stored in groups, depending on their source. Attributes can be named specifically, for example, ISchemaNames.COMMON_NAME, IAttributeNames.TCC_OS, but there are shortcuts available to access a whole group:
IConstants.APPLICATION_ATTRS Get attributes set by the web application
IConstants.CLIENT_ATTRS Get attributes sent by the SGD Client
IConstants.CONNECTION_ATTRS Get attributes from the connection between SGD Client and SGD server
IConstants.PROFILE_ATTRS Get attributes in the user's profile
IConstants.SERVER_ATTRS Get attributes set by the SGD server
Returns:
The attributes are returned in a child of the top-level object named, IConstantsXML.NAME_WEBTOPSESSION. The attributes are grouped as children of the child object, depending on their source. Possible children of the IConstantsXML.NAME_WEBTOPSESSION object are:

IConstantsXML.NAME_APPLICATION_ATTRS Contains arbitrary attributes set by the web application
IConstantsXML.NAME_CLIENT_ATTRS Contains attributes sent by the SGD Client, including
IConstantsXML.NAME_CONNECTION_ATTRS Contains attributes related to the connection, including
IConstantsXML.NAME_PROFILE_ATTRS Contains attributes from the user's profile, including
IConstantsXML.NAME_SERVER_ATTRS Contains attributes from the SGD schema, including

 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <obj name="webtopsession">
   <obj name="clientattributes">
    <attr name="tcctimezonestdoffset">0</attr>
    <attr name="tccscreenvirtualheight">1200</attr>
    <attr name="tccscreenvirtualwidth">1600</attr>
    <attr name="tccprintername">AGFA-AccuSet v52.3</attr>
    <attr name="tcctimezonestd">GMT Standard Time</attr>
    <attr name="tccscottasessiontccclientip">123.456.789.012</attr>
    <attr name="tccscreenheight">1200</attr>
    <attr name="tcclogfile">C:\Documents and Settings\auser\Local Settings\temp\tcc\4.40.907\tcc.txt</attr>
    <attr name="tccscreenwidth">1600</attr>
    <attr name="tccmaxoutofplacewidth">1592</attr>
    <attr name="tccmaxoutofplaceheight">1166</attr>
    <attr name="tccinputlangms">2057</attr>
    <attr name="tccarchitecture">x86</attr>
    <attr name="tcccode">C:\Documents and Settings\auser\Local Settings\temp\tcc\4.40.907\tcc.exe</attr>
    <attr name="tcctimezonedst">GMT Standard Time</attr>
    <attr name="tcccolordepth">32</attr>
    <attr name="tccos">Windows</attr>
   </obj>
   <obj name="connectionattributes">
    <attr name="tccconnection">true</attr>
    <attr name="useragent">Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)</attr>
    <attr name="port">5307</attr>
    <attr name="baseroute"></attr>
    <attr name="server">server.uk.sun.com</attr>
    <attr name="firewalltraversal">false</attr>
    <attr name="connheadersecurity">0</attr>
    <attr name="baseurl">http://server.uk.sun.com/sgd/tcc</attr>
    <attr name="tcchelpertype">java</attr>
    <attr name="connectionclientip">123.456.789.012</attr>
    <attr name="security">std</attr>
    <attr name="tccport">4272</attr>
   </obj>
   <obj name="applicationattributes">
    <attr name="clientprintqueue">resumed</attr>
    <attr name="preferredlanguage">en</attr>
   </obj>
   <obj name="profileattributes">
    <obj name="Default">
     <attr name="sessioncookie"></attr>
     <attr name="lastproxytype"></attr>
     <attr name="usesocks">false</attr>
     <attr name="objectclass">sunsgdprofile</attr>
     <attr name="url">http://server.uk.sun.com/sgd/index.jsp</attr>
     <attr name="autologin">false</attr>
     <attr name="lastproxyport">0</attr>
     <attr name="preferredlang">en</attr>
     <attr name="autologin_state">enabled</attr>
     <attr name="logging">logging_errorsonly</attr>
     <attr name="lastproxyhost"></attr>
     <attr name="reconnect_attempts">6</attr>
     <attr name="mode">integrated</attr>
     <attr name="reconnect_interval">10</attr>
     <attr name="usehttp">false</attr>
     <attr name="mobile_client">false</attr>
     <attr name="proxy">browser</attr>
     <attr name="reconnect_mode">reconnect_always</attr>
     <attr name="autostart">false</attr>
    </obj>
    <attr name="editable">false</attr>
   </obj>
   <obj name="serverattributes">
    <attr name="scottasessionsecurity">STD</attr>
    <attr name="scottasessionlogintime">1194968629717</attr>
    <attr name="scottasessiontoken">.../_token/DqCkentBbF+VL9kXavt0paNhgWY=</attr>
    <attr name="scottaauthoritativesource">server.uk.sun.com</attr>
    <attr name="objectclass">top</attr>
    <attr name="objectclass">scottasession</attr>
    <attr name="objectclass">scottawebtopsession</attr>
    <attr name="scottawebtopstate">connected</attr>
    <attr name="scottasessionpeerdnsname">server.uk.sun.com</attr>
    <attr name="scottawebtopsessionemulatorsecurity">STD</attr>
    <attr name="scottadeviceaccessibledata">IOC://server.uk.sun.com/5054251232;32;1;5;0;2;0;1;SCARD;0</attr>
    <attr name="scottadeviceaccessibledata">IOC://server.uk.sun.com/505425121;32;1;5;0;2;0;2;COM1;0</attr>
    <attr name="scottadeviceaccessibledata">LPD:16Universal PDF PrinterW32x86:HP Color LaserJet 8500 PSUniversal PDF Printer2</attr>
    <attr name="scottadeviceaccessibledata">LPD:16Universal PDF ViewerW32x86:HP Color LaserJet 8500 PSUniversal PDF Viewer2</attr>
    <attr name="scottadeviceaccessibledata">LPD:16\\tta-devprint1\HP LaserJet 5/5M PostScriptW32x86:HP LaserJet 5/5M PostScript\\tta-devprint1\HP LaserJet 5/5M PostScript2</attr>
    <attr name="scottadeviceaccessibledata">LPD:48AGFA-AccuSet v52.3W32x86:AGFA-AccuSet v52.3AGFA-AccuSet v52.32</attr>
    <attr name="scottasessionid">server.uk.sun.com:1194968629717:7854436686215328242</attr>
    <attr name="scottasessiontemplateowner">.../_ens/o=organization/cn=multi</attr>
    <attr name="scottasessionowner">.../_dns/server.uk.sun.com/_anon/1194883433663</attr>
    <attr name="scottaclientprintstate">1</attr>
    <attr name="scottasessionexternaldnsname">server.uk.sun.com</attr>
   </obj>
  </obj>
 </tta:response>
 
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

modifySession

java.lang.String modifySession(java.lang.String sessionCookie,
                               Item[] data,
                               java.lang.String mode)
                               throws java.rmi.RemoteException
Modifies a user session. The operation only affects attributes stored in the IConstantsXML.NAME_APPLICATION_ATTRS group.

Parameters:
sessionCookie - Identifies the user session performing the operation.
data - Array of attributes to change.
mode - Type of modification. One of:
IConstants.MODE_APPENDATTR Append the values to any existing values on the named attribute.
IConstants.MODE_REMOVEATTR Remove the named attributes. Attributes that are not named are left untouched.
IConstants.MODE_REPLACEATTR Replace the values on the named attributes with new values. Attributes that are not named are left untouched.
IConstants.MODE_REPLACEALLATTR Remove all attributes and replace them with the named values.
Returns:
The current IConstantsXML.NAME_APPLICATION_ATTRS, after the modification. The IConstantsXML.NAME_APPLICATION_ATTRS are in a child 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">
  <obj name="applicationattributes">
   <attr name="att2">val2</attr>
   <attr name="att1">val1</attr>
  </obj>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

refreshClientInfo

java.lang.String refreshClientInfo(java.lang.String sessionCookie)
                                   throws java.rmi.RemoteException
Requests an update of client information from the SGD Client. The SGD Client will query the client device and send the current settings to the server, where they will be stored in the IConstantsXML.NAME_CLIENT_ATTRS group.

Parameters:
sessionCookie - Identifies the user session performing the operation.
Returns:
The client attribute are returned in 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="tcctimezonestdoffset">0</attr>
  <attr name="tccscreenvirtualheight">1200</attr>
  <attr name="tccscreenvirtualwidth">1600</attr>
  <attr name="tccprintername">AGFA-AccuSet v52.3</attr>
  <attr name="tcctimezonestd">GMT Standard Time</attr>
  <attr name="tccscottasessiontccclientip">123.456.789.012</attr>
  <attr name="tccscreenheight">1200</attr>
  <attr name="tcclogfile">C:\Documents and Settings\auser\Local Settings\temp\tcc\4.40.907\tcc.txt</attr>
  <attr name="tccscreenwidth">1600</attr>
  <attr name="tccmaxoutofplacewidth">1592</attr>
  <attr name="tccmaxoutofplaceheight">1166</attr>
  <attr name="tccinputlangms">2057</attr>
  <attr name="tccarchitecture">x86</attr>
  <attr name="tcccode">C:\Documents and Settings\auser\Local Settings\temp\tcc\4.40.907\tcc.exe</attr>
  <attr name="tcctimezonedst">GMT Standard Time</attr>
  <attr name="tcccolordepth">32</attr>
  <attr name="tccos">Windows</attr>
 </tta:response>
 
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

refreshClientInfoEx

java.lang.String refreshClientInfoEx(java.lang.String sessionCookie,
                                     java.lang.String[] required)
                                     throws java.rmi.RemoteException
Requests an update of a sub-set of the client information from the SGD Client. The SGD Client will query the client device and send the current settings to the server, where they will be stored in the IConstantsXML.NAME_CLIENT_ATTRS group.

Parameters:
sessionCookie - Identifies the user session performing the operation.
required - List of the data to be refreshed.
Returns:
See refreshClientInfo(java.lang.String) for details.
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

restart

java.lang.String restart(java.lang.String sessionCookie,
                         java.lang.String reconnectToken)
                         throws java.rmi.RemoteException
Requests that a user session is linked to an SGD Client connection after an SGD server restart.

Parameters:
sessionCookie - Identifies the user session performing the operation.
reconnectToken - A token to associate the user session with an existing SGD Client.
Returns:
WHAT??
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

setTCCConfiguration

java.lang.String setTCCConfiguration(java.lang.String sessionCookie,
                                     java.lang.String userAgent,
                                     java.lang.String baseUrl,
                                     java.lang.String version,
                                     java.lang.String type)
                                     throws java.rmi.RemoteException
Sets the configuration needed to select an appropriate SGD Client. The configuration data controls two actions:

SGD Client Helper The userAgent and type parameters are used to determine which type of SGD Client Helper should be written to the HTML.
SGD Client The userAgent parameter is used to determine the correct SGD Client binary for the OS on the client device.

Parameters:
sessionCookie - Identifies the user session performing the operation.
userAgent - Identifies the browser hosting the SGD Client Helper.
baseUrl - Base URL to access the SGD Client.
version - Version of the SGD Client. This is an arbitrary value, but is often set to the version of the SGD software.
type - Type of SGD Client Helper to use. Must be java.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

setTCCConfigurationOverrides

java.lang.String setTCCConfigurationOverrides(java.lang.String sessionCookie,
                                              java.lang.String userAgent,
                                              java.lang.String baseUrl,
                                              java.lang.String version,
                                              java.lang.String type,
                                              Item[] overrides)
                                              throws java.rmi.RemoteException
Sets the configuration needed to select an appropriate SGD Client. This method allows additional parameters to be overridden and is useful when the connection between the SGD Client and server is not direct, for example, passing through a gateway.

See setTCCConfiguration(String, String, String, String, String) for general details.

Parameters:
sessionCookie - Identifies the user session performing the operation.
userAgent - Identifies the browser hosting the SGD Client Helper.
baseUrl - Base URL to access the SGD Client.
version - Version of the SGD Client. This is an arbitrary value, but is often set to the version of the SGD software.
type - Type of SGD Client Helper to use. Must be java.
overrides - Parameter overrides. Allowed overrides are:
IAttributeNames.SECURITY Sets the security of the initial connection. Deprecated
IAttributeNames.HOST Sets the server name for the client connection.
IAttributeNames.PORT Sets the port for the client connection.
IAttributeNames.BASEROUTE Sets the routing information to connect to the server.
IAttributeNames.TCCPORT Sets the port on which the SGD Client is listening for connections. Used when the client is started first.
IAttributeNames.TCCPORTFILE Sets the name of the file where the SGD Client will write the port on which it listens for connections.
IAttributeNames.FIREWALLTRAVERSAL Flag indicating that the server is running in firewall traversal mode.
IAttributeNames.TCC_DIRECTORY Sets the directory in which the SGD Client is installed.
IAttributeNames.TCC_ARGUMENTS Sets command-line arguments to the SGD Client.
IAttributeNames.FAILEDCONNECTIONURL Sets a URL that the SGD Client should load if it fails to establish a connection to the server.
IAttributeNames.TCCROAMING Flag indicating that the SGD Client should assume roaming profiles.
Returns:
An empty top-level object
Throws:
java.rmi.RemoteException - On receipt of a SOAP fault.
Since:
1.0

startTCC

java.lang.String startTCC(java.lang.String sessionCookie,
                          java.lang.String helperId,
                          java.lang.String handlerURL,
                          java.lang.String target)
                          throws java.rmi.RemoteException
Gets the information necessary to start the SGD Client. Optionally, a message can be stored in the server that will be sent to the SGD Client when it connects.

A web application accessed via a Java-enabled browser can send the data in the IAttributeNames.CODEFRAGMENT attribute to the browser and have the SGD Client Helper applet start the SGD Client. Applications not using a Java-enabled browser should construct a suitable command-line from the other parameters in the response, for example,


 tcc -connectioncookie 123 -server host.domain.com -port 5307 -secure
     [-baseroute CTSOCK...] [-firewalltraversal]
 

Parameters:
sessionCookie - Identifies the user session performing the operation.
helperId - Identity of SGD Client Helper to which the SGD Client should send the connection message.
handlerURL - URL of the handler of the connection message.
target - Output window or frame for the connection message.
Returns:
The following are returned as attributes of the top-level object:

IAttributeNames.HELPERIDID of SGD Client Helper.
IAttributeNames.CONNECTCOOKIECookie used by the SGD Client to connect to the SGD server.
ISchemaNames.SESSIONSECURITYSecurity level the SGD Client should use to connect to the SGD server (secure or standard).
IAttributeNames.HOSTThe SGD server to connect to.
IAttributeNames.PORTThe port to connect to.
IAttributeNames.VERSIONThe version set in setTCCConfiguration(String, String, String, String, String)
IAttributeNames.BASEROUTERouting information for the SGD Client to connect to the SGDesktop server.
IAttributeNames.TCCPORTPort on which the SGD Client is listening for connections.
IAttributeNames.TCCPORTFILEName of the file into which the SGD Client should write the port on which it listens.
IAttributeNames.FIREWALLTRAVERSALFlag indicating that firewall traversal is enabled.
IAttributeNames.CODEFRAGMENTA fragment of HTML code that can be used to instantiate an SGD Client Helper.


 Sample response:
 <?xml version="1.0" encoding="UTF-8"?>
 <tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
  <attr name="helperid">qqq</attr>
  <attr name="connectioncookie">0123456789012:server.uk.sun.com:-0123456789012345678:Li4uL19lbnMvbz1UYXJhbnRlbGxhIFN5c3RlbSBPYmplY3RzL2NuPUFkbWluaXN0cmF0b3I=</attr>
  <attr name="security">STD</attr>
  <attr name="server">server.uk.sun.com</attr>
  <attr name="port">5307</attr>
  <attr name="version">4.40.907</attr>
  <attr name="baseroute"></attr>
  <attr name="tccport"></attr>
  <attr name="tccportfile">1195051413347.port</attr>
  <attr name="firewalltraversal">false</attr>
  <attr name="codefragment"><![CDATA[<applet archive="ttalwG-jps.jar,ttalwwin32G-jps.jar"
 width="2"
 height="2"
 codebase="http://server.uk.sun.com/sgd/tcc/java"
 code="com.tarantella.tta.client.tcc.lwplugin.pluginG.TCCHelper"
 alt="Please enable Java before continuing."
 >
 <param name="helperid" value="Helper1">
 <param name="connectioncookie" value="0123456789012:server.uk.sun.com:-0123456789012345678:Li4uL19lbnMvbz1UYXJhbnRlbGxhIFN5c3RlbSBPYmplY3RzL2NuPUFkbWluaXN0cmF0b3I=">
 <param name="security" value="STD">
 <param name="server" value="server.uk.sun.com">
 <param name="port" value="5307">
 <param name="version" value="4.40.907">
 <param name="baseroute" value="">
 <param name="tccport" value="">
 <param name="tccportfile" value="1195051413347.port">
 <param name="StartTCC" value="true">
 <param name="firewalltraversal" value="false">
 <param name="TCCURL" value="http://server.uk.sun.com/sgd/tcc/win32/tcc_comp.exe">
 <param name="ForceTCCDownload" value="false">
 <param name="PreferredLanguage" value="en">
 <param name="tccroaming" value="missing">
 <param name="BrowserId" value="1">
 </applet>
 ]]></attr>
 </tta:response>
 
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.