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

Interface TunnelCloseListener

@Deprecated public interface TunnelCloseListener
Deprecated.
Listeners should instead implement the Listener interface.
A listener whose tunnelClosed() hook will fire immediately before an existing tunnel is closed.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    tunnelClosed(TunnelCloseEvent e)
    Deprecated.
    Event hook which fires immediately before an existing tunnel is closed.

  • Method Details

    • tunnelClosed

      boolean tunnelClosed(TunnelCloseEvent e) throws org.apache.guacamole.GuacamoleException
      Deprecated.
      Event hook which fires immediately before an existing tunnel is closed. The return value of this hook dictates whether the tunnel is allowed to be closed.
      Parameters:
      e - The TunnelCloseEvent describing the tunnel being closed and any associated credentials.
      Returns:
      true if the tunnel should be allowed to be closed, or false if the attempt should be denied, causing the attempt to effectively fail.
      Throws:
      org.apache.guacamole.GuacamoleException - If an error occurs while handling the tunnel close event. Throwing an exception will also stop the tunnel from being closed.