org.finra.herd.rest

Class JobRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.JobRestController

@RestController
 @RequestMapping(value="/rest",
                produces={"application/xml","application/json"})
public class JobRestController
extends HerdBaseController

The REST controller that handles job REST requests.

Constructor Summary

Constructors

Constructor and Description
JobRestController()

Method Summary

Modifier and Type	Method and Description
Job	createJob(JobCreateRequest request) Creates and starts a new job asynchronously.
Job	deleteJob(String id, JobDeleteRequest jobDeleteRequest) Deletes a currently running job and preserves the job state in history.
Job	getJob(String id, Boolean verbose) Gets the details of a previously submitted job.
JobSummaries	getJobs(String namespace, String jobName, JobStatusEnum status, String startTime, String endTime) Gets a list of job executions based on the specified filter parameters.
Job	signalJob(JobSignalRequest request) Signals the job with the receive task.
Job	updateJob(String id, JobUpdateRequest jobUpdateRequest) Activates or suspends a job execution.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Constructor Detail

JobRestController

public JobRestController()

Method Detail

createJob

@RequestMapping(value="/jobs",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_JOBS_POST")
public Job createJob(@RequestBody
                                                                                                                                                                                  JobCreateRequest request)
                                                                                                                                                                           throws Exception

Creates and starts a new job asynchronously.

Requires EXECUTE permission on namespace

Parameters:

request - the information needed to create the job.

Returns:

the created job information.

Throws:

Exception

getJobs

@RequestMapping(value="/jobs",
                method=GET)
 @Secured(value="FN_JOBS_GET")
public JobSummaries getJobs(@RequestParam(value="namespace",required=false)
                                                                                                                      String namespace,
                                                                                                                      @RequestParam(value="jobName",required=false)
                                                                                                                      String jobName,
                                                                                                                      @RequestParam(value="status",required=false)
                                                                                                                      JobStatusEnum status,
                                                                                                                      @RequestParam(value="startTime",required=false)
                                                                                                                      String startTime,
                                                                                                                      @RequestParam(value="endTime",required=false)
                                                                                                                      String endTime)
                                                                                                               throws Exception

Gets a list of job executions based on the specified filter parameters.

Jobs' namespace to which you do not have READ permissions to will be omitted from the result.

Parameters:

namespace - an optional namespace filter

jobName - an optional job name filter

status - an optional job status filter

startTime - an optional start time filter (ex. 2015, 2015-12, 2015-12-12T3:4:5)

endTime - an optional end time filter (ex. 2015, 2015-12, 2015-12-12T3:4:5)

Returns:

the list of job summaries.

Throws:

Exception - if any problems were encountered.

getJob

@RequestMapping(value="/jobs/ids/{id}",
                method=GET)
 @Secured(value="FN_JOBS_GET_BY_ID")
public Job getJob(@PathVariable(value="id")
                                                                                                                           String id,
                                                                                                                           @RequestParam(value="verbose",required=false,defaultValue="false")
                                                                                                                           Boolean verbose)
                                                                                                                    throws Exception

Gets the details of a previously submitted job.

Requires READ permission on namespace

Parameters:

id - the job id.

Returns:

the job information.

Throws:

Exception

signalJob

@RequestMapping(value="/jobs/signal",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_JOBS_SIGNAL_POST")
public Job signalJob(@RequestBody
                                                                                                                                                                                                JobSignalRequest request)
                                                                                                                                                                                         throws Exception

Signals the job with the receive task.

Requires EXECUTE permission on namespace

Parameters:

request - the information needed to signal the job.

Returns:

the created job information.

Throws:

Exception

updateJob

@RequestMapping(value="/jobs/ids/{id}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_JOBS_PUT")
public Job updateJob(@PathVariable(value="id")
                                                                                                                                                                                         String id,
                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                         JobUpdateRequest jobUpdateRequest)
                                                                                                                                                                                  throws Exception

Activates or suspends a job execution.

Requires EXECUTE permission on namespace

Parameters:

id - the job id

jobUpdateRequest - the job update request

Returns:

the job

Throws:

Exception - when any exception occurs

deleteJob

@RequestMapping(value="/jobs/ids/{id}",
                method=DELETE)
 @Secured(value="FN_JOBS_DELETE")
public Job deleteJob(@PathVariable(value="id")
                                                                                                                              String id,
                                                                                                                              @RequestBody
                                                                                                                              JobDeleteRequest jobDeleteRequest)
                                                                                                                       throws Exception

Deletes a currently running job and preserves the job state in history.

Requires EXECUTE permission on namespace

Parameters:

id - The job id

jobDeleteRequest - The delete request

Returns:

The job that has been deleted

Throws:

Exception - when any exception occurs