org.apache.myfaces.test.mock
Class MockHttpServletResponse

java.lang.Object
  extended by org.apache.myfaces.test.mock.MockHttpServletResponse
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class MockHttpServletResponse
extends Object
implements javax.servlet.http.HttpServletResponse

Mock implementation of HttpServletResponse.

$Id$

Since:
1.0.0

Field Summary
 
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()
          Return a default instance.
 
Method Summary
 void addCookie(javax.servlet.http.Cookie cookie)
          
 void addDateHeader(String name, long value)
          
 void addHeader(String name, String value)
          
 void addIntHeader(String name, int value)
          
 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()
          
 String getContentType()
          
 javax.servlet.http.Cookie getCookie(String name)
           
 String getHeader(String name)
          Retrieve the first value that was set for the specified header, if any.
 Locale getLocale()
          
 String getMessage()
          Return the text message for the HTTP status that was set.
 javax.servlet.ServletOutputStream getOutputStream()
          
 int getStatus()
          Return the HTTP status code that was set.
 PrintWriter getWriter()
          
 boolean isCommitted()
          
 void reset()
          
 void resetBuffer()
          
 void sendError(int status)
          
 void sendError(int status, String message)
          
 void sendRedirect(String location)
          
 void setBufferSize(int size)
          
 void setCharacterEncoding(String charset)
          
 void setContentLength(int length)
          
 void setContentType(String type)
          
 void setDateHeader(String name, long value)
          
 void setHeader(String name, String value)
          
 void setIntHeader(String name, int value)
          
 void setLocale(Locale locale)
          
 void setOutputStream(javax.servlet.ServletOutputStream stream)
          Deprecated. Let the getOutputStream() method create and return an instance of MockServletOutputStream for you
 void setStatus(int status)
          
 void setStatus(int status, String message)
          
 void setWriter(PrintWriter writer)
          Deprecated. Let the getWriter() method create and return an instance of MockPrintWriter for you
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MockHttpServletResponse

public MockHttpServletResponse()

Return a default instance.

Method Detail

getHeader

public String getHeader(String name)

Retrieve the first value that was set for the specified header, if any. Otherwise, return null.

Parameters:
name - Header name to look up

getCookie

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

getMessage

public String getMessage()

Return the text message for the HTTP status that was set.


getStatus

public int getStatus()

Return the HTTP status code that was set.


setOutputStream

public void setOutputStream(javax.servlet.ServletOutputStream stream)
Deprecated. Let the getOutputStream() method create and return an instance of MockServletOutputStream for you

Set the ServletOutputStream to be returned by a call to getOutputStream().

Parameters:
stream - The ServletOutputStream instance to use

setWriter

public void setWriter(PrintWriter writer)
Deprecated. Let the getWriter() method create and return an instance of MockPrintWriter for you

Set the PrintWriter to be returned by a call to getWriter().

Parameters:
writer - The PrintWriter instance to use

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:
addCookie in interface javax.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(String name,
                          long value)

Specified by:
addDateHeader in interface javax.servlet.http.HttpServletResponse

addHeader

public void addHeader(String name,
                      String value)

Specified by:
addHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(String name,
                         int value)

Specified by:
addIntHeader in interface javax.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(String name)

Specified by:
containsHeader in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

public String encodeRedirectUrl(String url)

Specified by:
encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

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

encodeUrl

public String encodeUrl(String url)

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

encodeURL

public String encodeURL(String url)

Specified by:
encodeURL in interface javax.servlet.http.HttpServletResponse

sendError

public void sendError(int status)

Specified by:
sendError in interface javax.servlet.http.HttpServletResponse

sendError

public void sendError(int status,
                      String message)

Specified by:
sendError in interface javax.servlet.http.HttpServletResponse

sendRedirect

public void sendRedirect(String location)

Specified by:
sendRedirect in interface javax.servlet.http.HttpServletResponse

setDateHeader

public void setDateHeader(String name,
                          long value)

Specified by:
setDateHeader in interface javax.servlet.http.HttpServletResponse

setHeader

public void setHeader(String name,
                      String value)

Specified by:
setHeader in interface javax.servlet.http.HttpServletResponse

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:
setIntHeader 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 message)

Specified by:
setStatus in interface javax.servlet.http.HttpServletResponse

flushBuffer

public void flushBuffer()

Specified by:
flushBuffer in interface javax.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:
getBufferSize in interface javax.servlet.ServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:
getCharacterEncoding in interface javax.servlet.ServletResponse

getContentType

public String getContentType()

Specified by:
getContentType in interface javax.servlet.ServletResponse

getLocale

public Locale getLocale()

Specified by:
getLocale in interface javax.servlet.ServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:
getOutputStream in interface javax.servlet.ServletResponse
Throws:
IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:
getWriter in interface javax.servlet.ServletResponse
Throws:
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 size)

Specified by:
setBufferSize in interface javax.servlet.ServletResponse

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:
setCharacterEncoding in interface javax.servlet.ServletResponse

setContentLength

public void setContentLength(int length)

Specified by:
setContentLength in interface javax.servlet.ServletResponse

setContentType

public void setContentType(String type)

Specified by:
setContentType in interface javax.servlet.ServletResponse

setLocale

public void setLocale(Locale locale)

Specified by:
setLocale in interface javax.servlet.ServletResponse


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.