net.sourceforge.guacamole.net.basic

Class BasicFileAuthenticationProvider

java.lang.Object

org.glyptodon.guacamole.net.auth.simple.SimpleAuthenticationProvider

net.sourceforge.guacamole.net.basic.BasicFileAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public class BasicFileAuthenticationProvider
extends SimpleAuthenticationProvider

Authenticates users against a static list of username/password pairs. Each username/password may be associated with multiple configurations. This list is stored in an XML file which is reread if modified.

Author:

Michael Jumper, Michal Kotas

Field Summary

Fields

Modifier and Type	Field and Description
static FileGuacamoleProperty	BASIC_USER_MAPPING The XML file to read the user mapping from.
static String	DEFAULT_USER_MAPPING The default filename to use for the user mapping, if not defined within guacamole.properties.

Constructor Summary

Constructors

Constructor and Description
BasicFileAuthenticationProvider() Creates a new BasicFileAuthenticationProvider that authenticates users against simple, monolithic XML file.

Method Summary

Modifier and Type	Method and Description
Map<String,GuacamoleConfiguration>	getAuthorizedConfigurations(Credentials credentials) Given an arbitrary credentials object, returns a Map containing all configurations authorized by those credentials.
String	getIdentifier() Returns the identifier which uniquely and consistently identifies this AuthenticationProvider implementation.

Methods inherited from class org.glyptodon.guacamole.net.auth.simple.SimpleAuthenticationProvider

authenticateUser, getUserContext, updateAuthenticatedUser, updateUserContext

Methods inherited from class java.lang.Object

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

Field Detail

BASIC_USER_MAPPING

public static final FileGuacamoleProperty BASIC_USER_MAPPING

The XML file to read the user mapping from.

DEFAULT_USER_MAPPING

public static final String DEFAULT_USER_MAPPING

The default filename to use for the user mapping, if not defined within guacamole.properties.

See Also:

Constant Field Values

Constructor Detail

BasicFileAuthenticationProvider

public BasicFileAuthenticationProvider()
                                throws GuacamoleException

Creates a new BasicFileAuthenticationProvider that authenticates users against simple, monolithic XML file.

Throws:

GuacamoleException - If a required property is missing, or an error occurs while parsing a property.

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.

Returns:

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

getAuthorizedConfigurations

public Map<String,GuacamoleConfiguration> getAuthorizedConfigurations(Credentials credentials)
                                                               throws GuacamoleException

Description copied from class: SimpleAuthenticationProvider

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.

Specified by:

getAuthorizedConfigurations in class SimpleAuthenticationProvider

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:

GuacamoleException - If an error occurs while retrieving configurations.