org.directwebremoting.util
Class FakeHttpServletResponse

java.lang.Object
  extended by org.directwebremoting.util.FakeHttpServletResponse

public class FakeHttpServletResponse
extends java.lang.Object

Mock implementation of the HttpServletResponse interface.

Author:
Rod Johnson, Juergen Hoeller, Joe Walker [joe at getahead dot ltd dot uk]

Constructor Summary
FakeHttpServletResponse()
           
 
Method Summary
 void addCookie(Cookie cookie)
           
 void addDateHeader(java.lang.String name, long value)
           
 void addHeader(java.lang.String name, java.lang.String value)
           
 void addIntHeader(java.lang.String name, int value)
           
 boolean containsHeader(java.lang.String name)
           
 java.lang.String encodeRedirectUrl(java.lang.String url)
           
 java.lang.String encodeRedirectURL(java.lang.String url)
           
 java.lang.String encodeUrl(java.lang.String url)
           
 java.lang.String encodeURL(java.lang.String url)
           
 void flushBuffer()
           
 int getBufferSize()
           
 java.lang.String getCharacterEncoding()
           
 byte[] getContentAsByteArray()
          Accessor for the content of output body
 java.lang.String getContentAsString()
          Accessor for the content of output body
 int getContentLength()
          Accessor for the content length of the output
 java.lang.String getContentType()
           
 Cookie getCookie(java.lang.String name)
          Get a cookie by a given name
 Cookie[] getCookies()
          Accessor for the array of current cookies
 java.lang.String getErrorMessage()
          Accessor for any error messages set using sendError(int) or sendError(int, String)
 java.lang.String getForwardedUrl()
          What URL are we forwarding to?
 java.lang.Object getHeader(java.lang.String name)
          Accessor for a header by a given name
 java.util.Set getHeaderNames()
          Accessor for the current set of headers
 java.util.List getHeaders(java.lang.String name)
          If there are multiple values for a given header, get them as a list
 java.lang.String getIncludedUrl()
          What URL are we including?
 java.util.Locale getLocale()
           
 ServletOutputStream getOutputStream()
           
 java.lang.String getRedirectedUrl()
          Accessor for the redirect URL set using sendRedirect(String)
 int getStatus()
          What HTTP status code should be returned?
 java.io.PrintWriter getWriter()
           
 boolean isCommitted()
           
 void reset()
           
 void resetBuffer()
           
 void sendError(int newStatus)
           
 void sendError(int newStatus, java.lang.String newErrorMessage)
           
 void sendRedirect(java.lang.String url)
           
 void setBufferSize(int bufferSize)
           
 void setCharacterEncoding(java.lang.String characterEncoding)
           
 void setCommitted(boolean committed)
           
 void setContentLength(int contentLength)
           
 void setContentType(java.lang.String contentType)
           
 void setDateHeader(java.lang.String name, long value)
           
 void setForwardedUrl(java.lang.String forwardedUrl)
          What URL are we forwarding to?
 void setHeader(java.lang.String name, java.lang.String value)
           
 void setIncludedUrl(java.lang.String includedUrl)
          What URL are we including?
 void setIntHeader(java.lang.String name, int value)
           
 void setLocale(java.util.Locale locale)
           
 void setStatus(int status)
           
 void setStatus(int status, java.lang.String errorMessage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FakeHttpServletResponse

public FakeHttpServletResponse()
Method Detail

setCharacterEncoding

public void setCharacterEncoding(java.lang.String characterEncoding)

getCharacterEncoding

public java.lang.String getCharacterEncoding()

getOutputStream

public ServletOutputStream getOutputStream()

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.UnsupportedEncodingException
Throws:
java.io.UnsupportedEncodingException

flushBuffer

public void flushBuffer()

sendError

public void sendError(int newStatus,
                      java.lang.String newErrorMessage)
               throws java.io.IOException
Throws:
java.io.IOException

sendError

public void sendError(int newStatus)
               throws java.io.IOException
Throws:
java.io.IOException

getErrorMessage

public java.lang.String getErrorMessage()
Accessor for any error messages set using sendError(int) or sendError(int, String)

Returns:
The current error message

sendRedirect

public void sendRedirect(java.lang.String url)
                  throws java.io.IOException
Throws:
java.io.IOException

getRedirectedUrl

public java.lang.String getRedirectedUrl()
Accessor for the redirect URL set using sendRedirect(String)

Returns:
The redirect URL

setStatus

public void setStatus(int status)

setStatus

public void setStatus(int status,
                      java.lang.String errorMessage)

getStatus

public int getStatus()
What HTTP status code should be returned?

Returns:
The current http status code

getContentAsByteArray

public byte[] getContentAsByteArray()
Accessor for the content of output body

Returns:
A byte array of the output body

getContentAsString

public java.lang.String getContentAsString()
                                    throws java.io.UnsupportedEncodingException
Accessor for the content of output body

Returns:
A string of the output body
Throws:
java.io.UnsupportedEncodingException

setContentLength

public void setContentLength(int contentLength)

getContentLength

public int getContentLength()
Accessor for the content length of the output

Returns:
The content length of the output

setContentType

public void setContentType(java.lang.String contentType)

getContentType

public java.lang.String getContentType()

setBufferSize

public void setBufferSize(int bufferSize)

getBufferSize

public int getBufferSize()

setCommitted

public void setCommitted(boolean committed)
Parameters:
committed -

isCommitted

public boolean isCommitted()

resetBuffer

public void resetBuffer()

reset

public void reset()

setLocale

public void setLocale(java.util.Locale locale)

getLocale

public java.util.Locale getLocale()

addCookie

public void addCookie(Cookie cookie)

getCookies

public Cookie[] getCookies()
Accessor for the array of current cookies

Returns:
The current set of output cookies

getCookie

public Cookie getCookie(java.lang.String name)
Get a cookie by a given name

Parameters:
name - The name of the cookie to fetch
Returns:
A matching cookie or null if there was no match

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

encodeURL

public java.lang.String encodeURL(java.lang.String url)

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String url)

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

addDateHeader

public void addDateHeader(java.lang.String name,
                          long value)

setDateHeader

public void setDateHeader(java.lang.String name,
                          long value)

addIntHeader

public void addIntHeader(java.lang.String name,
                         int value)

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

containsHeader

public boolean containsHeader(java.lang.String name)

getHeaderNames

public java.util.Set getHeaderNames()
Accessor for the current set of headers

Returns:
The current set of headers

getHeader

public java.lang.Object getHeader(java.lang.String name)
Accessor for a header by a given name

Parameters:
name - The header name to lookup
Returns:
The data behind this header

getHeaders

public java.util.List getHeaders(java.lang.String name)
If there are multiple values for a given header, get them as a list

Parameters:
name - The header name to lookup
Returns:
The data behind this header

setForwardedUrl

public void setForwardedUrl(java.lang.String forwardedUrl)
What URL are we forwarding to?

Parameters:
forwardedUrl - What URL are we forwarding to?

getForwardedUrl

public java.lang.String getForwardedUrl()
What URL are we forwarding to?

Returns:
What URL are we forwarding to?

setIncludedUrl

public void setIncludedUrl(java.lang.String includedUrl)
What URL are we including?

Parameters:
includedUrl - What URL are we including?

getIncludedUrl

public java.lang.String getIncludedUrl()
What URL are we including?

Returns:
What URL are we including?