Package org.jboss.resteasy.core

Class ResteasyHttpServletResponseWrapper

  • All Implemented Interfaces:
    javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
    public class ResteasyHttpServletResponseWrapper
extends javax.servlet.ServletResponseWrapper
implements javax.servlet.http.HttpServletResponse
    ResteasyHttpServletResponseWrapper is introduced to support the use of RequestDispatcher.forward() and RequestDispatcher.include(), which need to be able to retrieve the orginal HttpServletResponse.
    Version:
    $Revision: 1.1 $ Copyright Apr 18, 2014

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private javax.servlet.http.HttpServletResponse proxy  
      private javax.servlet.http.HttpServletResponse response  

      • 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
      ResteasyHttpServletResponseWrapper​(javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletResponse proxy)  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addCookie​(javax.servlet.http.Cookie cookie)  
      void addDateHeader​(java.lang.String name, long date)  
      void addHeader​(java.lang.String name, java.lang.String value)  
      void addIntHeader​(java.lang.String name, int value)  
      boolean containsHeader​(java.lang.String name)  
      java.lang.String encodeRedirectUrl​(java.lang.String url)
      Deprecated.
      As of version 2.1, use encodeRedirectURL(String url) instead
      java.lang.String encodeRedirectURL​(java.lang.String url)  
      java.lang.String encodeUrl​(java.lang.String url)
      Deprecated.
      As of version 2.1, use encodeURL(String url) instead
      java.lang.String encodeURL​(java.lang.String url)  
      void flushBuffer()  
      int getBufferSize()  
      java.lang.String getCharacterEncoding()  
      java.lang.String getContentType()  
      java.lang.String getHeader​(java.lang.String name)  
      java.util.Collection<java.lang.String> getHeaderNames()  
      java.util.Collection<java.lang.String> getHeaders​(java.lang.String name)  
      javax.servlet.http.HttpServletResponse getHttpServletResponse()  
      java.util.Locale getLocale()  
      javax.servlet.ServletOutputStream getOutputStream()  
      javax.servlet.ServletResponse getResponse()  
      int getStatus()  
      java.io.PrintWriter getWriter()  
      boolean isCommitted()  
      void reset()  
      void resetBuffer()  
      void sendError​(int sc)  
      void sendError​(int sc, java.lang.String msg)  
      void sendRedirect​(java.lang.String location)  
      void setBufferSize​(int size)  
      void setCharacterEncoding​(java.lang.String charset)  
      void setContentLength​(int len)  
      void setContentType​(java.lang.String type)  
      void setDateHeader​(java.lang.String name, long date)  
      void setHeader​(java.lang.String name, java.lang.String value)  
      void setIntHeader​(java.lang.String name, int value)  
      void setLocale​(java.util.Locale loc)  
      void setStatus​(int sc)  
      void setStatus​(int sc, java.lang.String sm)
      Deprecated.
      As of version 2.1, due to ambiguous meaning of the message parameter.

      • Methods inherited from class javax.servlet.ServletResponseWrapper

        isWrapperFor, isWrapperFor, setContentLengthLong, setResponse

      • Methods inherited from class java.lang.Object

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

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

        getTrailerFields, setTrailerFields

      • Methods inherited from interface javax.servlet.ServletResponse

        setContentLengthLong

    • Field Detail

      • response

        private javax.servlet.http.HttpServletResponse response

      • proxy

        private javax.servlet.http.HttpServletResponse proxy

    • Constructor Detail

      • ResteasyHttpServletResponseWrapper

        public ResteasyHttpServletResponseWrapper​(javax.servlet.http.HttpServletResponse response,
                                          javax.servlet.http.HttpServletResponse proxy)

    • Method Detail

      • getHttpServletResponse

        public javax.servlet.http.HttpServletResponse getHttpServletResponse()

      • getResponse

        public javax.servlet.ServletResponse getResponse()
        Overrides:
        getResponse in class javax.servlet.ServletResponseWrapper

      • getCharacterEncoding

        public java.lang.String getCharacterEncoding()
        Specified by:
        getCharacterEncoding in interface javax.servlet.ServletResponse
        Overrides:
        getCharacterEncoding in class javax.servlet.ServletResponseWrapper

      • getContentType

        public java.lang.String getContentType()
        Specified by:
        getContentType in interface javax.servlet.ServletResponse
        Overrides:
        getContentType in class javax.servlet.ServletResponseWrapper

      • getOutputStream

        public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException
        Specified by:
        getOutputStream in interface javax.servlet.ServletResponse
        Overrides:
        getOutputStream in class javax.servlet.ServletResponseWrapper
        Throws:
        java.io.IOException

      • getWriter

        public java.io.PrintWriter getWriter()
                              throws java.io.IOException
        Specified by:
        getWriter in interface javax.servlet.ServletResponse
        Overrides:
        getWriter in class javax.servlet.ServletResponseWrapper
        Throws:
        java.io.IOException

      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String charset)
        Specified by:
        setCharacterEncoding in interface javax.servlet.ServletResponse
        Overrides:
        setCharacterEncoding in class javax.servlet.ServletResponseWrapper

      • setContentLength

        public void setContentLength​(int len)
        Specified by:
        setContentLength in interface javax.servlet.ServletResponse
        Overrides:
        setContentLength in class javax.servlet.ServletResponseWrapper

      • setContentType

        public void setContentType​(java.lang.String type)
        Specified by:
        setContentType in interface javax.servlet.ServletResponse
        Overrides:
        setContentType in class javax.servlet.ServletResponseWrapper

      • setBufferSize

        public void setBufferSize​(int size)
        Specified by:
        setBufferSize in interface javax.servlet.ServletResponse
        Overrides:
        setBufferSize in class javax.servlet.ServletResponseWrapper

      • getBufferSize

        public int getBufferSize()
        Specified by:
        getBufferSize in interface javax.servlet.ServletResponse
        Overrides:
        getBufferSize in class javax.servlet.ServletResponseWrapper

      • flushBuffer

        public void flushBuffer()
                 throws java.io.IOException
        Specified by:
        flushBuffer in interface javax.servlet.ServletResponse
        Overrides:
        flushBuffer in class javax.servlet.ServletResponseWrapper
        Throws:
        java.io.IOException

      • resetBuffer

        public void resetBuffer()
        Specified by:
        resetBuffer in interface javax.servlet.ServletResponse
        Overrides:
        resetBuffer in class javax.servlet.ServletResponseWrapper

      • isCommitted

        public boolean isCommitted()
        Specified by:
        isCommitted in interface javax.servlet.ServletResponse
        Overrides:
        isCommitted in class javax.servlet.ServletResponseWrapper

      • reset

        public void reset()
        Specified by:
        reset in interface javax.servlet.ServletResponse
        Overrides:
        reset in class javax.servlet.ServletResponseWrapper

      • setLocale

        public void setLocale​(java.util.Locale loc)
        Specified by:
        setLocale in interface javax.servlet.ServletResponse
        Overrides:
        setLocale in class javax.servlet.ServletResponseWrapper

      • getLocale

        public java.util.Locale getLocale()
        Specified by:
        getLocale in interface javax.servlet.ServletResponse
        Overrides:
        getLocale in class javax.servlet.ServletResponseWrapper

      • addCookie

        public void addCookie​(javax.servlet.http.Cookie cookie)
        Specified by:
        addCookie in interface javax.servlet.http.HttpServletResponse

      • containsHeader

        public boolean containsHeader​(java.lang.String name)
        Specified by:
        containsHeader in interface javax.servlet.http.HttpServletResponse

      • encodeURL

        public java.lang.String encodeURL​(java.lang.String url)
        Specified by:
        encodeURL in interface javax.servlet.http.HttpServletResponse

      • encodeRedirectURL

        public java.lang.String encodeRedirectURL​(java.lang.String url)
        Specified by:
        encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

      • encodeUrl

        public java.lang.String encodeUrl​(java.lang.String url)
        Deprecated.
        As of version 2.1, use encodeURL(String url) instead
        Specified by:
        encodeUrl in interface javax.servlet.http.HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

      • encodeRedirectUrl

        public java.lang.String encodeRedirectUrl​(java.lang.String url)
        Deprecated.
        As of version 2.1, use encodeRedirectURL(String url) instead
        Specified by:
        encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

      • sendError

        public void sendError​(int sc,
                      java.lang.String msg)
               throws java.io.IOException
        Specified by:
        sendError in interface javax.servlet.http.HttpServletResponse
        Throws:
        java.io.IOException

      • sendError

        public void sendError​(int sc)
               throws java.io.IOException
        Specified by:
        sendError in interface javax.servlet.http.HttpServletResponse
        Throws:
        java.io.IOException

      • sendRedirect

        public void sendRedirect​(java.lang.String location)
                  throws java.io.IOException
        Specified by:
        sendRedirect in interface javax.servlet.http.HttpServletResponse
        Throws:
        java.io.IOException

      • setDateHeader

        public void setDateHeader​(java.lang.String name,
                          long date)
        Specified by:
        setDateHeader in interface javax.servlet.http.HttpServletResponse

      • addDateHeader

        public void addDateHeader​(java.lang.String name,
                          long date)
        Specified by:
        addDateHeader in interface javax.servlet.http.HttpServletResponse

      • setHeader

        public void setHeader​(java.lang.String name,
                      java.lang.String value)
        Specified by:
        setHeader in interface javax.servlet.http.HttpServletResponse

      • addHeader

        public void addHeader​(java.lang.String name,
                      java.lang.String value)
        Specified by:
        addHeader in interface javax.servlet.http.HttpServletResponse

      • setIntHeader

        public void setIntHeader​(java.lang.String name,
                         int value)
        Specified by:
        setIntHeader in interface javax.servlet.http.HttpServletResponse

      • addIntHeader

        public void addIntHeader​(java.lang.String name,
                         int value)
        Specified by:
        addIntHeader in interface javax.servlet.http.HttpServletResponse

      • setStatus

        public void setStatus​(int sc)
        Specified by:
        setStatus in interface javax.servlet.http.HttpServletResponse

      • setStatus

        public void setStatus​(int sc,
                      java.lang.String sm)
        Deprecated.
        As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.
        Specified by:
        setStatus in interface javax.servlet.http.HttpServletResponse
        Parameters:
        sc - the status code
        sm - the status message

      • getStatus

        public int getStatus()
        Specified by:
        getStatus in interface javax.servlet.http.HttpServletResponse

      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Specified by:
        getHeader in interface javax.servlet.http.HttpServletResponse

      • getHeaders

        public java.util.Collection<java.lang.String> getHeaders​(java.lang.String name)
        Specified by:
        getHeaders in interface javax.servlet.http.HttpServletResponse

      • getHeaderNames

        public java.util.Collection<java.lang.String> getHeaderNames()
        Specified by:
        getHeaderNames in interface javax.servlet.http.HttpServletResponse