de.gerdiproject.harvest.etls.rest

Class ETLRestResource

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestResource<ETLManager,GetETLManagerEvent>

de.gerdiproject.harvest.etls.rest.ETLRestResource

@Path(value="")
public class ETLRestResource
extends AbstractRestResource<ETLManager,GetETLManagerEvent>

A facade for the harvester that serves as a RESTful interface. It provides REST requests that manipulate the harvester in order to prepare and send search indices to Elastic Search.

Author:

Robin Weiss

See Also:

AbstractETL

Field Summary

Fields inherited from class de.gerdiproject.harvest.rest.AbstractRestResource

gson, restObject

Constructor Summary

Constructors

Constructor and Description
ETLRestResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	abort() Aborts an ongoing harvest.
javax.ws.rs.core.Response	checkIfEtlIssOutdated() Checks if the harvester should be triggered again.
javax.ws.rs.core.Response	getAllETLInfos() A HTTP GET request that returns a JSON representation of a all ETLs.
protected String	getAllowedRequests() This method returns a string that offers a description of viable HTTP requests.
javax.ws.rs.core.Response	getAllVersions() Displays the artifactIds and versions of all Maven libraries used in this service.
javax.ws.rs.core.Response	getETLInfo(javax.ws.rs.core.UriInfo uriInfo) A HTTP GET request that returns a JSON representation of a single ETL.
javax.ws.rs.core.Response	getHealth() Checks the health of the harvester.
javax.ws.rs.core.Response	getLog(String dateString, String levelString, String classString) Attempts to retrieve the log of the harvester service.
javax.ws.rs.core.Response	getVersions() Displays the artifactIds and versions of GeRDI Maven libraries used in this service.
javax.ws.rs.core.Response	reset() Attempts to completely reset the harvester service
javax.ws.rs.core.Response	startHarvest(javax.ws.rs.core.MultivaluedMap<String,String> formParams) Starts a harvest using the harvester that is registered in the MainContext.

Methods inherited from class de.gerdiproject.harvest.rest.AbstractRestResource

changeObject, getInfoText

Methods inherited from class java.lang.Object

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

Constructor Detail

ETLRestResource

public ETLRestResource()

Method Detail

getETLInfo

@GET
 @Path(value="etl")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getETLInfo(@Context
                                                                                                          javax.ws.rs.core.UriInfo uriInfo)

A HTTP GET request that returns a JSON representation of a single ETL.

Parameters:

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

Returns:

a JSON object that represents the ETL or an error response describing what went wrong

getAllETLInfos

@GET
 @Path(value="etls")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAllETLInfos()

A HTTP GET request that returns a JSON representation of a all ETLs.

Returns:

a JSON object that represents all ETLs or an error response describing what went wrong

startHarvest

@POST
 @Produces(value="application/json")
public javax.ws.rs.core.Response startHarvest(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Starts a harvest using the harvester that is registered in the MainContext.

Parameters:

formParams - optional parameters encompass "from" and "to" to set the harvest range

Returns:

a status string that describes the success or failure of the harvest

checkIfEtlIssOutdated

@GET
 @Path(value="outdated")
 @Produces(value="application/json")
public javax.ws.rs.core.Response checkIfEtlIssOutdated()

Checks if the harvester should be triggered again.

Returns:

true if the harvested data is outdated

abort

@POST
 @Path(value="abort")
 @Produces(value="application/json")
public javax.ws.rs.core.Response abort()

Aborts an ongoing harvest.

Returns:

a status message describing if the abort could be started or not

reset

@POST
 @Path(value="reset")
 @Produces(value="application/json")
public javax.ws.rs.core.Response reset()

Attempts to completely reset the harvester service

Returns:

a status message

getLog

@GET
 @Path(value="log")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response getLog(@QueryParam(value="date")
                                                                                                String dateString,
                                                                                                @QueryParam(value="level")
                                                                                                String levelString,
                                                                                                @QueryParam(value="class")
                                                                                                String classString)

Attempts to retrieve the log of the harvester service.

Parameters:

dateString - the log dates in YYYY-MM-DD format of the log messages as comma separated string, or null if this filter should not be applied

levelString - the log levels of the log messages as comma separated string, or null if this filter should not be applied

classString - the logger names of the log messages as comma separated string, or null if this filter should not be applied

Returns:

a the log of the harvester service

getHealth

@GET
 @Path(value="health")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getHealth()

Checks the health of the harvester.

Returns:

the health of the harvester

getVersions

@GET
 @Path(value="versions")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getVersions()

Displays the artifactIds and versions of GeRDI Maven libraries used in this service.

Returns:

artifactIds and versions of GeRDI Maven libraries used in this service.

getAllVersions

@GET
 @Path(value="versions-all")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAllVersions()

Displays the artifactIds and versions of all Maven libraries used in this service.

Returns:

artifactIds and versions of all Maven libraries used in this service.

getAllowedRequests

protected String getAllowedRequests()

Description copied from class: AbstractRestResource

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

Specified by:

getAllowedRequests in class AbstractRestResource<ETLManager,GetETLManagerEvent>

Returns:

a string that offers a description of viable HTTP requests