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

Class TokenRESTService

java.lang.Object

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

public class TokenRESTService
extends Object

A service for managing auth tokens via the Guacamole REST API.

Author:

James Muehlner, Michael Jumper

Constructor Summary

Constructors

Constructor and Description
TokenRESTService()

Method Summary

Modifier and Type	Method and Description
APIAuthenticationResult	createToken(String username, String password, String token, javax.servlet.http.HttpServletRequest consumedRequest, javax.ws.rs.core.MultivaluedMap<String,String> parameters) Authenticates a user, generates an auth token, associates that auth token with the user's UserContext for use by further requests.
void	invalidateToken(String authToken) Invalidates a specific auth token, effectively logging out the associated user.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenRESTService

public TokenRESTService()

Method Detail

createToken

public APIAuthenticationResult createToken(String username,
                                           String password,
                                           String token,
                                           @Context
                                           javax.servlet.http.HttpServletRequest consumedRequest,
                                           javax.ws.rs.core.MultivaluedMap<String,String> parameters)
                                    throws GuacamoleException

Authenticates a user, generates an auth token, associates that auth token with the user's UserContext for use by further requests. If an existing token is provided, the authentication procedure will attempt to update or reuse the provided token.

Parameters:

username - The username of the user who is to be authenticated.

password - The password of the user who is to be authenticated.

token - An optional existing auth token for the user who is to be authenticated.

consumedRequest - The HttpServletRequest associated with the login attempt. The parameters of this request may not be accessible, as the request may have been fully consumed by JAX-RS.

parameters - A MultivaluedMap containing all parameters from the given HTTP request. All request parameters must be made available through this map, even if those parameters are no longer accessible within the now-fully-consumed HTTP request.

Returns:

An authentication response object containing the possible-new auth token, as well as other related data.

Throws:

GuacamoleException - If an error prevents successful authentication.

invalidateToken

public void invalidateToken(String authToken)

Invalidates a specific auth token, effectively logging out the associated user.

Parameters:

authToken - The token being invalidated.