org.glyptodon.guacamole.net.basic.rest.auth

Class APIAuthenticationResult

java.lang.Object

org.glyptodon.guacamole.net.basic.rest.auth.APIAuthenticationResult

public class APIAuthenticationResult
extends Object

A simple object which describes the result of an authentication operation, including the resulting token.

Author:

James Muehlner, Michael Jumper

Constructor Summary

Constructors

Constructor and Description
APIAuthenticationResult(String authToken, String username, String dataSource, List<String> availableDataSources) Create a new APIAuthenticationResult object containing the given data.

Method Summary

Modifier and Type	Method and Description
String	getAuthToken() Returns the unique authentication token which identifies the current session.
List<String>	getAvailableDataSources() Returns the identifiers of all data sources available to the user associated with the current session.
String	getDataSource() Returns the unique identifier of the data source associated with the user account associated with the current session.
String	getUsername() Returns the user identified by the authentication token associated with the current session.

Methods inherited from class java.lang.Object

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

Constructor Detail

APIAuthenticationResult

public APIAuthenticationResult(String authToken,
                               String username,
                               String dataSource,
                               List<String> availableDataSources)

Create a new APIAuthenticationResult object containing the given data.

Parameters:

authToken - The unique token generated for the user that authenticated, to be used for the duration of their session.

username - The username of the user owning the given token.

dataSource - The unique identifier of the AuthenticationProvider which authenticated the user.

availableDataSources - The unique identifier of all AuthenticationProviders to which the user now has access.

Method Detail

getAuthToken

public String getAuthToken()

Returns the unique authentication token which identifies the current session.

Returns:

The user's authentication token.

getUsername

public String getUsername()

Returns the user identified by the authentication token associated with the current session.

Returns:

The user identified by this authentication token.

getDataSource

public String getDataSource()

Returns the unique identifier of the data source associated with the user account associated with the current session.

Returns:

The unique identifier of the data source associated with the user account associated with the current session.

getAvailableDataSources

public List<String> getAvailableDataSources()

Returns the identifiers of all data sources available to the user associated with the current session.

Returns:

The identifiers of all data sources available to the user associated with the current session.