com.tarantella.tta.webservices.client.views
Class SessionBean

java.lang.Object
  com.tarantella.tta.webservices.client.views.SessionBean

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

WebtopSessionJSP

public class SessionBean
extends java.lang.Object
implements java.io.Serializable

The class caches data on a Secure Global Desktop (SGD) user session, to avoid having to make repeated requests to the SGD server. Like any cache, it can become invalid and it is the caller's responsibility to ensure the data is current.

The SessionBean represents a user's interaction with SGD. 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 is parsed and data can be accessed through various methods of this class. For example, the session cookie is accessible through getSessionCookie() and can be used in other API calls. Note, methods implemented on this class do not take a cookie, but use the internal copy.
setTCCConfiguration(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)	Generates the HTML and parameters needed to launch the SGD Client.

See Also:

Serialized Form

Constructor Summary

SessionBean()
Default constructor.

SessionBean(java.lang.String sessionCookieArg)
Constructor.

Method Summary

void	addValue(java.lang.String attname, java.lang.Object attvalue) Stores an arbitrary value on the session.
boolean	associateTCC() Checks the list of views returned in the authenticate response and tries to associate this view with an SGD CLient already running for another view.
java.lang.String	authenticate(java.lang.String username, java.lang.String password, java.lang.String clientId, java.lang.String locale) Creates and authenticates 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[] loginContext) Creates and authenticates a user session that requires more credentials than just a username and password.
java.lang.String	authenticateMoreInfo(Item[] additionalCreds) Provides more information to authenticate a user session.
java.lang.String	authenticateMoreInfo(Item[] additionalCreds, java.lang.String prefLang) Provides more information to authenticate a user session.
DataRequest[]	authenticateMoreInfoPrompts() Gets information about additional credentials required in multi-stage authentication.
java.lang.String	endSession(boolean logout) Ends a user session.
java.lang.String	getAttribute(java.lang.String store, java.lang.String attributeName) Gets the named attribute from the named store.
java.lang.String[]	getAttributeArray(java.lang.String store, java.lang.String attributeName) Gets the named attribute from the named store.
java.lang.Object	getAttributeObject(java.lang.String store, java.lang.String attributeName) Gets a named attribute from the named store.
CombinedView	getCombinedView(java.lang.String name) Gets a named combined view.
java.lang.String	getDisplayName() Gets the user's display name.
EmulatorSessionsView	getEmulatorSessionsView(java.lang.String name) Gets a named application session view.
EventsView	getEventsView() Gets an event view.
boolean	getIsAdministrator() Checks if the user is an SGD administrator
IServiceLocator	getLocator() Gets the service locator
PrintJobsView	getPrintJobsView(java.lang.String name) Gets a named print jobs view.
java.lang.String	getSessionCookie() Gets the user session cookie.
java.lang.String	getStartTCCHelperId() Gets the ID of the SGD Client Helper that started the SGD Client.
java.lang.String	getTheme() Deprecated. Get the user's theme.
java.lang.Object	getValue(java.lang.String attname) Gets an arbitrary value from the session store.
java.lang.String	getVersion() Gets version information for the SGD server.
WebtopGroupContainer	getWebtopGroupContainer(java.lang.String name) Gets a named assigned applications group container.
WebtopViewBean	getWebtopView(java.lang.String name) Gets a named assigned applications view.
boolean	haveAuthentication() Tests if the session is already authenticated.
boolean	haveTccConnection() Tests if there is a connection between the SGD Client and the SGD server.
boolean	isAuthenticated() Tests if the session is already authenticated.
boolean	isEndingSession() Checks if the session is in process of ending.
boolean	isReallyAuthenticated() Tests if the session is already authenticated.
boolean	isTccAssociationAvailable() Tests if it is possible to associate with an existing SGD Client.
java.lang.String	lookupPrefs(java.lang.String[] desiredPreferences) Looks-up preferences for the user owning the session.
java.lang.String	lookupSession(java.lang.String[] desiredAttributes) Looks-up a user session.
java.lang.String	lookupUser(java.lang.String[] desiredAttributes) Looks-up attributes for the user who owns the user session.
java.lang.String	modifyPrefs(Item[] data) Modifies preferences for the user owning the session.
java.lang.String	modifySession(Item[] data, java.lang.String mode) Modifies a user session.
java.lang.String	refreshClientInfo() Requests an update of client information from the SGD Client.
void	refreshSessionState() Tests if the session is still valid.
java.lang.Object	removeValue(java.lang.String attname) Removes an arbitrary value from the session.
java.lang.String	restart(java.lang.String reconnectToken) Requests that a user session is linked to an SGD Client after an SGD server restart.
void	setLocator(IServiceLocator locator) Sets a service locator
java.lang.String	setSessionIdentity(java.lang.String username, java.lang.String clientId, java.lang.String locale, java.lang.String proxyUser, java.lang.String proxyCred) Requests that a user session is identified with a particular user.
void	setTCCConfiguration(java.lang.String userAgent, java.lang.String baseUrl, java.lang.String version, java.lang.String type) Sets the configuration for selecting SGD Client.
void	setTCCConfigurationOverrides(java.lang.String userAgent, java.lang.String baseUrl, java.lang.String version, java.lang.String type, Item[] overrides) Sets the configuration needed to select appropriate SGD Client.
java.lang.String	startTCC(java.lang.String helperId, java.lang.String handlerURL, java.lang.String target) Gets the information necessary to start the SGD Client.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionBean

public SessionBean()

Default constructor.

Since:

1.0

SessionBean

public SessionBean(java.lang.String sessionCookieArg)

Constructor.

Parameters:

sessionCookieArg - Existing session cookie.

Since:

1.0

Method Detail

getLocator

public IServiceLocator getLocator()

Gets the service locator

Returns:

The locator to web service end-points.

Since:

1.0

setLocator

public void setLocator(IServiceLocator locator)

Sets a service locator

Parameters:

locator - Locator of web service end-points.

Since:

1.0

authenticate

public java.lang.String authenticate(java.lang.String username,
                                     java.lang.String password,
                                     java.lang.String clientId,
                                     java.lang.String locale)
                              throws java.rmi.RemoteException

Creates and authenticates 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:

See ITarantellaWebtopSession.authenticate(String, String, String, String). This response is parsed within the method and data made accessible through getSessionCookie() and getAttribute(String, String).

Throws:

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

Since:

1.0

authenticateExt

public java.lang.String authenticateExt(java.lang.String username,
                                        java.lang.String password,
                                        java.lang.String clientId,
                                        java.lang.String locale,
                                        Item[] additionalCreds,
                                        Item[] loginContext)
                                 throws java.rmi.RemoteException

Creates and authenticates a user session that requires more credentials than just a username and password.

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.

additionalCreds - Array of additional credentials.

loginContext - Context of the multi-stage login. This will have been returned in the SOAP fault from a previous authentication request.

Returns:

See ITarantellaWebtopSession.authenticateExt(String, String, String, String, Item[], Item[]).

Throws:

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

Since:

1.0

authenticateMoreInfo

public java.lang.String authenticateMoreInfo(Item[] additionalCreds,
                                             java.lang.String prefLang)
                                      throws java.rmi.RemoteException

Provides more information to authenticate a user session. Used in multi-stage authentication processes, for example, resolving ambiguous users.

Parameters:

additionalCreds - Array of additional credentials.

prefLang - Preferred language.

Returns:

See ITarantellaWebtopSession.authenticateExt( String, String, String, String, Item[], Item[]) for details.

Throws:

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

Since:

1.0

authenticateMoreInfo

public java.lang.String authenticateMoreInfo(Item[] additionalCreds)
                                      throws java.rmi.RemoteException

Provides more information to authenticate a user session. Used in multi-stage authentication processes, for example, resolving ambiguous users.

Parameters:

additionalCreds - Array of additional credentials.

Returns:

See ITarantellaWebtopSession.authenticateExt( String, String, String, String, Item[], Item[]) for details.

Throws:

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

Since:

1.0

endSession

public java.lang.String endSession(boolean logout)
                            throws java.rmi.RemoteException

Ends a user session.

Parameters:

logout - Flag indicating if the user session is logged-out (true) or just ended (false).

Returns:

See ITarantellaWebtopSession.endSession(String, boolean).

Throws:

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

Since:

1.0

lookupSession

public java.lang.String lookupSession(java.lang.String[] desiredAttributes)
                               throws java.rmi.RemoteException

Looks-up a user session.

Parameters:

desiredAttributes - Array of attributes wanted in the response. For available shortcuts, see ITarantellaWebtopSession.lookupSession(String, String[]))

Returns:

See ITarantellaWebtopSession.lookupSession(String, String[]). The response is parsed within the method and the data stored in groups based on the source of the attributes. The data is accessible through getAttribute(String, String). For available stores, see ITarantellaWebtopSession.lookupSession(String, String[]))

Throws:

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

Since:

1.0

modifySession

public java.lang.String modifySession(Item[] data,
                                      java.lang.String mode)
                               throws java.rmi.RemoteException

Modifies a user session.

Parameters:

data - Array of attributes to change.

mode - Type of modification. See ITarantellaWebtopSession.modifySession(String, Item[], String). for details.

Returns:

See ITarantellaWebtopSession.modifySession(String, Item[], String).

Throws:

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

Since:

1.0

refreshClientInfo

public java.lang.String refreshClientInfo()
                                   throws java.rmi.RemoteException

Requests an update of client information from the SGD Client. The SGD Client * queries the client device and sends the current settings to the server, where they will be stored in the IConstantsXML.NAME_CLIENT_ATTRS group.

Returns:

See ITarantellaWebtopSession.refreshClientInfo(String).

Throws:

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

Since:

1.0

restart

public java.lang.String restart(java.lang.String reconnectToken)
                         throws java.rmi.RemoteException

Requests that a user session is linked to an SGD Client after an SGD server restart.

Parameters:

reconnectToken - A token to associate the user session with an existing SGD Client.

Returns:

See ITarantellaWebtopSession.restart(String, String).

Throws:

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

Since:

1.0

setSessionIdentity

public java.lang.String setSessionIdentity(java.lang.String username,
                                           java.lang.String clientId,
                                           java.lang.String locale,
                                           java.lang.String proxyUser,
                                           java.lang.String proxyCred)
                                    throws java.rmi.RemoteException

Requests that a user session is identified with a particular user. This 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.

proxyUser - The proxy user.

proxyCred - The proxy credential.

Returns:

See ITarantellaExternalAuth.setSessionIdentity(String, String, String).

Throws:

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

Since:

1.0

setTCCConfiguration

public void setTCCConfiguration(java.lang.String userAgent,
                                java.lang.String baseUrl,
                                java.lang.String version,
                                java.lang.String type)
                         throws java.rmi.RemoteException

Sets the configuration for selecting SGD Client. See ITarantellaWebtopSession.setTCCConfiguration(String, String, String, String, String) for details.

Parameters:

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.

Throws:

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

Since:

1.0

setTCCConfigurationOverrides

public void setTCCConfigurationOverrides(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 appropriate SGD Client. This method allows additional parameters to be overridden and is useful when the connection between SGD client and server is not direct, for example, passing through a gateway.

Parameters:

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. See ITarantellaWebtopSession.setTCCConfigurationOverrides(String, String, String, String, String, Item[]) for details of allowed overrides.

Throws:

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

Since:

1.0

startTCC

public java.lang.String startTCC(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.

Parameters:

helperId - Identifies SGD Client Helper ID.

handlerURL - URL of the handler of the connection message.

target - Output window or frame for the connection message.

Returns:

Returns the codeFragment from the response to ITarantellaWebtopSession.startTCC(String, String, String, String).

Throws:

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

Since:

1.0

associateTCC

public boolean associateTCC()

Checks the list of views returned in the authenticate response and tries to associate this view with an SGD CLient already running for another view.

Returns:

true if the association was successful, otherwise false. If association fails and the web application uses an SGD Client, it should call setTCCConfiguration(String, String, String, String) and startTCC(String, String, String).

getVersion

public java.lang.String getVersion()
                            throws java.rmi.RemoteException

Gets version information for the SGD server.

Returns:

Version info.

Throws:

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

Since:

1.0

getCombinedView

public CombinedView getCombinedView(java.lang.String name)

Gets a named combined view. A combined view contains both assigned applications and application session information in the same view hierarchy.

Parameters:

name - The name of the combined view.

Returns:

The combined view. A view is created if the named view does not exist.

Since:

1.0

getEmulatorSessionsView

public EmulatorSessionsView getEmulatorSessionsView(java.lang.String name)

Gets a named application session view.

Parameters:

name - The name of the application session view.

Returns:

The application session view. A view is created if the named view does not exist.

Since:

1.0

getWebtopView

public WebtopViewBean getWebtopView(java.lang.String name)

Gets a named assigned applications view.

Parameters:

name - The name of the assigned applications view.

Returns:

The assigned applications view. A view is created if the named view does not exist.

Since:

1.0

getPrintJobsView

public PrintJobsView getPrintJobsView(java.lang.String name)

Gets a named print jobs view.

Parameters:

name - The name of the print jobs view.

Returns:

The print jobs view. A view is created if the named view does not exist.

Since:

1.0

getEventsView

public EventsView getEventsView()

Gets an event view.

Returns:

The event view. The view is created if the view does not exist.

Since:

1.0

getWebtopGroupContainer

public WebtopGroupContainer getWebtopGroupContainer(java.lang.String name)

Gets a named assigned applications group container.

Parameters:

name - The name of the assigned applications group container.

Returns:

The assigned applications group container. A container is created if the named container if it does not exist.

Since:

1.0

getSessionCookie

public java.lang.String getSessionCookie()

Gets the user session cookie.

Returns:

The user session cookie.

Since:

1.0

getTheme

public java.lang.String getTheme()

Deprecated. Get the user's theme.

Returns:

User's theme.

Since:

1.0

getDisplayName

public java.lang.String getDisplayName()

Gets the user's display name.

Returns:

User's display name.

Since:

1.0

getStartTCCHelperId

public java.lang.String getStartTCCHelperId()

Gets the ID of the SGD Client Helper that started the SGD Client.

Returns:

The ID of the SGD Client Helper that started the SGD Client.

Since:

1.0

isEndingSession

public boolean isEndingSession()

Checks if the session is in process of ending.

Returns:

true if the session is ending, otherwise false

Since:

1.0

getIsAdministrator

public boolean getIsAdministrator()

Checks if the user is an SGD administrator

Returns:

true if the session belongs to an administrator, otherwise false

Since:

1.0

addValue

public void addValue(java.lang.String attname,
                     java.lang.Object attvalue)

Stores an arbitrary value on the session. The values are stored locally on the object and the SGD server is not involved.

Parameters:

attname - The name of the attribute.

attvalue - The value to be stored.

Since:

1.0

removeValue

public java.lang.Object removeValue(java.lang.String attname)

Removes an arbitrary value from the session. The values are stored locally on the object and the SGD server is not involved.

Parameters:

attname - The name of the attribute.

Returns:

The removed value or null if the named attribute is not in the store.

Since:

1.0

getValue

public java.lang.Object getValue(java.lang.String attname)

Gets an arbitrary value from the session store. The attribute remains in the store. The values are stored locally on the object and the SGD server is not involved.

Parameters:

attname - The name of the attribute.

Returns:

The value or null if the named attribute was not in the store.

Since:

1.0

isReallyAuthenticated

public boolean isReallyAuthenticated()

Tests if the session is already authenticated. Note that this tests the state of the session on the SGD server, so the response is always valid but expensive to obtain.

Returns:

true if authenticated, otherwise false

Since:

1.0

haveAuthentication

public boolean haveAuthentication()

Tests if the session is already authenticated. Note that this tests the value monitored by a server-side event listener registered to track changes. If a server-side event listener has not been registered, the method returns false.

Returns:

true if authenticated, otherwise false

Since:

1.0

isAuthenticated

public boolean isAuthenticated()

Tests if the session is already authenticated. Note that this tests a value locally and its response may be invalid.

Returns:

true is authenticated, otherwise false

Since:

1.0

lookupUser

public java.lang.String lookupUser(java.lang.String[] desiredAttributes)
                            throws java.rmi.RemoteException

Looks-up attributes for the user who owns the user session.

Parameters:

desiredAttributes - Array of attributes wanted in the response. IConstants.LOCAL_ATTRS is a shortcut to get those attributes that can be retrieved cheaply.

Returns:

See ITarantellaUser.lookupUser(String, String[]) for details.

Throws:

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

Since:

1.0

lookupPrefs

public java.lang.String lookupPrefs(java.lang.String[] desiredPreferences)
                             throws java.rmi.RemoteException

Looks-up preferences for the user owning the session.

Parameters:

desiredPreferences - The preferences wanted.

Returns:

See ITarantellaUser.lookupPrefs(String, String[]) for details.

Throws:

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

Since:

1.0

modifyPrefs

public java.lang.String modifyPrefs(Item[] data)
                             throws java.rmi.RemoteException

Modifies preferences for the user owning the session.

Parameters:

data - The preferences to be set.

Returns:

See ITarantellaUser.modifyPrefs(String, Item[]) for details.

Throws:

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

Since:

1.0

getAttributeObject

public java.lang.Object getAttributeObject(java.lang.String store,
                                           java.lang.String attributeName)

Gets a named attribute from the named store. This method operates on values cached locally after calls to the Secure Global Desktop server, for example, authenticate(String, String, String, String) and lookupSession(String[]). Unless the data has been obtained from the server previously, it will be missing from the cache.

Parameters:

store - The attribute store. A store is created for each source of attributes (see ITarantellaWebtopSession.lookupSession(String, String[])) for the names of the stores. If store is not one of the named stores, it tries each store in this order until the attribute is found or the stores exhausted.

attributeName - Name of the attribute.

Returns:

The attribute value.

Since:

1.0

getAttributeArray

public java.lang.String[] getAttributeArray(java.lang.String store,
                                            java.lang.String attributeName)

Gets the named attribute from the named store. See getAttributeObject(String, String) for details.

Parameters:

store - The attribute store.

attributeName - Name of the attribute.

Returns:

The attribute value.

Since:

1.0

getAttribute

public java.lang.String getAttribute(java.lang.String store,
                                     java.lang.String attributeName)

Gets the named attribute from the named store. See getAttributeObject(String, String) for details.

Parameters:

store - The attribute store.

attributeName - Name of the attribute.

Returns:

The attribute value.

Since:

1.0

authenticateMoreInfoPrompts

public DataRequest[] authenticateMoreInfoPrompts()

Gets information about additional credentials required in multi-stage authentication. Each element in the array contains information about an individual credential. See IConstantsGUI.

Returns:

An array of elements describing the additional credentials or null if there are not any.

Since:

1.0

haveTccConnection

public boolean haveTccConnection()

Tests if there is a connection between the SGD Client and the SGD server.

Returns:

true is there is a connection, otherwise false.

Since:

1.0

refreshSessionState

public void refreshSessionState()

Tests if the session is still valid. If it is not, internal state is cleared.

Since:

1.0

isTccAssociationAvailable

public boolean isTccAssociationAvailable()

Tests if it is possible to associate with an existing SGD Client.

Returns:

true if association is possible, otherwise false

Since:

1.0