Package org.flowable.rest.service.api.management

Class JobResource

java.lang.Object

org.flowable.rest.service.api.management.JobBaseResource

org.flowable.rest.service.api.management.JobResource

@RestController
public class JobResource
extends JobBaseResource

Author:

Frederik Heremans, Joram Barrez, Tijs Rademakers

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessEngineConfigurationImpl	processEngineConfiguration
protected RestResponseFactory	restResponseFactory

Fields inherited from class org.flowable.rest.service.api.management.JobBaseResource

managementService, restApiInterceptor

Constructor Summary

Constructors

Constructor	Description
JobResource()

Method Summary

Modifier and Type	Method	Description
void	deleteDeadLetterJob(String jobId)
void	deleteHistoryJob(String jobId)
void	deleteJob(String jobId)
void	deleteSuspendedJob(String jobId)
void	deleteTimerJob(String jobId)
void	executeDeadLetterJobAction(String jobId, RestActionRequest actionRequest)
void	executeHistoryJob(String jobId, RestActionRequest actionRequest)
void	executeJobAction(String jobId, RestActionRequest actionRequest)
void	executeTimerJobAction(String jobId, TimerJobActionRequest actionRequest)
JobResponse	getDeadletterJob(String jobId)
HistoryJobResponse	getHistoryJob(String jobId)
JobResponse	getJob(String jobId)
JobResponse	getSuspendedJob(String jobId)
JobResponse	getTimerJob(String jobId)

Methods inherited from class org.flowable.rest.service.api.management.JobBaseResource

getDeadLetterJobById, getHistoryJobById, getJobById, getSuspendedJobById, getTimerJobById, validateHistoryJob, validateJob

Methods inherited from class java.lang.Object

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

Field Details

restResponseFactory

@Autowired
protected RestResponseFactory restResponseFactory

processEngineConfiguration

@Autowired
protected ProcessEngineConfigurationImpl processEngineConfiguration

Constructor Details

JobResource

public JobResource()

Method Details

getJob

@GetMapping(value="/management/jobs/{jobId}",
            produces="application/json")
public JobResponse getJob(@PathVariable
 String jobId)

getTimerJob

@GetMapping(value="/management/timer-jobs/{jobId}",
            produces="application/json")
public JobResponse getTimerJob(@PathVariable
 String jobId)

getSuspendedJob

@GetMapping(value="/management/suspended-jobs/{jobId}",
            produces="application/json")
public JobResponse getSuspendedJob(@PathVariable
 String jobId)

getDeadletterJob

@GetMapping(value="/management/deadletter-jobs/{jobId}",
            produces="application/json")
public JobResponse getDeadletterJob(@PathVariable
 String jobId)

getHistoryJob

@GetMapping(value="/management/history-jobs/{jobId}",
            produces="application/json")
public HistoryJobResponse getHistoryJob(@PathVariable
 String jobId)

deleteJob

@DeleteMapping("/management/jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void deleteJob(@PathVariable
 String jobId)

deleteTimerJob

@DeleteMapping("/management/timer-jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void deleteTimerJob(@PathVariable
 String jobId)

deleteSuspendedJob

@DeleteMapping("/management/suspended-jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void deleteSuspendedJob(@PathVariable
 String jobId)

deleteDeadLetterJob

@DeleteMapping("/management/deadletter-jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void deleteDeadLetterJob(@PathVariable
 String jobId)

deleteHistoryJob

@DeleteMapping("/management/history-jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void deleteHistoryJob(@PathVariable
 String jobId)

executeJobAction

@PostMapping("/management/jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void executeJobAction(@PathVariable
 String jobId,
 @RequestBody
 RestActionRequest actionRequest)

executeHistoryJob

@PostMapping("/management/history-jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void executeHistoryJob(@PathVariable
 String jobId,
 @RequestBody
 RestActionRequest actionRequest)

executeTimerJobAction

@PostMapping("/management/timer-jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void executeTimerJobAction(@PathVariable
 String jobId,
 @RequestBody
 TimerJobActionRequest actionRequest)

executeDeadLetterJobAction

@PostMapping("/management/deadletter-jobs/{jobId}")
@ResponseStatus(NO_CONTENT)
public void executeDeadLetterJobAction(@PathVariable
 String jobId,
 @RequestBody
 RestActionRequest actionRequest)