Package com.helger.servlet.mock

Class MockHttpServletResponse

java.lang.Object

com.helger.servlet.mock.MockHttpServletResponse

All Implemented Interfaces:

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

@NotThreadSafe
public class MockHttpServletResponse
extends Object
implements jakarta.servlet.http.HttpServletResponse

Mock implementation of HttpServletResponse.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static Charset	DEFAULT_CHARSET_OBJ
static int	DEFAULT_SERVER_PORT

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_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

Constructors

Constructor	Description
MockHttpServletResponse()

Method Summary

Modifier and Type	Method	Description
void	addCookie(jakarta.servlet.http.Cookie aCookie)
void	addDateHeader(String sName, long nValue)
void	addHeader(String sName, String sValue)
void	addIntHeader(String sName, int nValue)
boolean	containsHeader(String sName)
String	encodeRedirectUrl(String sUrl)	Deprecated.
String	encodeRedirectURL(String sUrl)	The default implementation returns the given URL String as-is.
String	encodeUrl(String sUrl)	Deprecated.
String	encodeURL(String sUrl)	The default implementation returns the given URL String as-is.
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
Charset	getCharacterEncodingObj()
Charset	getCharacterEncodingObjOrDefault()
byte[]	getContentAsByteArray()
String	getContentAsString(Charset aCharset)
int	getContentLength()
String	getContentType()
jakarta.servlet.http.Cookie	getCookie(String sName)
jakarta.servlet.http.Cookie[]	getCookies()
String	getEncodeRedirectUrlSuffix()
String	getEncodeUrlSuffix()
String	getErrorMessage()
String	getForwardedUrl()
String	getHeader(String sName)	Return the primary value for the given header, if any.
com.helger.commons.collection.impl.ICommonsSet<String>	getHeaderNames()	Return the names of all specified headers as a Set of Strings.
com.helger.commons.collection.impl.ICommonsList<String>	getHeaders(String sName)	Return all values for the given header as a List of value objects.
String	getIncludedUrl()
Locale	getLocale()
jakarta.servlet.ServletOutputStream	getOutputStream()
String	getRedirectedUrl()
int	getStatus()
PrintWriter	getWriter()
boolean	isCommitted()
boolean	isOutputStreamAccessAllowed()
boolean	isWriterAccessAllowed()
void	reset()
void	resetBuffer()
void	sendError(int nStatus)
void	sendError(int nStatus, String sErrorMessage)
void	sendRedirect(String sUrl)
void	setBufferSize(int nBufferSize)
void	setCharacterEncoding(String sCharacterEncoding)
void	setCharacterEncoding(Charset aCharacterEncoding)
void	setCommitted(boolean bCommitted)
void	setContentLength(int nContentLength)
void	setContentLengthLong(long len)
void	setContentType(String sContentType)
void	setDateHeader(String sName, long nValue)
void	setEncodeRedirectUrlSuffix(String sEncodeRedirectUrlSuffix)
void	setEncodeUrlSuffix(String sEncodeUrlSuffix)
void	setForwardedUrl(String sForwardedUrl)
void	setHeader(String sName, String sValue)
void	setIncludedUrl(String sIncludedUrl)
void	setIntHeader(String sName, int nValue)
void	setLocale(Locale aLocale)
void	setOutputStreamAccessAllowed(boolean bOutputStreamAccessAllowed)	Set whether getOutputStream() access is allowed.
void	setStatus(int nStatus)
void	setStatus(int nStatus, String sErrorMessage)	Deprecated.
void	setWriterAccessAllowed(boolean bWriterAccessAllowed)	Set whether getWriter() access is allowed.

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, setTrailerFields

Field Detail

DEFAULT_SERVER_PORT

public static final int DEFAULT_SERVER_PORT

DEFAULT_CHARSET_OBJ

public static final Charset DEFAULT_CHARSET_OBJ

Constructor Detail

MockHttpServletResponse

public MockHttpServletResponse()

Method Detail

setOutputStreamAccessAllowed

public void setOutputStreamAccessAllowed(boolean bOutputStreamAccessAllowed)

Set whether getOutputStream() access is allowed.

Default is true.

Parameters:

bOutputStreamAccessAllowed - true to enabled

isOutputStreamAccessAllowed

public boolean isOutputStreamAccessAllowed()

Returns:

whether getOutputStream() access is allowed.

setWriterAccessAllowed

public void setWriterAccessAllowed(boolean bWriterAccessAllowed)

Set whether getWriter() access is allowed.

Default is true.

Parameters:

bWriterAccessAllowed - true to enabled

isWriterAccessAllowed

public boolean isWriterAccessAllowed()

Returns:

whether getOutputStream() access is allowed.

setCharacterEncoding

public void setCharacterEncoding(@Nullable
                                 String sCharacterEncoding)

Specified by:

setCharacterEncoding in interface jakarta.servlet.ServletResponse

setCharacterEncoding

public void setCharacterEncoding(@Nullable
                                 Charset aCharacterEncoding)

getCharacterEncoding

@Nullable
public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface jakarta.servlet.ServletResponse

getCharacterEncodingObj

@Nullable
public Charset getCharacterEncodingObj()

getCharacterEncodingObjOrDefault

@Nonnull
public Charset getCharacterEncodingObjOrDefault()

getOutputStream

@Nonnull
public jakarta.servlet.ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

getWriter

@Nonnull
public PrintWriter getWriter()

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

getContentAsByteArray

@Nonnull
@ReturnsMutableCopy
public byte[] getContentAsByteArray()

getContentAsString

@Nonnull
public String getContentAsString(@Nonnull
                                 Charset aCharset)

setContentLength

public void setContentLength(int nContentLength)

Specified by:

setContentLength in interface jakarta.servlet.ServletResponse

getContentLength

public int getContentLength()

setContentType

public void setContentType(@Nullable
                           String sContentType)

Specified by:

setContentType in interface jakarta.servlet.ServletResponse

getContentType

@Nullable
public String getContentType()

Specified by:

getContentType in interface jakarta.servlet.ServletResponse

setBufferSize

public void setBufferSize(int nBufferSize)

Specified by:

setBufferSize in interface jakarta.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface jakarta.servlet.ServletResponse

flushBuffer

public void flushBuffer()

Specified by:

flushBuffer in interface jakarta.servlet.ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface jakarta.servlet.ServletResponse

setCommitted

public void setCommitted(boolean bCommitted)

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface jakarta.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface jakarta.servlet.ServletResponse

setLocale

public void setLocale(@Nullable
                      Locale aLocale)

Specified by:

setLocale in interface jakarta.servlet.ServletResponse

getLocale

@Nullable
public Locale getLocale()

Specified by:

getLocale in interface jakarta.servlet.ServletResponse

addCookie

public void addCookie(@Nonnull
                      jakarta.servlet.http.Cookie aCookie)

Specified by:

addCookie in interface jakarta.servlet.http.HttpServletResponse

getCookies

@Nonnull
@ReturnsMutableCopy
public jakarta.servlet.http.Cookie[] getCookies()

getCookie

@Nullable
public jakarta.servlet.http.Cookie getCookie(@Nonnull
                                             String sName)

containsHeader

public boolean containsHeader(@Nullable
                              String sName)

Specified by:

containsHeader in interface jakarta.servlet.http.HttpServletResponse

getHeaderNames

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsSet<String> getHeaderNames()

Return the names of all specified headers as a Set of Strings.

Specified by:

getHeaderNames in interface jakarta.servlet.http.HttpServletResponse

Returns:

the Set of header name Strings, or an empty Set if none

getHeader

@Nullable
public String getHeader(@Nullable
                        String sName)

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 jakarta.servlet.http.HttpServletResponse

Parameters:

sName - the name of the header

Returns:

the associated header value, or null if none

getHeaders

@Nonnull
public com.helger.commons.collection.impl.ICommonsList<String> getHeaders(@Nullable
                                                                          String sName)

Return all values for the given header as a List of value objects.

Specified by:

getHeaders in interface jakarta.servlet.http.HttpServletResponse

Parameters:

sName - the name of the header

Returns:

the associated header values, or an empty List if none

encodeURL

@Nullable
public String encodeURL(@Nullable
                        String sUrl)

The default implementation returns the given URL String as-is. Use setEncodeUrlSuffix(String) to define a suffix to be appended.

Specified by:

encodeURL in interface jakarta.servlet.http.HttpServletResponse

Returns:

the encoded URL

encodeRedirectURL

@Nullable
public String encodeRedirectURL(@Nullable
                                String sUrl)

The default implementation returns the given URL String as-is. Use setEncodeRedirectUrlSuffix(String) to define a suffix to be appended.

Specified by:

encodeRedirectURL in interface jakarta.servlet.http.HttpServletResponse

Returns:

the encoded URL

encodeUrl

@Deprecated(forRemoval=false)
public String encodeUrl(@Nullable
                        String sUrl)

Deprecated.

Specified by:

encodeUrl in interface jakarta.servlet.http.HttpServletResponse

encodeRedirectUrl

@Deprecated(forRemoval=false)
public String encodeRedirectUrl(@Nullable
                                String sUrl)

Deprecated.

Specified by:

encodeRedirectUrl in interface jakarta.servlet.http.HttpServletResponse

sendError

public void sendError(int nStatus,
                      @Nullable
                      String sErrorMessage)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendError

public void sendError(int nStatus)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(@Nonnull
                         String sUrl)
                  throws IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

getRedirectedUrl

@Nullable
public String getRedirectedUrl()

setDateHeader

public void setDateHeader(@Nullable
                          String sName,
                          long nValue)

Specified by:

setDateHeader in interface jakarta.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(@Nullable
                          String sName,
                          long nValue)

Specified by:

addDateHeader in interface jakarta.servlet.http.HttpServletResponse

setHeader

public void setHeader(@Nullable
                      String sName,
                      @Nullable
                      String sValue)

Specified by:

setHeader in interface jakarta.servlet.http.HttpServletResponse

addHeader

public void addHeader(@Nullable
                      String sName,
                      @Nullable
                      String sValue)

Specified by:

addHeader in interface jakarta.servlet.http.HttpServletResponse

setIntHeader

public void setIntHeader(@Nullable
                         String sName,
                         int nValue)

Specified by:

setIntHeader in interface jakarta.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(@Nullable
                         String sName,
                         int nValue)

Specified by:

addIntHeader in interface jakarta.servlet.http.HttpServletResponse

setStatus

public void setStatus(int nStatus)

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

setStatus

@Deprecated(forRemoval=false)
public void setStatus(int nStatus,
                      @Nullable
                      String sErrorMessage)

Deprecated.

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface jakarta.servlet.http.HttpServletResponse

getErrorMessage

@Nullable
public String getErrorMessage()

setForwardedUrl

public void setForwardedUrl(@Nullable
                            String sForwardedUrl)

getForwardedUrl

@Nullable
public String getForwardedUrl()

setIncludedUrl

public void setIncludedUrl(@Nullable
                           String sIncludedUrl)

getIncludedUrl

@Nullable
public String getIncludedUrl()

setEncodeUrlSuffix

public void setEncodeUrlSuffix(@Nullable
                               String sEncodeUrlSuffix)

getEncodeUrlSuffix

@Nullable
public String getEncodeUrlSuffix()

setEncodeRedirectUrlSuffix

public void setEncodeRedirectUrlSuffix(@Nullable
                                       String sEncodeRedirectUrlSuffix)

getEncodeRedirectUrlSuffix

@Nullable
public String getEncodeRedirectUrlSuffix()

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface jakarta.servlet.ServletResponse