Class CustomRequestWrapper

java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
org.deltava.servlet.filter.CustomRequestWrapper
All Implemented Interfaces:
jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
public class CustomRequestWrapper extends jakarta.servlet.http.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 jakarta.servlet.http.HttpServletRequest

    BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomRequestWrapper(jakarta.servlet.http.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 jakarta.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, isRequestedSessionIdValid, isTrailerFieldsReady, login, logout, newPushBuilder, upgrade

    Methods inherited from class jakarta.servlet.ServletRequestWrapper

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

    Methods inherited from class Object

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

    Methods inherited from interface jakarta.servlet.ServletRequest

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

  • Constructor Details

    • CustomRequestWrapper

      public CustomRequestWrapper(jakarta.servlet.http.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 jakarta.servlet.http.HttpServletRequest
      Overrides:
      getAuthType in class jakarta.servlet.http.HttpServletRequestWrapper
      Returns:
      HttpServletRequest.FORM_AUTH

    • getRemoteUser

      public final String getRemoteUser()
      Returns the name of the logged in user.
      Specified by:
      getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
      Overrides:
      getRemoteUser in class jakarta.servlet.http.HttpServletRequestWrapper
      Returns:
      the User name, or null if not authenticated
      See Also:

    • 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 jakarta.servlet.http.HttpServletRequest
      Overrides:
      getUserPrincipal in class jakarta.servlet.http.HttpServletRequestWrapper
      Returns:
      the Person object, or null if not authenticated
      See Also:

    • 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 jakarta.servlet.http.HttpServletRequest
      Overrides:
      isUserInRole in class jakarta.servlet.http.HttpServletRequestWrapper
      Parameters:
      roleName - the role name
      Returns:
      TRUE if the user is a member of the role, otherwise FALSE
      See Also: