org.glyptodon.guacamole.net.basic.websocket.jetty

Class AuthenticatingWebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.WebSocketServlet

org.glyptodon.guacamole.net.basic.websocket.jetty.AuthenticatingWebSocketServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicGuacamoleWebSocketTunnelServlet

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

A WebSocket servlet wrapped around an AuthenticatingHttpServlet.

Author:

Michael Jumper

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticatingWebSocketServlet()

Method Summary

Modifier and Type	Method and Description
protected abstract org.eclipse.jetty.websocket.WebSocket	authenticatedConnect(UserContext context, javax.servlet.http.HttpServletRequest request, String protocol) Function called after the credentials given in the request (if any) are authenticated.
org.eclipse.jetty.websocket.WebSocket	doWebSocketConnect(javax.servlet.http.HttpServletRequest request, String protocol)
void	init()
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

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

checkOrigin, destroy

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

AuthenticatingWebSocketServlet

public AuthenticatingWebSocketServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class org.eclipse.jetty.websocket.WebSocketServlet

Throws:

javax.servlet.ServletException

service

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

Overrides:

service in class org.eclipse.jetty.websocket.WebSocketServlet

Throws:

IOException

javax.servlet.ServletException

doWebSocketConnect

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

authenticatedConnect

protected abstract org.eclipse.jetty.websocket.WebSocket authenticatedConnect(UserContext context,
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              String protocol)

Function called after the credentials given in the request (if any) are authenticated. If the current session is not associated with valid credentials, this function will not be called.

Parameters:

context - The current UserContext.

request - The HttpServletRequest being serviced.

protocol - The protocol being used over the WebSocket connection.