Package org.apache.guacamole.net.auth

Class DelegatingDirectory<ObjectType extends Identifiable>

java.lang.Object
org.apache.guacamole.net.auth.DelegatingDirectory<ObjectType>
Type Parameters:
ObjectType - The type of objects stored within this Directory.
All Implemented Interfaces:
Directory<ObjectType>
Direct Known Subclasses:
DecoratingDirectory
public class DelegatingDirectory<ObjectType extends Identifiable> extends Object implements Directory<ObjectType>
Directory implementation which simply delegates all function calls to an underlying Directory.

  • Constructor Details

    • DelegatingDirectory

      public DelegatingDirectory(Directory<ObjectType> directory)
      Wraps the given Directory such that all function calls against this DelegatingDirectory will be delegated to it.
      Parameters:
      directory - The directory to wrap.

  • Method Details

    • getDelegateDirectory

      protected Directory<ObjectType> getDelegateDirectory()
      Returns the underlying Directory wrapped by this DelegatingDirectory.
      Returns:
      The Directory wrapped by this DelegatingDirectory.

    • get

      public ObjectType get(String identifier) throws org.apache.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<ObjectType extends Identifiable>
      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.apache.guacamole.GuacamoleException - If an error occurs while retrieving the object, or if permission for retrieving the object is denied.

    • getAll

      public Collection<ObjectType> getAll(Collection<String> identifiers) throws org.apache.guacamole.GuacamoleException
      Description copied from interface: Directory
      Returns the objects having the given identifiers. Note that changes to any object returned will not necessarily affect the object stored within the Directory. To update an object stored within a Directory such that future calls to get() will return the updated object, you must call update() on the object after modification.
      Specified by:
      getAll in interface Directory<ObjectType extends Identifiable>
      Parameters:
      identifiers - The identifiers to use when locating the objects to return.
      Returns:
      The objects having the given identifiers. If any identifiers do not correspond to accessible objects, those identifiers will be ignored. If no objects correspond to any of the given identifiers, the returned collection will be empty.
      Throws:
      org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the objects, or if permission to retrieve the requested objects is denied.

    • getIdentifiers

      public Set<String> getIdentifiers() throws org.apache.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<ObjectType extends Identifiable>
      Returns:
      A Set of all identifiers.
      Throws:
      org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the identifiers.

    • add

      public void add(ObjectType object) throws org.apache.guacamole.GuacamoleException
      Description copied from interface: Directory
      Adds the given object to the overall set. If a new identifier is created for the added object, that identifier will be automatically assigned via setIdentifier().
      Specified by:
      add in interface Directory<ObjectType extends Identifiable>
      Parameters:
      object - The object to add.
      Throws:
      org.apache.guacamole.GuacamoleException - If an error occurs while adding the object, or if adding the object is not allowed.

    • update

      public void update(ObjectType object) throws org.apache.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<ObjectType extends Identifiable>
      Parameters:
      object - The object which will supply the data for the update.
      Throws:
      org.apache.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.apache.guacamole.GuacamoleException
      Description copied from interface: Directory
      Removes the object with the given identifier from the overall set.
      Specified by:
      remove in interface Directory<ObjectType extends Identifiable>
      Parameters:
      identifier - The identifier of the object to remove.
      Throws:
      org.apache.guacamole.GuacamoleException - If an error occurs while removing the object, or if removing the object is not allowed.

    • tryAtomically

      public void tryAtomically(AtomicDirectoryOperation<ObjectType> operation) throws org.apache.guacamole.GuacamoleException
      Description copied from interface: Directory
      Attempt to perform the provided operation atomically if possible. If the operation can be performed atomically, the atomic flag will be set to true, and the directory passed to the provided operation callback will peform directory operations atomically within the operation callback.
      Specified by:
      tryAtomically in interface Directory<ObjectType extends Identifiable>
      Parameters:
      operation - The directory operation that should be performed atomically.
      Throws:
      org.apache.guacamole.GuacamoleException - If an error occurs during execution of the provided operation.