org.glyptodon.guacamole.net.basic

Class AuthenticatingHttpServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.glyptodon.guacamole.net.basic.AuthenticatingHttpServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicGuacamoleTunnelServlet, BasicLogin, CaptureClipboard, Create, Create, Create, Delete, Delete, Delete, List, List, List, List, List, Move, Move, Update, Update, Update

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

Abstract servlet which provides an authenticatedService() function that is only called if the HTTP request is authenticated, or the current HTTP session has already been authenticated. The user context is retrieved using the authentication provider defined in guacamole.properties. The authentication provider has access to the request and session, in addition to any submitted username and password, in order to authenticate the user. The user context will be stored in the current HttpSession. Success and failure are logged.

Author:

Michael Jumper

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIPBOARD_ATTRIBUTE The session attribute holding the session-scoped clipboard storage.
static String	CONTEXT_ATTRIBUTE The session attribute holding the current UserContext.
static String	CREDENTIALS_ATTRIBUTE The session attribute holding the credentials authorizing this session.

Constructor Summary

Constructors

Constructor and Description
AuthenticatingHttpServlet()

Method Summary

Modifier and Type	Method and Description
protected abstract void	authenticatedService(UserContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Function called after the credentials given in the request (if any) are authenticated.
static ClipboardState	getClipboardState(javax.servlet.http.HttpSession session) Returns the ClipboardState associated with the given session.
static Credentials	getCredentials(javax.servlet.http.HttpSession session) Returns the credentials associated with the given session.
static UserContext	getUserContext(javax.servlet.http.HttpSession session) Returns the UserContext associated with the given session.
protected boolean	hasNewCredentials(javax.servlet.http.HttpServletRequest request) Returns whether the request given has updated credentials.
void	init()
static void	sendError(javax.servlet.http.HttpServletResponse response, GuacamoleStatus guac_status, String message) Sends an error on the given HTTP response using the information within the given GuacamoleStatus.
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, 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

Field Detail

CONTEXT_ATTRIBUTE

public static final String CONTEXT_ATTRIBUTE

The session attribute holding the current UserContext.

See Also:

Constant Field Values

CREDENTIALS_ATTRIBUTE

public static final String CREDENTIALS_ATTRIBUTE

The session attribute holding the credentials authorizing this session.

See Also:

Constant Field Values

CLIPBOARD_ATTRIBUTE

public static final String CLIPBOARD_ATTRIBUTE

The session attribute holding the session-scoped clipboard storage.

See Also:

Constant Field Values

Constructor Detail

AuthenticatingHttpServlet

public AuthenticatingHttpServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

sendError

public static void sendError(javax.servlet.http.HttpServletResponse response,
                             GuacamoleStatus guac_status,
                             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.

guac_status - The status to send

message - A human-readable message that can be presented to the user.

Throws:

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

getCredentials

public static Credentials getCredentials(javax.servlet.http.HttpSession session)

Returns the credentials associated with the given session.

Parameters:

session - The session to retrieve credentials from.

Returns:

The credentials associated with the given session.

getUserContext

public static UserContext getUserContext(javax.servlet.http.HttpSession session)

Returns the UserContext associated with the given session.

Parameters:

session - The session to retrieve UserContext from.

Returns:

The UserContext associated with the given session.

getClipboardState

public static ClipboardState getClipboardState(javax.servlet.http.HttpSession session)

Returns the ClipboardState associated with the given session. If none exists yet, one is created.

Parameters:

session - The session to retrieve the ClipboardState from.

Returns:

The ClipboardState associated with the given session.

hasNewCredentials

protected boolean hasNewCredentials(javax.servlet.http.HttpServletRequest request)

Returns whether the request given has updated credentials. If this function returns false, the UserContext will not be updated.

Parameters:

request - The request to check for credentials.

Returns:

true if the request contains credentials, false otherwise.

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

authenticatedService

protected abstract void authenticatedService(UserContext context,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws GuacamoleException

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.

response - An HttpServletResponse which controls the HTTP response of this servlet.

Throws:

GuacamoleException - If an error occurs that interferes with the normal operation of this servlet.