Package org.apache.myfaces.view

Class HttpServletResponseSwitch

  • All Implemented Interfaces:
    jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse, ResponseSwitch
    public class HttpServletResponseSwitch
extends jakarta.servlet.http.HttpServletResponseWrapper
implements ResponseSwitch
    Implementation of a switching response wrapper to turn output on and off according to the Faces spec 2.0.

    Implemented as HttpServletResponseWrapper, so that the switching does not interfere with methods that expect a HttpServletResponse when invoking ExternalContext.getResponse().

    • Field Summary

      • Fields inherited from interface jakarta.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
      HttpServletResponseSwitch​(jakarta.servlet.http.HttpServletResponse response)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void flushBuffer()  
      int getBufferSize()  
      jakarta.servlet.ServletOutputStream getOutputStream()  
      PrintWriter getWriter()  
      boolean isCommitted()  
      boolean isEnabled()
      Are the Response's Writer and OutputStream currently enabled?
      void reset()  
      void resetBuffer()  
      void setEnabled​(boolean enabled)
      Enables or disables the Response's Writer and OutputStream.
      void setResponse​(jakarta.servlet.ServletResponse response)  

      • Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

        addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setTrailerFields

      • Methods inherited from class jakarta.servlet.ServletResponseWrapper

        getCharacterEncoding, getContentType, getLocale, getResponse, isWrapperFor, isWrapperFor, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

      • Methods inherited from interface jakarta.servlet.ServletResponse

        getCharacterEncoding, getContentType, getLocale, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

    • Constructor Detail

      • HttpServletResponseSwitch

        public HttpServletResponseSwitch​(jakarta.servlet.http.HttpServletResponse response)

    • Method Detail

      • setEnabled

        public void setEnabled​(boolean enabled)
        Enables or disables the Response's Writer and OutputStream.
        Specified by:
        setEnabled in interface ResponseSwitch
        Parameters:
        enabled -

      • isEnabled

        public boolean isEnabled()
        Are the Response's Writer and OutputStream currently enabled?
        Specified by:
        isEnabled in interface ResponseSwitch
        Returns:

      • getBufferSize

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

      • isCommitted

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

      • reset

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

      • resetBuffer

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

      • flushBuffer

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

      • setResponse

        public void setResponse​(jakarta.servlet.ServletResponse response)
        Overrides:
        setResponse in class jakarta.servlet.ServletResponseWrapper

      • getOutputStream

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

      • getWriter

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