org.glyptodon.guacamole.net.basic

Class TunnelRequestService

java.lang.Object

org.glyptodon.guacamole.net.basic.TunnelRequestService

public class TunnelRequestService
extends Object

Utility class that takes a standard request from the Guacamole JavaScript client and produces the corresponding GuacamoleTunnel. The implementation of this utility is specific to the form of request used by the upstream Guacamole web application, and is not necessarily useful to applications that use purely the Guacamole API.

Author:

Michael Jumper, Vasily Loginov

Constructor Summary

Constructors

Constructor and Description
TunnelRequestService()

Method Summary

Modifier and Type	Method and Description
protected GuacamoleTunnel	createAssociatedTunnel(GuacamoleSession session, GuacamoleTunnel tunnel, TunnelRequest.Type type, String id) Associates the given tunnel with the given session, returning a wrapped version of the same tunnel which automatically handles closure and removal from the session.
protected GuacamoleTunnel	createConnectedTunnel(UserContext context, TunnelRequest.Type type, String id, GuacamoleClientInformation info) Creates a new tunnel using which is connected to the connection or connection group identifier by the given ID.
GuacamoleTunnel	createTunnel(TunnelRequest request) Creates a new tunnel using the parameters and credentials present in the given request.
protected GuacamoleClientInformation	getClientInformation(TunnelRequest request) Reads and returns the client information provided within the given request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TunnelRequestService

public TunnelRequestService()

Method Detail

getClientInformation

protected GuacamoleClientInformation getClientInformation(TunnelRequest request)
                                                   throws GuacamoleException

Reads and returns the client information provided within the given request.

Parameters:

request - The request describing tunnel to create.

Returns:

GuacamoleClientInformation An object containing information about the client sending the tunnel request.

Throws:

GuacamoleException - If the parameters of the tunnel request are invalid.

createConnectedTunnel

protected GuacamoleTunnel createConnectedTunnel(UserContext context,
                                                TunnelRequest.Type type,
                                                String id,
                                                GuacamoleClientInformation info)
                                         throws GuacamoleException

Creates a new tunnel using which is connected to the connection or connection group identifier by the given ID. Client information is specified in the info parameter.

Parameters:

context - The UserContext associated with the user for whom the tunnel is being created.

type - The type of object being connected to (connection or group).

id - The id of the connection or group being connected to.

info - Information describing the connected Guacamole client.

Returns:

A new tunnel, connected as required by the request.

Throws:

GuacamoleException - If an error occurs while creating the tunnel.

createAssociatedTunnel

protected GuacamoleTunnel createAssociatedTunnel(GuacamoleSession session,
                                                 GuacamoleTunnel tunnel,
                                                 TunnelRequest.Type type,
                                                 String id)
                                          throws GuacamoleException

Associates the given tunnel with the given session, returning a wrapped version of the same tunnel which automatically handles closure and removal from the session.

Parameters:

tunnel - The connected tunnel to wrap and monitor.

session - The Guacamole session to associate the tunnel with.

type - The type of object being connected to (connection or group).

id - The id of the connection or group being connected to.

Returns:

A new tunnel, associated with the given session, which delegates all functionality to the given tunnel while monitoring and automatically handling closure.

Throws:

GuacamoleException - If an error occurs while obtaining the tunnel.

createTunnel

public GuacamoleTunnel createTunnel(TunnelRequest request)
                             throws GuacamoleException

Creates a new tunnel using the parameters and credentials present in the given request.

Parameters:

request - The request describing the tunnel to create.

Returns:

The created tunnel, or null if the tunnel could not be created.

Throws:

GuacamoleException - If an error occurs while creating the tunnel.