org.slim3.struts.test
Class MockHttpServletResponse

java.lang.Object
  org.slim3.struts.test.MockHttpServletResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class MockHttpServletResponse
extends Object
implements HttpServletResponse

A mock implementation for MockHttpServletResponse.

Since:

3.0

Author:

higa

Field Summary

protected int	bufferSize The buffer size.
protected String	characterEncoding The character encoding.
protected boolean	committed The committed flag.
protected List<Cookie>	cookieList The list for Cookie.
protected boolean	getOutputStreamCalled Whether getOutputStream method is called.
protected boolean	getWriterCalled Whether getWriter method is called.
protected Map<String,List<String>>	headerMap The map for the response header.
protected Locale	locale The locale.
protected String	message The message.
protected ServletOutputStream	outputStream The output stream.
protected ByteArrayOutputStream	sourceOutput The source output.
protected int	status The status.
protected PrintWriter	writer The 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

MockHttpServletResponse()
Constructor.

Method Summary

void	addCookie(Cookie cookie)
void	addDateHeader(String name, long value)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
protected void	assertNotCommitted() Asserts this response is not committed.
boolean	containsHeader(String name)
String	encodeRedirectUrl(String url)
String	encodeRedirectURL(String url)
String	encodeUrl(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
int	getContentLength() Returns the content length.
String	getContentType()
Cookie[]	getCookies() Returns the cookies.
long	getDateHeader(String name) Returns the header as date.
String	getHeader(String name) Returns the header as string.
protected List<String>	getHeaderList(String name) Returns the header as list.
Enumeration<String>	getHeaderNames() Returns the header names.
Enumeration<String>	getHeaders(String name) Returns the header as Enumeration.
int	getIntHeader(String name) Returns the header as int.
Locale	getLocale()
String	getMessage() Returns the message.
byte[]	getOutputAsByteArray() Returns the output as array of bytes.
String	getOutputAsString() Returns the output as string.
ServletOutputStream	getOutputStream()
protected String	getResponseStatusMessage(int status) Returns the response status message.
int	getStatus() Returns the status.
PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int status)
void	sendError(int status, String message)
void	sendRedirect(String path)
void	setBufferSize(int bufferSize)
void	setCharacterEncoding(String characterEncoding)
void	setContentLength(int contentLength)
void	setContentType(String contentType)
void	setDateHeader(String name, long value)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale locale)
void	setStatus(int status)
void	setStatus(int status, String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cookieList

protected List<Cookie> cookieList

The list for Cookie.

headerMap

protected Map<String,List<String>> headerMap

The map for the response header.

committed

protected boolean committed

The committed flag.

status

protected int status

The status.

message

protected String message

The message.

locale

protected Locale locale

The locale.

characterEncoding

protected String characterEncoding

The character encoding.

sourceOutput

protected ByteArrayOutputStream sourceOutput

The source output.

writer

protected PrintWriter writer

The writer.

outputStream

protected ServletOutputStream outputStream

The output stream.

getWriterCalled

protected boolean getWriterCalled

Whether getWriter method is called.

getOutputStreamCalled

protected boolean getOutputStreamCalled

Whether getOutputStream method is called.

bufferSize

protected int bufferSize

The buffer size.

Constructor Detail

MockHttpServletResponse

public MockHttpServletResponse()

Constructor.

Method Detail

getCookies

public Cookie[] getCookies()

Returns the cookies.

Returns:

the cookies

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface HttpServletResponse

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface HttpServletResponse

encodeUrl

public String encodeUrl(String url)

Specified by:

encodeUrl in interface HttpServletResponse

encodeRedirectUrl

public String encodeRedirectUrl(String url)

Specified by:

encodeRedirectUrl in interface HttpServletResponse

getStatus

public int getStatus()

Returns the status.

Returns:

the status

setStatus

public void setStatus(int status,
                      String message)

Specified by:

setStatus in interface HttpServletResponse

setStatus

public void setStatus(int status)

Specified by:

setStatus in interface HttpServletResponse

getResponseStatusMessage

protected String getResponseStatusMessage(int status)

Returns the response status message.

Parameters:

status - the status

Returns:

the response status message

assertNotCommitted

protected void assertNotCommitted()

Asserts this response is not committed.

getMessage

public String getMessage()

Returns the message.

Returns:

the message

sendError

public void sendError(int status,
                      String message)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendError

public void sendError(int status)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String path)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

getHeaders

public Enumeration<String> getHeaders(String name)

Returns the header as Enumeration.

Parameters:

name - the name

Returns:

the header

getHeader

public String getHeader(String name)

Returns the header as string.

Parameters:

name - the name

Returns:

the header

getDateHeader

public long getDateHeader(String name)

Returns the header as date.

Parameters:

name - the name

Returns:

the header

getIntHeader

public int getIntHeader(String name)

Returns the header as int.

Parameters:

name - the name

Returns:

the header

getHeaderList

protected List<String> getHeaderList(String name)

Returns the header as list.

Parameters:

name - the name

Returns:

the header

getHeaderNames

public Enumeration<String> getHeaderNames()

Returns the header names.

Returns:

the header names

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface HttpServletResponse

addHeader

public void addHeader(String name,
                      String value)

Specified by:

addHeader in interface HttpServletResponse

setDateHeader

public void setDateHeader(String name,
                          long value)

Specified by:

setDateHeader in interface HttpServletResponse

addDateHeader

public void addDateHeader(String name,
                          long value)

Specified by:

addDateHeader in interface HttpServletResponse

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:

setIntHeader in interface HttpServletResponse

addIntHeader

public void addIntHeader(String name,
                         int value)

Specified by:

addIntHeader in interface HttpServletResponse

getContentLength

public int getContentLength()

Returns the content length.

Returns:

the content length

setContentLength

public void setContentLength(int contentLength)

Specified by:

setContentLength in interface ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletResponse

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface ServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

Specified by:

setCharacterEncoding in interface ServletResponse

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Throws:

IOException

getOutputAsByteArray

public byte[] getOutputAsByteArray()
                            throws IOException

Returns the output as array of bytes.

Returns:

the output

Throws:

IOException - if IOException is encountered

getOutputAsString

public String getOutputAsString()
                         throws IOException

Returns the output as string.

Returns:

the output

Throws:

IOException - if IOException is encountered

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

setBufferSize

public void setBufferSize(int bufferSize)

Specified by:

setBufferSize in interface ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Throws:

IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

reset

public void reset()

Specified by:

reset in interface ServletResponse

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse