Package org.sakaiproject.portal.util

Class ByteArrayServletResponse

  • All Implemented Interfaces:
    javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
    public class ByteArrayServletResponse
extends javax.servlet.http.HttpServletResponseWrapper
    ServletResponse instance used to buffer content. This buffering allows for the portlets title to be captured prior to rendering and other similar features.

    NOTE: Access the output stream for this response had undertermined results. It is expected that in most situations an IllegalArgumentException will be thrown.

    Since:
    Sakai 2.2.4
    Version:
    $Rev$

    • 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
      ByteArrayServletResponse​(javax.servlet.http.HttpServletResponse response)
      Sole Constructor.

    • Constructor Detail

      • ByteArrayServletResponse

        public ByteArrayServletResponse​(javax.servlet.http.HttpServletResponse response)
        Sole Constructor. Initializes the response wrapper and the buffered writer.
        Parameters:
        response - the original servlet response.

    • Method Detail

      • isCommitted

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

      • getContentType

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

      • setContentType

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

      • getRedirect

        public String getRedirect()

      • sendRedirect

        public void sendRedirect​(String redirectUrl)
                  throws IOException
        Specified by:
        sendRedirect in interface javax.servlet.http.HttpServletResponse
        Overrides:
        sendRedirect in class javax.servlet.http.HttpServletResponseWrapper
        Throws:
        IOException

      • getWriter

        public PrintWriter getWriter()
        Specified by:
        getWriter in interface javax.servlet.ServletResponse
        Overrides:
        getWriter in class javax.servlet.ServletResponseWrapper

      • getOutputStream

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

      • setContentLength

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

      • setContentLengthLong

        public void setContentLengthLong​(long i)
        Specified by:
        setContentLengthLong in interface javax.servlet.ServletResponse
        Overrides:
        setContentLengthLong in class javax.servlet.ServletResponseWrapper

      • flushBuffer

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

      • reset

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

      • forwardResponse

        public void forwardResponse()
                     throws IOException
        Forward the request up the chain.
        Throws:
        IOException

      • getInternalBuffer

        public String getInternalBuffer()
        Retrieve the buffer.
        Returns: