org.apache.guacamole.net.event

Class TunnelCloseEvent

java.lang.Object

org.apache.guacamole.net.event.TunnelCloseEvent

All Implemented Interfaces:

CredentialEvent, TunnelEvent, UserEvent

public class TunnelCloseEvent
extends Object
implements UserEvent, CredentialEvent, TunnelEvent

An event which is triggered whenever a tunnel is being closed. The tunnel being closed can be accessed through getTunnel(), and the UserContext associated with the request which is closing the tunnel can be retrieved with getUserContext().

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
TunnelCloseEvent(UserContext context, Credentials credentials, org.apache.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

Modifier and Type	Method and Description
Credentials	getCredentials() Returns the current credentials of the user triggering the event, if any.
org.apache.guacamole.net.GuacamoleTunnel	getTunnel() Returns the tunnel associated with this event, if any.
UserContext	getUserContext() Returns the current UserContext of the user triggering the 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(UserContext context,
                        Credentials credentials,
                        org.apache.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:

context - The UserContext associated with the request closing the tunnel.

credentials - The credentials associated with the request that connected the tunnel.

tunnel - The tunnel being closed.

Method Detail

getUserContext

public UserContext getUserContext()

Description copied from interface: UserEvent

Returns the current UserContext of the user triggering the event, if any.

Specified by:

getUserContext in interface UserEvent

Returns:

The current UserContext of the user triggering the event, if any, or null if no UserContext is associated with the event.

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 org.apache.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.