com.github.triceo.robozonky.common.remote

Class ApiProvider

java.lang.Object

com.github.triceo.robozonky.common.remote.ApiProvider

All Implemented Interfaces:

AutoCloseable

public class ApiProvider
extends Object
implements AutoCloseable

Provides instances of APIs for the rest of RoboZonky to use. When no longer needed, the ApiProvider needs to be close()ed in order to not leak WebServiceClients that weren't already closed by ApiProvider.ApiWrapper.close().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiProvider.ApiWrapper<T> Represents a close-able RESTEasy client proxy.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
ApiProvider()

Method Summary

Modifier and Type	Method and Description
ApiProvider.ApiWrapper<ZonkyApi>	anonymous() Retrieve user-specific Zonky API which does not require authentication.
ApiProvider.ApiWrapper<ZonkyApi>	authenticated(ZonkyApiToken token) Retrieve user-specific Zonky API which requires authentication.
void	close()
ApiProvider.ApiWrapper<ZonkyOAuthApi>	oauth() Retrieve Zonky's OAuth endpoint.
protected <T> ApiProvider.ApiWrapper<T>	obtain(Class<T> api, String url, RoboZonkyFilter filter) Instantiate an API as a RESTEasy client proxy.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected final org.slf4j.Logger LOGGER

Constructor Detail

ApiProvider

public ApiProvider()

Method Detail

obtain

protected <T> ApiProvider.ApiWrapper<T> obtain(Class<T> api,
                                               String url,
                                               RoboZonkyFilter filter)

Instantiate an API as a RESTEasy client proxy.

Type Parameters:

T - API type.

Parameters:

api - RESTEasy endpoint.

url - URL to the web API represented by the endpoint.

filter - Filter to use when communicating with the endpoint.

Returns:

RESTEasy client proxy for the API, ready to be called.

oauth

public ApiProvider.ApiWrapper<ZonkyOAuthApi> oauth()

Retrieve Zonky's OAuth endpoint.

Returns:

New API instance.

Throws:

IllegalStateException - If close() already called.

anonymous

public ApiProvider.ApiWrapper<ZonkyApi> anonymous()

Retrieve user-specific Zonky API which does not require authentication.

Returns:

New API instance.

Throws:

IllegalStateException - If close() already called.

authenticated

public ApiProvider.ApiWrapper<ZonkyApi> authenticated(ZonkyApiToken token)

Retrieve user-specific Zonky API which requires authentication.

Parameters:

token - The Zonky API token, representing an authenticated user.

Returns:

New API instance.

Throws:

IllegalStateException - If close() already called.

close

public void close()

Specified by:

close in interface AutoCloseable