org.apache.guacamole.servlet

Class GuacamoleHTTPTunnelServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class GuacamoleHTTPTunnelServlet
extends javax.servlet.http.HttpServlet

A HttpServlet implementing and abstracting the operations required by the HTTP implementation of the JavaScript Guacamole client's tunnel.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GuacamoleHTTPTunnelServlet()

Method Summary

Modifier and Type	Method and Description
protected void	deregisterTunnel(GuacamoleTunnel tunnel) Deregisters the given tunnel such that future read/write requests to that tunnel will be rejected.
void	destroy()
protected abstract GuacamoleTunnel	doConnect(javax.servlet.http.HttpServletRequest request) Called whenever the JavaScript Guacamole client makes a connection request via HTTP.
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doRead(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String tunnelUUID) Called whenever the JavaScript Guacamole client makes a read request.
protected void	doWrite(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String tunnelUUID) Called whenever the JavaScript Guacamole client makes a write request.
protected GuacamoleTunnel	getTunnel(String tunnelUUID) Returns the tunnel with the given UUID, if it has been registered with registerTunnel() and not yet deregistered with deregisterTunnel().
protected void	handleTunnelRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Dispatches every HTTP GET and POST request to the appropriate handler function based on the query string.
protected void	registerTunnel(GuacamoleTunnel tunnel) Registers the given tunnel such that future read/write requests to that tunnel will be properly directed.
protected void	sendError(javax.servlet.http.HttpServletResponse response, int guacamoleStatusCode, int guacamoleHttpCode, String message) Sends an error on the given HTTP response using the information within the given GuacamoleStatus.

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GuacamoleHTTPTunnelServlet

public GuacamoleHTTPTunnelServlet()

Method Detail

registerTunnel

protected void registerTunnel(GuacamoleTunnel tunnel)

Registers the given tunnel such that future read/write requests to that tunnel will be properly directed.

Parameters:

tunnel - The tunnel to register.

deregisterTunnel

protected void deregisterTunnel(GuacamoleTunnel tunnel)

Deregisters the given tunnel such that future read/write requests to that tunnel will be rejected.

Parameters:

tunnel - The tunnel to deregister.

getTunnel

protected GuacamoleTunnel getTunnel(String tunnelUUID)
                             throws GuacamoleException

Returns the tunnel with the given UUID, if it has been registered with registerTunnel() and not yet deregistered with deregisterTunnel().

Parameters:

tunnelUUID - The UUID of registered tunnel.

Returns:

The tunnel corresponding to the given UUID.

Throws:

GuacamoleException - If the requested tunnel does not exist because it has not yet been registered or it has been deregistered.

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

sendError

protected void sendError(javax.servlet.http.HttpServletResponse response,
                         int guacamoleStatusCode,
                         int guacamoleHttpCode,
                         String message)
                  throws javax.servlet.ServletException

Sends an error on the given HTTP response using the information within the given GuacamoleStatus.

Parameters:

response - The HTTP response to use to send the error.

guacamoleStatusCode - The GuacamoleStatus code to send.

guacamoleHttpCode - The numeric HTTP code to send.

message - The human-readable error message to send.

Throws:

javax.servlet.ServletException - If an error prevents sending of the error code.

handleTunnelRequest

protected void handleTunnelRequest(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws javax.servlet.ServletException

Dispatches every HTTP GET and POST request to the appropriate handler function based on the query string.

Parameters:

request - The HttpServletRequest associated with the GET or POST request received.

response - The HttpServletResponse associated with the GET or POST request received.

Throws:

javax.servlet.ServletException - If an error occurs while servicing the request.

doConnect

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

Called whenever the JavaScript Guacamole client makes a connection request via HTTP. 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.

doRead

protected void doRead(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      String tunnelUUID)
               throws GuacamoleException

Called whenever the JavaScript Guacamole client makes a read request. This function should in general not be overridden, as it already contains a proper implementation of the read operation.

Parameters:

request - The HttpServletRequest associated with the read request received.

response - The HttpServletResponse associated with the write request received. Any data to be sent to the client in response to the write request should be written to the response body of this HttpServletResponse.

tunnelUUID - The UUID of the tunnel to read from, as specified in the write request. This tunnel must have been created by a previous call to doConnect().

Throws:

GuacamoleException - If an error occurs while handling the read request.

doWrite

protected void doWrite(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       String tunnelUUID)
                throws GuacamoleException

Called whenever the JavaScript Guacamole client makes a write request. This function should in general not be overridden, as it already contains a proper implementation of the write operation.

Parameters:

request - The HttpServletRequest associated with the write request received. Any data to be written will be specified within the body of this request.

response - The HttpServletResponse associated with the write request received.

tunnelUUID - The UUID of the tunnel to write to, as specified in the write request. This tunnel must have been created by a previous call to doConnect().

Throws:

GuacamoleException - If an error occurs while handling the write request.

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet