org.apache.guacamole.net.event.listener

Interface TunnelCloseListener

public interface TunnelCloseListener

A listener whose tunnelClosed() hook will fire immediately after an existing tunnel is closed.

Author:

Michael Jumper

Method Summary

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

Method Detail

tunnelClosed

boolean tunnelClosed(TunnelCloseEvent e)
              throws org.apache.guacamole.GuacamoleException

Event hook which fires immediately after 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.