Package org.apache.guacamole.net.event.listener

Interface Listener

public interface Listener
A listener for events that occur in handing various Guacamole requests such as authentication, tunnel connect/close, etc. Listeners are registered through the extension manifest mechanism. When an event occurs, listeners are notified in the order in which they are declared in the manifest and continues until either all listeners have been notified or with the first listener that throws a GuacamoleException or other runtime exception.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    handleEvent(Object event)
    Notifies the recipient that an event has occurred.

  • Method Details

    • handleEvent

      void handleEvent(Object event) throws org.apache.guacamole.GuacamoleException
      Notifies the recipient that an event has occurred.

      Throwing an exception from an event listener can act to veto an action in progress for some event types. See the Javadoc for specific event types for details.

      Parameters:
      event - An object that describes the event that has occurred.
      Throws:
      org.apache.guacamole.GuacamoleException - If the listener wishes to stop notification of the event to subsequent listeners. For some event types, this acts to veto an action in progress; e.g. treating a successful authentication as though it failed.