Package io.vrap.rmf.base.client

Interface ApiHttpClient

All Superinterfaces:

AsyncApiClient<CompletableFuture<?>>, AutoCloseable, CompletableFutureApiClient, VrapHttpClient

All Known Subinterfaces:

ContextApiHttpClient

All Known Implementing Classes:

ApiHttpClientImpl, ContextApiHttpClientImpl, SerializerOnlyApiHttpClient

public interface ApiHttpClient
extends AutoCloseable, VrapHttpClient, CompletableFutureApiClient

Interface for an HTTP client accessing the API and mapping to a known output type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSED_MESSAGE
static final Duration	DEFAULT_TIMEOUT

Method Summary

Modifier and Type	Method	Description
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(ApiHttpRequest request, Class<O> outputType)
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(ApiHttpRequest request, Function<ApiHttpResponse<byte[]>,ApiHttpResponse<O>> mapper)
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(ApiHttpRequest request, tools.jackson.core.type.TypeReference<O> outputType)
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(ApiHttpRequest request, JavaType outputType)
default <T, O> CompletableFuture<ApiHttpResponse<O>>	execute(CreateHttpRequestCommand method, Class<O> outputType)
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(CreateHttpRequestCommand method, Function<ApiHttpResponse<byte[]>,ApiHttpResponse<O>> mapper)
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(CreateHttpRequestCommand method, tools.jackson.core.type.TypeReference<O> outputType)
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(CreateHttpRequestCommand method, JavaType outputType)
default <O> CompletableFuture<ApiHttpResponse<O>>	execute(HttpRequestCommand<O> method)
default <O> ApiHttpResponse<O>	executeBlocking(CreateHttpRequestCommand method, Class<O> outputType, Duration timeout)
default <O> ApiHttpResponse<O>	executeBlocking(CreateHttpRequestCommand method, Function<ApiHttpResponse<byte[]>,ApiHttpResponse<O>> mapper, Duration timeout)
default <O> ApiHttpResponse<O>	executeBlocking(CreateHttpRequestCommand method, tools.jackson.core.type.TypeReference<O> outputType, Duration timeout)
default <O> ApiHttpResponse<O>	executeBlocking(CreateHttpRequestCommand method, JavaType outputType, Duration timeout)
URI	getBaseUri()
ResponseSerializer	getSerializerService()
static ApiHttpClient	of(String baseUri, HandlerStack stack)
static ApiHttpClient	of(String baseUri, HandlerStack stack, ResponseSerializer serializer)
static ApiHttpClient	of(URI baseUri, HandlerStack stack)
static ApiHttpClient	of(URI baseUri, HandlerStack stack, ResponseSerializer serializer)
default CompletableFuture<ApiHttpResponse<byte[]>>	send(CreateHttpRequestCommand method)
default <T> ApiHttpResponse<byte[]>	sendBlocking(CreateHttpRequestCommand method, Duration timeout)

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface io.vrap.rmf.base.client.VrapHttpClient

execute

Field Details

CLOSED_MESSAGE

static final String CLOSED_MESSAGE

See Also:

• Constant Field Values

DEFAULT_TIMEOUT

static final Duration DEFAULT_TIMEOUT

Method Details

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(ApiHttpRequest request,
 Class<O> outputType)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(ApiHttpRequest request,
 tools.jackson.core.type.TypeReference<O> outputType)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(ApiHttpRequest request,
 JavaType outputType)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(ApiHttpRequest request,
 Function<ApiHttpResponse<byte[]>,ApiHttpResponse<O>> mapper)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(HttpRequestCommand<O> method)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <T,
O> CompletableFuture<ApiHttpResponse<O>> execute(CreateHttpRequestCommand method,
 Class<O> outputType)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(CreateHttpRequestCommand method,
 JavaType outputType)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(CreateHttpRequestCommand method,
 tools.jackson.core.type.TypeReference<O> outputType)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

execute

default <O> CompletableFuture<ApiHttpResponse<O>> execute(CreateHttpRequestCommand method,
 Function<ApiHttpResponse<byte[]>,ApiHttpResponse<O>> mapper)

Specified by:

execute in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

execute in interface CompletableFutureApiClient

executeBlocking

default <O> ApiHttpResponse<O> executeBlocking(CreateHttpRequestCommand method,
 Function<ApiHttpResponse<byte[]>,ApiHttpResponse<O>> mapper,
 Duration timeout)

Specified by:

executeBlocking in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

executeBlocking in interface CompletableFutureApiClient

executeBlocking

default <O> ApiHttpResponse<O> executeBlocking(CreateHttpRequestCommand method,
 Class<O> outputType,
 Duration timeout)

Specified by:

executeBlocking in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

executeBlocking in interface CompletableFutureApiClient

executeBlocking

default <O> ApiHttpResponse<O> executeBlocking(CreateHttpRequestCommand method,
 JavaType outputType,
 Duration timeout)

Specified by:

executeBlocking in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

executeBlocking in interface CompletableFutureApiClient

executeBlocking

default <O> ApiHttpResponse<O> executeBlocking(CreateHttpRequestCommand method,
 tools.jackson.core.type.TypeReference<O> outputType,
 Duration timeout)

Specified by:

executeBlocking in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

executeBlocking in interface CompletableFutureApiClient

send

default CompletableFuture<ApiHttpResponse<byte[]>> send(CreateHttpRequestCommand method)

Specified by:

send in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

send in interface CompletableFutureApiClient

sendBlocking

default <T> ApiHttpResponse<byte[]> sendBlocking(CreateHttpRequestCommand method,
 Duration timeout)

Specified by:

sendBlocking in interface AsyncApiClient<CompletableFuture<?>>

Specified by:

sendBlocking in interface CompletableFutureApiClient

getSerializerService

ResponseSerializer getSerializerService()

getBaseUri

URI getBaseUri()

of

static ApiHttpClient of(String baseUri,
 HandlerStack stack)

of

static ApiHttpClient of(URI baseUri,
 HandlerStack stack)

of

static ApiHttpClient of(String baseUri,
 HandlerStack stack,
 ResponseSerializer serializer)

of

static ApiHttpClient of(URI baseUri,
 HandlerStack stack,
 ResponseSerializer serializer)