org.glyptodon.guacamole.net.auth

Interface Directory<IdentifierType,ObjectType>

Type Parameters:

IdentifierType - The type of identifier used to identify objects stored within this Directory.

ObjectType - The type of objects stored within this Directory.

All Known Implementing Classes:

SimpleConnectionDirectory, SimpleConnectionGroupDirectory, SimpleUserDirectory

public interface Directory<IdentifierType,ObjectType>

Provides access to a collection of all objects with associated identifiers, and allows user manipulation and removal. Objects stored within a Directory are not necessarily returned to the use as references to the stored objects, thus updating an object requires calling an update function.

Author:

Michael Jumper

Method Summary

Methods

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

Method Detail

get

ObjectType get(IdentifierType identifier)
               throws GuacamoleException

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.

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:

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

getIdentifiers

Set<IdentifierType> getIdentifiers()
                                   throws GuacamoleException

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

Returns:

A Set of all identifiers.

Throws:

GuacamoleException - If an error occurs while retrieving the identifiers.

add

void add(ObjectType object)
         throws GuacamoleException

Adds the given object to the overall set.

Parameters:

object - The object to add.

Throws:

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

update

void update(ObjectType object)
            throws GuacamoleException

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

Parameters:

object - 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

void remove(IdentifierType identifier)
            throws GuacamoleException

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

Parameters:

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

void move(IdentifierType identifier,
        Directory<IdentifierType,ObjectType> directory)
          throws GuacamoleException

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

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.