Package org.imixs.workflow.jaxrs

Class SchedulerRestService

java.lang.Object

org.imixs.workflow.jaxrs.SchedulerRestService

@Path("/scheduler")
@Produces({"text/html","application/xml","application/json","text/xml"})
public class SchedulerRestService
extends Object

The SchedulerRestService provides methods to

• Load a Scheduler configuration
• Save a Scheduler configuration
• Start a Scheduler
• Stop a Scheduler

Author:

rsoika

See Also:

• SchedulerService

Constructor Summary

Constructors

Constructor	Description
SchedulerRestService()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.StreamingOutput	getHelpHTML()
jakarta.ws.rs.core.Response	loadConfiguration(String name, String items, String format)	Returns a scheduler configuration by its name
jakarta.ws.rs.core.Response	updateSchedulerConfiguration(XMLDocument xmlworkitem)	Update a scheduler configuration

Methods inherited from class java.lang.Object

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

Constructor Details

SchedulerRestService

public SchedulerRestService()

Method Details

getHelpHTML

@GET
@Produces("text/html")
@Path("/help")
public jakarta.ws.rs.core.StreamingOutput getHelpHTML()

updateSchedulerConfiguration

@POST
@Path("/")
@Produces("application/xml")
@Consumes({"application/xml","text/xml"})
public jakarta.ws.rs.core.Response updateSchedulerConfiguration(XMLDocument xmlworkitem)

Update a scheduler configuration

If the scheduler configuration is 'enabled' the scheduler will be started automatically. Otherwise the scheduler will be stopped if running

Parameters:

xmlworkitem - - entity to be saved

Returns:

loadConfiguration

@GET
@Path("/{name}")
public jakarta.ws.rs.core.Response loadConfiguration(@PathParam("name")
 String name,
 @QueryParam("items")
 String items,
 @QueryParam("format")
 String format)

Returns a scheduler configuration by its name

Parameters:

name - - name of the configuration

Returns:

the scheduler configuration entity