org.zalando.riptide.Http Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of riptide-core Show documentation

Client side response routing

There is a newer version: 4.0.0

package org.zalando.riptide;

import org.apiguardian.api.API;
import org.springframework.http.client.AsyncClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.client.RestTemplate;

import javax.annotation.Nullable;
import java.net.URI;
import java.util.concurrent.Executor;
import java.util.function.Supplier;

import static org.apiguardian.api.API.Status.STABLE;

/**
 * Central class for actual asynchronous HTTP-based communication. Http is loosely modeled after the HTTP protocol,
 * i.e. you start with a method and by a URL and optionally followed query parameters, headers and a body:
 *
 * {@code http.get("/users")
 *     .queryParam("active", "true")
 *     .accept(APPLICATION_JSON)
 *     .dispatch(..)}
 *
 * @see RestTemplate
 */
@API(status = STABLE)
public interface Http extends URIStage {

    static ExecutorStage builder() {
        return new DefaultHttpBuilder();
    }

    interface ExecutorStage {
        RequestFactoryStage executor(Executor executor);
        ConfigurationStage asyncRequestFactory(AsyncClientHttpRequestFactory asyncRequestFactory);
    }

    interface RequestFactoryStage {
        ConfigurationStage requestFactory(ClientHttpRequestFactory requestFactory);
    }

    interface ConfigurationStage extends FinalStage {
        ConfigurationStage defaultConverters();
        ConfigurationStage converters(Iterable> converters);
        ConfigurationStage converter(HttpMessageConverter converter);
        ConfigurationStage baseUrl(@Nullable String baseUrl);
        ConfigurationStage baseUrl(@Nullable URI baseUrl);
        ConfigurationStage baseUrl(Supplier baseUrlProvider);
        ConfigurationStage urlResolution(@Nullable UrlResolution resolution);
        ConfigurationStage defaultPlugins();
        ConfigurationStage plugins(Iterable plugins);
        ConfigurationStage plugin(Plugin plugin);
    }

    interface FinalStage {
        Http build();
    }

}