A B C D E F G H I J L M O P R S T W

A

AbstractBatchMetricsAspect - Class in de.codecentric.batch.metrics

This is a helper class for implementing method level profiling.

AbstractBatchMetricsAspect(GaugeService) - Constructor for class de.codecentric.batch.metrics.AbstractBatchMetricsAspect

addApplicationContextFactories(AutomaticJobRegistrar) - Method in class de.codecentric.batch.configuration.AutomaticJobRegistrarConfiguration

addApplicationContextFactories(AutomaticJobRegistrar) - Method in class de.codecentric.batch.configuration.AutomaticJobRegistrarConfigurationSupport

Add ApplicationContextFactories to the given job registrar.

addListenerToJob(AbstractJob) - Method in class de.codecentric.batch.listener.AddListenerToJobService

addListenerToJobService() - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

AddListenerToJobService - Class in de.codecentric.batch.listener

This service adds listeners to jobs.

AddListenerToJobService(boolean, boolean, ProtocolListener, RunningExecutionTrackerListener, LoggingListener, LoggingAfterJobListener) - Constructor for class de.codecentric.batch.listener.AddListenerToJobService

addRunningExecution(String, Long) - Method in class de.codecentric.batch.monitoring.RunningExecutionTracker

afterCompletion(int) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

afterJob(JobExecution) - Method in class de.codecentric.batch.listener.LoggingAfterJobListener

afterJob(JobExecution) - Method in class de.codecentric.batch.listener.LoggingListener

afterJob(JobExecution) - Method in class de.codecentric.batch.listener.ProtocolListener

afterJob(JobExecution) - Method in class de.codecentric.batch.listener.RunningExecutionTrackerListener

afterJob(JobExecution) - Method in class de.codecentric.batch.metrics.MetricsListener

afterStep(StepExecution) - Method in class de.codecentric.batch.listener.LoggingListener

afterStep(StepExecution) - Method in class de.codecentric.batch.metrics.MetricsListener

AutomaticJobRegistrarConfiguration - Class in de.codecentric.batch.configuration

Configuration for registration of ApplicationContextFactory with the AutomaticJobRegistrar that is instantiated inside the ModularBatchConfiguration.

AutomaticJobRegistrarConfiguration() - Constructor for class de.codecentric.batch.configuration.AutomaticJobRegistrarConfiguration

AutomaticJobRegistrarConfigurationSupport - Class in de.codecentric.batch.configuration

Extend this class to add custom ApplicationContextFactory.

AutomaticJobRegistrarConfigurationSupport() - Constructor for class de.codecentric.batch.configuration.AutomaticJobRegistrarConfigurationSupport

B

BaseConfiguration - Class in de.codecentric.batch.configuration

I don't like autowiring of business components, I prefer to reference them from a JavaConfig configuration class.

BaseConfiguration() - Constructor for class de.codecentric.batch.configuration.BaseConfiguration

batchMetrics() - Method in class de.codecentric.batch.configuration.MetricsConfiguration

BatchMetrics - Interface in de.codecentric.batch.metrics

Interface for business metrics.

batchMetricsAspects() - Method in class de.codecentric.batch.configuration.MetricsConfiguration

BatchMetricsImpl - Class in de.codecentric.batch.metrics

See BatchMetrics for documentation.

BatchMetricsImpl() - Constructor for class de.codecentric.batch.metrics.BatchMetricsImpl

BatchWebAutoConfiguration - Class in de.codecentric.batch.configuration

This configuration class will be picked up by Spring Boot's auto configuration capabilities as soon as it's on the classpath.

BatchWebAutoConfiguration() - Constructor for class de.codecentric.batch.configuration.BatchWebAutoConfiguration

beforeJob(JobExecution) - Method in class de.codecentric.batch.listener.LoggingAfterJobListener

beforeJob(JobExecution) - Method in class de.codecentric.batch.listener.LoggingListener

beforeJob(JobExecution) - Method in class de.codecentric.batch.listener.ProtocolListener

beforeJob(JobExecution) - Method in class de.codecentric.batch.listener.RunningExecutionTrackerListener

beforeJob(JobExecution) - Method in class de.codecentric.batch.metrics.MetricsListener

beforeStep(StepExecution) - Method in class de.codecentric.batch.listener.LoggingListener

C

configureMessageConverters(List<HttpMessageConverter<?>>) - Method in class de.codecentric.batch.configuration.WebConfig

createJobRepository() - Method in class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

CustomJsrJobOperator - Class in de.codecentric.batch.jsr352

We cannot use Spring Batch's JsrJobOperator out of two reasons:

CustomJsrJobOperator(JobExplorer, JobRepository, JobParametersConverter, AddListenerToJobService, PlatformTransactionManager) - Constructor for class de.codecentric.batch.jsr352.CustomJsrJobOperator

D

dataSource() - Method in class de.codecentric.batch.configuration.BaseConfiguration

de.codecentric.batch.configuration - package de.codecentric.batch.configuration

de.codecentric.batch.jsr352 - package de.codecentric.batch.jsr352

de.codecentric.batch.listener - package de.codecentric.batch.listener

de.codecentric.batch.logging - package de.codecentric.batch.logging

de.codecentric.batch.metrics - package de.codecentric.batch.metrics

de.codecentric.batch.monitoring - package de.codecentric.batch.monitoring

de.codecentric.batch.scheduling.concurrent - package de.codecentric.batch.scheduling.concurrent

de.codecentric.batch.web - package de.codecentric.batch.web

decrement(String) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Decrement the specified counter by 1.

decrement(String, Long) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Decrement the specified counter by the given value.

decrement(String) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

decrement(String, Long) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

decrementNonTransactional(String) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Decrement the specified counter by 1.

decrementNonTransactional(String, Long) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Decrement the specified counter by the given value.

decrementNonTransactional(String) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

decrementNonTransactional(String, Long) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

DefaultJobLogFileNameCreator - Class in de.codecentric.batch.logging

Default implementation used when there's no other Spring bean implementing JobLogFileNameCreator in the ApplicationContext.

DefaultJobLogFileNameCreator() - Constructor for class de.codecentric.batch.logging.DefaultJobLogFileNameCreator

E

execute(Runnable) - Method in class de.codecentric.batch.scheduling.concurrent.MdcThreadPoolTaskExecutor

All executions will have MDC injected.

F

findAllRunningExecutions() - Method in class de.codecentric.batch.web.JobMonitoringController

findExecution(long) - Method in class de.codecentric.batch.web.JobMonitoringController

findRegisteredJobs() - Method in class de.codecentric.batch.web.JobMonitoringController

findRunningExecutionsForJobName(String) - Method in class de.codecentric.batch.web.JobMonitoringController

format(List<RichGauge>, List<Metric<?>>) - Method in interface de.codecentric.batch.metrics.MetricsOutputFormatter

G

GAUGE_PREFIX - Static variable in class de.codecentric.batch.metrics.MetricsListener

getAllRunningExecutionIds() - Method in class de.codecentric.batch.monitoring.RunningExecutionTracker

getBaseName(JobExecution) - Method in class de.codecentric.batch.logging.DefaultJobLogFileNameCreator

getBaseName(JobExecution) - Method in interface de.codecentric.batch.logging.JobLogFileNameCreator

getExtension() - Method in class de.codecentric.batch.logging.DefaultJobLogFileNameCreator

getExtension() - Method in interface de.codecentric.batch.logging.JobLogFileNameCreator

getJobExplorer() - Method in class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

getJobLauncher() - Method in class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

getJobRepository() - Method in class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

getLogFile(HttpServletResponse, long) - Method in class de.codecentric.batch.web.JobOperationsController

getName(JobExecution) - Method in class de.codecentric.batch.logging.DefaultJobLogFileNameCreator

getName(JobExecution) - Method in interface de.codecentric.batch.logging.JobLogFileNameCreator

getOrder() - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

getOrder() - Method in class de.codecentric.batch.listener.JobLoggingApplicationListener

getOrder() - Method in class de.codecentric.batch.listener.LoggingAfterJobListener

getOrder() - Method in class de.codecentric.batch.listener.LoggingListener

getOrder() - Method in class de.codecentric.batch.listener.ProtocolListener

getOrder() - Method in class de.codecentric.batch.metrics.MetricsListener

getRunningExecutionIdsForJobName(String) - Method in class de.codecentric.batch.monitoring.RunningExecutionTracker

getStatus(long) - Method in class de.codecentric.batch.web.JobOperationsController

getTransactionManager() - Method in class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

H

handleAlreadyExists(Exception) - Method in class de.codecentric.batch.web.JobOperationsController

handleAlreadyRunningOrComplete(Exception) - Method in class de.codecentric.batch.web.JobOperationsController

handleFileNotFound(Exception) - Method in class de.codecentric.batch.web.JobOperationsController

handleNoBootstrapParametersCreatedByIncrementer(Exception) - Method in class de.codecentric.batch.web.JobOperationsController

handleNotFound(Exception) - Method in class de.codecentric.batch.web.JobMonitoringController

handleNotFound(Exception) - Method in class de.codecentric.batch.web.JobOperationsController

handleNotRunning(Exception) - Method in class de.codecentric.batch.web.JobOperationsController

handleParametersInvalid(Exception) - Method in class de.codecentric.batch.web.JobOperationsController

I

increment(String) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Increment the specified counter by 1.

increment(String, Long) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Increment the specified counter by the given value.

increment(String) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

increment(String, Long) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

incrementNonTransactional(String) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Increment the specified counter by 1.

incrementNonTransactional(String, Long) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Increment the specified counter by the given value.

incrementNonTransactional(String) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

incrementNonTransactional(String, Long) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

initialize() - Method in class de.codecentric.batch.configuration.AutomaticJobRegistrarConfigurationSupport

initialize() - Method in class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

J

JOB_PARAMETERS - Static variable in class de.codecentric.batch.web.JobOperationsController

jobExecutionListeners() - Method in interface de.codecentric.batch.configuration.ListenerProvider

Returns a set of JobExecutionListeners that will be added to each Job.

jobExecutionListeners() - Method in class de.codecentric.batch.configuration.MetricsConfiguration

jobExplorer() - Method in class de.codecentric.batch.configuration.BaseConfiguration

jobLauncher() - Method in class de.codecentric.batch.configuration.BaseConfiguration

JOBLOG_FILENAME - Static variable in class de.codecentric.batch.listener.LoggingListener

JobLogFileNameCreator - Interface in de.codecentric.batch.logging

Components implementing this interface specify the name of the job run specific log file.

JobLoggingApplicationListener - Class in de.codecentric.batch.listener

This ApplicationListener makes the batch.joblog.path available before the LoggingSystem is started.

JobLoggingApplicationListener() - Constructor for class de.codecentric.batch.listener.JobLoggingApplicationListener

jobMonitoringController() - Method in class de.codecentric.batch.configuration.WebConfig

JobMonitoringController - Class in de.codecentric.batch.web

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.

JobMonitoringController(JobOperator, JobExplorer, RunningExecutionTracker) - Constructor for class de.codecentric.batch.web.JobMonitoringController

jobOperationsController() - Method in class de.codecentric.batch.configuration.WebConfig

JobOperationsController - Class in de.codecentric.batch.web

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

JobOperationsController(JobOperator, JobExplorer, JobRegistry, JobRepository, JobLauncher, JsrJobOperator) - Constructor for class de.codecentric.batch.web.JobOperationsController

jobOperator() - Method in class de.codecentric.batch.configuration.BaseConfiguration

jobRegistry() - Method in class de.codecentric.batch.configuration.BaseConfiguration

jobRepository() - Method in class de.codecentric.batch.configuration.BaseConfiguration

Jsr352BatchConfiguration - Class in de.codecentric.batch.configuration

This configuration creates the components needed for starting JSR-352 style jobs.

Jsr352BatchConfiguration() - Constructor for class de.codecentric.batch.configuration.Jsr352BatchConfiguration

jsrJobOperator(PlatformTransactionManager) - Method in class de.codecentric.batch.configuration.Jsr352BatchConfiguration

jsrJobParametersConverter() - Method in class de.codecentric.batch.configuration.Jsr352BatchConfiguration

L

launch(String, MultiValueMap<String, String>) - Method in class de.codecentric.batch.web.JobOperationsController

ListenerProvider - Interface in de.codecentric.batch.configuration

spring-boot-starter-batch-web automatically registers JobExecutionListeners and StepExecutionListeners at each Job provided by Spring beans implementing this interface.

loggingAfterJobListener() - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

LoggingAfterJobListener - Class in de.codecentric.batch.listener

This extra listener is needed, because the LoggingListener removes the variable from the MDC in its afterStep method.

LoggingAfterJobListener() - Constructor for class de.codecentric.batch.listener.LoggingAfterJobListener

loggingListener() - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

LoggingListener - Class in de.codecentric.batch.listener

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.

LoggingListener() - Constructor for class de.codecentric.batch.listener.LoggingListener

M

MdcThreadPoolTaskExecutor - Class in de.codecentric.batch.scheduling.concurrent

A SLF4J MDC-compatible ThreadPoolExecutor.

MdcThreadPoolTaskExecutor() - Constructor for class de.codecentric.batch.scheduling.concurrent.MdcThreadPoolTaskExecutor

MdcThreadPoolTaskExecutor(Map<String, String>) - Constructor for class de.codecentric.batch.scheduling.concurrent.MdcThreadPoolTaskExecutor

MetricsConfiguration - Class in de.codecentric.batch.configuration

Configuration containing all metrics stuff.

MetricsConfiguration() - Constructor for class de.codecentric.batch.configuration.MetricsConfiguration

metricsListener() - Method in class de.codecentric.batch.configuration.MetricsConfiguration

MetricsListener - Class in de.codecentric.batch.metrics

This listener exports all metrics with the prefix 'counter.batch.{jobName}.{jobExecutionId}.{stepName} and all gauges with the prefix 'gauge.batch.{jobName}.{stepName}' to the Step- ExecutionContext without the prefix.

MetricsListener(GaugeService, RichGaugeReader, MetricReader, List<Exporter>) - Constructor for class de.codecentric.batch.metrics.MetricsListener

MetricsOutputFormatter - Interface in de.codecentric.batch.metrics

Used in MetricsListener to define the format of the metrics log.

O

onApplicationEvent(ContextRefreshedEvent) - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

onApplicationEvent(ApplicationPreparedEvent) - Method in class de.codecentric.batch.listener.JobLoggingApplicationListener

P

profileMethod(ProceedingJoinPoint) - Method in class de.codecentric.batch.metrics.AbstractBatchMetricsAspect

profileProcessMethods(ProceedingJoinPoint) - Method in class de.codecentric.batch.metrics.ReaderProcessorWriterMetricsAspect

profileReadMethods(ProceedingJoinPoint) - Method in class de.codecentric.batch.metrics.ReaderProcessorWriterMetricsAspect

profileWriteMethods(ProceedingJoinPoint) - Method in class de.codecentric.batch.metrics.ReaderProcessorWriterMetricsAspect

protocolListener() - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

ProtocolListener - Class in de.codecentric.batch.listener

This listener adds a protocol header and a protocol summary to the log.

ProtocolListener() - Constructor for class de.codecentric.batch.listener.ProtocolListener

R

ReaderProcessorWriterMetricsAspect - Class in de.codecentric.batch.metrics

Central aspect-configuration to profile Spring Batch Jobs with AspectJ and Spring Boot Metrics.

ReaderProcessorWriterMetricsAspect(GaugeService) - Constructor for class de.codecentric.batch.metrics.ReaderProcessorWriterMetricsAspect

registerJobsFromJavaConfig(AutomaticJobRegistrar) - Method in class de.codecentric.batch.configuration.AutomaticJobRegistrarConfiguration

registerJobsFromXml(AutomaticJobRegistrar) - Method in class de.codecentric.batch.configuration.AutomaticJobRegistrarConfiguration

removeRunningExecution(Long) - Method in class de.codecentric.batch.monitoring.RunningExecutionTracker

reset(String) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Reset the specified counter.

reset(String) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

resetNonTransactional(String) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Reset the specified counter.

resetNonTransactional(String) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

runningExecutionTracker() - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

RunningExecutionTracker - Class in de.codecentric.batch.monitoring

Container for keeping track of running JobExecutions in this application.

RunningExecutionTracker() - Constructor for class de.codecentric.batch.monitoring.RunningExecutionTracker

runningExecutionTrackerListener() - Method in class de.codecentric.batch.configuration.BatchWebAutoConfiguration

RunningExecutionTrackerListener - Class in de.codecentric.batch.listener

This listener is needed for tracking the running JobExecutions on this server.

RunningExecutionTrackerListener(RunningExecutionTracker) - Constructor for class de.codecentric.batch.listener.RunningExecutionTrackerListener

S

setApplicationContext(ApplicationContext) - Method in class de.codecentric.batch.jsr352.CustomJsrJobOperator

setDataSource(DataSource) - Method in class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

setJobLogFileNameCreator(JobLogFileNameCreator) - Method in class de.codecentric.batch.listener.LoggingAfterJobListener

setJobLogFileNameCreator(JobLogFileNameCreator) - Method in class de.codecentric.batch.listener.LoggingListener

setJobLogFileNameCreator(JobLogFileNameCreator) - Method in class de.codecentric.batch.web.JobOperationsController

setListenerProviders(Set<ListenerProvider>) - Method in class de.codecentric.batch.listener.AddListenerToJobService

setMetricsOutputFormatter(MetricsOutputFormatter) - Method in class de.codecentric.batch.metrics.MetricsListener

setTaskExecutor(TaskExecutor) - Method in class de.codecentric.batch.jsr352.CustomJsrJobOperator

start(String, Properties) - Method in class de.codecentric.batch.jsr352.CustomJsrJobOperator

StepExecutionJacksonMixIn - Class in de.codecentric.batch.configuration

Jackson MixIn for StepExecution serialization.

StepExecutionJacksonMixIn() - Constructor for class de.codecentric.batch.configuration.StepExecutionJacksonMixIn

stepExecutionListeners() - Method in interface de.codecentric.batch.configuration.ListenerProvider

Returns a set of StepExecutionListeners that will be added to each Job.

stepExecutionListeners() - Method in class de.codecentric.batch.configuration.MetricsConfiguration

stop(long) - Method in class de.codecentric.batch.web.JobOperationsController

submit(String, double) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Set the specified gauge value.

submit(String, double) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

submitNonTransactional(String, double) - Method in interface de.codecentric.batch.metrics.BatchMetrics

Set the specified gauge value

submitNonTransactional(String, double) - Method in class de.codecentric.batch.metrics.BatchMetricsImpl

T

taskExecutor() - Method in class de.codecentric.batch.configuration.BaseConfiguration

taskExecutor() - Method in class de.codecentric.batch.configuration.TaskExecutorConfiguration

TaskExecutorBatchConfigurer - Class in de.codecentric.batch.configuration

This batch infrastructure configuration is quite similar to the DefaultBatchConfigurer, it only references a TaskExecutor used in the SimpleJobLauncher for starting jobs asynchronously.

TaskExecutorBatchConfigurer() - Constructor for class de.codecentric.batch.configuration.TaskExecutorBatchConfigurer

TaskExecutorConfiguration - Class in de.codecentric.batch.configuration

This is the default configuration for a TaskExecutor used in the SimpleJobLauncher for starting jobs asynchronously.

TaskExecutorConfiguration() - Constructor for class de.codecentric.batch.configuration.TaskExecutorConfiguration

TIMER_PREFIX - Static variable in class de.codecentric.batch.metrics.AbstractBatchMetricsAspect

TIMER_PREFIX - Static variable in class de.codecentric.batch.metrics.MetricsListener

W

WebConfig - Class in de.codecentric.batch.configuration

This configuration adds the controllers for the two endpoints, and it adds a Jackson MixIn to the message converter to avoid a stack overflow through circular references in the JobExecution / StepExecution.

WebConfig() - Constructor for class de.codecentric.batch.configuration.WebConfig

wrap(Runnable, Map<String, String>) - Static method in class de.codecentric.batch.scheduling.concurrent.MdcThreadPoolTaskExecutor

A B C D E F G H I J L M O P R S T W