org.eurekaclinical.standardapis.filter

Class RolesRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.eurekaclinical.standardapis.filter.RolesRequestWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class RolesRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper

Wraps an HttpServletRequest object, so that roles for the principal can be implemented if none are populated in the request instance.

Author:

hrathod

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
RolesRequestWrapper(javax.servlet.http.HttpServletRequest inRequest, Principal inPrincipal, String[] inRoles) Create a wrapper with the given principal, role assigned to that principal, and the original request.

Method Summary

Modifier and Type	Method and Description
Set<String>	getRoles()
Principal	getUserPrincipal() Returns the Principal that was passed into the constructor.
boolean	isUserInRole(String inRole) Checks if the given role is one of those that were passed into the constructor.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, login, logout

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, 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, 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 Detail

RolesRequestWrapper

public RolesRequestWrapper(javax.servlet.http.HttpServletRequest inRequest,
                           Principal inPrincipal,
                           String[] inRoles)

Create a wrapper with the given principal, role assigned to that principal, and the original request.

Parameters:

inRequest - The original request. Cannot be null.

inPrincipal - The request principal. Cannot be null.

inRoles - The roles assigned to the principal.

Method Detail

isUserInRole

public boolean isUserInRole(String inRole)

Checks if the given role is one of those that were passed into the constructor. If null passed in for roles, it checks the request that was passed into the constructor instead.

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

Overrides:

isUserInRole in class javax.servlet.http.HttpServletRequestWrapper

Parameters:

inRole - a role.

Returns:

true or false.

getUserPrincipal

public Principal getUserPrincipal()

Returns the Principal that was passed into the constructor. If null was passed into the constructor, it tries getting the Principal from the request that was passed into the constructor.

Specified by:

getUserPrincipal in interface javax.servlet.http.HttpServletRequest

Overrides:

getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper

Returns:

a user principal.

getRoles

public Set<String> getRoles()