org.glyptodon.guacamole.net.auth

Interface AuthenticationProvider

All Known Implementing Classes:

SimpleAuthenticationProvider

public interface AuthenticationProvider

Provides means of accessing and managing the available GuacamoleConfiguration objects and User objects. Access to each configuration and each user is limited by a given Credentials object.

Author:

Michael Jumper

Method Summary

Methods

Modifier and Type	Method and Description
UserContext	getUserContext(Credentials credentials) Returns the UserContext of the user authorized by the given credentials.
UserContext	updateUserContext(UserContext context, Credentials credentials) Returns a new or updated UserContext for the user authorized by the give credentials and having the given existing UserContext.

Method Detail

getUserContext

UserContext getUserContext(Credentials credentials)
                           throws org.glyptodon.guacamole.GuacamoleException

Returns the UserContext of the user authorized by the given credentials.

Parameters:

credentials - The credentials to use to retrieve the environment.

Returns:

The UserContext of the user authorized by the given credentials, or null if the credentials are not authorized.

Throws:

org.glyptodon.guacamole.GuacamoleException - If an error occurs while creating the UserContext.

updateUserContext

UserContext updateUserContext(UserContext context,
                            Credentials credentials)
                              throws org.glyptodon.guacamole.GuacamoleException

Returns a new or updated UserContext for the user authorized by the give credentials and having the given existing UserContext. Note that because this function will be called for all future requests after initial authentication, including tunnel requests, care must be taken to avoid using functions of HttpServletRequest which invalidate the entire request body, such as getParameter().

Parameters:

context - The existing UserContext belonging to the user in question.

credentials - The credentials to use to retrieve or update the environment.

Returns:

The updated UserContext, which need not be the same as the UserContext given, or null if the user is no longer authorized.

Throws:

org.glyptodon.guacamole.GuacamoleException - If an error occurs while updating the UserContext.