Package dev.mayuna.simpleapi

Interface WrappedApi

public interface WrappedApi

Method Summary

Modifier and Type	Method	Description
default <T> void	applyHeadersToHttpRequestBuilder(ApiRequest<T> apiRequest, HttpRequest.Builder httpRequestBuilder, RequestHeader[] requestHeaders)	Applies the RequestHeaders to the given HttpRequest.Builder. If the ApiRequest.applyHeadersToHttpRequestBuilder(HttpRequest.Builder, RequestHeader[]) is overridden, this method may not be called, depending on the implementation.
default <T> String	computeEndpoint(ApiRequest<T> apiRequest)	Computers the endpoint of this ApiRequest. If the ApiRequest.getComputedEndpoint() is overridden, this method may not be called, depending on the implementation.
default HttpClient	createHttpClientInstance()	Creates a new HttpClient instance that will be used for sending requests. If the ApiRequest.createHttpClientInstance() is overridden, this method may not be called, depending on the implementation.
default HttpRequest.Builder	createHttpRequestBuilderInstance()	Creates a new HttpRequest.Builder instance that will be used for building requests. If the ApiRequest.createHttpRequestBuilderInstance() is overridden, this method may not be called, depending on the implementation.
default <T> T	createInstanceOfResponseClass(Class<T> responseClass)	Creates a new instance of the response class. If the ApiRequest.createInstanceOfResponseClass() is overridden, this method may not be called, depending on the implementation.
default RequestHeader[]	getDefaultRequestHeaders()	Gets the default RequestHeaders for this API. Useful if you want to set some headers for all requests.
String	getDefaultUrl()	Gets the default URL for this API.
default Duration	getTimeoutDuration()	Gets the default timeout duration for the API requests.
default <T> T	handleResponse(ApiRequest<T> apiRequest, HttpResponse<?> httpResponse)	Handles the given HttpResponse. If the ApiRequest.handleResponse(HttpResponse) is overridden, this method may not be called, depending on the implementation.
default <T> void	onAfterApiRequest(ApiRequest<T> request)	It is called after the request is sent but before the response is handled. If the request send fails with exception, this method is not called.
default <T> void	onAfterHandledApiRequest(ApiRequest<T> request, T response)	It is called after the request's response is handled. If the request send and/or request's response handler fails with exception, this method is not called.
default <T> void	onApiRequest(ApiRequest<T> request)	Is called before the request is sent.
default <T> void	onException(ApiRequest<T> request, Throwable throwable)	It is called when any exception occurs when sending the request or handling the response. Note: This method does not catch any exceptions. All exceptions are re-thrown after this method is called, if the rethrowExceptions() returns true.
default boolean	rethrowExceptions()	Determines if exceptions should be re-thrown after onException(ApiRequest, Throwable) is called. Also, if this method returns false, all responses that failed to be sent or handled will be null.
default void	runAsync(Runnable runnable)	This method is used for async requests.
default <T> T	send(ApiRequest<T> apiRequest)	Sends the request synchronously. If the ApiRequest.send() is overridden, this method may not be called, depending on the implementation.

Method Details

getDefaultUrl

String getDefaultUrl()

Gets the default URL for this API.

Returns:

The default URL for this API.

getDefaultRequestHeaders

default RequestHeader[] getDefaultRequestHeaders()

Gets the default RequestHeaders for this API.
Useful if you want to set some headers for all requests.

Returns:

Nullable array of RequestHeaders.

computeEndpoint

default <T> String computeEndpoint(ApiRequest<T> apiRequest)

Computers the endpoint of this ApiRequest.
If the ApiRequest.getComputedEndpoint() is overridden, this method may not be called, depending on the implementation.

Type Parameters:

T - The type of the response.

Parameters:

apiRequest - The ApiRequest to compute the endpoint of.

Returns:

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

applyHeadersToHttpRequestBuilder

default <T> void applyHeadersToHttpRequestBuilder(ApiRequest<T> apiRequest,
 HttpRequest.Builder httpRequestBuilder,
 RequestHeader[] requestHeaders)

Applies the RequestHeaders to the given HttpRequest.Builder.
If the ApiRequest.applyHeadersToHttpRequestBuilder(HttpRequest.Builder, RequestHeader[]) is overridden, this method may not be called, depending on the implementation.

Type Parameters:

T - The type of the response.

Parameters:

apiRequest - The ApiRequest to apply the RequestHeaders to.

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

requestHeaders - The RequestHeaders to apply.

createHttpClientInstance

default HttpClient createHttpClientInstance()

Creates a new HttpClient instance that will be used for sending requests.
If the ApiRequest.createHttpClientInstance() is overridden, this method may not be called, depending on the implementation.

Returns:

The created HttpClient instance.

createHttpRequestBuilderInstance

default HttpRequest.Builder createHttpRequestBuilderInstance()

Creates a new HttpRequest.Builder instance that will be used for building requests.
If the ApiRequest.createHttpRequestBuilderInstance() is overridden, this method may not be called, depending on the implementation.

Returns:

The created HttpRequest.Builder instance.

getTimeoutDuration

default Duration getTimeoutDuration()

Gets the default timeout duration for the API requests.

Returns:

The default timeout duration for the API requests.

runAsync

default void runAsync(Runnable runnable)

This method is used for async requests. You may override this method to change the way async requests are sent, for example, using a thread pool, etc.

Parameters:

runnable - The runnable to run.

createInstanceOfResponseClass

default <T> T createInstanceOfResponseClass(Class<T> responseClass)
                                     throws NoSuchMethodException,
InvocationTargetException,
InstantiationException,
IllegalAccessException

Creates a new instance of the response class.
If the ApiRequest.createInstanceOfResponseClass() is overridden, this method may not be called, depending on the implementation.

Type Parameters:

T - The type of the response.

Parameters:

responseClass - The response class to create an instance of.

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> T handleResponse(ApiRequest<T> apiRequest,
 HttpResponse<?> httpResponse)
                      throws InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

Handles the given HttpResponse.
If the ApiRequest.handleResponse(HttpResponse) is overridden, this method may not be called, depending on the implementation.

Type Parameters:

T - The type of the response.

Parameters:

apiRequest - The ApiRequest to handle the response for.

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.

send

default <T> T send(ApiRequest<T> apiRequest)
            throws IOException,
InterruptedException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

Sends the request synchronously.
If the ApiRequest.send() is overridden, this method may not be called, depending on the implementation.

Type Parameters:

T - The type of the response.

Parameters:

apiRequest - The request to send.

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.

onApiRequest

default <T> void onApiRequest(ApiRequest<T> request)

Is called before the request is sent.

Type Parameters:

T - The type of the response.

Parameters:

request - The request.

onAfterApiRequest

default <T> void onAfterApiRequest(ApiRequest<T> request)

It is called after the request is sent but before the response is handled.
If the request send fails with exception, this method is not called.

Type Parameters:

T - The type of the response.

Parameters:

request - The request.

onAfterHandledApiRequest

default <T> void onAfterHandledApiRequest(ApiRequest<T> request,
 T response)

It is called after the request's response is handled.
If the request send and/or request's response handler fails with exception, this method is not called.

Type Parameters:

T - The type of the response.

Parameters:

request - The request.

response - The response.

onException

default <T> void onException(ApiRequest<T> request,
 Throwable throwable)

It is called when any exception occurs when sending the request or handling the response.

Note: This method does not catch any exceptions.
All exceptions are re-thrown after this method is called, if the rethrowExceptions() returns true.

Type Parameters:

T - The type of the response.

Parameters:

request - The request.

throwable - The exception.

rethrowExceptions

default boolean rethrowExceptions()

Determines if exceptions should be re-thrown after onException(ApiRequest, Throwable) is called.
Also, if this method returns false, all responses that failed to be sent or handled will be null.

Returns:

If exceptions should be re-thrown after onException(ApiRequest, Throwable) is called.