Package org.apache.batchee.jaxrs.common

Interface JBatchResource

All Known Implementing Classes:

JBatchResourceImpl

@Consumes("application/json")
@Produces("application/json")
@Path("batchee")
public interface JBatchResource

Method Summary

Modifier and Type	Method	Description
void	abandon(long executionId)
RestJobExecution	getJobExecution(long executionId)
RestJobExecution[]	getJobExecutions(long id, String name)
RestJobInstance	getJobInstance(long executionId)
int	getJobInstanceCount(String jobName)
RestJobInstance[]	getJobInstances(String jobName, int start, int count)
String[]	getJobNames()
RestProperties	getParameters(long executionId)
Long[]	getRunningExecutions(String jobName)
RestStepExecution[]	getStepExecutions(long jobExecutionId)
long	restart(long executionId, RestProperties restartParameters)
long	start(String jobXMLName, RestProperties jobParameters)
void	stop(long executionId)

Method Detail

getJobNames

@GET
@Path("job-names")
String[] getJobNames()

getJobInstanceCount

@GET
@Path("job-instance/count/{name}")
@Produces("text/plain")
int getJobInstanceCount(@PathParam("name")
                        String jobName)

getJobInstances

@GET
@Path("job-instances/{name}")
RestJobInstance[] getJobInstances(@PathParam("name")
                                  String jobName,
                                  @QueryParam("start")
                                  int start,
                                  @QueryParam("count")
                                  int count)

getRunningExecutions

@GET
@Path("executions/running/{name}")
Long[] getRunningExecutions(@PathParam("name")
                            String jobName)

getParameters

@GET
@Path("execution/parameter/{id}")
RestProperties getParameters(@PathParam("id")
                             long executionId)

getJobInstance

@GET
@Path("job-instance/{id}")
RestJobInstance getJobInstance(@PathParam("id")
                               long executionId)

getJobExecutions

@GET
@Path("job-executions/{id}/{name}")
RestJobExecution[] getJobExecutions(@PathParam("id")
                                    long id,
                                    @PathParam("name")
                                    String name)

getJobExecution

@GET
@Path("job-execution/{id}")
RestJobExecution getJobExecution(@PathParam("id")
                                 long executionId)

getStepExecutions

@GET
@Path("step-executions/{id}")
RestStepExecution[] getStepExecutions(@PathParam("id")
                                      long jobExecutionId)

start

@POST
@Path("execution/start/{name}")
@Produces("text/plain")
long start(@PathParam("name")
           String jobXMLName,
           RestProperties jobParameters)

restart

@POST
@Path("execution/restart/{id}")
@Produces("text/plain")
long restart(@PathParam("id")
             long executionId,
             RestProperties restartParameters)

stop

@HEAD
@Path("execution/stop/{id}")
void stop(@PathParam("id")
          long executionId)

abandon

@HEAD
@Path("execution/abandon/{id}")
void abandon(@PathParam("id")
             long executionId)