org.glyptodon.guacamole.net.basic.websocket.jetty8

Class GuacamoleWebSocketTunnelServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.WebSocketServlet

org.glyptodon.guacamole.net.basic.websocket.jetty8.GuacamoleWebSocketTunnelServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.eclipse.jetty.websocket.WebSocketFactory.Acceptor

Direct Known Subclasses:

BasicGuacamoleWebSocketTunnelServlet

public abstract class GuacamoleWebSocketTunnelServlet
extends org.eclipse.jetty.websocket.WebSocketServlet

A WebSocketServlet partial re-implementation of GuacamoleTunnelServlet.

Author:

Michael Jumper

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GuacamoleWebSocketTunnelServlet()

Method Summary

Modifier and Type	Method and Description
static void	closeConnection(org.eclipse.jetty.websocket.WebSocket.Connection connection, GuacamoleStatus guac_status) Sends the given status on the given WebSocket connection and closes the connection.
protected abstract GuacamoleTunnel	doConnect(javax.servlet.http.HttpServletRequest request) Called whenever the JavaScript Guacamole client makes a connection request.
org.eclipse.jetty.websocket.WebSocket	doWebSocketConnect(javax.servlet.http.HttpServletRequest request, String protocol)

Methods inherited from class org.eclipse.jetty.websocket.WebSocketServlet

checkOrigin, destroy, init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

GuacamoleWebSocketTunnelServlet

public GuacamoleWebSocketTunnelServlet()

Method Detail

closeConnection

public static void closeConnection(org.eclipse.jetty.websocket.WebSocket.Connection connection,
                                   GuacamoleStatus guac_status)

Sends the given status on the given WebSocket connection and closes the connection.

Parameters:

connection - The WebSocket connection to close.

guac_status - The status to send.

doWebSocketConnect

public org.eclipse.jetty.websocket.WebSocket doWebSocketConnect(javax.servlet.http.HttpServletRequest request,
                                                                String protocol)

doConnect

protected abstract GuacamoleTunnel doConnect(javax.servlet.http.HttpServletRequest request)
                                      throws GuacamoleException

Called whenever the JavaScript Guacamole client makes a connection request. It it up to the implementor of this function to define what conditions must be met for a tunnel to be configured and returned as a result of this connection request (whether some sort of credentials must be specified, for example).

Parameters:

request - The HttpServletRequest associated with the connection request received. Any parameters specified along with the connection request can be read from this object.

Returns:

A newly constructed GuacamoleTunnel if successful, null otherwise.

Throws:

GuacamoleException - If an error occurs while constructing the GuacamoleTunnel, or if the conditions required for connection are not met.