org.springframework.web.reactive.function.client.ExchangeFunction.java Source code

Introduction

Here is the source code for org.springframework.web.reactive.function.client.ExchangeFunction.java

Source

/*
 * 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
 *
 *      https://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.web.reactive.function.client;

import reactor.core.publisher.Mono;

/**
 * Represents a function that exchanges a {@linkplain ClientRequest request} for a (delayed)
 * {@linkplain ClientResponse}. Can be used as an alternative to {@link WebClient}.
 *
 * <p>For example:
 * <pre class="code">
 * ExchangeFunction exchangeFunction = ExchangeFunctions.create(new ReactorClientHttpConnector());
 * ClientRequest&lt;Void&gt; request = ClientRequest.method(HttpMethod.GET, "https://example.com/resource").build();
 *
 * Mono&lt;String&gt; result = exchangeFunction
 *     .exchange(request)
 *     .then(response -> response.bodyToMono(String.class));
 * </pre>
 *
 * @author Arjen Poutsma
 * @since 5.0
 */
@FunctionalInterface
public interface ExchangeFunction {

    /**
     * Exchange the given request for a response mono.
     * @param request the request to exchange
     * @return the delayed response
     */
    Mono<ClientResponse> exchange(ClientRequest request);

    /**
     * Filters this exchange function with the given {@code ExchangeFilterFunction}, resulting in a
     * filtered {@code ExchangeFunction}.
     * @param filter the filter to apply to this exchange
     * @return the filtered exchange
     * @see ExchangeFilterFunction#apply(ExchangeFunction)
     */
    default ExchangeFunction filter(ExchangeFilterFunction filter) {
        return filter.apply(this);
    }

}