org.glyptodon.guacamole.net.auth.simple

Class SimpleConnectionDirectory

java.lang.Object

org.glyptodon.guacamole.net.auth.simple.SimpleConnectionDirectory

All Implemented Interfaces:

Directory<String,Connection>

public class SimpleConnectionDirectory
extends Object
implements Directory<String,Connection>

An extremely simple read-only implementation of a Directory of GuacamoleConfigurations which provides access to a pre-defined Map of GuacamoleConfigurations.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
SimpleConnectionDirectory(Map<String,org.glyptodon.guacamole.protocol.GuacamoleConfiguration> configs) Creates a new SimpleConnectionDirectory which provides access to the configurations contained within the given Map.

Method Summary

Methods

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

SimpleConnectionDirectory

public SimpleConnectionDirectory(Map<String,org.glyptodon.guacamole.protocol.GuacamoleConfiguration> configs)

Creates a new SimpleConnectionDirectory which provides access to the configurations contained within the given Map.

Parameters:

configs - The Map of GuacamoleConfigurations to provide access to.

Method Detail

get

public Connection 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,Connection>

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,Connection>

Returns:

A Set of all identifiers.

Throws:

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

add

public void add(Connection connection)
         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,Connection>

Parameters:

connection - 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(Connection connection)
            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,Connection>

Parameters:

connection - 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,Connection>

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,Connection> 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,Connection>

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.

putConnection

public Connection putConnection(Connection connection)

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

Parameters:

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

Returns:

The previous connection for the connection identifier, if found.

removeConnection

public Connection removeConnection(String identifier)

An internal method for removing a Connection from this Directory.

Parameters:

identifier - The identifier of the Connection to remove.

Returns:

The previous connection for the given identifier, if found.