org.springframework.mock.http.server.reactive

Class MockServerHttpResponse

java.lang.Object

org.springframework.http.server.reactive.AbstractServerHttpResponse

org.springframework.mock.http.server.reactive.MockServerHttpResponse

All Implemented Interfaces:

HttpMessage, ReactiveHttpOutputMessage, ServerHttpResponse

public class MockServerHttpResponse
extends AbstractServerHttpResponse

Mock implementation of ServerHttpResponse.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	body
private java.util.function.Function<<any>,<any>>	writeHandler

Constructor Summary

Constructors

Constructor and Description
MockServerHttpResponse()

Method Summary

Modifier and Type	Method and Description
protected void	applyCookies() Implement this method to add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response.
protected void	applyHeaders() Implement this method to apply header changes from AbstractServerHttpResponse.getHeaders() to the underlying response.
protected void	applyStatusCode() Implement this method to write the status code to the underlying response.
private static java.lang.String	bufferToString(DataBuffer buffer, java.nio.charset.Charset charset)
<any>	getBody() Return the request body, or an error stream if the body was never set or when setWriteHandler(java.util.function.Function<<any>, <any>>) is configured.
<any>	getBodyAsString() Shortcut method that delegates to getBody() and then aggregates the data buffers and converts to a String using the charset of the Content-Type header or falling back on "UTF-8" by default.
private java.nio.charset.Charset	getCharset()
private java.util.function.Function<<any>,<any>>	initDefaultWriteHandler()
<any>	setComplete() Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via HttpMessage.getHeaders() to the underlying HTTP message (if not applied already).
void	setWriteHandler(java.util.function.Function<<any>,<any>> writeHandler) Configure a custom handler for writing the request body.
protected <any>	writeAndFlushWithInternal(<any> body) Implement this method to write to the underlying the response, and flush after each Publisher<DataBuffer>.
protected <any>	writeWithInternal(<any> body) Implement this method to write to the underlying the response.

Methods inherited from class org.springframework.http.server.reactive.AbstractServerHttpResponse

beforeCommit, bufferFactory, doCommit, doCommit, encodeUrl, getCookies, getHeaders, getStatusCode, isCommitted, registerUrlEncoder, setStatusCode, writeAndFlushWith, writeWith

Methods inherited from class java.lang.Object

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

Field Detail

body

private <any> body

writeHandler

private java.util.function.Function<<any>,<any>> writeHandler

Constructor Detail

MockServerHttpResponse

public MockServerHttpResponse()

Method Detail

initDefaultWriteHandler

private java.util.function.Function<<any>,<any>> initDefaultWriteHandler()

getBody

public <any> getBody()

Return the request body, or an error stream if the body was never set or when setWriteHandler(java.util.function.Function<<any>, <any>>) is configured.

getBodyAsString

public <any> getBodyAsString()

Shortcut method that delegates to getBody() and then aggregates the data buffers and converts to a String using the charset of the Content-Type header or falling back on "UTF-8" by default.

bufferToString

private static java.lang.String bufferToString(DataBuffer buffer,
                                               java.nio.charset.Charset charset)

getCharset

private java.nio.charset.Charset getCharset()

setWriteHandler

public void setWriteHandler(java.util.function.Function<<any>,<any>> writeHandler)

Configure a custom handler for writing the request body.

The default write handler consumes and caches the request body so it may be accessed subsequently, e.g. in test assertions. Use this property when the request body is an infinite stream.

Parameters:

writeHandler - the write handler to use returning Mono<Void> when the body has been "written" (i.e. consumed).

applyStatusCode

protected void applyStatusCode()

Description copied from class: AbstractServerHttpResponse

Implement this method to write the status code to the underlying response. This method is called once only.

Specified by:

applyStatusCode in class AbstractServerHttpResponse

applyHeaders

protected void applyHeaders()

Description copied from class: AbstractServerHttpResponse

Implement this method to apply header changes from AbstractServerHttpResponse.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyHeaders in class AbstractServerHttpResponse

applyCookies

protected void applyCookies()

Description copied from class: AbstractServerHttpResponse

Implement this method to add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyCookies in class AbstractServerHttpResponse

writeWithInternal

protected <any> writeWithInternal(<any> body)

Description copied from class: AbstractServerHttpResponse

Implement this method to write to the underlying the response.

Specified by:

writeWithInternal in class AbstractServerHttpResponse

Parameters:

body - the publisher to write with

writeAndFlushWithInternal

protected <any> writeAndFlushWithInternal(<any> body)

Description copied from class: AbstractServerHttpResponse

Implement this method to write to the underlying the response, and flush after each Publisher<DataBuffer>.

Specified by:

writeAndFlushWithInternal in class AbstractServerHttpResponse

Parameters:

body - the publisher to write and flush with

setComplete

public <any> setComplete()

Description copied from interface: ReactiveHttpOutputMessage

Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via HttpMessage.getHeaders() to the underlying HTTP message (if not applied already).

This method should be automatically invoked at the end of message processing so typically applications should not have to invoke it. If invoked multiple times it should have no side effects.

Specified by:

setComplete in interface ReactiveHttpOutputMessage

Overrides:

setComplete in class AbstractServerHttpResponse

Returns:

a Mono that indicates completion or error