Class ClientHttpRequestDecorator
java.lang.Object
org.springframework.http.client.reactive.ClientHttpRequestDecorator
- All Implemented Interfaces:
ClientHttpRequest,HttpMessage,ReactiveHttpOutputMessage
Wraps another
ClientHttpRequest and delegates all methods to it.
Sub-classes can override specific methods selectively.- Since:
- 5.0
- Author:
- Rossen Stoyanchev
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidbeforeCommit(Supplier<? extends reactor.core.publisher.Mono<Void>> action) Register an action to apply just before the HttpOutputMessage is committed.Return aDataBufferFactorythat can be used to create the body.Return a mutable map of request cookies to send to the server.Return the headers of this message.Return the HTTP method of the request.<T> TReturn the request from the underlying HTTP library.getURI()Return the URI of the request.booleanWhether the HttpOutputMessage is committed.reactor.core.publisher.Mono<Void>Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made viaHttpMessage.getHeaders()to the underlying HTTP message (if not applied already).toString()reactor.core.publisher.Mono<Void>writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>> body) Use the givenPublisherofPublishersto write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after eachPublisher<DataBuffer>.reactor.core.publisher.Mono<Void>writeWith(Publisher<? extends DataBuffer> body) Use the givenPublisherto write the body of the message to the underlying HTTP layer.
-
Constructor Details
-
ClientHttpRequestDecorator
-
-
Method Details
-
getDelegate
-
getMethod
Description copied from interface:ClientHttpRequestReturn the HTTP method of the request.- Specified by:
getMethodin interfaceClientHttpRequest
-
getURI
Description copied from interface:ClientHttpRequestReturn the URI of the request.- Specified by:
getURIin interfaceClientHttpRequest
-
getHeaders
Description copied from interface:HttpMessageReturn the headers of this message.- Specified by:
getHeadersin interfaceHttpMessage- Returns:
- a corresponding HttpHeaders object (never
null)
-
getCookies
Description copied from interface:ClientHttpRequestReturn a mutable map of request cookies to send to the server.- Specified by:
getCookiesin interfaceClientHttpRequest
-
bufferFactory
Description copied from interface:ReactiveHttpOutputMessageReturn aDataBufferFactorythat can be used to create the body.- Specified by:
bufferFactoryin interfaceReactiveHttpOutputMessage- Returns:
- a buffer factory
- See Also:
-
getNativeRequest
public <T> T getNativeRequest()Description copied from interface:ClientHttpRequestReturn the request from the underlying HTTP library.- Specified by:
getNativeRequestin interfaceClientHttpRequest- Type Parameters:
T- the expected type of the request to cast to
-
beforeCommit
Description copied from interface:ReactiveHttpOutputMessageRegister an action to apply just before the HttpOutputMessage is committed.Note: the supplied action must be properly deferred, e.g. via
Mono.defer(java.util.function.Supplier<? extends reactor.core.publisher.Mono<? extends T>>)orMono.fromRunnable(java.lang.Runnable), to ensure it's executed in the right order, relative to other actions.- Specified by:
beforeCommitin interfaceReactiveHttpOutputMessage- Parameters:
action- the action to apply
-
isCommitted
public boolean isCommitted()Description copied from interface:ReactiveHttpOutputMessageWhether the HttpOutputMessage is committed.- Specified by:
isCommittedin interfaceReactiveHttpOutputMessage
-
writeWith
Description copied from interface:ReactiveHttpOutputMessageUse the givenPublisherto write the body of the message to the underlying HTTP layer.- Specified by:
writeWithin interfaceReactiveHttpOutputMessage- Parameters:
body- the body content publisher- Returns:
- a
Monothat indicates completion or error
-
writeAndFlushWith
public reactor.core.publisher.Mono<Void> writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>> body) Description copied from interface:ReactiveHttpOutputMessageUse the givenPublisherofPublishersto write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after eachPublisher<DataBuffer>.- Specified by:
writeAndFlushWithin interfaceReactiveHttpOutputMessage- Parameters:
body- the body content publisher- Returns:
- a
Monothat indicates completion or error
-
setComplete
Description copied from interface:ReactiveHttpOutputMessageIndicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made viaHttpMessage.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:
setCompletein interfaceReactiveHttpOutputMessage- Returns:
- a
Monothat indicates completion or error
-
toString
-