de.gerdiproject.harvest.config.rest

Class ConfigurationRestResource

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestResource<Configuration,GetConfigurationEvent>

de.gerdiproject.harvest.config.rest.ConfigurationRestResource

@Path(value="config")
public final class ConfigurationRestResource
extends AbstractRestResource<Configuration,GetConfigurationEvent>

This facade serves as an interface between REST and the Configuration.

Author:

Robin Weiss

Field Summary

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

gson, restObject

Constructor Summary

Constructors

Constructor and Description
ConfigurationRestResource() Constructor

Method Summary

Modifier and Type	Method and Description
protected 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.
javax.ws.rs.core.Response	postConfiguration(String configJson) Changes parameters of the configuration.
javax.ws.rs.core.Response	putParameters(javax.ws.rs.core.MultivaluedMap<String,String> formParams) Changes parameters of the configuration.

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

changeObject

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationRestResource

public ConfigurationRestResource()

Constructor

Method Detail

putParameters

@PUT
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response putParameters(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Changes parameters of the configuration.

Parameters:

formParams - a key value map where the keys represent the parameter names and the values the new values

Returns:

a feedback text about parameter changes or failures to do so

postConfiguration

@Path(value="_set")
 @POST
 @Consumes(value="application/json")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response postConfiguration(String configJson)

Changes parameters of the configuration.

Parameters:

configJson - a key value map where the keys represent the parameter names and the values the new values

Returns:

a feedback text about parameter changes or failures to do so

getInfoText

public javax.ws.rs.core.Response getInfoText(javax.ws.rs.core.UriInfo uriInfo)

Description copied from class: AbstractRestResource

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.

Overrides:

getInfoText in class AbstractRestResource<Configuration,GetConfigurationEvent>

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 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<Configuration,GetConfigurationEvent>

Returns:

a string that offers a description of viable HTTP requests