Class SlingServletRequestAdapter

java.lang.Object
javax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
org.apache.sling.engine.impl.adapter.SlingServletRequestAdapter
All Implemented Interfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, Adaptable, SlingHttpServletRequest

public class SlingServletRequestAdapter extends SlingHttpServletRequestWrapper
The SlingServletRequestAdapter class is a ComponentRequestWrapper which does not delegate to a wrapped ComponentRequest but to a wrapped HttpServletRequest. This is required if any user of the RequestDispatcher.include method uses a HttpServletRequestWrapper instead of a ComponentRequestWrapper.
  • Constructor Details

    • SlingServletRequestAdapter

      public SlingServletRequestAdapter(SlingHttpServletRequest delegatee, javax.servlet.http.HttpServletRequest request)
  • Method Details

    • getLocalAddr

      public String getLocalAddr()
      Specified by:
      getLocalAddr in interface javax.servlet.ServletRequest
      Overrides:
      getLocalAddr in class javax.servlet.ServletRequestWrapper
    • getLocalName

      public String getLocalName()
      Specified by:
      getLocalName in interface javax.servlet.ServletRequest
      Overrides:
      getLocalName in class javax.servlet.ServletRequestWrapper
    • getLocalPort

      public int getLocalPort()
      Specified by:
      getLocalPort in interface javax.servlet.ServletRequest
      Overrides:
      getLocalPort in class javax.servlet.ServletRequestWrapper
    • getRemotePort

      public int getRemotePort()
      Specified by:
      getRemotePort in interface javax.servlet.ServletRequest
      Overrides:
      getRemotePort in class javax.servlet.ServletRequestWrapper
    • getAuthType

      public String getAuthType()
      Description copied from interface: SlingHttpServletRequest
      Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the request is not authenticated null is returned.
      Specified by:
      getAuthType in interface javax.servlet.http.HttpServletRequest
      Specified by:
      getAuthType in interface SlingHttpServletRequest
      Overrides:
      getAuthType in class javax.servlet.http.HttpServletRequestWrapper
      Returns:
      the authentication scheme or {code null}
      See Also:
    • getContextPath

      public String getContextPath()
      Specified by:
      getContextPath in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getContextPath in class javax.servlet.http.HttpServletRequestWrapper
    • getCookies

      public javax.servlet.http.Cookie[] getCookies()
      Specified by:
      getCookies in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getCookies in class javax.servlet.http.HttpServletRequestWrapper
    • getDateHeader

      public long getDateHeader(String name)
      Specified by:
      getDateHeader in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getDateHeader in class javax.servlet.http.HttpServletRequestWrapper
    • getHeader

      public String getHeader(String name)
      Specified by:
      getHeader in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getHeader in class javax.servlet.http.HttpServletRequestWrapper
    • getHeaderNames

      public Enumeration<String> getHeaderNames()
      Specified by:
      getHeaderNames in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getHeaderNames in class javax.servlet.http.HttpServletRequestWrapper
    • getHeaders

      public Enumeration<String> getHeaders(String name)
      Specified by:
      getHeaders in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getHeaders in class javax.servlet.http.HttpServletRequestWrapper
    • getIntHeader

      public int getIntHeader(String name)
      Specified by:
      getIntHeader in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getIntHeader in class javax.servlet.http.HttpServletRequestWrapper
    • getMethod

      public String getMethod()
      Specified by:
      getMethod in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getMethod in class javax.servlet.http.HttpServletRequestWrapper
    • getPathInfo

      public String getPathInfo()
      Specified by:
      getPathInfo in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getPathInfo in class javax.servlet.http.HttpServletRequestWrapper
    • getPathTranslated

      public String getPathTranslated()
      Specified by:
      getPathTranslated in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getPathTranslated in class javax.servlet.http.HttpServletRequestWrapper
    • getQueryString

      public String getQueryString()
      Specified by:
      getQueryString in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getQueryString in class javax.servlet.http.HttpServletRequestWrapper
    • getRemoteUser

      public String getRemoteUser()
      Description copied from interface: SlingHttpServletRequest
      Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
      Specified by:
      getRemoteUser in interface javax.servlet.http.HttpServletRequest
      Specified by:
      getRemoteUser in interface SlingHttpServletRequest
      Overrides:
      getRemoteUser in class javax.servlet.http.HttpServletRequestWrapper
      Returns:
      a String specifying the login of the user making this request, or null
      See Also:
    • getRequestURI

      public String getRequestURI()
      Specified by:
      getRequestURI in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getRequestURI in class javax.servlet.http.HttpServletRequestWrapper
    • getRequestURL

      public StringBuffer getRequestURL()
      Specified by:
      getRequestURL in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getRequestURL in class javax.servlet.http.HttpServletRequestWrapper
    • getRequestedSessionId

      public String getRequestedSessionId()
      Specified by:
      getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getRequestedSessionId in class javax.servlet.http.HttpServletRequestWrapper
    • getServletPath

      public String getServletPath()
      Specified by:
      getServletPath in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getServletPath in class javax.servlet.http.HttpServletRequestWrapper
    • getSession

      public javax.servlet.http.HttpSession getSession()
      Specified by:
      getSession in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getSession in class javax.servlet.http.HttpServletRequestWrapper
    • getSession

      public javax.servlet.http.HttpSession getSession(boolean create)
      Specified by:
      getSession in interface javax.servlet.http.HttpServletRequest
      Overrides:
      getSession in class javax.servlet.http.HttpServletRequestWrapper
    • getUserPrincipal

      public Principal getUserPrincipal()
      Description copied from interface: SlingHttpServletRequest
      Returns a java.security.Principal object containing the name of the current authenticated user.

      Note: This method deviates from the parent interface and might return a prinicpal even for anonymous users. Therefore it cannot be used to determine whether the user is authenticated.

      Specified by:
      getUserPrincipal in interface javax.servlet.http.HttpServletRequest
      Specified by:
      getUserPrincipal in interface SlingHttpServletRequest
      Overrides:
      getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper
      Returns:
      a java.security.Principal or null.
      See Also:
    • isRequestedSessionIdFromCookie

      public boolean isRequestedSessionIdFromCookie()
      Specified by:
      isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromCookie in class javax.servlet.http.HttpServletRequestWrapper
    • isRequestedSessionIdFromURL

      public boolean isRequestedSessionIdFromURL()
      Specified by:
      isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromURL in class javax.servlet.http.HttpServletRequestWrapper
    • isRequestedSessionIdFromUrl

      @Deprecated public boolean isRequestedSessionIdFromUrl()
      Deprecated.
      Specified by:
      isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdFromUrl in class javax.servlet.http.HttpServletRequestWrapper
    • isRequestedSessionIdValid

      public boolean isRequestedSessionIdValid()
      Specified by:
      isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
      Overrides:
      isRequestedSessionIdValid in class javax.servlet.http.HttpServletRequestWrapper
    • isUserInRole

      public boolean isUserInRole(String role)
      Specified by:
      isUserInRole in interface javax.servlet.http.HttpServletRequest
      Overrides:
      isUserInRole in class javax.servlet.http.HttpServletRequestWrapper
    • getAttribute

      public Object getAttribute(String name)
      Specified by:
      getAttribute in interface javax.servlet.ServletRequest
      Overrides:
      getAttribute in class javax.servlet.ServletRequestWrapper
    • getAttributeNames

      public Enumeration<String> getAttributeNames()
      Specified by:
      getAttributeNames in interface javax.servlet.ServletRequest
      Overrides:
      getAttributeNames in class javax.servlet.ServletRequestWrapper
    • getCharacterEncoding

      public String getCharacterEncoding()
      Specified by:
      getCharacterEncoding in interface javax.servlet.ServletRequest
      Overrides:
      getCharacterEncoding in class javax.servlet.ServletRequestWrapper
    • getContentLength

      public int getContentLength()
      Specified by:
      getContentLength in interface javax.servlet.ServletRequest
      Overrides:
      getContentLength in class javax.servlet.ServletRequestWrapper
    • getContentType

      public String getContentType()
      Specified by:
      getContentType in interface javax.servlet.ServletRequest
      Overrides:
      getContentType in class javax.servlet.ServletRequestWrapper
    • getInputStream

      public javax.servlet.ServletInputStream getInputStream() throws IOException
      Specified by:
      getInputStream in interface javax.servlet.ServletRequest
      Overrides:
      getInputStream in class javax.servlet.ServletRequestWrapper
      Throws:
      IOException
    • getLocale

      public Locale getLocale()
      Specified by:
      getLocale in interface javax.servlet.ServletRequest
      Overrides:
      getLocale in class javax.servlet.ServletRequestWrapper
    • getLocales

      public Enumeration<Locale> getLocales()
      Specified by:
      getLocales in interface javax.servlet.ServletRequest
      Overrides:
      getLocales in class javax.servlet.ServletRequestWrapper
    • getParameter

      public String getParameter(String name)
      Specified by:
      getParameter in interface javax.servlet.ServletRequest
      Overrides:
      getParameter in class javax.servlet.ServletRequestWrapper
    • getParameterMap

      public Map<String,String[]> getParameterMap()
      Specified by:
      getParameterMap in interface javax.servlet.ServletRequest
      Overrides:
      getParameterMap in class javax.servlet.ServletRequestWrapper
    • getParameterNames

      public Enumeration<String> getParameterNames()
      Specified by:
      getParameterNames in interface javax.servlet.ServletRequest
      Overrides:
      getParameterNames in class javax.servlet.ServletRequestWrapper
    • getParameterValues

      public String[] getParameterValues(String name)
      Specified by:
      getParameterValues in interface javax.servlet.ServletRequest
      Overrides:
      getParameterValues in class javax.servlet.ServletRequestWrapper
    • getProtocol

      public String getProtocol()
      Specified by:
      getProtocol in interface javax.servlet.ServletRequest
      Overrides:
      getProtocol in class javax.servlet.ServletRequestWrapper
    • getReader

      public BufferedReader getReader() throws IOException
      Specified by:
      getReader in interface javax.servlet.ServletRequest
      Overrides:
      getReader in class javax.servlet.ServletRequestWrapper
      Throws:
      IOException
    • getRealPath

      @Deprecated public String getRealPath(String path)
      Deprecated.
      Specified by:
      getRealPath in interface javax.servlet.ServletRequest
      Overrides:
      getRealPath in class javax.servlet.ServletRequestWrapper
    • getRemoteAddr

      public String getRemoteAddr()
      Specified by:
      getRemoteAddr in interface javax.servlet.ServletRequest
      Overrides:
      getRemoteAddr in class javax.servlet.ServletRequestWrapper
    • getRemoteHost

      public String getRemoteHost()
      Specified by:
      getRemoteHost in interface javax.servlet.ServletRequest
      Overrides:
      getRemoteHost in class javax.servlet.ServletRequestWrapper
    • getRequest

      public javax.servlet.ServletRequest getRequest()
      Overrides:
      getRequest in class javax.servlet.ServletRequestWrapper
    • getSlingRequest

      public SlingHttpServletRequest getSlingRequest()
      Description copied from class: SlingHttpServletRequestWrapper
      Return the original SlingHttpServletRequest object wrapped by this.
      Overrides:
      getSlingRequest in class SlingHttpServletRequestWrapper
      Returns:
      The wrapped request.
    • getRequestDispatcher

      public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
      Specified by:
      getRequestDispatcher in interface javax.servlet.ServletRequest
      Overrides:
      getRequestDispatcher in class javax.servlet.ServletRequestWrapper
    • getScheme

      public String getScheme()
      Specified by:
      getScheme in interface javax.servlet.ServletRequest
      Overrides:
      getScheme in class javax.servlet.ServletRequestWrapper
    • getServerName

      public String getServerName()
      Specified by:
      getServerName in interface javax.servlet.ServletRequest
      Overrides:
      getServerName in class javax.servlet.ServletRequestWrapper
    • getServerPort

      public int getServerPort()
      Specified by:
      getServerPort in interface javax.servlet.ServletRequest
      Overrides:
      getServerPort in class javax.servlet.ServletRequestWrapper
    • isSecure

      public boolean isSecure()
      Specified by:
      isSecure in interface javax.servlet.ServletRequest
      Overrides:
      isSecure in class javax.servlet.ServletRequestWrapper
    • removeAttribute

      public void removeAttribute(String name)
      Specified by:
      removeAttribute in interface javax.servlet.ServletRequest
      Overrides:
      removeAttribute in class javax.servlet.ServletRequestWrapper
    • setAttribute

      public void setAttribute(String name, Object o)
      Specified by:
      setAttribute in interface javax.servlet.ServletRequest
      Overrides:
      setAttribute in class javax.servlet.ServletRequestWrapper
    • setCharacterEncoding

      public void setCharacterEncoding(String enc) throws UnsupportedEncodingException
      Specified by:
      setCharacterEncoding in interface javax.servlet.ServletRequest
      Overrides:
      setCharacterEncoding in class javax.servlet.ServletRequestWrapper
      Throws:
      UnsupportedEncodingException