Package io.github.devlibx.easy.http.util

Class EasyHttp

java.lang.Object

io.github.devlibx.easy.http.util.EasyHttp

public class EasyHttp
extends Object

Constructor Summary

Constructors

Constructor	Description
EasyHttp()

Method Summary

Modifier and Type	Method	Description
static <T> io.reactivex.rxjava3.core.Observable<T>	callAsync(Call<T> call)	Make a HTTP call which returns a observable.
static <T> T	callSync(Call<T> call)	Make a HTTP call which returns a response.
static void	installEasyHttpImplementation(IEasyHttpImplementation easyHttpImplementor)	This is a method to setup you custom EasyHttpObject.
static void	setup(Config config)	Setup EasyHttp to make HTTP requests
static void	setup(Config config, IMetrics metrics)	Setup EasyHttp to make HTTP requests
static void	shutdown()	Free all resources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EasyHttp

public EasyHttp()

Method Details

installEasyHttpImplementation

public static void installEasyHttpImplementation(IEasyHttpImplementation easyHttpImplementor)

This is a method to setup you custom EasyHttpObject. It is mainly helpful in test cases.

setup

public static void setup(Config config,
 IMetrics metrics)

Setup EasyHttp to make HTTP requests

setup

public static void setup(Config config)

Setup EasyHttp to make HTTP requests

shutdown

public static void shutdown()

Free all resources

callSync

public static <T> T callSync(Call<T> call)

Make a HTTP call which returns a response.
Note - to check for timeout errors you must catch both EasyHttpExceptions.EasyResilienceRequestTimeoutException and EasyHttpExceptions.EasyRequestTimeOutException

Type Parameters:

T - type of response

Parameters:

call - request object

Returns:

response of http call

Throws:

EasyHttpExceptions.EasyHttpRequestException - if error, it provides EasyHttpExceptions.EasyHttpRequestException. You can catch specific type of errors by caching sub-class of EasyHttpRequestException. e.g. EasyHttpExceptions.EasyInternalServerErrorException, EasyHttpExceptions.EasyBadRequestException

It also throws EasyHttpExceptions.EasyResilienceException which is also a sub-class of EasyHttpExceptions.EasyHttpRequestException. These resilience exception are thrown when circuit is open, too many calls are made, or request timed out.

callAsync

public static <T>
io.reactivex.rxjava3.core.Observable<T> callAsync(Call<T> call)

Make a HTTP call which returns a observable.
Note - to check for timeout errors you must catch both EasyHttpExceptions.EasyResilienceRequestTimeoutException and EasyHttpExceptions.EasyRequestTimeOutException

Type Parameters:

T - type of response

Parameters:

call - request object

Returns:

observable for response of http call

Throws:

EasyHttpExceptions.EasyHttpRequestException - (exceptions will be received in the onError callback in subscriber) if error, it provides EasyHttpExceptions.EasyHttpRequestException. You can catch specific type of errors by caching sub-class of EasyHttpRequestException. e.g. EasyHttpExceptions.EasyInternalServerErrorException, EasyHttpExceptions.EasyBadRequestException

It also throws EasyHttpExceptions.EasyResilienceException which is also a sub-class of EasyHttpExceptions.EasyHttpRequestException. These resilience exception are thrown when circuit is open, too many calls are made, or request timed out.