extends
Object
implements
HttpServletResponse
Mock implementation of the
HttpServletResponse
interface.
As of Spring 6.0, this set of mocks is designed on a Servlet 6.0 baseline.
Since:
1.0.2
Author:
Juergen Hoeller, Rod Johnson, Brian Clozel, Vedran Pavic, Sebastien Deleuze, Sam Brannen
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
The default implementation returns the given URL String as-is.
byte[]
Get the content of the response body as a
String
, using the charset
specified for the response by the application, either through
HttpServletResponse
methods or through a charset parameter on the
Content-Type
.
Get the content of the response body as a
String
, using the provided
fallbackCharset
if no charset has been explicitly defined and otherwise
using the charset specified for the response by the application, either
through
HttpServletResponse
methods or through a charset parameter on the
Content-Type
.
Return the primary value for the given header as a String, if any.
Return the names of all specified headers as a Set of Strings.
Return all values for the given header as a List of Strings.
Return the primary value for the given header, if any.
Return all values for the given header as a List of value objects.
boolean
Determine whether the character encoding has been explicitly set through
HttpServletResponse
methods or through a
charset
parameter
on the
Content-Type
.
boolean
boolean
boolean
Set the
default
character encoding for the response.
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
setOutputStreamAccessAllowed
public
void
setOutputStreamAccessAllowed
(boolean outputStreamAccessAllowed)
setWriterAccessAllowed
public
void
setWriterAccessAllowed
(boolean writerAccessAllowed)
Set whether
getWriter()
access is allowed.
Default is
true
.
setDefaultCharacterEncoding
public
void
setDefaultCharacterEncoding
(
String
characterEncoding)
Set the
default
character encoding for the response.
If this method is not invoked,
ISO-8859-1
will be used as the
default character encoding.
If the
character encoding
for the
response has not already been explicitly set via
setCharacterEncoding(String)
or
setContentType(String)
, the character encoding for the response
will be set to the supplied default character encoding.
Parameters:
characterEncoding
- the default character encoding
Since:
5.3.10
See Also:
setCharacterEncoding(String)
setContentType(String)
isCharset
public
boolean
isCharset
()
getContentAsString
Get the content of the response body as a
String
, using the charset
specified for the response by the application, either through
HttpServletResponse
methods or through a charset parameter on the
Content-Type
. If no charset has been explicitly defined, the
default character encoding
will be used.
Returns:
the content as a
String
Throws:
UnsupportedEncodingException
- if the character encoding is not supported
See Also:
getContentAsString(Charset)
setCharacterEncoding(String)
setContentType(String)
getContentAsString
Get the content of the response body as a
String
, using the provided
fallbackCharset
if no charset has been explicitly defined and otherwise
using the charset specified for the response by the application, either
through
HttpServletResponse
methods or through a charset parameter on the
Content-Type
.
Returns:
the content as a
String
Throws:
UnsupportedEncodingException
- if the character encoding is not supported
Since:
See Also:
getContentAsString()
setCharacterEncoding(String)
setContentType(String)
getHeaderNames
Return the names of all specified headers as a Set of Strings.
As of Servlet 3.0, this method is also defined in
HttpServletResponse
.
Specified by:
getHeaderNames
in interface
HttpServletResponse
Returns:
the
Set
of header name
Strings
, or an empty
Set
if none
Return the primary value for the given header as a String, if any.
Will return the first value in case of multiple values.
Returns a stringified value for Servlet 3.0 compatibility. Consider
using
getHeaderValue(String)
for raw Object access.
Specified by:
getHeader
in interface
HttpServletResponse
Parameters:
name
- the name of the header
Returns:
the associated header value, or
null
if none
See Also:
HttpServletResponse.getHeader(String)
getHeaders
Return all values for the given header as a List of Strings.
Returns a List of stringified values for Servlet 3.0 compatibility.
Consider using
getHeaderValues(String)
for raw Object access.
Specified by:
getHeaders
in interface
HttpServletResponse
Parameters:
name
- the name of the header
Returns:
the associated header values, or an empty List if none
See Also:
HttpServletResponse.getHeaders(String)
Return the primary value for the given header, if any.
Will return the first value in case of multiple values.
Parameters:
name
- the name of the header
Returns:
the associated header value, or
null
if none
getHeaderValues
Return all values for the given header as a List of value objects.
Parameters:
name
- the name of the header
Returns:
the associated header values, or an empty List if none
encodeURL
The default implementation returns the given URL String as-is.
Can be overridden in subclasses, appending a session id or the like.
Specified by:
encodeURL
in interface
HttpServletResponse
encodeRedirectURL
The default implementation delegates to
encodeURL(java.lang.String)
,
returning the given URL String as-is.
Can be overridden in subclasses, appending a session id or the like
in a redirect-specific fashion. For general URL encoding rules,
override the common
encodeURL(java.lang.String)
method instead, applying
to redirect URLs as well as to general URLs.
Specified by:
encodeRedirectURL
in interface
HttpServletResponse