Package org.apache.guacamole.net.event

Interface IdentifiableObjectEvent<ObjectType extends Identifiable>

Type Parameters:
ObjectType - The type of object affected or related to the event.
All Superinterfaces:
AuthenticationProviderEvent, UserEvent
All Known Subinterfaces:
DirectoryEvent<ObjectType>, DirectoryFailureEvent<ObjectType>, DirectorySuccessEvent<ObjectType>
public interface IdentifiableObjectEvent<ObjectType extends Identifiable> extends AuthenticationProviderEvent, UserEvent
Abstract basis for events which affect or directly relate to objects that are Identifiable and may be stored within a Directory.

  • Method Details

    • getAuthenticationProvider

      AuthenticationProvider getAuthenticationProvider()
      Returns the AuthenticationProvider that resulted in the event, if any. If the event occurred without any definite causing AuthenticationProvider, this may be null.

      NOTE: For subclasses of IdentifiableObjectEvent, this will be the AuthenticationProvider associated with the affected, Identifiable object. This is not necessarily the same as the AuthenticationProvider that authenticated the user performing the operation, which can be retrieved via UserEvent.getAuthenticatedUser() and AuthenticatedUser.getAuthenticationProvider().

      Specified by:
      getAuthenticationProvider in interface AuthenticationProviderEvent
      Returns:
      The AuthenticationProvider that resulted in the event, or null if no such AuthenticationProvider is known.

    • getDirectoryType

      Directory.Type getDirectoryType()
      Returns the type of Directory that may contains the object affected by the operation.
      Returns:
      The type of objects stored within the Directory.

    • getObjectIdentifier

      String getObjectIdentifier()
      Returns the identifier of the object affected by the operation.
      Returns:
      The identifier of the object affected by the operation.

    • getObject

      ObjectType getObject()
      Returns the object affected by the operation, if available. Whether the affected object is available is context- and implementation-dependent. There is no general guarantee across all implementations of this event that the affected object will be available. If the object is not available, null is returned.
      Returns:
      The object affected by the operation performed, or null if that object is not available in the context of this event.