org.jberet.rest.resource

Class JobInstanceResource

java.lang.Object

org.jberet.rest.resource.JobInstanceResource

@Path(value="/jobinstances")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public class JobInstanceResource
extends Object

REST resource class for job instance. This class supports job-instance-related operations such as listing job instances for a job name/id, getting job instance for a job execution, and counting job instances for a job name/id.

Since:

1.3.0

Constructor Summary

Constructors

Constructor and Description
JobInstanceResource()

Method Summary

Modifier and Type	Method and Description
int	getJobInstanceCount(String jobName) Gets the number of job instances for the specified job name/id.
javax.ws.rs.core.Response	getJobInstances(String jobName, int start, int count, long jobExecutionId) Gets job instance(s) for a job name/id, or job execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobInstanceResource

public JobInstanceResource()

Method Detail

getJobInstances

@GET
public javax.ws.rs.core.Response getJobInstances(@QueryParam(value="jobName")
                                                      String jobName,
                                                      @QueryParam(value="start")
                                                      int start,
                                                      @QueryParam(value="count")
                                                      int count,
                                                      @QueryParam(value="jobExecutionId")
                                                      long jobExecutionId)

Gets job instance(s) for a job name/id, or job execution. If jobExecutionId is present in query parameters, returns the response with job instance (org.jberet.rest.entity.JobInstanceEntity) for the job execution id. Otherwise, returns the response with job instances (org.jberet.rest.entity.JobInstanceEntity[] matching the specified jobName, start and count.

Parameters:

jobName - job name/id for which to get job instances

start - the offset position in the list of all eligible job instances to include

count - limit the number of job instances in the result

jobExecutionId - the job execution id for which to get job instance

Returns:

javax.ws.rs.core.Response including response status, and response entity (org.jberet.rest.entity.JobInstanceEntity for job execution id, and org.jberet.rest.entity.JobInstanceEntity[] for job name/id.

getJobInstanceCount

@Path(value="/count")
 @GET
public int getJobInstanceCount(@QueryParam(value="jobName")
                                                           String jobName)

Gets the number of job instances for the specified job name/id.

Parameters:

jobName - the job name/id to count its job instances

Returns:

the number of job instances for jobName