de.gerdiproject.harvest.scheduler.rest

Class SchedulerRestResource

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestResource<Scheduler,GetSchedulerEvent>

de.gerdiproject.harvest.scheduler.rest.SchedulerRestResource

@Path(value="schedule")
public class SchedulerRestResource
extends AbstractRestResource<Scheduler,GetSchedulerEvent>

This class serves as a REST interface to the Scheduler.

Author:

Robin Weiss

Field Summary

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

gson, restObject

Constructor Summary

Constructors

Constructor and Description
SchedulerRestResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addTask(String crontab) Adds a harvesting task with a specified cron tab to the schedule.
javax.ws.rs.core.Response	deleteAllTasks() Deletes a harvesting task with a specified cron tab from the schedule.
javax.ws.rs.core.Response	deleteTask(String crontab) Deletes a harvesting task with a specified cron tab from the schedule.
protected String	getAllowedRequests() This method returns a string that offers a description of viable HTTP requests.

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

SchedulerRestResource

public SchedulerRestResource()

Method Detail

addTask

@Path(value="_add")
 @POST
 @Consumes(value="application/json")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response addTask(String crontab)

Adds a harvesting task with a specified cron tab to the schedule.

Parameters:

crontab - a cron tab describing when a harvest should take place

Returns:

an info message explaining if the operation was successful or not

deleteTask

@Path(value="_delete")
 @POST
 @Consumes(value="application/json")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response deleteTask(String crontab)

Deletes a harvesting task with a specified cron tab from the schedule.

Parameters:

crontab - the cron tab that is to be removed

Returns:

an info message explaining if the operation was successful or not

deleteAllTasks

@Path(value="_deleteAll")
 @POST
 @Produces(value="text/plain")
public javax.ws.rs.core.Response deleteAllTasks()

Deletes a harvesting task with a specified cron tab from the schedule.

Returns:

an info message explaining if the operation was successful or not

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<Scheduler,GetSchedulerEvent>

Returns:

a string that offers a description of viable HTTP requests