engineer.nightowl.groupsio.api.resource

Class BaseResource

java.lang.Object

engineer.nightowl.groupsio.api.resource.BaseResource

Direct Known Subclasses:

ArchiveResource, GroupResource, MemberResource, UserResource

public class BaseResource
extends Object

Base class for Groups.io resources. Contains common methods to call into the API. Only one method is public, login(String), which can be called by any child class (rather than creating a BaseResource instance).

Field Summary

Fields

Modifier and Type	Field and Description
protected GroupsIOApiClient	apiClient
protected String	baseUrl
protected static String	MAX_RESULTS
static com.fasterxml.jackson.databind.ObjectMapper	OM

Constructor Summary

Constructors

Constructor and Description
BaseResource(GroupsIOApiClient client, String baseUrl)

Method Summary

Modifier and Type	Method and Description
protected <T> T	callApi(org.apache.http.client.methods.HttpUriRequest request, Class<T> type) Main API call method.
protected <T> T	callApi(org.apache.http.client.methods.HttpUriRequest request, Class<T> type, Boolean login) Main API call method.
String	login(String password) Carry out initial login to the Groups.io API and set the API token.

Methods inherited from class java.lang.Object

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

Field Detail

apiClient

protected final GroupsIOApiClient apiClient

baseUrl

protected final String baseUrl

MAX_RESULTS

protected static final String MAX_RESULTS

See Also:

Constant Field Values

OM

public static final com.fasterxml.jackson.databind.ObjectMapper OM

Constructor Detail

BaseResource

public BaseResource(GroupsIOApiClient client,
                    String baseUrl)

Method Detail

login

public String login(String password)
             throws URISyntaxException,
                    GroupsIOApiException,
                    IOException

Carry out initial login to the Groups.io API and set the API token.

Returns:

API token for the configured user as a String

Throws:

URISyntaxException

GroupsIOApiException

IOException

callApi

protected <T> T callApi(org.apache.http.client.methods.HttpUriRequest request,
                        Class<T> type)
                 throws IOException,
                        GroupsIOApiException

Main API call method. Takes in a HttpUriRequest comprising of a URI and method

Parameters:

request - with the relevant URI and method (with associated data is appropriate)

type -

Returns:

the type requested

Throws:

IOException - if it's not possible to get a valid response from the API

GroupsIOApiException - if the API returns an error, or an error is experienced during deserialisation

callApi

protected <T> T callApi(org.apache.http.client.methods.HttpUriRequest request,
                        Class<T> type,
                        Boolean login)
                 throws IOException,
                        GroupsIOApiException

Main API call method. Takes in a HttpUriRequest comprising of a URI and method

Parameters:

request - with the relevant URI and method (with associated data is appropriate)

type - what the response should interpreted as

login - whether this is a call specifically to login

Returns:

the type requested

Throws:

IOException - if it's not possible to get a valid response from the API

GroupsIOApiException - if the API returns an error, or an error is experienced during deserialisation