net.sourceforge.guacamole.net.auth.simple

Class SimpleAuthenticationProvider

java.lang.Object

net.sourceforge.guacamole.net.auth.simple.SimpleAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public abstract class SimpleAuthenticationProvider
extends Object
implements AuthenticationProvider

Provides means of retrieving a set of named GuacamoleConfigurations for a given Credentials object. This is a simple AuthenticationProvider implementation intended to be easily extended. It is useful for simple authentication situations where access to web-based administration and complex users and permissions are not required. The interface provided by SimpleAuthenticationProvider is similar to that of the AuthenticationProvider interface of older Guacamole releases.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
SimpleAuthenticationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Map<String,net.sourceforge.guacamole.protocol.GuacamoleConfiguration>	getAuthorizedConfigurations(Credentials credentials) Given an arbitrary credentials object, returns a Map containing all configurations authorized by those credentials.
UserContext	getUserContext(Credentials credentials) Returns the UserContext of the user authorized by the given credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleAuthenticationProvider

public SimpleAuthenticationProvider()

Method Detail

getAuthorizedConfigurations

public abstract Map<String,net.sourceforge.guacamole.protocol.GuacamoleConfiguration> getAuthorizedConfigurations(Credentials credentials)
                                                                                                           throws net.sourceforge.guacamole.GuacamoleException

Given an arbitrary credentials object, returns a Map containing all configurations authorized by those credentials. The keys of this Map are Strings which uniquely identify each configuration.

Parameters:

credentials - The credentials to use to retrieve authorized configurations.

Returns:

A Map of all configurations authorized by the given credentials, or null if the credentials given are not authorized.

Throws:

net.sourceforge.guacamole.GuacamoleException - If an error occurs while retrieving configurations.

getUserContext

public UserContext getUserContext(Credentials credentials)
                           throws net.sourceforge.guacamole.GuacamoleException

Description copied from interface: AuthenticationProvider

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

Specified by:

getUserContext in interface AuthenticationProvider

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:

net.sourceforge.guacamole.GuacamoleException - If an error occurs while creating the UserContext.