io.vrap.rmf.base.client

Class ApiMethod<T extends ApiMethod<T,TResult>,TResult>

java.lang.Object

io.vrap.rmf.base.client.ApiMethod<T,TResult>

All Implemented Interfaces:

ClientRequestCommand<TResult>, RequestCommand<TResult>

Direct Known Subclasses:

BodyApiMethod

public abstract class ApiMethod<T extends ApiMethod<T,TResult>,TResult>
extends Object
implements RequestCommand<TResult>, ClientRequestCommand<TResult>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiMethod.ParamEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
ApiMethod(ApiHttpClient apiHttpClient)
ApiMethod(ApiHttpClient apiHttpClient, ApiHttpHeaders headers, List<ApiMethod.ParamEntry<String,String>> queryParams)
ApiMethod(ApiMethod<T,TResult> apiMethod)

Method Summary

Modifier and Type	Method and Description
T	addHeader(String key, String value) adds an additional header with the specified value
<V> T	addQueryParam(String key, V value) add an additional query parameter
T	addQueryParams(List<ApiMethod.ParamEntry<String,String>> queryParams) add the query parameters
T	contentType(String contentType) set specific content type
ApiHttpRequest	createHttpRequest()
abstract boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<TResult>>	execute()
abstract CompletableFuture<ApiHttpResponse<TResult>>	execute(ApiHttpClient client)
<TReturn> CompletableFuture<ApiHttpResponse<TReturn>>	execute(ApiHttpClient client, Class<TReturn> returnType)
<TReturn> CompletableFuture<ApiHttpResponse<TReturn>>	execute(ApiHttpClient client, JavaType returnJavaType)
<TReturn> CompletableFuture<ApiHttpResponse<TReturn>>	execute(ApiHttpClient client, com.fasterxml.jackson.core.type.TypeReference<TReturn> returnTypeReference)
<TReturn> CompletableFuture<ApiHttpResponse<TReturn>>	execute(Class<TReturn> returnType)
<TReturn> CompletableFuture<ApiHttpResponse<TReturn>>	execute(JavaType returnJavaType)
<TReturn> CompletableFuture<ApiHttpResponse<TReturn>>	execute(com.fasterxml.jackson.core.type.TypeReference<TReturn> returnTypeReference)
ApiHttpResponse<TResult>	executeBlocking()
ApiHttpResponse<TResult>	executeBlocking(ApiHttpClient client)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(ApiHttpClient client, Class<TReturn> clazz)
abstract ApiHttpResponse<TResult>	executeBlocking(ApiHttpClient client, Duration timeout)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(ApiHttpClient client, Duration timeout, Class<TReturn> clazz)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(ApiHttpClient client, Duration timeout, JavaType javaType)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(ApiHttpClient client, Duration timeout, com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(ApiHttpClient client, JavaType javaType)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(ApiHttpClient client, com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(Class<TReturn> clazz)
ApiHttpResponse<TResult>	executeBlocking(Duration timeout)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(Duration timeout, Class<TReturn> clazz)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(Duration timeout, JavaType javaType)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(Duration timeout, com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(JavaType javaType)
<TReturn> ApiHttpResponse<TReturn>	executeBlocking(com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)
String	getFirstQueryParam(String key)
ApiHttpHeaders	getHeaders()
List<String>	getQueryParam(String key)
List<ApiMethod.ParamEntry<String,String>>	getQueryParams()
String	getQueryParamUriString()
List<String>	getQueryParamUriStrings()
abstract int	hashCode()
int	reflectionHashCode()
CompletableFuture<ApiHttpResponse<byte[]>>	send()
ApiHttpResponse<byte[]>	sendBlocking()
ApiHttpResponse<byte[]>	sendBlocking(Duration timeout)
String	toString()
<U> T	with(BiFunction<T,U,T> op, U arg) allows to provide a function to modify the ApiMethod itself
T	with(Function<T,T> op) allows to provide a function to modify the ApiMethod itself
T	withHeader(String key, String value) set the header with the specified value
T	withHeaders(ApiHttpHeaders headers) set the headers
T	withHttpRequest(Function<ApiHttpRequest,ApiHttpRequest> op) allows to modify the HTTP request before it will be executed
T	withoutHeader(String key) removes the specified header
T	withoutQueryParam(String key) removes the specified query parameter
<V> T	withQueryParam(String key, V value) set the query parameter with the specified value
T	withQueryParams(List<ApiMethod.ParamEntry<String,String>> queryParams) set the query parameters

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiMethod

public ApiMethod(ApiHttpClient apiHttpClient)

ApiMethod

public ApiMethod(ApiHttpClient apiHttpClient,
                 ApiHttpHeaders headers,
                 List<ApiMethod.ParamEntry<String,String>> queryParams)

ApiMethod

public ApiMethod(ApiMethod<T,TResult> apiMethod)

Method Detail

addHeader

public T addHeader(String key,
                   String value)

adds an additional header with the specified value

Parameters:

key - header name

value - header value

Returns:

T

withoutHeader

public T withoutHeader(String key)

removes the specified header

Parameters:

key - header name

Returns:

T

withHeader

public T withHeader(String key,
                    String value)

set the header with the specified value

Parameters:

key - header name

value - header value

Returns:

T

withHeaders

public T withHeaders(ApiHttpHeaders headers)

set the headers

Parameters:

headers -

Returns:

contentType

public T contentType(String contentType)

set specific content type

Parameters:

contentType -

Returns:

getHeaders

public ApiHttpHeaders getHeaders()

addQueryParam

public <V> T addQueryParam(String key,
                           V value)

add an additional query parameter

Type Parameters:

V - value type

Parameters:

key - query parameter name

value - query parameter value

Returns:

T

withQueryParam

public <V> T withQueryParam(String key,
                            V value)

set the query parameter with the specified value

Type Parameters:

V - value type

Parameters:

key - query parameter name

value - query parameter value

Returns:

T

withoutQueryParam

public T withoutQueryParam(String key)

removes the specified query parameter

Parameters:

key - query parameter name

Returns:

T

withQueryParams

public T withQueryParams(List<ApiMethod.ParamEntry<String,String>> queryParams)

set the query parameters

Parameters:

queryParams - list of query parameters

Returns:

T

addQueryParams

public T addQueryParams(List<ApiMethod.ParamEntry<String,String>> queryParams)

add the query parameters

Parameters:

queryParams - list of query parameters

Returns:

T

getQueryParams

public List<ApiMethod.ParamEntry<String,String>> getQueryParams()

getQueryParam

public List<String> getQueryParam(String key)

getQueryParamUriStrings

public List<String> getQueryParamUriStrings()

getQueryParamUriString

public String getQueryParamUriString()

getFirstQueryParam

@Nullable
public String getFirstQueryParam(String key)

createHttpRequest

public ApiHttpRequest createHttpRequest()

execute

public CompletableFuture<ApiHttpResponse<TResult>> execute()

Specified by:

execute in interface RequestCommand<TResult>

execute

public abstract CompletableFuture<ApiHttpResponse<TResult>> execute(ApiHttpClient client)

Specified by:

execute in interface ClientRequestCommand<TResult>

withHttpRequest

public T withHttpRequest(Function<ApiHttpRequest,ApiHttpRequest> op)

allows to modify the HTTP request before it will be executed

Parameters:

op - decorator function

Returns:

the method itself

with

public T with(Function<T,T> op)

allows to provide a function to modify the ApiMethod itself

Parameters:

op - decorator function

Returns:

the method itself

with

public <U> T with(BiFunction<T,U,T> op,
                  U arg)

allows to provide a function to modify the ApiMethod itself

Type Parameters:

U - the method type itself

Parameters:

op - decorator function

arg - decorator function argument

Returns:

the method itself

execute

public <TReturn> CompletableFuture<ApiHttpResponse<TReturn>> execute(Class<TReturn> returnType)

execute

public <TReturn> CompletableFuture<ApiHttpResponse<TReturn>> execute(ApiHttpClient client,
                                                                     Class<TReturn> returnType)

execute

public <TReturn> CompletableFuture<ApiHttpResponse<TReturn>> execute(com.fasterxml.jackson.core.type.TypeReference<TReturn> returnTypeReference)

execute

public <TReturn> CompletableFuture<ApiHttpResponse<TReturn>> execute(ApiHttpClient client,
                                                                     com.fasterxml.jackson.core.type.TypeReference<TReturn> returnTypeReference)

execute

public <TReturn> CompletableFuture<ApiHttpResponse<TReturn>> execute(JavaType returnJavaType)

execute

public <TReturn> CompletableFuture<ApiHttpResponse<TReturn>> execute(ApiHttpClient client,
                                                                     JavaType returnJavaType)

executeBlocking

public ApiHttpResponse<TResult> executeBlocking()

Specified by:

executeBlocking in interface RequestCommand<TResult>

executeBlocking

public ApiHttpResponse<TResult> executeBlocking(ApiHttpClient client)

Specified by:

executeBlocking in interface ClientRequestCommand<TResult>

executeBlocking

public ApiHttpResponse<TResult> executeBlocking(Duration timeout)

Specified by:

executeBlocking in interface RequestCommand<TResult>

executeBlocking

public abstract ApiHttpResponse<TResult> executeBlocking(ApiHttpClient client,
                                                         Duration timeout)

Specified by:

executeBlocking in interface ClientRequestCommand<TResult>

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(Class<TReturn> clazz)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(ApiHttpClient client,
                                                          Class<TReturn> clazz)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(Duration timeout,
                                                          Class<TReturn> clazz)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(ApiHttpClient client,
                                                          Duration timeout,
                                                          Class<TReturn> clazz)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(ApiHttpClient client,
                                                          com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(Duration timeout,
                                                          com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(ApiHttpClient client,
                                                          Duration timeout,
                                                          com.fasterxml.jackson.core.type.TypeReference<TReturn> typeReference)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(JavaType javaType)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(ApiHttpClient client,
                                                          JavaType javaType)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(Duration timeout,
                                                          JavaType javaType)

executeBlocking

public <TReturn> ApiHttpResponse<TReturn> executeBlocking(ApiHttpClient client,
                                                          Duration timeout,
                                                          JavaType javaType)

send

public CompletableFuture<ApiHttpResponse<byte[]>> send()

sendBlocking

public ApiHttpResponse<byte[]> sendBlocking()

sendBlocking

public ApiHttpResponse<byte[]> sendBlocking(Duration timeout)

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()