Package org.apache.xmlrpc.webserver

Class HttpServletResponseImpl

  • All Implemented Interfaces:
    javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
    public class HttpServletResponseImpl
extends java.lang.Object
implements javax.servlet.http.HttpServletResponse
    Stub implementation of a HttpServletResponse with lots of unimplemented methods. I implemented only those, which are required for testing the XmlRpcServlet. Perhaps someone else is adding more at a later time?

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) static int BUFFER_SIZE  
      private java.lang.String charEncoding  
      private java.util.Map headers  
      private java.util.Locale locale  
      private java.lang.String message  
      private java.io.OutputStream ostream  
      private java.net.Socket socket  
      private ServletOutputStreamImpl soStream  
      private int status  
      private java.io.PrintWriter writer  

      • 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
      HttpServletResponseImpl​(java.net.Socket pSocket)
      Creates a new instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addCookie​(javax.servlet.http.Cookie pCookie)  
      void addDateHeader​(java.lang.String pHeader, long pDate)  
      void addHeader​(java.lang.String pHeader, java.lang.String pValue)  
      void addIntHeader​(java.lang.String pHeader, int pValue)  
      boolean containsHeader​(java.lang.String pHeader)  
      java.lang.String encodeRedirectUrl​(java.lang.String pURL)  
      java.lang.String encodeRedirectURL​(java.lang.String pURL)  
      java.lang.String encodeUrl​(java.lang.String pURL)  
      java.lang.String encodeURL​(java.lang.String pURL)  
      void flushBuffer()  
      int getBufferSize()  
      java.lang.String getCharacterEncoding()  
      java.lang.String getContentType()
      Returns the content type used for the MIME body sent in this response.
      java.lang.String getHeader​(java.lang.String pHeader)  
      java.util.Collection getHeaderNames()  
      java.util.Collection getHeaders​(java.lang.String pHeader)  
      (package private) java.lang.String getHttpHeaders​(java.lang.Integer pContentLength)  
      java.util.Locale getLocale()  
      javax.servlet.ServletOutputStream getOutputStream()  
      int getStatus()  
      static java.lang.String getStatusMessage​(int pStatusCode)
      Returns a default message for a given HTTP status code.
      java.io.PrintWriter getWriter()  
      boolean isCommitted()  
      void reset()  
      void resetBuffer()  
      void sendError​(int pStatusCode)  
      void sendError​(int pStatusCode, java.lang.String pMessage)  
      protected void sendError​(int pStatusCode, java.lang.String pMessage, java.lang.String pDescription)  
      void sendRedirect​(java.lang.String arg0)  
      void setBufferSize​(int pBufferSize)  
      void setCharacterEncoding​(java.lang.String pCharset)
      Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
      void setContentLength​(int pContentLength)  
      void setContentLengthLong​(long arg0)  
      void setContentType​(java.lang.String pType)  
      void setDateHeader​(java.lang.String arg0, long arg1)  
      void setHeader​(java.lang.String pHeader, java.lang.String pValue)  
      void setIntHeader​(java.lang.String pHeader, int pValue)  
      void setLocale​(java.util.Locale pLocale)  
      void setStatus​(int pStatusCode)  
      void setStatus​(int pStatusCode, java.lang.String pMessage)  

      • 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

    • Field Detail

      • socket

        private final java.net.Socket socket

      • ostream

        private final java.io.OutputStream ostream

      • headers

        private final java.util.Map headers

      • status

        private int status

      • message

        private java.lang.String message

      • locale

        private java.util.Locale locale

      • charEncoding

        private java.lang.String charEncoding

      • writer

        private java.io.PrintWriter writer

    • Constructor Detail

      • HttpServletResponseImpl

        public HttpServletResponseImpl​(java.net.Socket pSocket)
                        throws java.io.IOException
        Creates a new instance.
        Parameters:
        pSocket - The clients socket.
        Throws:
        java.io.IOException - Accessing the sockets output stream failed.

    • Method Detail

      • addCookie

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

      • addDateHeader

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

      • addHeader

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

      • getHeader

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

      • getHeaderNames

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

      • getHeaders

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

      • getStatus

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

      • addIntHeader

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

      • containsHeader

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

      • encodeRedirectURL

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

      • encodeRedirectUrl

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

      • encodeURL

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

      • encodeUrl

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

      • sendError

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

      • sendError

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

      • sendError

        protected void sendError​(int pStatusCode,
                         java.lang.String pMessage,
                         java.lang.String pDescription)
                  throws java.io.IOException
        Throws:
        java.io.IOException

      • sendRedirect

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

      • setDateHeader

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

      • setHeader

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

      • setIntHeader

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

      • setStatus

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

      • setStatus

        public void setStatus​(int pStatusCode,
                      java.lang.String pMessage)
        Specified by:
        setStatus in interface javax.servlet.http.HttpServletResponse

      • flushBuffer

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

      • getBufferSize

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

      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String pCharset)

        Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set by setContentType(java.lang.String) or setLocale(java.util.Locale), this method overrides it. Calling setContentType(java.lang.String) with the String of text/html and calling this method with the String of UTF-8 is equivalent with calling setContentType with the String of text/html; charset=UTF-8.

        This method can be called repeatedly to change the character encoding. This method has no effect if it is called after getWriter has been called or after the response has been committed.

        Containers must communicate the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the Content-Type header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.

        Specified by:
        setCharacterEncoding in interface javax.servlet.ServletResponse
        Parameters:
        pCharset - A String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
        Since:
        Servlet API 2.4
        See Also:
        setLocale(Locale)

      • getCharacterEncoding

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

      • getLocale

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

      • getOutputStream

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

      • getWriter

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

      • isCommitted

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

      • reset

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

      • resetBuffer

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

      • setBufferSize

        public void setBufferSize​(int pBufferSize)
        Specified by:
        setBufferSize in interface javax.servlet.ServletResponse

      • setContentLength

        public void setContentLength​(int pContentLength)
        Specified by:
        setContentLength in interface javax.servlet.ServletResponse

      • getContentType

        public java.lang.String getContentType()

        Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using setContentType(java.lang.String) before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified and a character encoding has been explicitly or implicitly specified as described in getCharacterEncoding(), the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.

        Specified by:
        getContentType in interface javax.servlet.ServletResponse
        Returns:
        A String specifying the content type, for example, text/html; charset=UTF-8, or null
        Since:
        Servlet API 2.4
        See Also:
        setContentType(String)

      • setContentType

        public void setContentType​(java.lang.String pType)
        Specified by:
        setContentType in interface javax.servlet.ServletResponse

      • setLocale

        public void setLocale​(java.util.Locale pLocale)
        Specified by:
        setLocale in interface javax.servlet.ServletResponse

      • getStatusMessage

        public static java.lang.String getStatusMessage​(int pStatusCode)
        Returns a default message for a given HTTP status code.
        Parameters:
        pStatusCode - The status code being queried.
        Returns:
        The default message.

      • getHttpHeaders

        java.lang.String getHttpHeaders​(java.lang.Integer pContentLength)

      • setContentLengthLong

        public void setContentLengthLong​(long arg0)
        Specified by:
        setContentLengthLong in interface javax.servlet.ServletResponse