org.springframework.batch.step.tasklet.x

Class AbstractProcessBuilderTasklet

java.lang.Object

org.springframework.batch.step.tasklet.x.AbstractProcessBuilderTasklet

All Implemented Interfaces:

org.springframework.batch.core.step.tasklet.Tasklet, org.springframework.batch.core.StepExecutionListener, org.springframework.batch.core.StepListener, org.springframework.beans.factory.Aware, org.springframework.context.EnvironmentAware

Direct Known Subclasses:

GploadTasklet, SqoopTasklet

public abstract class AbstractProcessBuilderTasklet
extends java.lang.Object
implements org.springframework.batch.core.step.tasklet.Tasklet, org.springframework.context.EnvironmentAware, org.springframework.batch.core.StepExecutionListener

Abstract tasklet for running code in a separate process and capturing the log output. The step execution context will be updated with some runtime information as well as with the log output. Note: This this class is not thread-safe.

Since:

1.1

Author:

Thomas Rrisberg

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.core.env.ConfigurableEnvironment	environment
protected int	exitCode Exit code of job
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractProcessBuilderTasklet()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnvironmentProvider(EnvironmentProvider environmentProvider)
org.springframework.batch.core.ExitStatus	afterStep(org.springframework.batch.core.StepExecution stepExecution)
void	beforeStep(org.springframework.batch.core.StepExecution stepExecution)
protected abstract java.util.List<java.lang.String>	createCommand()
org.springframework.batch.repeat.RepeatStatus	execute(org.springframework.batch.core.StepContribution contribution, org.springframework.batch.core.scope.context.ChunkContext chunkContext)
protected abstract java.lang.String	getCommandDescription()
protected abstract java.lang.String	getCommandDisplayString()
protected abstract java.lang.String	getCommandName()
protected java.lang.String	getFirstExceptionMessage(java.util.List<java.lang.String> out, java.util.List<java.lang.String> err)
protected java.util.List<java.lang.String>	getProcessOutput(java.io.File f)
protected abstract boolean	isStoppable()
protected void	printLog(java.lang.String commandName, java.util.List<java.lang.String> out, java.util.List<java.lang.String> err)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setJobExplorer(org.springframework.batch.core.explore.JobExplorer jobExplorer)
void	setSystemProcessExitCodeMapper(org.springframework.batch.core.step.tasklet.SystemProcessExitCodeMapper systemProcessExitCodeMapper)
void	setTerminationCheckInterval(long checkInterval) The time interval how often the tasklet will check for termination status.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

environment

protected org.springframework.core.env.ConfigurableEnvironment environment

exitCode

protected int exitCode

Exit code of job

Constructor Detail

AbstractProcessBuilderTasklet

public AbstractProcessBuilderTasklet()

Method Detail

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

addEnvironmentProvider

public void addEnvironmentProvider(EnvironmentProvider environmentProvider)

execute

public org.springframework.batch.repeat.RepeatStatus execute(org.springframework.batch.core.StepContribution contribution,
                                                    org.springframework.batch.core.scope.context.ChunkContext chunkContext)
                                                      throws java.lang.Exception

Specified by:

execute in interface org.springframework.batch.core.step.tasklet.Tasklet

Throws:

java.lang.Exception

beforeStep

public void beforeStep(org.springframework.batch.core.StepExecution stepExecution)

Specified by:

beforeStep in interface org.springframework.batch.core.StepExecutionListener

afterStep

public org.springframework.batch.core.ExitStatus afterStep(org.springframework.batch.core.StepExecution stepExecution)

Specified by:

afterStep in interface org.springframework.batch.core.StepExecutionListener

isStoppable

protected abstract boolean isStoppable()

createCommand

protected abstract java.util.List<java.lang.String> createCommand()
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getCommandDisplayString

protected abstract java.lang.String getCommandDisplayString()

getCommandName

protected abstract java.lang.String getCommandName()

getCommandDescription

protected abstract java.lang.String getCommandDescription()

getProcessOutput

protected java.util.List<java.lang.String> getProcessOutput(java.io.File f)

printLog

protected void printLog(java.lang.String commandName,
            java.util.List<java.lang.String> out,
            java.util.List<java.lang.String> err)

getFirstExceptionMessage

protected java.lang.String getFirstExceptionMessage(java.util.List<java.lang.String> out,
                                        java.util.List<java.lang.String> err)

setJobExplorer

public void setJobExplorer(org.springframework.batch.core.explore.JobExplorer jobExplorer)

setSystemProcessExitCodeMapper

public void setSystemProcessExitCodeMapper(org.springframework.batch.core.step.tasklet.SystemProcessExitCodeMapper systemProcessExitCodeMapper)

Parameters:

systemProcessExitCodeMapper - maps system process return value to ExitStatus returned by Tasklet. SimpleSystemProcessExitCodeMapper is used by default.

setTerminationCheckInterval

public void setTerminationCheckInterval(long checkInterval)

The time interval how often the tasklet will check for termination status.

Parameters:

checkInterval - time interval in milliseconds (1 second by default).