de.codecentric.batch.web

Class JobMonitoringController

java.lang.Object

de.codecentric.batch.web.JobMonitoringController

@RestController
@RequestMapping(value="${batch.web.monitoring.base:/batch/monitoring}")
public class JobMonitoringController
extends Object

Controller for delivering monitoring information, like

• which jobs are deployed?
• which jobs are currently running on this machine?
• detailed information on any running or finished job.

The base url can be set via property batch.web.monitoring.base, its default is /batch/monitoring. There are four endpoints available:

1. Retrieving the names of deployed jobs
   {base_url}/jobs / GET
   On success, it returns a JSON array of String containing the names of the deployed jobs.
2. Retrieving the ids of JobExecutions running on this server
   {base_url}/jobs/runningexecutions / GET
   On success, it returns a JSON array containing the ids of the JobExecutions running on this server.
3. Retrieving the ids of JobExecutions running on this server for a certain job name
   {base_url}/jobs/runningexecutions/{jobName} / GET
   On success, it returns a JSON array containing the ids of the JobExecutions running on this server belonging to the specified job.
4. Retrieving the JobExecution
   {base_url}/jobs/executions/{executionId} / GET
   On success, it returns a JSON representation of the JobExecution specified by the id. This representation contains everything you need to know about that job, from job name and BatchStatus to the number of processed items and time used and so on.
   If the JobExecution cannot be found, a HTTP response code 404 is returned.

Author:

Tobias Flohre

Constructor Summary

Constructors

Constructor and Description
JobMonitoringController(org.springframework.batch.core.launch.JobOperator jobOperator, org.springframework.batch.core.explore.JobExplorer jobExplorer, RunningExecutionTracker runningExecutionTracker)

Method Summary

Methods

Modifier and Type	Method and Description
Set<Long>	findAllRunningExecutions()
org.springframework.batch.core.JobExecution	findExecution(long executionId)
Set<String>	findRegisteredJobs()
Set<Long>	findRunningExecutionsForJobName(String jobName)
String	handleNotFound(Exception ex)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobMonitoringController

public JobMonitoringController(org.springframework.batch.core.launch.JobOperator jobOperator,
                       org.springframework.batch.core.explore.JobExplorer jobExplorer,
                       RunningExecutionTracker runningExecutionTracker)

Method Detail

findRegisteredJobs

@RequestMapping(value="/jobs",
                method=GET)
public Set<String> findRegisteredJobs()
                               throws IOException

Throws:

IOException

findAllRunningExecutions

@RequestMapping(value="/jobs/runningexecutions",
                method=GET)
public Set<Long> findAllRunningExecutions()

findRunningExecutionsForJobName

@RequestMapping(value="/jobs/runningexecutions/{jobName}",
                method=GET)
public Set<Long> findRunningExecutionsForJobName(@PathVariable
                                                       String jobName)

findExecution

@RequestMapping(value="/jobs/executions/{executionId}",
                method=GET)
public org.springframework.batch.core.JobExecution findExecution(@PathVariable
                                                                       long executionId)
                                                          throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

handleNotFound

@ResponseStatus(value=NOT_FOUND)
@ExceptionHandler(value=org.springframework.batch.core.launch.NoSuchJobExecutionException.class)
public String handleNotFound(Exception ex)