/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.http.client.reactive;
import java.net.URI;
import java.util.function.Function;
import reactor.core.publisher.Mono;
import org.springframework.http.HttpMethod;
Abstraction over HTTP clients driving the underlying HTTP client to connect to the origin server and provide all necessary infrastructure to send a ClientHttpRequest
and receive a ClientHttpResponse
. Author: Brian Clozel Since: 5.0
/**
* 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
*/
public interface ClientHttpConnector {
Connect to the origin server using the given HttpMethod
and URI
and apply the given requestCallback
when the HTTP request of the underlying API can be initialized and written to. Params: - method – the HTTP request method
- uri – the HTTP request URI
- requestCallback – a function that prepares and writes to the request, returning a publisher that signals when it's done writing. Implementations can return a
Mono<Void>
by calling ReactiveHttpOutputMessage.writeWith
or ReactiveHttpOutputMessage.setComplete
.
Returns: publisher for the ClientHttpResponse
/**
* Connect to the origin server using the given {@code HttpMethod} and
* {@code URI} and apply the given {@code requestCallback} when the HTTP
* request of the underlying API can be initialized and written to.
* @param method the HTTP request method
* @param uri the HTTP request URI
* @param requestCallback a function that prepares and writes to the request,
* returning a publisher that signals when it's done writing.
* Implementations can return a {@code Mono<Void>} by calling
* {@link ClientHttpRequest#writeWith} or {@link ClientHttpRequest#setComplete}.
* @return publisher for the {@link ClientHttpResponse}
*/
Mono<ClientHttpResponse> connect(HttpMethod method, URI uri,
Function<? super ClientHttpRequest, Mono<Void>> requestCallback);
}