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

Class ThreadLocalHttpServletResponseProxy

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

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

    • Field Summary

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

        SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

    • Constructor Summary

      Constructors 
      Constructor Description
      ThreadLocalHttpServletResponseProxy()
      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
      void addCookie​(javax.servlet.http.Cookie cookie)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void addDateHeader​(String name, long date)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void addHeader​(String name, String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void addIntHeader​(String name, int value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean containsHeader​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String encodeRedirectUrl​(String url)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String encodeRedirectURL​(String url)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String encodeUrl​(String url)
      Deprecated, for removal: This API element is subject to removal in a future version.
      String encodeURL​(String url)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void flushBuffer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      int getBufferSize()
      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.
      String getContentType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      protected javax.servlet.http.HttpServletResponse getCurrent()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the current HttpServletResponse from ThreadLocal storage.
      String getHeader​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Collection<String> getHeaderNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Collection<String> getHeaders​(String name)
      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.
      javax.servlet.ServletOutputStream getOutputStream()
      Deprecated, for removal: This API element is subject to removal in a future version.
      int getStatus()
      Deprecated, for removal: This API element is subject to removal in a future version.
      PrintWriter getWriter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      boolean isCommitted()
      Deprecated, for removal: This API element is subject to removal in a future version.
      void reset()
      Deprecated, for removal: This API element is subject to removal in a future version.
      void resetBuffer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      void sendError​(int sc)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void sendError​(int sc, String msg)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void sendRedirect​(String location)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setBufferSize​(int size)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setCharacterEncoding​(String charset)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setContentLength​(int len)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setContentLengthLong​(long len)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setContentType​(String type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setDateHeader​(String name, long date)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setHeader​(String name, String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setIntHeader​(String name, int value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setLocale​(Locale loc)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setStatus​(int sc)
      Deprecated, for removal: This API element is subject to removal in a future version.
      void setStatus​(int sc, String sm)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • Constructor Detail

      • ThreadLocalHttpServletResponseProxy

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

    • Method Detail

      • 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.ServletResponse

      • 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.ServletResponse

      • getOutputStream

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

      • getWriter

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

      • setCharacterEncoding

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

      • setContentLength

        public void setContentLength​(int len)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setContentLength in interface javax.servlet.ServletResponse

      • setContentType

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

      • setBufferSize

        public void setBufferSize​(int size)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setBufferSize in interface javax.servlet.ServletResponse

      • getBufferSize

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

      • flushBuffer

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

      • resetBuffer

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

      • isCommitted

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

      • reset

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

      • setLocale

        public void setLocale​(Locale loc)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setLocale in interface javax.servlet.ServletResponse

      • 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.ServletResponse

      • addCookie

        public void addCookie​(javax.servlet.http.Cookie cookie)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        addCookie in interface javax.servlet.http.HttpServletResponse

      • containsHeader

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

      • encodeURL

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

      • encodeRedirectURL

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

      • encodeUrl

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

      • encodeRedirectUrl

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

      • sendError

        public void sendError​(int sc,
                      String msg)
               throws IOException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        sendError in interface javax.servlet.http.HttpServletResponse
        Throws:
        IOException

      • sendError

        public void sendError​(int sc)
               throws IOException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        sendError in interface javax.servlet.http.HttpServletResponse
        Throws:
        IOException

      • sendRedirect

        public void sendRedirect​(String location)
                  throws IOException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        sendRedirect in interface javax.servlet.http.HttpServletResponse
        Throws:
        IOException

      • setDateHeader

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

      • addDateHeader

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

      • setHeader

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

      • addHeader

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

      • setIntHeader

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

      • addIntHeader

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

      • setStatus

        public void setStatus​(int sc)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setStatus in interface javax.servlet.http.HttpServletResponse

      • setStatus

        public void setStatus​(int sc,
                      String sm)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setStatus in interface javax.servlet.http.HttpServletResponse

      • getStatus

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

      • 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.HttpServletResponse

      • getHeaders

        public Collection<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.HttpServletResponse

      • getHeaderNames

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

      • setContentLengthLong

        public void setContentLengthLong​(long len)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        setContentLengthLong in interface javax.servlet.ServletResponse

      • getCurrent

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