de.codecentric.batch.listener

Class LoggingListener

java.lang.Object

de.codecentric.batch.listener.LoggingListener

All Implemented Interfaces:

org.springframework.batch.core.JobExecutionListener, org.springframework.batch.core.StepExecutionListener, org.springframework.batch.core.StepListener, org.springframework.core.Ordered

public class LoggingListener
extends Object
implements org.springframework.batch.core.JobExecutionListener, org.springframework.batch.core.StepExecutionListener, org.springframework.core.Ordered

This listener writes the job log file name to the MDC so that it can be picked up by the logging framework for logging to it. It's a JobExecutionListener and a StepExecutionListener because in partitioning we may have a lot of StepExecutions running in different threads. Due to the fact that the afterStep - method would remove the variable from the MDC in single threaded execution we need to re-set it, that's what's the LoggingAfterJobListener is for. Note that, of the three local parallelization features in Spring Batch, log file separation only works for partitioning and parallel step, not for multi-threaded step. The log file name is determined by a JobLogFileNameCreator. It's default implementation DefaultJobLogFileNameCreator is used when there's no other bean of this type in the ApplicationContext.

Author:

Tobias Flohre

Field Summary

Fields

Modifier and Type	Field and Description
static String	JOBLOG_FILENAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
LoggingListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterJob(org.springframework.batch.core.JobExecution jobExecution)
org.springframework.batch.core.ExitStatus	afterStep(org.springframework.batch.core.StepExecution stepExecution)
void	beforeJob(org.springframework.batch.core.JobExecution jobExecution)
void	beforeStep(org.springframework.batch.core.StepExecution stepExecution)
int	getOrder()
void	setJobLogFileNameCreator(JobLogFileNameCreator jobLogFileNameCreator)

Methods inherited from class java.lang.Object

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

Field Detail

JOBLOG_FILENAME

public static final String JOBLOG_FILENAME

See Also:

Constant Field Values

Constructor Detail

LoggingListener

public LoggingListener()

Method Detail

beforeJob

public void beforeJob(org.springframework.batch.core.JobExecution jobExecution)

Specified by:

beforeJob in interface org.springframework.batch.core.JobExecutionListener

afterJob

public void afterJob(org.springframework.batch.core.JobExecution jobExecution)

Specified by:

afterJob in interface org.springframework.batch.core.JobExecutionListener

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

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setJobLogFileNameCreator

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