org.glyptodon.guacamole.net.basic.extension

Class AuthenticationProviderFacade

java.lang.Object

org.glyptodon.guacamole.net.basic.extension.AuthenticationProviderFacade

All Implemented Interfaces:

AuthenticationProvider

public class AuthenticationProviderFacade
extends Object
implements AuthenticationProvider

Provides a safe wrapper around an AuthenticationProvider subclass, such that authentication attempts can cleanly fail, and errors can be properly logged, even if the AuthenticationProvider cannot be instantiated.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
AuthenticationProviderFacade(Class<? extends AuthenticationProvider> authProviderClass) Creates a new AuthenticationProviderFacade which delegates all function calls to an instance of the given AuthenticationProvider subclass.

Method Summary

Modifier and Type	Method and Description
AuthenticatedUser	authenticateUser(Credentials credentials) Returns an AuthenticatedUser representing the user authenticated by the given credentials, if any.
String	getIdentifier() Returns the identifier which uniquely and consistently identifies this AuthenticationProvider implementation.
UserContext	getUserContext(AuthenticatedUser authenticatedUser) Returns the UserContext of the user authenticated by the given credentials.
AuthenticatedUser	updateAuthenticatedUser(AuthenticatedUser authenticatedUser, Credentials credentials) Returns a new or updated AuthenticatedUser for the given credentials already having produced the given AuthenticatedUser.
UserContext	updateUserContext(UserContext context, AuthenticatedUser authenticatedUser) Returns a new or updated UserContext for the given AuthenticatedUser already having the given UserContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationProviderFacade

public AuthenticationProviderFacade(Class<? extends AuthenticationProvider> authProviderClass)

Creates a new AuthenticationProviderFacade which delegates all function calls to an instance of the given AuthenticationProvider subclass. If an instance of the given class cannot be created, creation of this facade will still succeed, but its use will result in errors being logged, and all authentication attempts will fail.

Parameters:

authProviderClass - The AuthenticationProvider subclass to instantiate.

Method Detail

getIdentifier

public String getIdentifier()

Description copied from interface: AuthenticationProvider

Returns the identifier which uniquely and consistently identifies this AuthenticationProvider implementation. This identifier may not be null and must be unique across all AuthenticationProviders loaded by the Guacamole web application.

Specified by:

getIdentifier in interface AuthenticationProvider

Returns:

The unique identifier assigned to this AuthenticationProvider, which may not be null.

authenticateUser

public AuthenticatedUser authenticateUser(Credentials credentials)
                                   throws GuacamoleException

Description copied from interface: AuthenticationProvider

Returns an AuthenticatedUser representing the user authenticated by the given credentials, if any.

Specified by:

authenticateUser in interface AuthenticationProvider

Parameters:

credentials - The credentials to use for authentication.

Returns:

An AuthenticatedUser representing the user authenticated by the given credentials, if any, or null if the credentials are invalid.

Throws:

GuacamoleException - If an error occurs while authenticating the user, or if access is temporarily, permanently, or conditionally denied, such as if the supplied credentials are insufficient or invalid.

updateAuthenticatedUser

public AuthenticatedUser updateAuthenticatedUser(AuthenticatedUser authenticatedUser,
                                                 Credentials credentials)
                                          throws GuacamoleException

Description copied from interface: AuthenticationProvider

Returns a new or updated AuthenticatedUser for the given credentials already having produced the given AuthenticatedUser. 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(). Doing otherwise may cause the GuacamoleHTTPTunnelServlet to fail.

Specified by:

updateAuthenticatedUser in interface AuthenticationProvider

Parameters:

authenticatedUser - An AuthenticatedUser object representing the user authenticated by an arbitrary set of credentials. The AuthenticatedUser may come from this AuthenticationProvider or any other installed AuthenticationProvider.

credentials - The credentials to use for authentication.

Returns:

An updated AuthenticatedUser representing the user authenticated by the given credentials, if any, or null if the credentials are invalid.

Throws:

GuacamoleException - If an error occurs while updating the AuthenticatedUser.

getUserContext

public UserContext getUserContext(AuthenticatedUser authenticatedUser)
                           throws GuacamoleException

Description copied from interface: AuthenticationProvider

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

Specified by:

getUserContext in interface AuthenticationProvider

Parameters:

authenticatedUser - An AuthenticatedUser object representing the user authenticated by an arbitrary set of credentials. The AuthenticatedUser may come from this AuthenticationProvider or any other installed AuthenticationProvider.

Returns:

A UserContext describing the permissions, connection, connection groups, etc. accessible or associated with the given authenticated user, or null if this AuthenticationProvider refuses to provide any such data.

Throws:

GuacamoleException - If an error occurs while creating the UserContext.

updateUserContext

public UserContext updateUserContext(UserContext context,
                                     AuthenticatedUser authenticatedUser)
                              throws GuacamoleException

Description copied from interface: AuthenticationProvider

Returns a new or updated UserContext for the given AuthenticatedUser already having the given 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(). Doing otherwise may cause the GuacamoleHTTPTunnelServlet to fail.

Specified by:

updateUserContext in interface AuthenticationProvider

Parameters:

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

authenticatedUser - An AuthenticatedUser object representing the user authenticated by an arbitrary set of credentials. The AuthenticatedUser may come from this AuthenticationProvider or any other installed AuthenticationProvider.

Returns:

An updated UserContext describing the permissions, connection, connection groups, etc. accessible or associated with the given authenticated user, or null if this AuthenticationProvider refuses to provide any such data.

Throws:

GuacamoleException - If an error occurs while updating the UserContext.