Improve ClientHttpRequestFactory javadoc

This commit underlines the fact that the request created by a
ClientHttpRequestFactory should be augmented with a message body using
the `ClientHttpRequest#setBody` method before it is executed.

See #82
This commit is contained in:
Brian Clozel 2016-04-04 22:51:25 +02:00
parent ddf996cfeb
commit 09327181c4
1 changed files with 4 additions and 0 deletions

View File

@ -17,6 +17,8 @@ package org.springframework.http.client.reactive;
import java.net.URI;
import org.reactivestreams.Publisher;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
@ -29,6 +31,8 @@ public interface ClientHttpRequestFactory {
/**
* Create a new {@link ClientHttpRequest} for the specified HTTP method, URI and headers
* <p>The returned request can be {@link ClientHttpRequest#setBody(Publisher) written to},
* and then executed by calling {@link ClientHttpRequest#execute()}
*
* @param httpMethod the HTTP method to execute
* @param uri the URI to create a request for