Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices
Interface ITarantellaExternalAuth


public interface ITarantellaExternalAuth

Defines the web services for external authentication.

In normal operation, the Secure Global Desktop (SGD) server is responsible for authenticating users. This interface allows a third-party component to authenticate users and then pass the identity to the SGD server.

The URL to access web service APIs on this interface is protected by web server authentication and web service requests must have correct credentials to be processed. The client application is responsible for storing these credentials safely and supplying them with requests.


Method Summary
 java.lang.String setSessionIdentity(java.lang.String username, java.lang.String clientId, java.lang.String locale)
          Requests that a user session is created for a particular user.
 

Method Detail

setSessionIdentity

java.lang.String setSessionIdentity(java.lang.String username,
                                    java.lang.String clientId,
                                    java.lang.String locale)
                                    throws java.rmi.RemoteException
Requests that a user session is created for a particular user. The API assumes that the web application has applied appropriate authentication.

Parameters:
username - The owner of the user session.
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:
See ITarantellaWebtopSession.authenticate(String, String, String, String) for details.
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.