org.glyptodon.guacamole.net.auth.simple

Class SimpleConnectionGroupDirectory

java.lang.Object

org.glyptodon.guacamole.net.auth.simple.SimpleConnectionGroupDirectory

All Implemented Interfaces:

Directory<String,ConnectionGroup>

public class SimpleConnectionGroupDirectory
extends Object
implements Directory<String,ConnectionGroup>

An extremely simple read-only implementation of a Directory of ConnectionGroup which provides which provides access to a pre-defined Collection of ConnectionGroups.

Author:

James Muehlner

Constructor Summary

Constructors

Constructor and Description
SimpleConnectionGroupDirectory(Collection<ConnectionGroup> groups) Creates a new SimpleConnectionGroupDirectory which contains the given groups.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ConnectionGroup connectionGroup) Adds the given object to the overall set.
ConnectionGroup	get(String identifier) 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,ConnectionGroup> directory) Moves the object with the given identifier to the given directory.
ConnectionGroup	putConnectionGroup(ConnectionGroup connectionGroup) An internal method for modifying the ConnectionGroups in this Directory.
void	remove(String identifier) Removes the object with the given identifier from the overall set.
ConnectionGroup	removeConnectionGroup(String identifier) An internal method for removing a ConnectionGroup from this Directory.
void	update(ConnectionGroup connectionGroup) 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

SimpleConnectionGroupDirectory

public SimpleConnectionGroupDirectory(Collection<ConnectionGroup> groups)

Creates a new SimpleConnectionGroupDirectory which contains the given groups.

Parameters:

groups - A Collection of all groups that should be present in this connection group directory.

Method Detail

get

public ConnectionGroup get(String identifier)
                    throws org.glyptodon.guacamole.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,ConnectionGroup>

Parameters:

identifier - 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:

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

getIdentifiers

public Set<String> getIdentifiers()
                           throws org.glyptodon.guacamole.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,ConnectionGroup>

Returns:

A Set of all identifiers.

Throws:

org.glyptodon.guacamole.GuacamoleException - If an error occurs while retrieving the identifiers.

add

public void add(ConnectionGroup connectionGroup)
         throws org.glyptodon.guacamole.GuacamoleException

Description copied from interface: Directory

Adds the given object to the overall set.

Specified by:

add in interface Directory<String,ConnectionGroup>

Parameters:

connectionGroup - The object to add.

Throws:

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

update

public void update(ConnectionGroup connectionGroup)
            throws org.glyptodon.guacamole.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,ConnectionGroup>

Parameters:

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

Throws:

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

remove

public void remove(String identifier)
            throws org.glyptodon.guacamole.GuacamoleException

Description copied from interface: Directory

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

Specified by:

remove in interface Directory<String,ConnectionGroup>

Parameters:

identifier - The identifier of the object to remove.

Throws:

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

move

public void move(String identifier,
        Directory<String,ConnectionGroup> directory)
          throws org.glyptodon.guacamole.GuacamoleException

Description copied from interface: Directory

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

Specified by:

move in interface Directory<String,ConnectionGroup>

Parameters:

identifier - The identifier of the object to remove.

directory - The directory to move the object to.

Throws:

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

putConnectionGroup

public ConnectionGroup putConnectionGroup(ConnectionGroup connectionGroup)

An internal method for modifying the ConnectionGroups in this Directory. Returns the previous connection group for the given identifier, if found.

Parameters:

connectionGroup - The connection group to add or update the Directory with.

Returns:

The previous connection group for the connection group identifier, if found.

removeConnectionGroup

public ConnectionGroup removeConnectionGroup(String identifier)

An internal method for removing a ConnectionGroup from this Directory.

Parameters:

identifier - The identifier of the ConnectionGroup to remove.

Returns:

The previous connection group for the given identifier, if found.