org.glyptodon.guacamole.net.auth.simple

Class SimpleUserDirectory

java.lang.Object

org.glyptodon.guacamole.net.auth.simple.SimpleUserDirectory

All Implemented Interfaces:

Directory<String,User>

public class SimpleUserDirectory
extends Object
implements Directory<String,User>

An extremely simple read-only implementation of a Directory of Users which provides access to a single pre-defined User.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
SimpleUserDirectory(User user) Creates a new SimpleUserDirectory which provides access to the single user provided.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(User user) Adds the given object to the overall set.
User	get(String username) Returns the object having the given identifier.
Set<String>	getIdentifiers() Returns a Set containing all identifiers for all objects within this Directory.
void	move(String identifier, Directory<String,User> directory) Moves the object with the given identifier to the given directory.
void	remove(String username) Removes the object with the given identifier from the overall set.
void	update(User user) Updates the stored object with the data contained in the given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleUserDirectory

public SimpleUserDirectory(User user)

Creates a new SimpleUserDirectory which provides access to the single user provided.

Parameters:

user - The user to provide access to.

Method Detail

get

public User get(String username)
         throws GuacamoleException

Description copied from interface: Directory

Returns the object having the given identifier. Note that changes to the object returned will not necessarily affect the object stored within the Directory. To update an object stored within an Directory such that future calls to get() will return the updated object, you must call update() on the object after modification.

Specified by:

get in interface Directory<String,User>

Parameters:

username - The identifier to use when locating the object to return.

Returns:

The object having the given identifier, or null if no such object exists.

Throws:

GuacamoleException - If an error occurs while retrieving the object, or if permission for retrieving the object is denied.

getIdentifiers

public Set<String> getIdentifiers()
                           throws GuacamoleException

Description copied from interface: Directory

Returns a Set containing all identifiers for all objects within this Directory.

Specified by:

getIdentifiers in interface Directory<String,User>

Returns:

A Set of all identifiers.

Throws:

GuacamoleException - If an error occurs while retrieving the identifiers.

add

public void add(User user)
         throws GuacamoleException

Description copied from interface: Directory

Adds the given object to the overall set.

Specified by:

add in interface Directory<String,User>

Parameters:

user - The object to add.

Throws:

GuacamoleException - If an error occurs while adding the object , or if adding the object is not allowed.

update

public void update(User user)
            throws GuacamoleException

Description copied from interface: Directory

Updates the stored object with the data contained in the given object.

Specified by:

update in interface Directory<String,User>

Parameters:

user - The object which will supply the data for the update.

Throws:

GuacamoleException - If an error occurs while updating the object, or if updating the object is not allowed.

remove

public void remove(String username)
            throws GuacamoleException

Description copied from interface: Directory

Removes the object with the given identifier from the overall set.

Specified by:

remove in interface Directory<String,User>

Parameters:

username - The identifier of the object to remove.

Throws:

GuacamoleException - If an error occurs while removing the object, or if removing object is not allowed.

move

public void move(String identifier,
        Directory<String,User> directory)
          throws GuacamoleException

Description copied from interface: Directory

Moves the object with the given identifier to the given directory.

Specified by:

move in interface Directory<String,User>

Parameters:

identifier - The identifier of the object to remove.

directory - The directory to move the object to.

Throws:

GuacamoleException - If an error occurs while moving the object, or if moving object is not allowed.