Package dev.mayuna.simpleapi

Interface ApiRequest<T>

Type Parameters:

T - The type of the response.

public interface ApiRequest<T>

Represents an API request. Can send API requests.

Method Summary

Modifier and Type	Method	Description
default void	applyHeadersToHttpRequestBuilder(HttpRequest.Builder httpRequestBuilder, RequestHeader[] requestHeaders)	Applies the RequestHeaders to the given HttpRequest.Builder.
static <T> ApiRequestBuilder<T>	builder(WrappedApi wrappedApi, Class<T> responseClass)	Creates a new ApiRequestBuilder for the given WrappedApi and Class.
default HttpClient	createHttpClientInstance()	Creates a new HttpClient instance.
default HttpRequest.Builder	createHttpRequestBuilderInstance()	Creates a new HttpRequest.Builder instance.
default T	createInstanceOfResponseClass()	Creates a new instance of the response class.
default HttpResponse.BodyHandler<?>	getBodyHandler()	Gets the HttpResponse.BodyHandler of this ApiRequest.
default HttpRequest.BodyPublisher	getBodyPublisher()	Gets the HttpRequest.BodyPublisher of this ApiRequest.
default String	getComputedEndpoint()	Gets the computed endpoint of this ApiRequest.
@NotNull String	getEndpoint()	Gets the endpoint of this ApiRequest.
default @Nullable PathParameter[]	getPathParameters()	Gets the PathParameters of this ApiRequest.
default @Nullable RequestHeader[]	getRequestHeaders()	Gets the RequestHeaders of this ApiRequest.
@NotNull RequestMethod	getRequestMethod()	Gets the RequestMethod of this ApiRequest.
default @Nullable RequestQuery[]	getRequestQueries()	Gets the RequestQuerys of this ApiRequest.
@NotNull Class<T>	getResponseClass()	Gets the Class of the response.
@Nullable String	getUrl()	Gets the URL of this ApiRequest.
@NotNull WrappedApi	getWrappedApi()	Gets the WrappedApi of this ApiRequest.
default T	handleResponse(HttpResponse<?> httpResponse)	Handles the given HttpResponse.
default T	send()	Sends the request synchronously.
default CompletableFuture<T>	sendAsync()	Sends the request asynchronously using WrappedApi.runAsync(Runnable).

Method Details

builder

static <T> ApiRequestBuilder<T> builder(WrappedApi wrappedApi,
 Class<T> responseClass)

Creates a new ApiRequestBuilder for the given WrappedApi and Class.

Type Parameters:

T - The type of the response.

Parameters:

wrappedApi - The WrappedApi to use.

responseClass - The Class of the response.

Returns:

The created ApiRequestBuilder.

getWrappedApi

@NotNull
@NotNull WrappedApi getWrappedApi()

Gets the WrappedApi of this ApiRequest.

Returns:

The WrappedApi of this ApiRequest.

getResponseClass

@NotNull
@NotNull Class<T> getResponseClass()

Gets the Class of the response.

Returns:

The Class of the response.

getUrl

@Nullable
@Nullable String getUrl()

Gets the URL of this ApiRequest.

Returns:

The URL of this ApiRequest. If null, the default URL of the WrappedApi will be used.

getEndpoint

@NotNull
@NotNull String getEndpoint()

Gets the endpoint of this ApiRequest.

Returns:

The endpoint of this ApiRequest.

getRequestMethod

@NotNull
@NotNull RequestMethod getRequestMethod()

Gets the RequestMethod of this ApiRequest.

Returns:

The RequestMethod of this ApiRequest.

getPathParameters

@Nullable
default @Nullable PathParameter[] getPathParameters()

Gets the PathParameters of this ApiRequest.

Returns:

The PathParameters of this ApiRequest.

getRequestQueries

@Nullable
default @Nullable RequestQuery[] getRequestQueries()

Gets the RequestQuerys of this ApiRequest.

Returns:

The RequestQuerys of this ApiRequest.

getRequestHeaders

@Nullable
default @Nullable RequestHeader[] getRequestHeaders()

Gets the RequestHeaders of this ApiRequest.

Returns:

The RequestHeaders of this ApiRequest.

getBodyPublisher

@NonNull
default HttpRequest.BodyPublisher getBodyPublisher()

Gets the HttpRequest.BodyPublisher of this ApiRequest.

Returns:

The HttpRequest.BodyPublisher of this ApiRequest.

getBodyHandler

@NotNull
default HttpResponse.BodyHandler<?> getBodyHandler()

Gets the HttpResponse.BodyHandler of this ApiRequest.

Returns:

The HttpResponse.BodyHandler of this ApiRequest.

getComputedEndpoint

default String getComputedEndpoint()

Gets the computed endpoint of this ApiRequest.

Returns:

The computed endpoint of this ApiRequest with all PathParameters replaces and RequestQuerys added.

applyHeadersToHttpRequestBuilder

default void applyHeadersToHttpRequestBuilder(HttpRequest.Builder httpRequestBuilder,
 RequestHeader[] requestHeaders)

Applies the RequestHeaders to the given HttpRequest.Builder.

Parameters:

httpRequestBuilder - The HttpRequest.Builder to apply the RequestHeaders to.

requestHeaders - The RequestHeaders to apply.

createHttpClientInstance

default HttpClient createHttpClientInstance()

Creates a new HttpClient instance.

Returns:

The created HttpClient instance.

createHttpRequestBuilderInstance

default HttpRequest.Builder createHttpRequestBuilderInstance()

Creates a new HttpRequest.Builder instance.

Returns:

The created HttpRequest.Builder instance.

createInstanceOfResponseClass

default T createInstanceOfResponseClass()
                                 throws NoSuchMethodException,
InvocationTargetException,
InstantiationException,
IllegalAccessException

Creates a new instance of the response class.

Returns:

The created instance of the response class.

Throws:

NoSuchMethodException - Is thrown if the response class does not have a default constructor.

InvocationTargetException - Is thrown if the constructor of the response class throws an exception.

InstantiationException - Is thrown if the response class is abstract or interface.

IllegalAccessException - Is thrown if the constructor of the response class is not accessible.

handleResponse

default T handleResponse(HttpResponse<?> httpResponse)
                  throws InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

Handles the given HttpResponse.

Parameters:

httpResponse - The HttpResponse to handle.

Returns:

The instance of the response class.

Throws:

NoSuchMethodException - Is thrown if the response class does not have a default constructor.

InvocationTargetException - Is thrown if the constructor of the response class throws an exception.

InstantiationException - Is thrown if the response class is abstract or interface.

IllegalAccessException - Is thrown if the constructor of the response class is not accessible.

sendAsync

default CompletableFuture<T> sendAsync()

Sends the request asynchronously using WrappedApi.runAsync(Runnable).

Returns:

A CompletableFuture that will be completed with the instance of response class.

send

default T send()
        throws IOException,
InterruptedException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

Sends the request synchronously.

Returns:

The instance of the response class.

Throws:

IOException - If an I/O error occurs.

InterruptedException - If the operation is interrupted.

NoSuchMethodException - Is thrown if the response class does not have a default constructor.

InvocationTargetException - Is thrown if the constructor of the response class throws an exception.

InstantiationException - Is thrown if the response class is abstract or interface.

IllegalAccessException - Is thrown if the constructor of the response class is not accessible.