org.apache.guacamole.net.event.listener

Interface TunnelConnectListener

public interface TunnelConnectListener

A listener whose tunnelConnected() hook will fire immediately after a new tunnel is connected.

Author:

Michael Jumper

Method Summary

Modifier and Type	Method and Description
boolean	tunnelConnected(TunnelConnectEvent e) Event hook which fires immediately after a new tunnel is connected.

Method Detail

tunnelConnected

boolean tunnelConnected(TunnelConnectEvent e)
                 throws org.apache.guacamole.GuacamoleException

Event hook which fires immediately after a new tunnel is connected. The return value of this hook dictates whether the tunnel is made visible to the session.

Parameters:

e - The TunnelConnectEvent describing the tunnel being connected and any associated credentials.

Returns:

true if the tunnel should be allowed to be connected, 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 connect event. Throwing an exception will also stop the tunnel from being made visible to the session.