de.codecentric.batch.web

Class JobOperationsController

java.lang.Object

de.codecentric.batch.web.JobOperationsController

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

Very simple REST-API for starting and stopping jobs and keeping track of its status. Made for script interaction.

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

1. Starting jobs
   {base_url}/jobs/{jobName} / POST
   Optionally you may define job parameters via request param 'jobParameters'. If a JobParametersIncrementer is specified in the job, it is used to increment the parameters.
   On success, it returns the JobExecution's id as a plain string.
   On failure, it returns the message of the Exception as a plain string. There are different failure possibilities:
   • HTTP response code 404 (NOT_FOUND): the job cannot be found, not deployed on this server.
   • HTTP response code 409 (CONFLICT): the JobExecution already exists and is either running or not restartable.
   • HTTP response code 422 (UNPROCESSABLE_ENTITY): the job parameters didn't pass the validator.
   • HTTP response code 500 (INTERNAL_SERVER_ERROR): any other unexpected failure.
2. Retrieving an JobExecution's ExitCode
   {base_url}/jobs/executions/{executionId} / GET
   On success, it returns the ExitCode of the JobExecution specified by the executionId as a plain string.
   On failure, it returns the message of the Exception as a plain string. There are different failure possibilities:
   • HTTP response code 404 (NOT_FOUND): the JobExecution cannot be found.
   • HTTP response code 500 (INTERNAL_SERVER_ERROR): any other unexpected failure.
3. Retrieving a log file for a specific JobExecution
   {base_url}/jobs/executions/{executionId}/log / GET
   On success, it returns the log file belonging to the run of the JobExecution specified by the executionId as a plain string.
   On failure, it returns the message of the Exception as a plain string. There are different failure possibilities:
   • HTTP response code 404 (NOT_FOUND): the log file cannot be found.
   • HTTP response code 500 (INTERNAL_SERVER_ERROR): any other unexpected failure.
4. Stopping jobs
   {base_url}/jobs/executions/{executionId} / DELETE
   On success, it returns true.
   On failure, it returns the message of the Exception as a plain string. There are different failure possibilities:
   • HTTP response code 404 (NOT_FOUND): the JobExecution cannot be found.
   • HTTP response code 409 (CONFLICT): the JobExecution is not running.
   • HTTP response code 500 (INTERNAL_SERVER_ERROR): any other unexpected failure.

Author:

Dennis Schulte, Tobias Flohre

Field Summary

Fields

Modifier and Type	Field and Description
static String	JOB_PARAMETERS

Constructor Summary

Constructors

Constructor and Description

JobOperationsController(org.springframework.batch.core.launch.JobOperator jobOperator, org.springframework.batch.core.explore.JobExplorer jobExplorer, org.springframework.batch.core.configuration.JobRegistry jobRegistry, org.springframework.batch.core.repository.JobRepository jobRepository, org.springframework.batch.core.launch.JobLauncher jobLauncher, org.springframework.batch.core.jsr.launch.JsrJobOperator jsrJobOperator)

Method Summary

Methods

Modifier and Type	Method and Description
void	getLogFile(javax.servlet.http.HttpServletResponse response, long executionId)
String	getStatus(long executionId)
String	handleAlreadyExists(Exception ex)
String	handleAlreadyRunningOrComplete(Exception ex)
String	handleFileNotFound(Exception ex)
String	handleNotFound(Exception ex)
String	handleNotRunning(Exception ex)
String	handleParametersInvalid(Exception ex)
String	launch(String jobName, org.springframework.util.MultiValueMap<String,String> payload)
void	setJobLogFileNameCreator(JobLogFileNameCreator jobLogFileNameCreator)
String	stop(long executionId)

Methods inherited from class java.lang.Object

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

Field Detail

JOB_PARAMETERS

public static final String JOB_PARAMETERS

See Also:

Constant Field Values

Constructor Detail

JobOperationsController

public JobOperationsController(org.springframework.batch.core.launch.JobOperator jobOperator,
                       org.springframework.batch.core.explore.JobExplorer jobExplorer,
                       org.springframework.batch.core.configuration.JobRegistry jobRegistry,
                       org.springframework.batch.core.repository.JobRepository jobRepository,
                       org.springframework.batch.core.launch.JobLauncher jobLauncher,
                       org.springframework.batch.core.jsr.launch.JsrJobOperator jsrJobOperator)

Method Detail

launch

@RequestMapping(value="/jobs/{jobName}",
                method=POST)
public String launch(@PathVariable
                           String jobName,
                           @RequestParam
                           org.springframework.util.MultiValueMap<String,String> payload)
              throws org.springframework.batch.core.launch.NoSuchJobException,
                     org.springframework.batch.core.launch.JobInstanceAlreadyExistsException,
                     org.springframework.batch.core.JobParametersInvalidException,
                     org.springframework.batch.core.repository.JobExecutionAlreadyRunningException,
                     org.springframework.batch.core.repository.JobRestartException,
                     org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

Throws:

org.springframework.batch.core.launch.NoSuchJobException

org.springframework.batch.core.launch.JobInstanceAlreadyExistsException

org.springframework.batch.core.JobParametersInvalidException

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

getStatus

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

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

getLogFile

@RequestMapping(value="/jobs/executions/{executionId}/log",
                method=GET)
public void getLogFile(javax.servlet.http.HttpServletResponse response,
                             @PathVariable
                             long executionId)
                throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                       IOException

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

IOException

stop

@RequestMapping(value="/jobs/executions/{executionId}",
                method=DELETE)
public String stop(@PathVariable
                         long executionId)
            throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                   org.springframework.batch.core.launch.JobExecutionNotRunningException

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

org.springframework.batch.core.launch.JobExecutionNotRunningException

handleNotFound

@ResponseStatus(value=NOT_FOUND)
@ExceptionHandler(value={org.springframework.batch.core.launch.NoSuchJobException.class,org.springframework.batch.core.launch.NoSuchJobExecutionException.class,javax.batch.operations.JobStartException.class})
public String handleNotFound(Exception ex)

handleAlreadyExists

@ResponseStatus(value=CONFLICT)
@ExceptionHandler(value={org.springframework.batch.core.UnexpectedJobExecutionException.class,org.springframework.batch.core.launch.JobInstanceAlreadyExistsException.class})
public String handleAlreadyExists(Exception ex)

handleAlreadyRunningOrComplete

@ResponseStatus(value=CONFLICT)
@ExceptionHandler(value={org.springframework.batch.core.repository.JobExecutionAlreadyRunningException.class,javax.batch.operations.JobExecutionAlreadyCompleteException.class,org.springframework.batch.core.repository.JobRestartException.class})
public String handleAlreadyRunningOrComplete(Exception ex)

handleParametersInvalid

@ResponseStatus(value=UNPROCESSABLE_ENTITY)
@ExceptionHandler(value=org.springframework.batch.core.JobParametersInvalidException.class)
public String handleParametersInvalid(Exception ex)

handleFileNotFound

@ResponseStatus(value=NOT_FOUND)
@ExceptionHandler(value=java.io.FileNotFoundException.class)
public String handleFileNotFound(Exception ex)

handleNotRunning

@ResponseStatus(value=CONFLICT)
@ExceptionHandler(value=org.springframework.batch.core.launch.JobExecutionNotRunningException.class)
public String handleNotRunning(Exception ex)

setJobLogFileNameCreator

@Autowired(required=false)
public void setJobLogFileNameCreator(JobLogFileNameCreator jobLogFileNameCreator)