Package org.apache.juneau.rest.mock

Class MockServletResponse

java.lang.Object

org.apache.juneau.rest.mock.MockServletResponse

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse

public class MockServletResponse
extends Object
implements jakarta.servlet.http.HttpServletResponse

An implementation of HttpServletResponse for mocking purposes.

See Also:

• juneau-rest-mock Basics

Field Summary

Fields inherited from interface jakarta.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_MISDIRECTED_REQUEST, 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_PERMANENT_REDIRECT, 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_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE, SC_UPGRADE_REQUIRED, SC_USE_PROXY

Constructor Summary

Constructors

Constructor	Description
MockServletResponse()

Method Summary

Modifier and Type	Method	Description
void	addCookie(jakarta.servlet.http.Cookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
boolean	containsHeader(String name)
static MockServletResponse	create()	Creates a new servlet response.
String	encodeRedirectURL(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
String	getContentType()
String	getHeader(String name)
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
Locale	getLocale()
String	getMessage()	Returns the response message.
jakarta.servlet.ServletOutputStream	getOutputStream()
int	getStatus()
PrintWriter	getWriter()
MockServletResponse	header(String name, String value)	Fluent setter for setHeader(String,String).
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	sendRedirect(String location, int sc, boolean clearBuffer)
void	setBufferSize(int size)
void	setCharacterEncoding(String charset)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setContentType(String type)
void	setDateHeader(String name, long date)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale loc)
void	setStatus(int sc)
MockServletResponse	status(int value)	Fluent setter for setStatus(int).

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.http.HttpServletResponse

getTrailerFields, sendRedirect, sendRedirect, setTrailerFields

Methods inherited from interface jakarta.servlet.ServletResponse

setCharacterEncoding

Constructor Details

MockServletResponse

public MockServletResponse()

Method Details

create

public static MockServletResponse create()

Creates a new servlet response.

Returns:

A new response.

addCookie

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

Specified by:

addCookie in interface jakarta.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(String name,
 long date)

Specified by:

addDateHeader in interface jakarta.servlet.http.HttpServletResponse

addHeader

public void addHeader(String name,
 String value)

Specified by:

addHeader in interface jakarta.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(String name,
 int value)

Specified by:

addIntHeader in interface jakarta.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface jakarta.servlet.http.HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface jakarta.servlet.http.HttpServletResponse

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface jakarta.servlet.http.HttpServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface jakarta.servlet.ServletResponse

Throws:

IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface jakarta.servlet.ServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface jakarta.servlet.ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface jakarta.servlet.ServletResponse

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface jakarta.servlet.http.HttpServletResponse

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface jakarta.servlet.http.HttpServletResponse

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface jakarta.servlet.http.HttpServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface jakarta.servlet.ServletResponse

getMessage

public String getMessage()

Returns the response message.

Returns:

The response message.

getOutputStream

public jakarta.servlet.ServletOutputStream getOutputStream()
                                                    throws IOException

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

Throws:

IOException

getStatus

public int getStatus()

Specified by:

getStatus in interface jakarta.servlet.http.HttpServletResponse

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Throws:

IOException

header

public MockServletResponse header(String name,
 String value)

Fluent setter for setHeader(String,String).

Parameters:

name - The header name.

value - The new header value.

Returns:

This object.

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface jakarta.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface jakarta.servlet.ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface jakarta.servlet.ServletResponse

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendError

public void sendError(int sc,
 String msg)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String location,
 int sc,
 boolean clearBuffer)
                  throws IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface jakarta.servlet.ServletResponse

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface jakarta.servlet.ServletResponse

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface jakarta.servlet.ServletResponse

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface jakarta.servlet.ServletResponse

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface jakarta.servlet.ServletResponse

setDateHeader

public void setDateHeader(String name,
 long date)

Specified by:

setDateHeader in interface jakarta.servlet.http.HttpServletResponse

setHeader

public void setHeader(String name,
 String value)

Specified by:

setHeader in interface jakarta.servlet.http.HttpServletResponse

setIntHeader

public void setIntHeader(String name,
 int value)

Specified by:

setIntHeader in interface jakarta.servlet.http.HttpServletResponse

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface jakarta.servlet.ServletResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

status

public MockServletResponse status(int value)

Fluent setter for setStatus(int).

Parameters:

value - The new property value.

Returns:

This object.