net.sourceforge.guacamole.net.event
Class TunnelCloseEvent

java.lang.Object
  extended by net.sourceforge.guacamole.net.event.TunnelCloseEvent
All Implemented Interfaces:
CredentialEvent, TunnelEvent

public class TunnelCloseEvent
extends Object
implements CredentialEvent, TunnelEvent

An event which is triggered whenever a tunnel is being closed. The tunnel being closed can be accessed through getTunnel(), and the set of all credentials available from the request which is closing the tunnel can be retrieved using getCredentials().

Author:
Michael Jumper

Constructor Summary
TunnelCloseEvent(Credentials credentials, net.sourceforge.guacamole.net.GuacamoleTunnel tunnel)
          Creates a new TunnelCloseEvent which represents the closing of the given tunnel via a request associated with the given credentials.
 
Method Summary
 Credentials getCredentials()
          Returns the current credentials of the user triggering the event, if any.
 net.sourceforge.guacamole.net.GuacamoleTunnel getTunnel()
          Returns the tunnel associated with this event, if any.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TunnelCloseEvent

public TunnelCloseEvent(Credentials credentials,
                        net.sourceforge.guacamole.net.GuacamoleTunnel tunnel)
Creates a new TunnelCloseEvent which represents the closing of the given tunnel via a request associated with the given credentials.

Parameters:
credentials - The credentials associated with the request closing the tunnel.
tunnel - The tunnel being closed.
Method Detail

getCredentials

public Credentials getCredentials()
Description copied from interface: CredentialEvent
Returns the current credentials of the user triggering the event, if any.

Specified by:
getCredentials in interface CredentialEvent
Returns:
The current credentials of the user triggering the event, if any, or null if no credentials are associated with the event.

getTunnel

public net.sourceforge.guacamole.net.GuacamoleTunnel getTunnel()
Description copied from interface: TunnelEvent
Returns the tunnel associated with this event, if any.

Specified by:
getTunnel in interface TunnelEvent
Returns:
The tunnel associated with this event, if any, or null if no tunnel is associated with this event.


Copyright © 2012. All Rights Reserved.