Package net.shibboleth.utilities.java.support.net.impl

Class ThreadLocalHttpServletRequestProxy

  • All Implemented Interfaces:
    javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
    @Deprecated(since="8.4.0",
            forRemoval=true)
public class ThreadLocalHttpServletRequestProxy
extends Object
implements javax.servlet.http.HttpServletRequest
    Deprecated, for removal: This API element is subject to removal in a future version.
    An implementation of HttpServletRequest which serves as a proxy for the current thread-local servlet request obtained from HttpServletRequestResponseContext.

    This should be avoided in place of ThreadLocalHttpServletRequestSupplier which indirects the access to the interface.

    This copy of the class contains the deprecation warning and will be used within Shibboleth software so deployers note it. The original classes do not warn and prevent any of our deployed code using the original classes from emitting the warnings.

    • Field Summary

      • Fields inherited from interface javax.servlet.http.HttpServletRequest

        BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

    • Constructor Summary

      Constructors 
      Constructor Description
      ThreadLocalHttpServletRequestProxy()
      Deprecated, for removal: This API element is subject to removal in a future version.
       

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean authenticate​(javax.servlet.http.HttpServletResponse response)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String changeSessionId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.AsyncContext getAsyncContext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Object getAttribute​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enumeration<String> getAttributeNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getAuthType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getCharacterEncoding()
      Deprecated, for removal: This API element is subject to removal in a future version.
      int getContentLength()
      Deprecated, for removal: This API element is subject to removal in a future version.
      long getContentLengthLong()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getContentType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getContextPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.http.Cookie[] getCookies()
      Deprecated, for removal: This API element is subject to removal in a future version.
      protected javax.servlet.http.HttpServletRequest getCurrent()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the current HttpServletRequest from ThreadLocal storage.
      long getDateHeader​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.DispatcherType getDispatcherType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getHeader​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enumeration<String> getHeaderNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enumeration<String> getHeaders​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.ServletInputStream getInputStream()
      Deprecated, for removal: This API element is subject to removal in a future version.
      int getIntHeader​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getLocalAddr()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Locale getLocale()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enumeration<Locale> getLocales()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getLocalName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      int getLocalPort()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getMethod()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getParameter​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Map<String,​String[]> getParameterMap()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enumeration<String> getParameterNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String[] getParameterValues​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.http.Part getPart​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Collection<javax.servlet.http.Part> getParts()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getPathInfo()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getPathTranslated()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getProtocol()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getQueryString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      BufferedReader getReader()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getRealPath​(String path)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getRemoteAddr()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getRemoteHost()
      Deprecated, for removal: This API element is subject to removal in a future version.
      int getRemotePort()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getRemoteUser()
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.RequestDispatcher getRequestDispatcher​(String path)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getRequestedSessionId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getRequestURI()
      Deprecated, for removal: This API element is subject to removal in a future version.
      StringBuffer getRequestURL()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getScheme()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getServerName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      int getServerPort()
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.ServletContext getServletContext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      String getServletPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.http.HttpSession getSession()
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.http.HttpSession getSession​(boolean create)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Principal getUserPrincipal()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isAsyncStarted()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isAsyncSupported()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isRequestedSessionIdFromCookie()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isRequestedSessionIdFromUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isRequestedSessionIdFromURL()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isRequestedSessionIdValid()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isSecure()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isUserInRole​(String role)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void login​(String username, String password)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void logout()
      Deprecated, for removal: This API element is subject to removal in a future version.
      void removeAttribute​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setAttribute​(String name, Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setCharacterEncoding​(String env)
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.AsyncContext startAsync()
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.servlet.AsyncContext startAsync​(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
      Deprecated, for removal: This API element is subject to removal in a future version.
      <T extends javax.servlet.http.HttpUpgradeHandler>
      T      		 upgrade​(Class<T> handlerClass)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • Constructor Detail

      • ThreadLocalHttpServletRequestProxy

        public ThreadLocalHttpServletRequestProxy()
        Deprecated, for removal: This API element is subject to removal in a future version.

    • Method Detail

      • getAttribute

        public Object getAttribute​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getAttribute in interface javax.servlet.ServletRequest

      • getAttributeNames

        public Enumeration<String> getAttributeNames()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getAttributeNames in interface javax.servlet.ServletRequest

      • getCharacterEncoding

        public String getCharacterEncoding()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getCharacterEncoding in interface javax.servlet.ServletRequest

      • setCharacterEncoding

        public void setCharacterEncoding​(String env)
                          throws UnsupportedEncodingException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setCharacterEncoding in interface javax.servlet.ServletRequest
        Throws:
        UnsupportedEncodingException

      • getContentLength

        public int getContentLength()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getContentLength in interface javax.servlet.ServletRequest

      • getContentType

        public String getContentType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getContentType in interface javax.servlet.ServletRequest

      • getInputStream

        public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getInputStream in interface javax.servlet.ServletRequest
        Throws:
        IOException

      • getParameter

        public String getParameter​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getParameter in interface javax.servlet.ServletRequest

      • getParameterNames

        public Enumeration<String> getParameterNames()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getParameterNames in interface javax.servlet.ServletRequest

      • getParameterValues

        public String[] getParameterValues​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getParameterValues in interface javax.servlet.ServletRequest

      • getParameterMap

        public Map<String,​String[]> getParameterMap()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getParameterMap in interface javax.servlet.ServletRequest

      • getProtocol

        public String getProtocol()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getProtocol in interface javax.servlet.ServletRequest

      • getScheme

        public String getScheme()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getScheme in interface javax.servlet.ServletRequest

      • getServerName

        public String getServerName()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getServerName in interface javax.servlet.ServletRequest

      • getServerPort

        public int getServerPort()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getServerPort in interface javax.servlet.ServletRequest

      • getReader

        public BufferedReader getReader()
                         throws IOException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getReader in interface javax.servlet.ServletRequest
        Throws:
        IOException

      • getRemoteAddr

        public String getRemoteAddr()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRemoteAddr in interface javax.servlet.ServletRequest

      • getRemoteHost

        public String getRemoteHost()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRemoteHost in interface javax.servlet.ServletRequest

      • setAttribute

        public void setAttribute​(String name,
                         Object o)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setAttribute in interface javax.servlet.ServletRequest

      • removeAttribute

        public void removeAttribute​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        removeAttribute in interface javax.servlet.ServletRequest

      • getLocale

        public Locale getLocale()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getLocale in interface javax.servlet.ServletRequest

      • getLocales

        public Enumeration<Locale> getLocales()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getLocales in interface javax.servlet.ServletRequest

      • isSecure

        public boolean isSecure()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isSecure in interface javax.servlet.ServletRequest

      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher​(String path)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRequestDispatcher in interface javax.servlet.ServletRequest

      • getRealPath

        public String getRealPath​(String path)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRealPath in interface javax.servlet.ServletRequest

      • getRemotePort

        public int getRemotePort()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRemotePort in interface javax.servlet.ServletRequest

      • getLocalName

        public String getLocalName()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getLocalName in interface javax.servlet.ServletRequest

      • getLocalAddr

        public String getLocalAddr()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getLocalAddr in interface javax.servlet.ServletRequest

      • getLocalPort

        public int getLocalPort()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getLocalPort in interface javax.servlet.ServletRequest

      • getAuthType

        public String getAuthType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getAuthType in interface javax.servlet.http.HttpServletRequest

      • getCookies

        public javax.servlet.http.Cookie[] getCookies()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getCookies in interface javax.servlet.http.HttpServletRequest

      • getDateHeader

        public long getDateHeader​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getDateHeader in interface javax.servlet.http.HttpServletRequest

      • getHeader

        public String getHeader​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getHeader in interface javax.servlet.http.HttpServletRequest

      • getHeaders

        public Enumeration<String> getHeaders​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getHeaders in interface javax.servlet.http.HttpServletRequest

      • getHeaderNames

        public Enumeration<String> getHeaderNames()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getHeaderNames in interface javax.servlet.http.HttpServletRequest

      • getIntHeader

        public int getIntHeader​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getIntHeader in interface javax.servlet.http.HttpServletRequest

      • getMethod

        public String getMethod()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getMethod in interface javax.servlet.http.HttpServletRequest

      • getPathInfo

        public String getPathInfo()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getPathInfo in interface javax.servlet.http.HttpServletRequest

      • getPathTranslated

        public String getPathTranslated()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getPathTranslated in interface javax.servlet.http.HttpServletRequest

      • getContextPath

        public String getContextPath()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getContextPath in interface javax.servlet.http.HttpServletRequest

      • getQueryString

        public String getQueryString()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getQueryString in interface javax.servlet.http.HttpServletRequest

      • getRemoteUser

        public String getRemoteUser()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRemoteUser in interface javax.servlet.http.HttpServletRequest

      • isUserInRole

        public boolean isUserInRole​(String role)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isUserInRole in interface javax.servlet.http.HttpServletRequest

      • getUserPrincipal

        public Principal getUserPrincipal()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getUserPrincipal in interface javax.servlet.http.HttpServletRequest

      • getRequestedSessionId

        public String getRequestedSessionId()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

      • getRequestURI

        public String getRequestURI()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRequestURI in interface javax.servlet.http.HttpServletRequest

      • getRequestURL

        public StringBuffer getRequestURL()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getRequestURL in interface javax.servlet.http.HttpServletRequest

      • getServletPath

        public String getServletPath()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getServletPath in interface javax.servlet.http.HttpServletRequest

      • getSession

        public javax.servlet.http.HttpSession getSession​(boolean create)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest

      • getSession

        public javax.servlet.http.HttpSession getSession()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest

      • isRequestedSessionIdValid

        public boolean isRequestedSessionIdValid()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

      • isRequestedSessionIdFromCookie

        public boolean isRequestedSessionIdFromCookie()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

      • isRequestedSessionIdFromURL

        public boolean isRequestedSessionIdFromURL()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

      • isRequestedSessionIdFromUrl

        public boolean isRequestedSessionIdFromUrl()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

      • getServletContext

        public javax.servlet.ServletContext getServletContext()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getServletContext in interface javax.servlet.ServletRequest

      • startAsync

        public javax.servlet.AsyncContext startAsync()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        startAsync in interface javax.servlet.ServletRequest

      • startAsync

        public javax.servlet.AsyncContext startAsync​(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        startAsync in interface javax.servlet.ServletRequest

      • isAsyncStarted

        public boolean isAsyncStarted()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isAsyncStarted in interface javax.servlet.ServletRequest

      • isAsyncSupported

        public boolean isAsyncSupported()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        isAsyncSupported in interface javax.servlet.ServletRequest

      • getAsyncContext

        public javax.servlet.AsyncContext getAsyncContext()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getAsyncContext in interface javax.servlet.ServletRequest

      • getDispatcherType

        public javax.servlet.DispatcherType getDispatcherType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getDispatcherType in interface javax.servlet.ServletRequest

      • authenticate

        public boolean authenticate​(javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        authenticate in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException

      • login

        public void login​(String username,
                  String password)
           throws javax.servlet.ServletException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        login in interface javax.servlet.http.HttpServletRequest
        Throws:
        javax.servlet.ServletException

      • logout

        public void logout()
            throws javax.servlet.ServletException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        logout in interface javax.servlet.http.HttpServletRequest
        Throws:
        javax.servlet.ServletException

      • getParts

        public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getParts in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException

      • getPart

        public javax.servlet.http.Part getPart​(String name)
                                throws IOException,
                                       javax.servlet.ServletException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getPart in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException

      • getContentLengthLong

        public long getContentLengthLong()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getContentLengthLong in interface javax.servlet.ServletRequest

      • changeSessionId

        public String changeSessionId()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        changeSessionId in interface javax.servlet.http.HttpServletRequest

      • upgrade

        public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade​(Class<T> handlerClass)
                                                            throws IOException,
                                                                   javax.servlet.ServletException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        upgrade in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException

      • getCurrent

        protected javax.servlet.http.HttpServletRequest getCurrent()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Get the current HttpServletRequest from ThreadLocal storage.
        Returns:
        the current request