Class MockHttpServletResponse

java.lang.Object
com.jalios.servlet.http.MockHttpServletResponse
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class MockHttpServletResponse extends Object implements javax.servlet.http.HttpServletResponse
Mock implementation of the HttpServletResponse interface. Supports the Servlet 2.5 API level.
  • Field Details

  • Constructor Details

    • MockHttpServletResponse

      public MockHttpServletResponse()
  • Method Details

    • setOutputStreamAccessAllowed

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

      Default is true.

      Parameters:
      outputStreamAccessAllowed - boolean
    • isOutputStreamAccessAllowed

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

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

      Default is true.

      Parameters:
      writerAccessAllowed - boolean
    • isWriterAccessAllowed

      public boolean isWriterAccessAllowed()
      Return whether getOutputStream() access is allowed.
      Returns:
      boolean
    • setCharacterEncoding

      public void setCharacterEncoding(String characterEncoding)
      Specified by:
      setCharacterEncoding in interface javax.servlet.ServletResponse
    • getCharacterEncoding

      public String getCharacterEncoding()
      Specified by:
      getCharacterEncoding in interface javax.servlet.ServletResponse
    • getOutputStream

      public javax.servlet.ServletOutputStream getOutputStream()
      Specified by:
      getOutputStream in interface javax.servlet.ServletResponse
    • getWriter

      public PrintWriter getWriter() throws UnsupportedEncodingException
      Specified by:
      getWriter in interface javax.servlet.ServletResponse
      Throws:
      UnsupportedEncodingException
    • getContentAsByteArray

      public byte[] getContentAsByteArray()
    • getContentAsString

      public String getContentAsString() throws UnsupportedEncodingException
      Throws:
      UnsupportedEncodingException
    • setContentLength

      public void setContentLength(int contentLength)
      Specified by:
      setContentLength in interface javax.servlet.ServletResponse
    • getContentLength

      public int getContentLength()
    • setContentType

      public void setContentType(String contentType)
      Specified by:
      setContentType in interface javax.servlet.ServletResponse
    • getContentType

      public String getContentType()
      Specified by:
      getContentType in interface javax.servlet.ServletResponse
    • setBufferSize

      public void setBufferSize(int bufferSize)
      Specified by:
      setBufferSize in interface javax.servlet.ServletResponse
    • getBufferSize

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

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

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

      public void setCommitted(boolean committed)
    • isCommitted

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

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

      public void setLocale(Locale locale)
      Specified by:
      setLocale in interface javax.servlet.ServletResponse
    • getLocale

      public Locale getLocale()
      Specified by:
      getLocale in interface javax.servlet.ServletResponse
    • addCookie

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

      public javax.servlet.http.Cookie[] getCookies()
    • getCookie

      public javax.servlet.http.Cookie getCookie(String name)
    • containsHeader

      public boolean containsHeader(String name)
      Specified by:
      containsHeader in interface javax.servlet.http.HttpServletResponse
    • getHeaderNames

      public Set<String> getHeaderNames()
      Return the names of all specified headers as a Set of Strings.
      Specified by:
      getHeaderNames in interface javax.servlet.http.HttpServletResponse
      Returns:
      the Set of header name Strings, or an empty Set if none
    • getHeader

      public String getHeader(String name)
      Return the primary value for the given header, if any.

      Will return the first value in case of multiple values.

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

      public List<String> getHeaders(String name)
      Return all values for the given header as a List of value objects.
      Specified by:
      getHeaders in interface javax.servlet.http.HttpServletResponse
      Parameters:
      name - the name of the header
      Returns:
      the associated header values, or an empty List if none
    • encodeURL

      public String encodeURL(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 javax.servlet.http.HttpServletResponse
    • encodeRedirectURL

      public String encodeRedirectURL(String url)
      The default implementation delegates to encodeURL(java.lang.String), returning the given URL String as-is.

      Can be overridden in subclasses, appending a session id or the like in a redirect-specific fashion. For general URL encoding rules, override the common encodeURL(java.lang.String) method instead, appyling to redirect URLs as well as to general URLs.

      Specified by:
      encodeRedirectURL in interface javax.servlet.http.HttpServletResponse
    • encodeUrl

      public String encodeUrl(String url)
      Specified by:
      encodeUrl in interface javax.servlet.http.HttpServletResponse
    • encodeRedirectUrl

      public String encodeRedirectUrl(String url)
      Specified by:
      encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse
    • sendError

      public void sendError(int status, String errorMessage) throws IOException
      Specified by:
      sendError in interface javax.servlet.http.HttpServletResponse
      Throws:
      IOException
    • sendError

      public void sendError(int status) throws IOException
      Specified by:
      sendError in interface javax.servlet.http.HttpServletResponse
      Throws:
      IOException
    • sendRedirect

      public void sendRedirect(String url) throws IOException
      Specified by:
      sendRedirect in interface javax.servlet.http.HttpServletResponse
      Throws:
      IOException
    • getRedirectedUrl

      public String getRedirectedUrl()
    • setDateHeader

      public void setDateHeader(String name, long value)
      Specified by:
      setDateHeader in interface javax.servlet.http.HttpServletResponse
    • addDateHeader

      public void addDateHeader(String name, long value)
      Specified by:
      addDateHeader in interface javax.servlet.http.HttpServletResponse
    • setHeader

      public void setHeader(String name, String value)
      Specified by:
      setHeader in interface javax.servlet.http.HttpServletResponse
    • addHeader

      public void addHeader(String name, String value)
      Specified by:
      addHeader in interface javax.servlet.http.HttpServletResponse
    • setIntHeader

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

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

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

      public void setStatus(int status, String errorMessage)
      Specified by:
      setStatus in interface javax.servlet.http.HttpServletResponse
    • getStatus

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

      public String getErrorMessage()
    • setForwardedUrl

      public void setForwardedUrl(String forwardedUrl)
    • getForwardedUrl

      public String getForwardedUrl()
    • setIncludedUrl

      public void setIncludedUrl(String includedUrl)
    • getIncludedUrl

      public String getIncludedUrl()
    • addIncludedUrl

      public void addIncludedUrl(String includedUrl)
    • getIncludedUrls

      public List<String> getIncludedUrls()
    • setContentLengthLong

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