de.gerdiproject.harvest.rest

Class AbstractRestResource<T extends AbstractRestObject<T,?>,S extends GetRestObjectEvent<T>>

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestResource<T,S>

Type Parameters:

T - the type of the singleton object that is represented by the AbstractRestResource

S - the type of a GetRestObjectEvent that is used to retrieve the singleton object

Direct Known Subclasses:

ConfigurationRestResource, ETLRestResource, SchedulerRestResource

public abstract class AbstractRestResource<T extends AbstractRestObject<T,?>,S extends GetRestObjectEvent<T>>
extends Object

This abstract class represents the interface between HTTP requests and a singleton object that can be manipulated by such. It offers a standard plain-text and JSON getter, as well as a helper function for manipulating the singleton object.

Author:

Robin Weiss

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gson.Gson	gson
protected T	restObject

Constructor Summary

Constructors

Constructor and Description
AbstractRestResource() This constructor constructs and dispatches an instance of the generic GetRestObjectEvent in order to retrieve the singleton object.
AbstractRestResource(com.google.gson.Gson gson) This constructor constructs and dispatches an instance of the generic GetRestObjectEvent in order to retrieve the singleton object.

Method Summary

Modifier and Type	Method and Description
protected <P,R> javax.ws.rs.core.Response	changeObject(Function<P,R> changeFunction, String jsonRaw, Class<P> jsonClass) Parses the required JSON object from a specified string and calls a string returning function using the parsed object as argument.
protected abstract String	getAllowedRequests() This method returns a string that offers a description of viable HTTP requests.
javax.ws.rs.core.Response	getInfoText(javax.ws.rs.core.UriInfo uriInfo) A HTTP GET request that returns a plain-text representation of the singleton object, as well as some help text that shows which HTTP requests are possible.

Methods inherited from class java.lang.Object

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

Field Detail

restObject

protected final T extends AbstractRestObject<T,?> restObject

gson

protected final com.google.gson.Gson gson

Constructor Detail

AbstractRestResource

public AbstractRestResource(com.google.gson.Gson gson)

This constructor constructs and dispatches an instance of the generic GetRestObjectEvent in order to retrieve the singleton object.

Parameters:

gson - a gson instance used to parse JSON requests and responses

AbstractRestResource

public AbstractRestResource()

This constructor constructs and dispatches an instance of the generic GetRestObjectEvent in order to retrieve the singleton object. It creates a new Gson instance without custom adapters.

Method Detail

getInfoText

@GET
 @Produces(value={"text/plain","application/json"})
public javax.ws.rs.core.Response getInfoText(@Context
                                                                                                      javax.ws.rs.core.UriInfo uriInfo)

A HTTP GET request that returns a plain-text representation of the singleton object, as well as some help text that shows which HTTP requests are possible.

Parameters:

uriInfo - an object that can be used to retrieve the path and possible query parameters.

Returns:

a pretty plain text that represents the singleton object or an error response describing what went wrong

getAllowedRequests

protected abstract String getAllowedRequests()

This method returns a string that offers a description of viable HTTP requests.

Returns:

a string that offers a description of viable HTTP requests

changeObject

protected <P,R> javax.ws.rs.core.Response changeObject(Function<P,R> changeFunction,
                                                       String jsonRaw,
                                                       Class<P> jsonClass)

Parses the required JSON object from a specified string and calls a string returning function using the parsed object as argument. Returns various HTTP error codes and explanations if the process fails. This function can be used as a fail-safe manipulator of the singleton object.

Type Parameters:

P - the target type of the JSON object body

R - the return type of the changeFunction

Parameters:

changeFunction - a function that expects a JSON object and returns a string

jsonRaw - the unparsed JSON string

jsonClass - the class that is to be created from the JSON string

Returns:

a response that describes the status of the operation