org.springframework.mock.web

Class MockHttpServletResponse

  • java.lang.Object
    • org.springframework.mock.web.MockHttpServletResponse
  • All Implemented Interfaces:
    HttpServletResponse, ServletResponse


    public class MockHttpServletResponse
    extends java.lang.Object
    implements HttpServletResponse
    Mock implementation of the HttpServletResponse interface.

    As of Spring Framework 5.0, this set of mocks is designed on a Servlet 4.0 baseline.

    Since:
    1.0.2
    Author:
    Juergen Hoeller, Rod Johnson, Brian Clozel, Vedran Pavic
    • Constructor Detail

      • MockHttpServletResponse

        public MockHttpServletResponse()
    • Method Detail

      • setOutputStreamAccessAllowed

        public void setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)
        Set whether getOutputStream() access is allowed.

        Default is true.

      • isOutputStreamAccessAllowed

        public boolean isOutputStreamAccessAllowed()
        Return whether getOutputStream() access is allowed.
      • setWriterAccessAllowed

        public void setWriterAccessAllowed(boolean writerAccessAllowed)
        Set whether getWriter() access is allowed.

        Default is true.

      • isWriterAccessAllowed

        public boolean isWriterAccessAllowed()
        Return whether getOutputStream() access is allowed.
      • isCharset

        public boolean isCharset()
        Return whether the character encoding has been set.

        If false, getCharacterEncoding() will return a default encoding value.

      • setCharacterEncoding

        public void setCharacterEncoding(java.lang.String characterEncoding)
        Description copied from interface: javax.servlet.ServletResponse
        Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the response character encoding has already been set by the ServletContext.setResponseCharacterEncoding(java.lang.String), deployment descriptor, or using the setContentType() or setLocale() methods, the value set in this method overrides any of those values. Calling ServletResponse.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 ServletResponse
        Parameters:
        characterEncoding - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
        See Also:
        ServletResponse.setContentType(java.lang.String), ServletResponse.setLocale(java.util.Locale)
      • getCharacterEncoding

        @Nullable
        public java.lang.String getCharacterEncoding()
        Description copied from interface: javax.servlet.ServletResponse
        Returns the name of the character encoding (MIME charset) used for the body sent in this response. The following methods for specifying the response character encoding are consulted, in decreasing order of priority: per request, perweb-app (using ServletContext.setResponseCharacterEncoding(java.lang.String), deployment descriptor), and per container (for all web applications deployed in that container, using vendor specific configuration). The first one of these methods that yields a result is returned. Per-request, the charset for the response can be specified explicitly using the setCharacterEncoding and setContentType methods, or implicitly using the setLocale(java.util.Locale) method. Explicit specifications take precedence over implicit specifications. Calls made to these methods after getWriter has been called or after the response has been committed have no effect on the character encoding. If no character encoding has been specified, ISO-8859-1 is returned.

        See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.

        Specified by:
        getCharacterEncoding in interface ServletResponse
        Returns:
        a String specifying the name of the character encoding, for example, UTF-8
      • getContentAsByteArray

        public byte[] getContentAsByteArray()
      • getContentAsString

        public java.lang.String getContentAsString()
                                            throws java.io.UnsupportedEncodingException
        Throws:
        java.io.UnsupportedEncodingException
      • setContentLength

        public void setContentLength(int contentLength)
        Description copied from interface: javax.servlet.ServletResponse
        Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
        Specified by:
        setContentLength in interface ServletResponse
        Parameters:
        contentLength - an integer specifying the length of the content being returned to the client; sets the Content-Length header
      • getContentLength

        public int getContentLength()
      • setContentLengthLong

        public void setContentLengthLong(long contentLength)
        Description copied from interface: javax.servlet.ServletResponse
        Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
        Specified by:
        setContentLengthLong in interface ServletResponse
        Parameters:
        contentLength - a long specifying the length of the content being returned to the client; sets the Content-Length header
      • getContentLengthLong

        public long getContentLengthLong()
      • setContentType

        public void setContentType(@Nullable
                                   java.lang.String contentType)
        Description copied from interface: javax.servlet.ServletResponse
        Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example, text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called before getWriter is called.

        This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after getWriter has been called or after the response has been committed.

        Containers must communicate the content type and 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 Content-Type header is used.

        Specified by:
        setContentType in interface ServletResponse
        Parameters:
        contentType - a String specifying the MIME type of the content
        See Also:
        ServletResponse.setLocale(java.util.Locale), ServletResponse.setCharacterEncoding(java.lang.String), ServletResponse.getOutputStream(), ServletResponse.getWriter()
      • getContentType

        @Nullable
        public java.lang.String getContentType()
        Description copied from interface: javax.servlet.ServletResponse
        Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using ServletResponse.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 ServletResponse.getCharacterEncoding() or ServletResponse.getWriter() has been called, 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 ServletResponse
        Returns:
        a String specifying the content type, for example, text/html; charset=UTF-8, or null
      • setBufferSize

        public void setBufferSize(int bufferSize)
        Description copied from interface: javax.servlet.ServletResponse
        Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size used can be found using getBufferSize.

        A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.

        This method must be called before any response body content is written; if content has been written or the response object has been committed, this method throws an IllegalStateException.

        Specified by:
        setBufferSize in interface ServletResponse
        Parameters:
        bufferSize - the preferred buffer size
        See Also:
        ServletResponse.getBufferSize(), ServletResponse.flushBuffer(), ServletResponse.isCommitted(), ServletResponse.reset()
      • setCommitted

        public void setCommitted(boolean committed)
      • setLocale

        public void setLocale(java.util.Locale locale)
        Description copied from interface: javax.servlet.ServletResponse
        Sets the locale of the response, if the response has not been committed yet. It also sets the response's character encoding appropriately for the locale, if the character encoding has not been explicitly set using ServletResponse.setContentType(java.lang.String) or ServletResponse.setCharacterEncoding(java.lang.String), getWriter hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains a locale-encoding-mapping-list element, and that element provides a mapping for the given locale, that mapping is used. Otherwise, the mapping from locale to character encoding is container dependent.

        This method may be called repeatedly to change locale and character encoding. The method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after ServletResponse.setContentType(java.lang.String) has been called with a charset specification, after ServletResponse.setCharacterEncoding(java.lang.String) has been called, after getWriter has been called, or after the response has been committed.

        Containers must communicate the locale and 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 locale is communicated via the Content-Language header, the character encoding 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:
        setLocale in interface ServletResponse
        Parameters:
        locale - the locale of the response
        See Also:
        ServletResponse.getLocale(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)
      • getCookies

        public Cookie[] getCookies()
      • containsHeader

        public boolean containsHeader(java.lang.String name)
        Description copied from interface: javax.servlet.http.HttpServletResponse
        Returns a boolean indicating whether the named response header has already been set.
        Specified by:
        containsHeader in interface HttpServletResponse
        Parameters:
        name - the header name
        Returns:
        true if the named response header has already been set; false otherwise
      • getHeaderNames

        public java.util.Collection<java.lang.String> getHeaderNames()
        Return the names of all specified headers as a Set of Strings.

        As of Servlet 3.0, this method is also defined HttpServletResponse.

        Specified by:
        getHeaderNames in interface HttpServletResponse
        Returns:
        the Set of header name Strings, or an empty Set if none
      • getHeader

        @Nullable
        public java.lang.String getHeader(java.lang.String name)
        Return the primary value for the given header as a String, if any. Will return the first value in case of multiple values.

        As of Servlet 3.0, this method is also defined in HttpServletResponse. As of Spring 3.1, it returns a stringified value for Servlet 3.0 compatibility. Consider using getHeaderValue(String) for raw Object access.

        Specified by:
        getHeader in interface HttpServletResponse
        Parameters:
        name - the name of the header
        Returns:
        the associated header value, or null if none
      • getHeaders

        public java.util.List<java.lang.String> getHeaders(java.lang.String name)
        Return all values for the given header as a List of Strings.

        As of Servlet 3.0, this method is also defined in HttpServletResponse. As of Spring 3.1, it returns a List of stringified values for Servlet 3.0 compatibility. Consider using getHeaderValues(String) for raw Object access.

        Specified by:
        getHeaders in interface HttpServletResponse
        Parameters:
        name - the name of the header
        Returns:
        the associated header values, or an empty List if none
      • getHeaderValue

        @Nullable
        public java.lang.Object getHeaderValue(java.lang.String name)
        Return the primary value for the given header, if any.

        Will return the first value in case of multiple values.

        Parameters:
        name - the name of the header
        Returns:
        the associated header value, or null if none
      • getHeaderValues

        public java.util.List<java.lang.Object> getHeaderValues(java.lang.String name)
        Return all values for the given header as a List of value objects.
        Parameters:
        name - the name of the header
        Returns:
        the associated header values, or an empty List if none
      • encodeURL

        public java.lang.String encodeURL(java.lang.String url)
        The default implementation returns the given URL String as-is.

        Can be overridden in subclasses, appending a session id or the like.

        Specified by:
        encodeURL in interface HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.
      • encodeUrl

        @Deprecated
        public java.lang.String encodeUrl(java.lang.String url)
        Deprecated. 
        Specified by:
        encodeUrl in interface HttpServletResponse
        Parameters:
        url - the url to be encoded.
        Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.
      • encodeRedirectUrl

        @Deprecated
        public java.lang.String encodeRedirectUrl(java.lang.String url)
        Deprecated. 
        Specified by:
        encodeRedirectUrl in interface 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 status,
                              java.lang.String errorMessage)
                       throws java.io.IOException
        Description copied from interface: javax.servlet.http.HttpServletResponse

        Sends an error response to the client using the specified status and clears the buffer. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html". The caller is not responsible for escaping or re-encoding the message to ensure it is safe with respect to the current response encoding and content type. This aspect of safety is the responsibility of the container, as it is generating the error page containing the message. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response.

        If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter and the msg parameter will be ignored.

        If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

        Specified by:
        sendError in interface HttpServletResponse
        Parameters:
        status - the error status code
        errorMessage - the descriptive message
        Throws:
        java.io.IOException - If an input or output exception occurs
      • sendError

        public void sendError(int status)
                       throws java.io.IOException
        Description copied from interface: javax.servlet.http.HttpServletResponse
        Sends an error response to the client using the specified status code and clears the buffer. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back the error page

        If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

        Specified by:
        sendError in interface HttpServletResponse
        Parameters:
        status - the error status code
        Throws:
        java.io.IOException - If an input or output exception occurs
      • sendRedirect

        public void sendRedirect(java.lang.String url)
                          throws java.io.IOException
        Description copied from interface: javax.servlet.http.HttpServletResponse
        Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer. The buffer will be replaced with the data set by this method. Calling this method sets the status code to HttpServletResponse.SC_FOUND 302 (Found). This method can accept relative URLs;the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root. If the location is relative with two leading '/' the container interprets it as a network-path reference (see RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, section 4.2 "Relative Reference").

        If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

        Specified by:
        sendRedirect in interface HttpServletResponse
        Parameters:
        url - the redirect location URL
        Throws:
        java.io.IOException - If an input or output exception occurs
      • getRedirectedUrl

        @Nullable
        public java.lang.String getRedirectedUrl()
      • getDateHeader

        public long getDateHeader(java.lang.String name)
      • setStatus

        public void setStatus(int status)
        Description copied from interface: javax.servlet.http.HttpServletResponse
        Sets the status code for this response.

        This method is used to set the return status code when there is no error (for example, for the SC_OK or SC_MOVED_TEMPORARILY status codes).

        If this method is used to set an error code, then the container's error page mechanism will not be triggered. If there is an error and the caller wishes to invoke an error page defined in the web application, then HttpServletResponse.sendError(int, java.lang.String) must be used instead.

        This method preserves any cookies and other response headers.

        Valid status codes are those in the 2XX, 3XX, 4XX, and 5XX ranges. Other status codes are treated as container specific.

        Specified by:
        setStatus in interface HttpServletResponse
        Parameters:
        status - the status code
        See Also:
        HttpServletResponse.sendError(int, java.lang.String)
      • setStatus

        @Deprecated
        public void setStatus(int status,
                                          java.lang.String errorMessage)
        Deprecated. 
        Specified by:
        setStatus in interface HttpServletResponse
        Parameters:
        status - the status code
        errorMessage - the status message
      • getErrorMessage

        @Nullable
        public java.lang.String getErrorMessage()
      • setForwardedUrl

        public void setForwardedUrl(@Nullable
                                    java.lang.String forwardedUrl)
      • getForwardedUrl

        @Nullable
        public java.lang.String getForwardedUrl()
      • setIncludedUrl

        public void setIncludedUrl(@Nullable
                                   java.lang.String includedUrl)
      • getIncludedUrl

        @Nullable
        public java.lang.String getIncludedUrl()
      • addIncludedUrl

        public void addIncludedUrl(java.lang.String includedUrl)
      • getIncludedUrls

        public java.util.List<java.lang.String> getIncludedUrls()