org.springframework.http.client.reactive

Class ReactorClientHttpRequest

java.lang.Object

org.springframework.http.client.reactive.AbstractClientHttpRequest

org.springframework.http.client.reactive.ReactorClientHttpRequest

All Implemented Interfaces:

ClientHttpRequest, HttpMessage, ReactiveHttpOutputMessage, ZeroCopyHttpOutputMessage

public class ReactorClientHttpRequest
extends AbstractClientHttpRequest
implements ZeroCopyHttpOutputMessage

ClientHttpRequest implementation for the Reactor-Netty HTTP client.

Since:

5.0

Author:

Brian Clozel

See Also:

HttpClient

Constructor Summary

Constructors

Constructor and Description
ReactorClientHttpRequest(HttpMethod httpMethod, URI uri, reactor.ipc.netty.http.client.HttpClientRequest httpRequest)

Method Summary

Modifier and Type	Method and Description
protected void	applyCookies() Add cookies from AbstractClientHttpRequest.getHeaders() to the underlying response.
protected void	applyHeaders() Apply header changes from AbstractClientHttpRequest.getHeaders() to the underlying response.
DataBufferFactory	bufferFactory() Return a DataBufferFactory that can be used to create the body.
HttpMethod	getMethod() Return the HTTP method of the request.
URI	getURI() Return the URI of the request.
reactor.core.publisher.Mono<Void>	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).
reactor.core.publisher.Mono<Void>	writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends DataBuffer>> body) Use the given Publisher of Publishers to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each Publisher<DataBuffer>.
reactor.core.publisher.Mono<Void>	writeWith(File file, long position, long count) Use the given File to write the body of the message to the underlying HTTP layer.
reactor.core.publisher.Mono<Void>	writeWith(org.reactivestreams.Publisher<? extends DataBuffer> body) Use the given Publisher to write the body of the message to the underlying HTTP layer.

Methods inherited from class org.springframework.http.client.reactive.AbstractClientHttpRequest

beforeCommit, doCommit, doCommit, getCookies, getHeaders, isCommitted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.ReactiveHttpOutputMessage

beforeCommit, isCommitted

Methods inherited from interface org.springframework.http.HttpMessage

getHeaders

Constructor Detail

ReactorClientHttpRequest

public ReactorClientHttpRequest(HttpMethod httpMethod,
                                URI uri,
                                reactor.ipc.netty.http.client.HttpClientRequest httpRequest)

Method Detail

bufferFactory

public DataBufferFactory bufferFactory()

Description copied from interface: ReactiveHttpOutputMessage

Return a DataBufferFactory that can be used to create the body.

Specified by:

bufferFactory in interface ReactiveHttpOutputMessage

Returns:

a buffer factory

See Also:

ReactiveHttpOutputMessage.writeWith(Publisher)

getMethod

public HttpMethod getMethod()

Description copied from interface: ClientHttpRequest

Return the HTTP method of the request.

Specified by:

getMethod in interface ClientHttpRequest

getURI

public URI getURI()

Description copied from interface: ClientHttpRequest

Return the URI of the request.

Specified by:

getURI in interface ClientHttpRequest

writeWith

public reactor.core.publisher.Mono<Void> writeWith(org.reactivestreams.Publisher<? extends DataBuffer> body)

Description copied from interface: ReactiveHttpOutputMessage

Use the given Publisher to write the body of the message to the underlying HTTP layer.

Specified by:

writeWith in interface ReactiveHttpOutputMessage

Parameters:

body - the body content publisher

Returns:

a Mono that indicates completion or error

writeAndFlushWith

public reactor.core.publisher.Mono<Void> writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends DataBuffer>> body)

Description copied from interface: ReactiveHttpOutputMessage

Use the given Publisher of Publishers to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each Publisher<DataBuffer>.

Specified by:

writeAndFlushWith in interface ReactiveHttpOutputMessage

Parameters:

body - the body content publisher

Returns:

a Mono that indicates completion or error

writeWith

public reactor.core.publisher.Mono<Void> writeWith(File file,
                                                   long position,
                                                   long count)

Description copied from interface: ZeroCopyHttpOutputMessage

Use the given File to write the body of the message to the underlying HTTP layer.

Specified by:

writeWith in interface ZeroCopyHttpOutputMessage

Parameters:

file - the file to transfer

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

Returns:

a publisher that indicates completion or error.

setComplete

public reactor.core.publisher.Mono<Void> 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

Returns:

a Mono that indicates completion or error

applyHeaders

protected void applyHeaders()

Description copied from class: AbstractClientHttpRequest

Apply header changes from AbstractClientHttpRequest.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyHeaders in class AbstractClientHttpRequest

applyCookies

protected void applyCookies()

Description copied from class: AbstractClientHttpRequest

Add cookies from AbstractClientHttpRequest.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyCookies in class AbstractClientHttpRequest