Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve javadoc on reactive classes

Browse Source 
Ensure type-level Javadoc in every class, comply with guidelines for
80 char on Javadoc, and minor polish.
This commit is contained in:
Rossen Stoyanchev
2016-07-18 08:46:47 -04:00
parent 7a0c2422c6
commit 3e096ce810
62 changed files with 255 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-web/src/main/java/org/springframework/http/client/reactive/AbstractClientHttpRequest.java
View File

@@ -47,6 +47,7 @@ public abstract class AbstractClientHttpRequest implements ClientHttpRequest {
private final List<Supplier<? extends Mono<Void>>> beforeCommitActions = new ArrayList<>(4);
public AbstractClientHttpRequest() {
this(new HttpHeaders());
}
@@ -57,6 +58,7 @@ public abstract class AbstractClientHttpRequest implements ClientHttpRequest {
this.cookies = new LinkedMultiValueMap<>();
}
@Override
public HttpHeaders getHeaders() {
if (State.COMITTED.equals(this.state.get())) {

17
spring-web/src/main/java/org/springframework/http/client/reactive/ClientHttpConnector.java
View File

@@ -23,10 +23,9 @@ import reactor.core.publisher.Mono;
import org.springframework.http.HttpMethod;
/**
* Client abstraction for HTTP client runtimes.
* {@link ClientHttpConnector} drives the underlying HTTP client implementation
* so as to connect to the origin server and provide all the necessary infrastructure
* to send the actual {@link ClientHttpRequest} and receive the {@link ClientHttpResponse}
* Abstraction over HTTP clients driving the underlying HTTP client to connect
* to the origin server and provide all necessary infrastructure to send a
* {@link ClientHttpRequest} and receive a {@link ClientHttpResponse}.
*
* @author Brian Clozel
* @since 5.0
@@ -34,16 +33,16 @@ import org.springframework.http.HttpMethod;
public interface ClientHttpConnector {
/**
* Connect to the origin server using the given {@code HttpMethod} and {@code URI},
* then apply the given {@code requestCallback} on the {@link ClientHttpRequest}
* once the connection has been established.
* Connect to the origin server using the given {@code HttpMethod} and
* {@code URI}, then apply the given {@code requestCallback} on the
* {@link ClientHttpRequest} once the connection has been established.
* <p>Return a publisher of the {@link ClientHttpResponse}.
*
* @param method the HTTP request method
* @param uri the HTTP request URI
* @param requestCallback a function that prepares and writes the request,
* returning a publisher that signals when it's done interacting with the request.
* Implementations should return a {@code Mono<Void>} by calling
* returning a publisher that signals when it's done interacting with the
* request. Implementations should return a {@code Mono<Void>} by calling
* {@link ClientHttpRequest#writeWith} or {@link ClientHttpRequest#setComplete}.
* @return a publisher of the {@link ClientHttpResponse}
*/

2
spring-web/src/main/java/org/springframework/http/client/reactive/ClientHttpRequest.java
View File

@@ -24,7 +24,7 @@ import org.springframework.http.ReactiveHttpOutputMessage;
import org.springframework.util.MultiValueMap;
/**
* Represents a reactive client-side HTTP request.
* Represents a client-side reactive HTTP request.
*
* @author Arjen Poutsma
* @author Brian Clozel

2
spring-web/src/main/java/org/springframework/http/client/reactive/ClientHttpResponse.java
View File

@@ -22,7 +22,7 @@ import org.springframework.http.ResponseCookie;
import org.springframework.util.MultiValueMap;
/**
* Represents a reactive client-side HTTP response.
* Represents a client-side reactive HTTP response.
*
* @author Arjen Poutsma
* @since 5.0

1
spring-web/src/main/java/org/springframework/http/client/reactive/ReactorClientHttpConnector.java
View File

@@ -47,4 +47,5 @@ public class ReactorClientHttpConnector implements ClientHttpConnector {
.otherwise(HttpException.class, exc -> Mono.just(exc.getChannel()))
.map(httpInbound -> new ReactorClientHttpResponse(httpInbound));
}
}

4
spring-web/src/main/java/org/springframework/http/client/reactive/ReactorClientHttpRequest.java
View File

@@ -33,7 +33,7 @@ import org.springframework.core.io.buffer.NettyDataBufferFactory;
import org.springframework.http.HttpMethod;
/**
* {@link ClientHttpRequest} implementation for the Reactor-Netty HTTP client
* {@link ClientHttpRequest} implementation for the Reactor-Netty HTTP client.
*
* @author Brian Clozel
* @since 5.0
@@ -49,6 +49,7 @@ public class ReactorClientHttpRequest extends AbstractClientHttpRequest {
private final NettyDataBufferFactory bufferFactory;
public ReactorClientHttpRequest(HttpMethod httpMethod, URI uri, HttpClientRequest httpRequest) {
this.httpMethod = httpMethod;
this.uri = uri;
@@ -56,6 +57,7 @@ public class ReactorClientHttpRequest extends AbstractClientHttpRequest {
this.bufferFactory = new NettyDataBufferFactory(httpRequest.delegate().alloc());
}
@Override
public DataBufferFactory bufferFactory() {
return this.bufferFactory;

4
spring-web/src/main/java/org/springframework/http/client/reactive/ReactorClientHttpResponse.java
View File

@@ -31,7 +31,7 @@ import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
/**
* {@link ClientHttpResponse} implementation for the Reactor-Netty HTTP client
* {@link ClientHttpResponse} implementation for the Reactor-Netty HTTP client.
*
* @author Brian Clozel
* @see reactor.io.netty.http.HttpClient
@@ -43,11 +43,13 @@ public class ReactorClientHttpResponse implements ClientHttpResponse {
private final HttpInbound response;
public ReactorClientHttpResponse(HttpInbound response) {
this.response = response;
this.dataBufferFactory = new NettyDataBufferFactory(response.delegate().alloc());
}
@Override
public Flux<DataBuffer> getBody() {
return response.receive()

9
spring-web/src/main/java/org/springframework/http/codec/SseEvent.java
View File

@@ -20,10 +20,9 @@ import org.springframework.http.MediaType;
import org.springframework.http.codec.SseEventEncoder;
/**
* Represent a Server-Sent Event.
*
* <p>{@code Flux<SseEvent>} is Spring Web Reactive equivalent to Spring MVC
* {@code SseEmitter} type. It allows to send Server-Sent Events in a reactive way.
* Representation for a Server-Sent Event for use with Spring's reactive Web
* support. {@code Flux<SseEvent>} or {@code Observable<SseEvent>} is the
* reactive equivalent to Spring MVC's {@code SseEmitter}.
*
* @author Sebastien Deleuze
* @since 5.0
@@ -44,6 +43,7 @@ public class SseEvent {
private String comment;
/**
* Create an empty instance.
*/
@@ -65,6 +65,7 @@ public class SseEvent {
this.mediaType = mediaType;
}
/**
* Set the {@code id} SSE field
*/

6
spring-web/src/main/java/org/springframework/http/codec/SseEventEncoder.java
View File

@@ -36,8 +36,10 @@ import org.springframework.util.Assert;
import org.springframework.util.MimeType;
/**
* An encoder for {@link SseEvent}s that also supports any other kind of {@link Object}
* (in that case, the object will be the data of the {@link SseEvent}).
* Encoder that supports a stream of {@link SseEvent}s and also plain
* {@link Object}s which is the same as an {@link SseEvent} with data
* only.
*
* @author Sebastien Deleuze
* @since 5.0
*/

6
spring-web/src/main/java/org/springframework/http/codec/xml/Jaxb2Decoder.java
View File

@@ -44,7 +44,8 @@ import org.springframework.util.MimeTypeUtils;
import org.springframework.util.xml.StaxUtils;
/**
* Decode from a bytes stream of XML elements to a stream of {@code Object} (POJO).
* Decode from a bytes stream containing XML elements to a stream of
* {@code Object}s (POJOs).
*
* @author Sebastien Deleuze
* @author Arjen Poutsma
@@ -66,10 +67,12 @@ public class Jaxb2Decoder extends AbstractDecoder<Object> {
private final JaxbContextContainer jaxbContexts = new JaxbContextContainer();
public Jaxb2Decoder() {
super(MimeTypeUtils.APPLICATION_XML, MimeTypeUtils.TEXT_XML);
}
@Override
public boolean canDecode(ResolvableType elementType, MimeType mimeType, Object... hints) {
if (super.canDecode(elementType, mimeType, hints)) {
@@ -85,6 +88,7 @@ public class Jaxb2Decoder extends AbstractDecoder<Object> {
@Override
public Flux<Object> decode(Publisher<DataBuffer> inputStream, ResolvableType elementType,
MimeType mimeType, Object... hints) {
Class<?> outputClass = elementType.getRawClass();
Flux<XMLEvent> xmlEventFlux =
this.xmlEventDecoder.decode(inputStream, null, mimeType);

2
spring-web/src/main/java/org/springframework/http/codec/xml/Jaxb2Encoder.java
View File

@@ -34,7 +34,7 @@ import org.springframework.util.MimeType;
import org.springframework.util.MimeTypeUtils;
/**
* Encode from an {@code Object} stream to a byte stream of XML elements.
* Encode from {@code Object} stream to a byte stream containing XML elements.
*
* @author Sebastien Deleuze
* @author Arjen Poutsma

2
spring-web/src/main/java/org/springframework/http/codec/xml/JaxbContextContainer.java
View File

@@ -31,9 +31,11 @@ import org.springframework.util.Assert;
*/
final class JaxbContextContainer {
private final ConcurrentMap<Class<?>, JAXBContext> jaxbContexts =
new ConcurrentHashMap<>(64);
public Marshaller createMarshaller(Class<?> clazz) throws JAXBException {
JAXBContext jaxbContext = getJaxbContext(clazz);
return jaxbContext.createMarshaller();

4
spring-web/src/main/java/org/springframework/http/server/reactive/AbstractRequestBodyPublisher.java
View File

@@ -34,8 +34,8 @@ import org.springframework.core.io.buffer.DataBuffer;
/**
* Abstract base class for {@code Publisher} implementations that bridge between
* event-listener APIs and Reactive Streams. Specifically, base class for the Servlet 3.1
* and Undertow support.
* event-listener APIs and Reactive Streams. Specifically, base class for the
* Servlet 3.1 and Undertow support.
*
* @author Arjen Poutsma
* @since 5.0

5
spring-web/src/main/java/org/springframework/http/server/reactive/AbstractResponseBodyProcessor.java
View File

@@ -35,8 +35,9 @@ import org.springframework.util.Assert;
/**
* Abstract base class for {@code Subscriber} implementations that bridge between
* event-listener APIs and Reactive Streams. Specifically, base class for the Servlet 3.1
* and Undertow support.
* event-listener APIs and Reactive Streams. Specifically, base class for the
* Servlet 3.1 and Undertow support.
*
* @author Arjen Poutsma
* @since 5.0
* @see ServletServerHttpRequest

17
spring-web/src/main/java/org/springframework/http/server/reactive/ReactorHttpHandlerAdapter.java
View File

@@ -25,28 +25,27 @@ import org.springframework.core.io.buffer.NettyDataBufferFactory;
import org.springframework.util.Assert;
/**
* Adapt {@link HttpHandler} to the Reactor Netty {@link ChannelHandler}.
*
* @author Stephane Maldini
* @since 5.0
*/
public class ReactorHttpHandlerAdapter
implements ChannelHandler<ByteBuf, ByteBuf, HttpChannel> {
public class ReactorHttpHandlerAdapter implements ChannelHandler<ByteBuf, ByteBuf, HttpChannel> {
private final HttpHandler httpHandler;
public ReactorHttpHandlerAdapter(HttpHandler httpHandler) {
Assert.notNull(httpHandler, "'httpHandler' is required.");
this.httpHandler = httpHandler;
}
@Override
public Mono<Void> apply(HttpChannel channel) {
NettyDataBufferFactory dataBufferFactory =
new NettyDataBufferFactory(channel.delegate().alloc());
ReactorServerHttpRequest adaptedRequest =
new ReactorServerHttpRequest(channel, dataBufferFactory);
ReactorServerHttpResponse adaptedResponse =
new ReactorServerHttpResponse(channel, dataBufferFactory);
NettyDataBufferFactory bufferFactory = new NettyDataBufferFactory(channel.delegate().alloc());
ReactorServerHttpRequest adaptedRequest = new ReactorServerHttpRequest(channel, bufferFactory);
ReactorServerHttpResponse adaptedResponse = new ReactorServerHttpResponse(channel, bufferFactory);
return this.httpHandler.handle(adaptedRequest, adaptedResponse);
}

1
spring-web/src/main/java/org/springframework/http/server/reactive/ResponseBodyWriteResultPublisher.java
View File

@@ -28,6 +28,7 @@ import reactor.core.publisher.Operators;
/**
* Publisher returned from {@link ServerHttpResponse#writeWith(Publisher)}.
*
* @author Arjen Poutsma
* @since 5.0
*/

14
spring-web/src/main/java/org/springframework/http/server/reactive/RxNettyHttpHandlerAdapter.java
View File

@@ -28,6 +28,8 @@ import org.springframework.core.io.buffer.NettyDataBufferFactory;
import org.springframework.util.Assert;
/**
* Adapt {@link HttpHandler} to the RxNetty {@link RequestHandler}.
*
* @author Rossen Stoyanchev
* @since 5.0
*/
@@ -35,20 +37,18 @@ public class RxNettyHttpHandlerAdapter implements RequestHandler<ByteBuf, ByteBu
private final HttpHandler httpHandler;
public RxNettyHttpHandlerAdapter(HttpHandler httpHandler) {
Assert.notNull(httpHandler, "'httpHandler' is required");
this.httpHandler = httpHandler;
}
@Override
public Observable<Void> handle(HttpServerRequest<ByteBuf> request, HttpServerResponse<ByteBuf> response) {
NettyDataBufferFactory dataBufferFactory =
new NettyDataBufferFactory(response.unsafeNettyChannel().alloc());
RxNettyServerHttpRequest adaptedRequest =
new RxNettyServerHttpRequest(request, dataBufferFactory);
RxNettyServerHttpResponse adaptedResponse =
new RxNettyServerHttpResponse(response, dataBufferFactory);
NettyDataBufferFactory bufferFactory = new NettyDataBufferFactory(response.unsafeNettyChannel().alloc());
RxNettyServerHttpRequest adaptedRequest = new RxNettyServerHttpRequest(request, bufferFactory);
RxNettyServerHttpResponse adaptedResponse = new RxNettyServerHttpResponse(response, bufferFactory);
Publisher<Void> result = this.httpHandler.handle(adaptedRequest, adaptedResponse);
return RxJava1Adapter.publisherToObservable(result);
}

4
spring-web/src/main/java/org/springframework/http/server/reactive/ServletHttpHandlerAdapter.java
View File

@@ -34,6 +34,9 @@ import org.springframework.core.io.buffer.DefaultDataBufferFactory;
import org.springframework.util.Assert;
/**
* Adapt {@link HttpHandler} to an {@link HttpServlet} using Servlet Async
* support and Servlet 3.1 Non-blocking I/O.
*
* @author Arjen Poutsma
* @author Rossen Stoyanchev
* @since 5.0
@@ -54,6 +57,7 @@ public class ServletHttpHandlerAdapter extends HttpServlet {
private int bufferSize = DEFAULT_BUFFER_SIZE;
public void setHandler(HttpHandler handler) {
Assert.notNull(handler, "'handler' must not be null");
this.handler = handler;

1
spring-web/src/main/java/org/springframework/http/server/reactive/ServletServerHttpRequest.java
View File

@@ -43,6 +43,7 @@ import org.springframework.util.StringUtils;
/**
* Adapt {@link ServerHttpRequest} to the Servlet {@link HttpServletRequest}.
*
* @author Rossen Stoyanchev
* @since 5.0
*/

1
spring-web/src/main/java/org/springframework/http/server/reactive/ServletServerHttpResponse.java
View File

@@ -38,6 +38,7 @@ import org.springframework.util.Assert;
/**
* Adapt {@link ServerHttpResponse} to the Servlet {@link HttpServletResponse}.
*
* @author Rossen Stoyanchev
* @since 5.0
*/

7
spring-web/src/main/java/org/springframework/http/server/reactive/UndertowHttpHandlerAdapter.java
View File

@@ -26,6 +26,8 @@ import org.springframework.core.io.buffer.DataBufferFactory;
import org.springframework.util.Assert;
/**
* Adapt {@link HttpHandler} to the Undertow {@link io.undertow.server.HttpHandler}.
*
* @author Marek Hawrylczak
* @author Rossen Stoyanchev
* @author Arjen Poutsma
@@ -40,14 +42,15 @@ public class UndertowHttpHandlerAdapter implements io.undertow.server.HttpHandle
private final DataBufferFactory dataBufferFactory;
public UndertowHttpHandlerAdapter(HttpHandler delegate,
DataBufferFactory dataBufferFactory) {
public UndertowHttpHandlerAdapter(HttpHandler delegate, DataBufferFactory dataBufferFactory) {
Assert.notNull(delegate, "'delegate' is required");
Assert.notNull(dataBufferFactory, "'dataBufferFactory' must not be null");
this.delegate = delegate;
this.dataBufferFactory = dataBufferFactory;
}
@Override
public void handleRequest(HttpServerExchange exchange) throws Exception {

2
spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpRequest.java
View File

@@ -39,7 +39,7 @@ import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
/**
* Adapt {@link ServerHttpRequest} to the Underow {@link HttpServerExchange}.
* Adapt {@link ServerHttpRequest} to the Undertow {@link HttpServerExchange}.
*
* @author Marek Hawrylczak
* @author Rossen Stoyanchev

1
spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpResponse.java
View File

@@ -42,6 +42,7 @@ import org.springframework.util.Assert;
/**
* Adapt {@link ServerHttpResponse} to the Undertow {@link HttpServerExchange}.
*
* @author Marek Hawrylczak
* @author Rossen Stoyanchev
* @author Arjen Poutsma

9
spring-web/src/main/java/org/springframework/web/client/reactive/BodyExtractor.java
View File

@@ -22,11 +22,11 @@ import org.springframework.http.client.reactive.ClientHttpResponse;
import org.springframework.http.converter.reactive.HttpMessageConverter;
/**
* A {@code BodyExtractor} extracts the content of a raw {@link ClientHttpResponse},
* decoding the response body and using a target composition API.
* Contract to extract the content of a raw {@link ClientHttpResponse} decoding
* the response body and using a target composition API.
*
* <p>See static factory methods in {@link ResponseExtractors}
* and {@link org.springframework.web.client.reactive.support.RxJava1ResponseExtractors}.
* <p>See static factory methods in {@link ResponseExtractors} and
* {@link org.springframework.web.client.reactive.support.RxJava1ResponseExtractors}.
*
* @author Brian Clozel
* @since 5.0
@@ -40,4 +40,5 @@ public interface BodyExtractor<T> {
* @return the relevant content
*/
T extract(ClientHttpResponse clientResponse, List<HttpMessageConverter<?>> messageConverters);
}

14
spring-web/src/main/java/org/springframework/web/client/reactive/ClientWebRequest.java
View File

@@ -27,15 +27,18 @@ import org.springframework.http.HttpMethod;
import org.springframework.util.MultiValueMap;
/**
* Holds all the application information required to build an actual HTTP client request.
* <p>The request body is materialized by a {@code Publisher} of Objects and their type
* by a {@code ResolvableType} instance; it should be later converted to a
* {@code Publisher<DataBuffer>} to be written to the actual HTTP client request.
* Simple container for application-level information required to perform an
* HTTP client request.
*
* <p>The request body is provided through a {@code Publisher<Object>} where the
* type of each Object is indicated through a {@link ResolvableType} which
* subsequently is used to correctly serialize into the
* {@code Publisher<DataBuffer>} actually written to request body.
*
* @author Brian Clozel
* @since 5.0
*/
public class ClientWebRequest {
public class ClientWebRequest {
protected final HttpMethod httpMethod;
@@ -55,6 +58,7 @@ public class ClientWebRequest {
this.url = url;
}
public HttpMethod getMethod() {
return httpMethod;
}

2
spring-web/src/main/java/org/springframework/web/client/reactive/ClientWebRequestBuilder.java
View File

@@ -17,7 +17,7 @@
package org.springframework.web.client.reactive;
/**
* Build {@link ClientWebRequest}s
* Build {@link ClientWebRequest}s.
*
* @author Brian Clozel
* @since 5.0

4
spring-web/src/main/java/org/springframework/web/client/reactive/ClientWebRequestBuilders.java
View File

@@ -20,7 +20,8 @@ package org.springframework.web.client.reactive;
import org.springframework.http.HttpMethod;
/**
* Static factory methods for {@link DefaultClientWebRequestBuilder ClientWebRequestBuilders}
* Static factory methods for {@link DefaultClientWebRequestBuilder
* ClientWebRequestBuilders}.
*
* @author Brian Clozel
* @since 5.0
@@ -47,7 +48,6 @@ public abstract class ClientWebRequestBuilders {
return new DefaultClientWebRequestBuilder(HttpMethod.POST, urlTemplate, urlVariables);
}
/**
* Create a {@link DefaultClientWebRequestBuilder} for a PUT request.
*

11
spring-web/src/main/java/org/springframework/web/client/reactive/ClientWebRequestPostProcessor.java
View File

@@ -17,8 +17,9 @@
package org.springframework.web.client.reactive;
/**
* Allow post processing and/or wrapping the {@link ClientWebRequest} before
* it's sent to the origin server.
* Contract to post-process the {@link ClientWebRequest} after it is created
* an initialized in order to mofidy or even wrap it. This may be used for
* example to pre-package specific modifications to the request.
*
* @author Rob Winch
* @author Brian Clozel
@@ -28,10 +29,10 @@ package org.springframework.web.client.reactive;
public interface ClientWebRequestPostProcessor {
/**
* Implementations can modify and/or wrap the {@link ClientWebRequest} passed in
* and return it
*
* Implementations can modify and/or wrap the {@link ClientWebRequest}
* passed in and return it
* @param request the {@link ClientWebRequest} to be modified and/or wrapped.
*/
ClientWebRequest postProcess(ClientWebRequest request);
}

2
spring-web/src/main/java/org/springframework/web/client/reactive/DefaultClientWebRequestBuilder.java
View File

@@ -41,7 +41,7 @@ import org.springframework.web.util.UriTemplateHandler;
* Builds a {@link ClientHttpRequest} using a {@link Publisher}
* as request body.
*
* <p>See static factory methods in {@link ClientWebRequestBuilders}
* <p>See static factory methods in {@link ClientWebRequestBuilders}.
*
* @author Brian Clozel
* @since 5.0

9
spring-web/src/main/java/org/springframework/web/client/reactive/ResponseErrorHandler.java
View File

@@ -22,8 +22,8 @@ import org.springframework.http.client.reactive.ClientHttpResponse;
import org.springframework.http.converter.reactive.HttpMessageConverter;
/**
* Strategy interface used by the {@link WebClient} to handle
* errors in {@link ClientHttpResponse}s if needed.
* Strategy interface used by the {@link WebClient} to handle errors in
* {@link ClientHttpResponse}s if needed.
*
* @author Brian Clozel
* @see DefaultResponseErrorHandler
@@ -33,8 +33,9 @@ public interface ResponseErrorHandler {
/**
* Handle the error in the given response.
* Implementations will typically inspect the {@link ClientHttpResponse#getStatusCode() HttpStatus}
* of the response and throw {@link WebClientException}s in case of errors.
* Implementations will typically inspect the
* {@link ClientHttpResponse#getStatusCode() HttpStatus} of the response and
* throw {@link WebClientException}s in case of errors.
*/
void handleError(ClientHttpResponse response, List<HttpMessageConverter<?>> messageConverters);

18
spring-web/src/main/java/org/springframework/web/client/reactive/WebClient.java
View File

@@ -55,21 +55,23 @@ import reactor.core.publisher.Mono;
* <p>Here is a simple example of a GET request:
*
* <pre class="code">
* static imports: ClientWebRequestBuilder.*, ResponseExtractors.*
*
* // should be shared between HTTP calls
* WebClient client = new WebClient(new ReactorHttpClient());
*
* Mono&lt;String&gt; result = client
* .perform(ClientWebRequestBuilders.get("http://example.org/resource")
* .accept(MediaType.TEXT_PLAIN))
* .extract(ResponseExtractors.body(String.class));
* .perform(get("http://example.org/resource").accept(MediaType.TEXT_PLAIN))
* .extract(body(String.class));
* </pre>
*
* <p>This Web client relies on
* <p>This Web client relies on the following:
* <ul>
* <li>an {@link ClientHttpConnector} implementation that drives the underlying library (e.g. Reactor-Netty)</li>
* <li>a {@link ClientWebRequestBuilder} which creates a Web request with a builder API (see
* {@link ClientWebRequestBuilders})</li>
* <li>an {@link ResponseExtractor} which extracts the relevant part of the server
* <li>{@link ClientHttpConnector} implementation to drive the underlying
* library (e.g. Reactor-Netty)</li>
* <li>{@link ClientWebRequestBuilder} to create a Web request with a builder
* API (see {@link ClientWebRequestBuilders})</li>
* <li>{@link ResponseExtractor} to extract the relevant part of the server
* response with the composition API of choice (see {@link ResponseExtractors}</li>
* </ul>
*

23
spring-web/src/main/java/org/springframework/web/client/reactive/WebClientErrorException.java
View File

@@ -18,7 +18,6 @@ package org.springframework.web.client.reactive;
import java.util.List;
import org.springframework.http.HttpStatus;
import org.springframework.http.client.reactive.ClientHttpResponse;
import org.springframework.http.converter.reactive.HttpMessageConverter;
@@ -31,15 +30,21 @@ import org.springframework.http.converter.reactive.HttpMessageConverter;
@SuppressWarnings("serial")
public class WebClientErrorException extends WebClientResponseException {
/**
* Construct a new instance of {@code HttpClientErrorException} based on a {@link ClientHttpResponse}
* and {@link HttpMessageConverter}s to optionally help decoding the response body
* @param clientResponse the HTTP response
* @param messageConverters the message converters that may decode the HTTP response body
* Construct a new instance of {@code HttpClientErrorException} based on a
* {@link ClientHttpResponse} and {@link HttpMessageConverter}s to optionally
* help decoding the response body
*
* @param response the HTTP response
* @param converters the message converters that may decode the HTTP response body
*/
public WebClientErrorException(ClientHttpResponse clientResponse,
List<HttpMessageConverter<?>> messageConverters) {
super(clientResponse.getStatusCode().value() + " " + clientResponse.getStatusCode().getReasonPhrase(),
clientResponse, messageConverters);
public WebClientErrorException(ClientHttpResponse response, List<HttpMessageConverter<?>> converters) {
super(initMessage(response), response, converters);
}
private static String initMessage(ClientHttpResponse response) {
return response.getStatusCode().value() + " " + response.getStatusCode().getReasonPhrase();
}
}

4
spring-web/src/main/java/org/springframework/web/client/reactive/WebClientException.java
View File

@@ -19,8 +19,7 @@ package org.springframework.web.client.reactive;
import org.springframework.core.NestedRuntimeException;
/**
* Base class for exceptions thrown by {@link WebClient} whenever
* it encounters errors.
* Base class for exceptions thrown by {@link WebClient}.
*
* @author Brian Clozel
* @since 5.0
@@ -35,4 +34,5 @@ public class WebClientException extends NestedRuntimeException {
public WebClientException(String msg, Throwable cause) {
super(msg, cause);
}
}

5
spring-web/src/main/java/org/springframework/web/client/reactive/WebClientResponseException.java
View File

@@ -24,7 +24,8 @@ import org.springframework.http.client.reactive.ClientHttpResponse;
import org.springframework.http.converter.reactive.HttpMessageConverter;
/**
* Base class for exceptions associated with specific HTTP client response status codes.
* Base class for exceptions associated with specific HTTP client response
* status codes.
*
* @author Brian Clozel
* @since 5.0
@@ -36,6 +37,7 @@ public class WebClientResponseException extends WebClientException {
private final List<HttpMessageConverter<?>> messageConverters;
/**
* Construct a new instance of {@code WebClientResponseException} with the given response data
* @param message the given error message
@@ -49,6 +51,7 @@ public class WebClientResponseException extends WebClientException {
this.messageConverters = messageConverters;
}
/**
* Return the HTTP status
*/

1
spring-web/src/main/java/org/springframework/web/client/reactive/WebResponseActions.java
View File

@@ -47,4 +47,5 @@ public interface WebResponseActions {
* </pre>
*/
<T> T extract(ResponseExtractor<T> extractor);
}

19
spring-web/src/main/java/org/springframework/web/client/reactive/WebServerErrorException.java
View File

@@ -32,13 +32,18 @@ import org.springframework.http.converter.reactive.HttpMessageConverter;
public class WebServerErrorException extends WebClientResponseException {
/**
* Construct a new instance of {@code HttpServerErrorException} based on a {@link ClientHttpResponse}
* and {@link HttpMessageConverter}s to optionally help decoding the response body
* @param clientResponse the HTTP response
* @param messageConverters the message converters that may decode the HTTP response body
* Construct a new instance of {@code HttpServerErrorException} based on a
* {@link ClientHttpResponse} and {@link HttpMessageConverter}s to optionally
* help decoding the response body
* @param response the HTTP response
* @param converters the message converters that may decode the HTTP response body
*/
public WebServerErrorException(ClientHttpResponse clientResponse, List<HttpMessageConverter<?>> messageConverters) {
super(clientResponse.getStatusCode().value() + " " + clientResponse.getStatusCode().getReasonPhrase(),
clientResponse, messageConverters);
public WebServerErrorException(ClientHttpResponse response, List<HttpMessageConverter<?>> converters) {
super(initMessage(response), response, converters);
}
private static String initMessage(ClientHttpResponse response) {
return response.getStatusCode().value() + " " + response.getStatusCode().getReasonPhrase();
}
}

2
spring-web/src/main/java/org/springframework/web/server/session/DefaultWebSession.java
View File

@@ -30,6 +30,8 @@ import reactor.core.publisher.Mono;
import org.springframework.util.Assert;
/**
* Default implementation of {@link org.springframework.web.server.WebSession}.
*
* @author Rossen Stoyanchev
* @since 5.0
*/