org.glyptodon.guacamole.net.basic.websocket.tomcat

Class AuthenticatingWebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.catalina.websocket.WebSocketServlet

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicGuacamoleWebSocketTunnelServlet

public abstract class AuthenticatingWebSocketServlet
extends org.apache.catalina.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.apache.catalina.websocket.StreamInbound	authenticatedConnect(UserContext context, javax.servlet.http.HttpServletRequest request, String protocol) Function called after the credentials given in the request (if any) are authenticated.
org.apache.catalina.websocket.StreamInbound	createWebSocketInbound(String protocol, javax.servlet.http.HttpServletRequest request)
void	init()
protected String	selectSubProtocol(List<String> subProtocols)
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.apache.catalina.websocket.WebSocketServlet

doGet, verifyOrigin

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

destroy, 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 javax.servlet.GenericServlet

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 javax.servlet.http.HttpServlet

Throws:

IOException

javax.servlet.ServletException

selectSubProtocol

protected String selectSubProtocol(List<String> subProtocols)

Overrides:

selectSubProtocol in class org.apache.catalina.websocket.WebSocketServlet

createWebSocketInbound

public org.apache.catalina.websocket.StreamInbound createWebSocketInbound(String protocol,
                                                                          javax.servlet.http.HttpServletRequest request)

Specified by:

createWebSocketInbound in class org.apache.catalina.websocket.WebSocketServlet

authenticatedConnect

protected abstract org.apache.catalina.websocket.StreamInbound 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.