org.jberet.rest.resource

Class JobResource

java.lang.Object

org.jberet.rest.resource.JobResource

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

REST resource class for batch job. This class supports job-related operations such as starting by job XML name, restarting the latest job execution of a job name (id), and listing currently known jobs.

Since:

1.3.0

Constructor Summary

Constructors

Constructor and Description
JobResource()

Method Summary

Modifier and Type	Method and Description
JobEntity[]	getJobs() Gets all jobs known to the current batch runtime.
JobExecutionEntity	restart(String jobXmlName, javax.ws.rs.core.UriInfo uriInfo, Properties jobParamsAsProps) Restarts the most recent job execution of a job name/id, with optional restart job parameters.
org.jberet.schedule.JobSchedule	schedule(org.jberet.schedule.JobScheduleConfig scheduleConfig)
javax.ws.rs.core.Response	start(String jobXmlName, javax.ws.rs.core.UriInfo uriInfo, Properties jobParamsAsProps) Starts a new job execution for the specified jobXmlName.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobResource

public JobResource()

Method Detail

start

@Path(value="{jobXmlName}/start")
 @POST
public javax.ws.rs.core.Response start(@PathParam(value="jobXmlName")
                                                                                String jobXmlName,
                                                                                @Context
                                                                                javax.ws.rs.core.UriInfo uriInfo,
                                                                                Properties jobParamsAsProps)

Starts a new job execution for the specified jobXmlName. Job parameters can be taken from query parameters, obtained from uriInfo, or jobParamsAsProps as java.util.Properties, or both. When extracting query parameters from uriInfo, only the first value of each key is used. When a key exists in both query parameters and props, the latter takes precedence.

Parameters:

jobXmlName - job xml name, which usually is the same as job id

uriInfo - javax.ws.rs.core.UriInfo that contains query parameters and other info

jobParamsAsProps - job parameters properties

Returns:

javax.ws.rs.core.Response, which includes response status and newly started job execution of type JobExecutionEntity

schedule

@Path(value="{jobXmlName}/schedule")
 @POST
public org.jberet.schedule.JobSchedule schedule(org.jberet.schedule.JobScheduleConfig scheduleConfig)

restart

@Path(value="{jobXmlName}/restart")
 @POST
public JobExecutionEntity restart(@PathParam(value="jobXmlName")
                                                                             String jobXmlName,
                                                                             @Context
                                                                             javax.ws.rs.core.UriInfo uriInfo,
                                                                             Properties jobParamsAsProps)

Restarts the most recent job execution of a job name/id, with optional restart job parameters.

Job parameters can be taken from query parameters, obtained from uriInfo, or jobParamsAsProps as java.util.Properties, or both. When extracting query parameters from uriInfo, only the first value of each key is used. When a key exists in both query parameters and props, the latter takes precedence.

Job parameters in the previous job execution that is to be restarted will continue to be used in the restart job execution. Job parameters (as query parameters or java.util.Properties) in the current invocation will complement and override any same-keyed job parameters.

Parameters:

jobXmlName - job name/id, whose most recent job execution will be restarted

uriInfo - javax.ws.rs.core.UriInfo that contains additional query parameters and other info

jobParamsAsProps - additional job parameters properties

Returns:

org.jberet.rest.entity.JobExecutionEntity for the new job execution

See Also:

start(String, UriInfo, Properties), JobExecutionResource.restart(long, UriInfo, Properties)

getJobs

@GET
public JobEntity[] getJobs()

Gets all jobs known to the current batch runtime. Note that historical jobs that are not currently loaded in the batch runtime will not be included in the result.

Returns:

array of org.jberet.rest.entity.JobEntity known to the batch runtime