Package org.apache.sling.api.wrappers

Class SlingJakartaHttpServletRequestWrapper

java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
org.apache.sling.api.wrappers.SlingJakartaHttpServletRequestWrapper
All Implemented Interfaces:
jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest, Adaptable, SlingJakartaHttpServletRequest
public class SlingJakartaHttpServletRequestWrapper extends jakarta.servlet.http.HttpServletRequestWrapper implements SlingJakartaHttpServletRequest
The SlingJakartaHttpServletRequestWrapper class is a default wrapper class around a SlingJakartaHttpServletRequest which may be extended to amend the functionality of the original request object.
Since:
2.9.0

  • Field Summary

    Fields inherited from interface jakarta.servlet.http.HttpServletRequest

    BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

  • Constructor Summary

    Constructors
    Constructor
    Description
    SlingJakartaHttpServletRequestWrapper(SlingJakartaHttpServletRequest wrappedRequest)
    Create a wrapper for the supplied wrappedRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    <AdapterType>
    AdapterType
    adaptTo(Class<AdapterType> type)
    Adapts the adaptable to another type.
    jakarta.servlet.http.Cookie
    getCookie(String name)
    Returns the named cookie from the HTTP request or null if no such cookie exists in the request.
    jakarta.servlet.RequestDispatcher
    getRequestDispatcher(String path, RequestDispatcherOptions options)
    Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
    jakarta.servlet.RequestDispatcher
    getRequestDispatcher(Resource resource)
    Same as SlingJakartaHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions) but using empty options.
    jakarta.servlet.RequestDispatcher
    getRequestDispatcher(Resource resource, RequestDispatcherOptions options)
    Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given resource.
    RequestParameter
    getRequestParameter(String name)
    Returns the value of a request parameter as a RequestParameter, or null if the parameter does not exist.
    List<RequestParameter>
    getRequestParameterList()
    Returns the request parameters as instances of the RequestParameter interface in the order or the request where the query string parameters are first and the POST request parameters are second.
    RequestParameterMap
    getRequestParameterMap()
    Returns a Map of the parameters of this request.
    RequestParameter[]
    getRequestParameters(String name)
    Returns an array of RequestParameter objects containing all of the values the given request parameter has, or null if the parameter does not exist.
    RequestPathInfo
    getRequestPathInfo()
    Returns the RequestPathInfo pertaining to this request.
    RequestProgressTracker
    getRequestProgressTracker()
    Returns the RequestProgressTracker of this request.
    Resource
    getResource()
    Returns the Resource object on whose behalf the servlet acts.
    ResourceBundle
    getResourceBundle(String baseName, Locale locale)
    Returns the resource bundle of the given base name for the given locale.
    ResourceBundle
    getResourceBundle(Locale locale)
    Returns the resource bundle for the given locale.
    ResourceResolver
    getResourceResolver()
    Returns the ResourceResolver which resolved the resource of this request.
    String
    getResponseContentType()
    Returns the framework preferred content type for the response.
    Enumeration<String>
    getResponseContentTypes()
    Gets a list of content types which the framework accepts for the response.
    SlingJakartaHttpServletRequest
    getSlingRequest()
    Return the original SlingJakartaHttpServletRequest object wrapped by this.

    Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper

    authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, 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 java.lang.Object

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

    Methods inherited from interface jakarta.servlet.http.HttpServletRequest

    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, isUserInRole, login, logout, newPushBuilder, upgrade

    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

    Methods inherited from interface org.apache.sling.api.SlingJakartaHttpServletRequest

    getAuthType, getRemoteUser, getUserPrincipal