Class CustomRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.deltava.servlet.filter.CustomRequestWrapper

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class CustomRequestWrapper
extends HttpServletRequestWrapper

A custom HTTP request wrapper to allow access to custom security information via standard Servlet API calls.

Since:

1.0

Version:

2.4

Author:

Luke

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
CustomRequestWrapper(HttpServletRequest req)	Creates a new wrapper from a raw servlet request.

Method Summary

Modifier and Type	Method	Description
final String	getAuthType()	Returns the authentication type.
final String	getRemoteUser()	Returns the name of the logged in user.
final Principal	getUserPrincipal()	Returns the user object associated with the logged in user.
final boolean	isUserInRole(String roleName)	Checks if a user is a member of a particular role.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, changeSessionId, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, login, logout, newPushBuilder, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Details

CustomRequestWrapper

public CustomRequestWrapper(HttpServletRequest req)

Creates a new wrapper from a raw servlet request.

Parameters:

req - the HTTP Servlet Request

Method Details

getAuthType

public final String getAuthType()

Returns the authentication type.

Specified by:

getAuthType in interface HttpServletRequest

Overrides:

getAuthType in class HttpServletRequestWrapper

Returns:

HttpServletRequest.FORM_AUTH

getRemoteUser

public final String getRemoteUser()

Returns the name of the logged in user.

Specified by:

getRemoteUser in interface HttpServletRequest

Overrides:

getRemoteUser in class HttpServletRequestWrapper

Returns:

the User name, or null if not authenticated

See Also:

• getUserPrincipal()

getUserPrincipal

public final Principal getUserPrincipal()

Returns the user object associated with the logged in user. Since Person implements Principal, this value can be safely casted.

Specified by:

getUserPrincipal in interface HttpServletRequest

Overrides:

getUserPrincipal in class HttpServletRequestWrapper

Returns:

the Person object, or null if not authenticated

See Also:

• getRemoteUser()
• Person
• HTTPContext.USER_ATTR_NAME

isUserInRole

public final boolean isUserInRole(String roleName)

Checks if a user is a member of a particular role. Unauthenticated users are members of the "anonymous" role.

Specified by:

isUserInRole in interface HttpServletRequest

Overrides:

isUserInRole in class HttpServletRequestWrapper

Parameters:

roleName - the role name

Returns:

TRUE if the user is a member of the role, otherwise FALSE

See Also:

• Person.isInRole(String)