org.finra.herd.rest

Class JobDefinitionRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.JobDefinitionRestController

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

The REST controller that handles job definition REST requests.

Constructor Summary

Constructors

Constructor and Description
JobDefinitionRestController()

Method Summary

Modifier and Type	Method and Description
JobDefinition	createJobDefinition(JobDefinitionCreateRequest request) Creates a new job definition.
JobDefinition	getJobDefinition(String namespace, String jobName) Gets an existing job definition.
JobDefinition	updateJobDefinition(String namespace, String jobName, JobDefinitionUpdateRequest request) Updates an existing job definition.

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

JobDefinitionRestController

public JobDefinitionRestController()

Method Detail

createJobDefinition

@RequestMapping(value="/jobDefinitions",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_JOB_DEFINITIONS_POST")
public JobDefinition createJobDefinition(@RequestBody
                                                                                                                                                                                                                           JobDefinitionCreateRequest request)
                                                                                                                                                                                                                    throws Exception

Creates a new job definition.

Requires WRITE permission on namespace

Parameters:

request - the information needed to create the job definition.

Returns:

the created job definition.

Throws:

Exception

updateJobDefinition

@RequestMapping(value="/jobDefinitions/namespaces/{namespace}/jobNames/{jobName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_JOB_DEFINITIONS_PUT")
public JobDefinition updateJobDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                   String namespace,
                                                                                                                                                                                                                                                                   @PathVariable(value="jobName")
                                                                                                                                                                                                                                                                   String jobName,
                                                                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                                                                   JobDefinitionUpdateRequest request)
                                                                                                                                                                                                                                                            throws Exception

Updates an existing job definition.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace of the job definition.

jobName - the job name of the job definition.

request - the information needed to update the job definition.

Returns:

the updated job definition.

Throws:

Exception

getJobDefinition

@RequestMapping(value="/jobDefinitions/namespaces/{namespace}/jobNames/{jobName}",
                method=GET)
 @Secured(value="FN_JOB_DEFINITIONS_GET")
public JobDefinition getJobDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                               String namespace,
                                                                                                                                                                                               @PathVariable(value="jobName")
                                                                                                                                                                                               String jobName)
                                                                                                                                                                                        throws Exception

Gets an existing job definition.

Requires READ permission on namespace

Parameters:

namespace - the namespace of the job definition.

jobName - the job name of the job definition.

Returns:

the job definition.

Throws:

Exception