org.finra.herd.rest

Class SystemJobRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.SystemJobRestController

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

The REST controller that handles system job REST requests.

Constructor Summary

Constructors

Constructor and Description
SystemJobRestController()

Method Summary

Modifier and Type	Method and Description
SystemJobRunResponse	runSystemJob(SystemJobRunRequest request) Starts a system job asynchronously.

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

SystemJobRestController

public SystemJobRestController()

Method Detail

runSystemJob

@RequestMapping(value="/systemJobs",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_SYSTEM_JOBS_POST")
public SystemJobRunResponse runSystemJob(@RequestBody
                                                                                                                                                                                                                   SystemJobRunRequest request)
                                                                                                                                                                                                            throws Exception

Starts a system job asynchronously.

Parameters:

request - the information needed to run the system job

Returns:

the system job information

Throws:

Exception