Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abandon(long) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- abandon(long) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Abandon the job execution with the given ID.
- abandon(long) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- abandon(JobExecution) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Mark the
JobExecutionas ABANDONED. - abandon(JobExecution) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- abandon(JobExecution) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- ABANDONED - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
Status of a batch job that did not stop properly and can not be restarted.
- abandonStepExecution() - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
-
Handle any status changes that might be needed at the start of a state.
- abandonStepExecution() - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- AbstractApplicationContextFactory - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- AbstractApplicationContextFactory(Object...) - Constructor for class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Create a factory instance with the resource specified.
- AbstractFlowParser - Class in org.springframework.batch.core.configuration.xml
- AbstractFlowParser() - Constructor for class org.springframework.batch.core.configuration.xml.AbstractFlowParser
- AbstractJdbcBatchMetadataDao - Class in org.springframework.batch.core.repository.dao
-
Encapsulates common functionality needed by JDBC batch metadata DAOs - provides jdbcTemplate for subclasses and handles table prefixes.
- AbstractJdbcBatchMetadataDao() - Constructor for class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- AbstractJob - Class in org.springframework.batch.core.job
-
Abstract implementation of the
Jobinterface. - AbstractJob() - Constructor for class org.springframework.batch.core.job.AbstractJob
-
Default constructor.
- AbstractJob(String) - Constructor for class org.springframework.batch.core.job.AbstractJob
-
Convenience constructor to immediately add name (which is mandatory but not final).
- AbstractJobExplorerFactoryBean - Class in org.springframework.batch.core.repository.explore.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- AbstractJobExplorerFactoryBean() - Constructor for class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.
- AbstractJobRepositoryFactoryBean - Class in org.springframework.batch.core.repository.support
-
A
FactoryBeanthat automates the creation of aSimpleJobRepository. - AbstractJobRepositoryFactoryBean() - Constructor for class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- AbstractListenerFactoryBean<T> - Class in org.springframework.batch.core.listener
-
FactoryBeanimplementation that builds a listener based on the various lifecycle methods or annotations that are provided. - AbstractListenerFactoryBean() - Constructor for class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- AbstractListenerParser - Class in org.springframework.batch.core.configuration.xml
- AbstractListenerParser() - Constructor for class org.springframework.batch.core.configuration.xml.AbstractListenerParser
- AbstractPartitionHandler - Class in org.springframework.batch.core.partition.support
-
Base
PartitionHandlerimplementation providing common base features. - AbstractPartitionHandler() - Constructor for class org.springframework.batch.core.partition.support.AbstractPartitionHandler
- AbstractState - Class in org.springframework.batch.core.job.flow.support.state
- AbstractState(String) - Constructor for class org.springframework.batch.core.job.flow.support.state.AbstractState
- AbstractStep - Class in org.springframework.batch.core.step
-
A
Stepimplementation that provides common behavior to subclasses, including registering and calling listeners. - AbstractStep() - Constructor for class org.springframework.batch.core.step.AbstractStep
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 for removal in 7.0. Use
AbstractStep(JobRepository)instead. - AbstractStep(String) - Constructor for class org.springframework.batch.core.step.AbstractStep
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 for removal in 7.0. Use
AbstractStep(JobRepository)instead. - AbstractStep(JobRepository) - Constructor for class org.springframework.batch.core.step.AbstractStep
-
Create a new
AbstractStepwith the given job repository. - AbstractStepParser - Class in org.springframework.batch.core.configuration.xml
-
Internal parser for the <step/> elements inside a job.
- AbstractStepParser() - Constructor for class org.springframework.batch.core.configuration.xml.AbstractStepParser
- AbstractTaskletStepBuilder<B> - Class in org.springframework.batch.core.step.builder
-
Base class for step builders that want to build a
TaskletStep. - AbstractTaskletStepBuilder(AbstractTaskletStepBuilder) - Constructor for class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Create a new builder initialized with any properties in the parent.
- AbstractTaskletStepBuilder(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- add(Flow...) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.SplitBuilder
-
Add flows to the split, in addition to the current state already present in the parent builder.
- addApplicationContextFactory(ApplicationContextFactory) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.Add a single
ApplicationContextFactoryto the set that is used to load contexts and jobs. - addDate(String, Date) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
Dateparameter for the given key. - addDate(String, Date, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
Dateparameter for the given key. - addDouble(String, Double) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
Doubleparameter for the given key. - addDouble(String, Double, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
Doubleparameter for the given key. - addExitDescription(String) - Method in class org.springframework.batch.core.ExitStatus
-
Add an exit description to an existing
ExitStatus. - addExitDescription(Throwable) - Method in class org.springframework.batch.core.ExitStatus
-
Extract the stack trace from the throwable provided and append it to the existing description.
- addExitStatus(String) - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
- addExitStatus(String) - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- addFailureException(Throwable) - Method in class org.springframework.batch.core.job.JobExecution
-
Add the provided throwable to the failure exception list.
- addFailureException(Throwable) - Method in class org.springframework.batch.core.step.StepExecution
-
Add a
Throwableto failure exceptions. - addJobExecution(JobExecution) - Method in class org.springframework.batch.core.job.JobInstance
- addJobExecutionListener(JobExecutionListener) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- addJobParameter(String, T, Class) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add an identifying job parameter.
- addJobParameter(String, T, Class, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a job parameter.
- addJobParameter(JobParameter) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
JobParameterfor the given key. - addJobParameters(JobParameters) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Copy job parameters into the current state.
- addLocalDate(String, LocalDate) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
LocalDateparameter for the given key. - addLocalDate(String, LocalDate, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
LocalDateparameter for the given key. - addLocalDateTime(String, LocalDateTime) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
LocalDateTimeparameter for the given key. - addLocalDateTime(String, LocalDateTime, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
LocalDateTimeparameter for the given key. - addLocalTime(String, LocalTime) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
LocalTimeparameter for the given key. - addLocalTime(String, LocalTime, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
LocalTimeparameter for the given key. - addLong(String, Long) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
Longparameter for the given key. - addLong(String, Long, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
Longparameter for the given key. - addStep(Step) - Method in class org.springframework.batch.core.job.SimpleJob
-
Convenience method for adding a single step to the job.
- addStepExecution(StepExecution) - Method in class org.springframework.batch.core.job.JobExecution
-
Add a step execution.
- addStepExecutionListener(StepExecutionListener) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- addStepExecutionListeners(List) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- addStepExecutionListeners(List) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- addStepExecutions(List) - Method in class org.springframework.batch.core.job.JobExecution
-
Add some step executions.
- addString(String, String) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying String parameter for the given key.
- addString(String, String, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new String parameter for the given key.
- AFTER_CHUNK - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- AFTER_CHUNK_ERROR - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- AFTER_JOB - Enum constant in enum class org.springframework.batch.core.listener.JobListenerMetaData
- AFTER_PROCESS - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- AFTER_READ - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- AFTER_STEP - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- AFTER_WRITE - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- afterChunk(ChunkContext) - Method in interface org.springframework.batch.core.listener.ChunkListener
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
ChunkListener.afterChunk(Chunk)instead. Scheduled for removal in 6.2 or later. - afterChunk(ChunkContext) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
CompositeChunkListener.afterChunk(Chunk)instead. Scheduled for removal in 6.2 or later. - afterChunk(ChunkContext) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- afterChunk(Chunk) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Call the registered listeners in reverse order.
- afterChunk(Chunk) - Method in interface org.springframework.batch.core.listener.ChunkListener
-
Callback after the chunk is written, inside the transaction.
- AfterChunk - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after a chunk is processed.
- afterChunkError(ChunkContext) - Method in interface org.springframework.batch.core.listener.ChunkListener
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
ChunkListener.onChunkError(Exception,Chunk)instead. Scheduled for removal in 6.2 or later. - afterChunkError(ChunkContext) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
CompositeChunkListener.onChunkError(Exception,Chunk)instead. Scheduled for removal in 6.2 or later. - afterChunkError(ChunkContext) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- AfterChunkError - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after a chunk has failed and been marked for rollback.
Expected signature: void afterFailedChunk(ChunkContext context) - afterJob(JobExecution) - Method in class org.springframework.batch.core.listener.CompositeJobExecutionListener
-
Call the registered listeners in reverse order, respecting and prioritising those that implement
Ordered. - afterJob(JobExecution) - Method in interface org.springframework.batch.core.listener.JobExecutionListener
-
Callback after completion of a job.
- AfterJob - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after a
Jobhas completed. - afterProcess(T, S) - Method in class org.springframework.batch.core.listener.CompositeItemProcessListener
-
Call the registered listeners in reverse order, respecting and prioritising those that implement
Ordered. - afterProcess(T, S) - Method in interface org.springframework.batch.core.listener.ItemProcessListener
-
Called after
ItemProcessor.process(Object)returns. - afterProcess(T, S) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- AfterProcess - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after an item is passed to an
ItemProcessor. - afterPropertiesSet() - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- afterPropertiesSet() - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.
- afterPropertiesSet() - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.Make sure the registry is set before use.
- afterPropertiesSet() - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
-
Check mandatory properties (name).
- afterPropertiesSet() - Method in class org.springframework.batch.core.job.AbstractJob
-
Assert mandatory properties:
JobRepository. - afterPropertiesSet() - Method in class org.springframework.batch.core.job.flow.FlowStep
-
Ensure that the flow is set.
- afterPropertiesSet() - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
-
Locate start state and pre-populate data structures needed for execution.
- afterPropertiesSet() - Method in class org.springframework.batch.core.job.parameters.CompositeJobParametersValidator
- afterPropertiesSet() - Method in class org.springframework.batch.core.job.parameters.DefaultJobParametersValidator
-
Check that there are no overlaps between required and optional keys.
- afterPropertiesSet() - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
- afterPropertiesSet() - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.Check mandatory properties.
- afterPropertiesSet() - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.Ensure the required dependencies of a
JobRepositoryhave been set. - afterPropertiesSet() - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- afterPropertiesSet() - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- afterPropertiesSet() - Method in class org.springframework.batch.core.listener.ExecutionContextPromotionListener
- afterPropertiesSet() - Method in class org.springframework.batch.core.partition.PartitionStep
-
Assert that mandatory properties are set (stepExecutionSplitter, partitionHandler) and delegate top superclass.
- afterPropertiesSet() - Method in class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.explore.support.MongoJobExplorerFactoryBean
-
Deprecated.
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- afterPropertiesSet() - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- afterPropertiesSet() - Method in class org.springframework.batch.core.step.AbstractStep
- afterPropertiesSet() - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
- afterPropertiesSet() - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Check mandatory properties.
- afterPropertiesSet() - Method in class org.springframework.batch.core.step.job.JobStep
- afterPropertiesSet() - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- afterPropertiesSet() - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
- afterRead(T) - Method in class org.springframework.batch.core.listener.CompositeItemReadListener
-
Call the registered listeners in reverse order, respecting and prioritising those that implement
Ordered. - afterRead(T) - Method in interface org.springframework.batch.core.listener.ItemReadListener
-
Called after
ItemReader.read(). - afterRead(T) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- AfterRead - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after an item is read from an
ItemReader
Expected signature: void afterRead(T item) - afterSingletonsInstantiated() - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.
- afterSingletonsInstantiated() - Method in class org.springframework.batch.core.configuration.support.MapJobRegistry
- afterStep(StepExecution) - Method in class org.springframework.batch.core.listener.CompositeStepExecutionListener
-
Call the registered listeners in reverse order, respecting and prioritizing those that implement
Ordered. - afterStep(StepExecution) - Method in class org.springframework.batch.core.listener.ExecutionContextPromotionListener
- afterStep(StepExecution) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- afterStep(StepExecution) - Method in interface org.springframework.batch.core.listener.StepExecutionListener
-
Give a listener a chance to modify the exit status from a step.
- afterStep(StepExecution) - Method in class org.springframework.batch.core.step.NoWorkFoundStepExecutionListener
- AfterStep - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after a
Stephas completed. - afterWrite(Chunk) - Method in class org.springframework.batch.core.listener.CompositeItemWriteListener
-
Call the registered listeners in reverse order, respecting and prioritising those that implement
Ordered. - afterWrite(Chunk) - Method in interface org.springframework.batch.core.listener.ItemWriteListener
-
Called after
ItemWriter.write(Chunk). - afterWrite(Chunk) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- AfterWrite - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after an item is passed to an
ItemWriter. - aggregate(Collection) - Method in interface org.springframework.batch.core.job.flow.support.state.FlowExecutionAggregator
- aggregate(Collection) - Method in class org.springframework.batch.core.job.flow.support.state.MaxValueFlowExecutionAggregator
-
Aggregate all of the
FlowExecutionStatuses of theFlowExecutions into one status. - aggregate(StepExecution, Collection) - Method in interface org.springframework.batch.core.partition.StepExecutionAggregator
-
Take the inputs and aggregate, putting the aggregates into the result.
- aggregate(StepExecution, Collection) - Method in class org.springframework.batch.core.partition.support.DefaultStepExecutionAggregator
-
Aggregates the input executions into the result
StepExecution. - aggregate(StepExecution, Collection) - Method in class org.springframework.batch.core.partition.support.RemoteStepExecutionAggregator
-
Aggregates the input executions into the result
StepExecutiondelegating to the delegate aggregator once the input has been refreshed from theJobRepository. - aggregator(StepExecutionAggregator) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Provide a step execution aggregator for aggregating partitioned step executions into a single result for the
PartitionStepitself. - allowStartIfComplete(boolean) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- AlwaysSkipItemSkipPolicy - Class in org.springframework.batch.core.step.skip
-
Implementation of the
SkipPolicyinterface that will always return that an item should be skipped. - AlwaysSkipItemSkipPolicy() - Constructor for class org.springframework.batch.core.step.skip.AlwaysSkipItemSkipPolicy
- and(ExitStatus) - Method in class org.springframework.batch.core.ExitStatus
-
Create a new
ExitStatuswith a logical combination of the exit code and a concatenation of the descriptions. - applicationContext - Variable in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
- ApplicationContextFactory - Interface in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- ApplicationContextJobFactory - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- ApplicationContextJobFactory(String, ApplicationContextFactory) - Constructor for class org.springframework.batch.core.configuration.support.ApplicationContextJobFactory
-
Deprecated.
- apply(StepContribution) - Method in class org.springframework.batch.core.step.StepExecution
-
This method should be called on successful execution just before a chunk commit.
- applyConfiguration(SimpleStepBuilder) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.
- applyConfiguration(SimpleStepBuilder) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- AutomaticJobRegistrar - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- AutomaticJobRegistrar() - Constructor for class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- autoregisterBeansForNamespace(ParserContext, Object) - Static method in class org.springframework.batch.core.configuration.xml.CoreNamespaceUtils
-
Create the beans based on the content of the source.
B
- backOffPolicy(BackOffPolicy) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Provide a backoff policy to prevent items being retried immediately (e.g. in case the failure was caused by a remote resource failure that might take some time to be resolved).
- BATCH_VERSION_KEY - Static variable in class org.springframework.batch.core.SpringBatchVersion
-
The key to use in the execution context for batch version.
- BatchConfigurationException - Exception Class in org.springframework.batch.core.configuration
-
Represents that an error has occurred in the configuration of the base batch infrastructure (the creation of a
JobRepository, for example). - BatchConfigurationException(String) - Constructor for exception class org.springframework.batch.core.configuration.BatchConfigurationException
-
Create an exception with the given message.
- BatchConfigurationException(String, Throwable) - Constructor for exception class org.springframework.batch.core.configuration.BatchConfigurationException
-
Create an exception with the given message and
Throwable. - BatchConfigurationException(Throwable) - Constructor for exception class org.springframework.batch.core.configuration.BatchConfigurationException
-
Create an exception with the given
Throwable. - BatchMetrics - Class in org.springframework.batch.core.observability
-
Central class for batch metrics.
- BatchObservabilityBeanPostProcessor - Class in org.springframework.batch.core.configuration.annotation
-
Bean post processor that configures observable batch artifacts (typically jobs and steps) with a Micrometer's observation registry.
- BatchObservabilityBeanPostProcessor() - Constructor for class org.springframework.batch.core.configuration.annotation.BatchObservabilityBeanPostProcessor
- BatchRetryTemplate - Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 with no replacement. Scheduled for removal in 7.0.
- BatchRetryTemplate() - Constructor for class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- BatchScopeSupport - Class in org.springframework.batch.core.scope
-
ScopeSupport.
- BatchScopeSupport(String) - Constructor for class org.springframework.batch.core.scope.BatchScopeSupport
- BatchScopeSupport.Scopifier - Class in org.springframework.batch.core.scope
-
Helper class to scan a bean definition hierarchy and force the use of auto-proxy for step scoped beans.
- BatchStatus - Enum Class in org.springframework.batch.core
-
Enumeration representing the status of an execution.
- BeanDefinitionUtils - Class in org.springframework.batch.core.configuration.xml
- BEFORE_CHUNK - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- BEFORE_JOB - Enum constant in enum class org.springframework.batch.core.listener.JobListenerMetaData
- BEFORE_PROCESS - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- BEFORE_READ - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- BEFORE_STEP - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- BEFORE_WRITE - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- beforeChunk(ChunkContext) - Method in interface org.springframework.batch.core.listener.ChunkListener
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
ChunkListener.beforeChunk(Chunk)instead. Scheduled for removal in 6.2 or later. - beforeChunk(ChunkContext) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
CompositeChunkListener.beforeChunk(Chunk)instead. Scheduled for removal in 6.2 or later. - beforeChunk(ChunkContext) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- beforeChunk(Chunk) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Call the registered listeners in order, respecting and prioritizing those that implement
Ordered. - beforeChunk(Chunk) - Method in interface org.springframework.batch.core.listener.ChunkListener
-
Callback after a chunk is read but before it is processed, inside the transaction.
- BeforeChunk - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called before a chunk is executed.
- beforeJob(JobExecution) - Method in class org.springframework.batch.core.listener.CompositeJobExecutionListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered. - beforeJob(JobExecution) - Method in interface org.springframework.batch.core.listener.JobExecutionListener
-
Callback before a job executes.
- BeforeJob - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called before a
Jobis executed, which comes after aJobExecutionis created and persisted but before the firstStepis executed. - beforeProcess(T) - Method in class org.springframework.batch.core.listener.CompositeItemProcessListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered. - beforeProcess(T) - Method in interface org.springframework.batch.core.listener.ItemProcessListener
-
Called before
ItemProcessor.process(Object). - beforeProcess(T) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- BeforeProcess - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called before an item is passed to an
ItemProcessor
Expected signature: void beforeProcess(T item) - beforeRead() - Method in class org.springframework.batch.core.listener.CompositeItemReadListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered. - beforeRead() - Method in interface org.springframework.batch.core.listener.ItemReadListener
-
Called before
ItemReader.read() - beforeRead() - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- BeforeRead - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called before an item is read from an
ItemReader
Expected signature: void beforeRead() - beforeStep(StepExecution) - Method in class org.springframework.batch.core.listener.CompositeStepExecutionListener
-
Call the registered listeners in order, respecting and prioritizing those that implement
Ordered. - beforeStep(StepExecution) - Method in class org.springframework.batch.core.listener.JobParameterExecutionContextCopyListener
- beforeStep(StepExecution) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- beforeStep(StepExecution) - Method in interface org.springframework.batch.core.listener.StepExecutionListener
-
Initialize the state of the listener with the
StepExecutionfrom the current scope. - beforeStep(StepExecution) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.Set up a
SimpleCompletionPolicywith a commit interval taken from theJobParameters. - beforeStep(StepExecution) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Get a reference to
StepExecutionfor interrupt checks during system command execution. - BeforeStep - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called before a
Stepis executed, which comes after aStepExecutionis created and persisted but before the first item is read. - beforeWrite(Chunk) - Method in class org.springframework.batch.core.listener.CompositeItemWriteListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered. - beforeWrite(Chunk) - Method in interface org.springframework.batch.core.listener.ItemWriteListener
-
Called before
ItemWriter.write(Chunk) - beforeWrite(Chunk) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- BeforeWrite - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called before a chunk is passed to an
ItemWriter. - bind(JobFactory, Map) - Method in class org.springframework.batch.core.configuration.support.JobFactoryRegistrationListener
-
Deprecated.Take the
JobFactoryprovided and register it with theJobRegistry. - build() - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Validate the current state of the builder and build a flow.
- build() - Method in class org.springframework.batch.core.job.builder.FlowJobBuilder
-
Build a job that executes the flow provided, normally composed of other steps.
- build() - Method in class org.springframework.batch.core.job.builder.JobFlowBuilder
-
Build a flow and inject it into the parent builder.
- build() - Method in class org.springframework.batch.core.job.builder.SimpleJobBuilder
- build() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Build the step from the components collected by the fluent setters.
- build() - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
- build() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- build() - Method in class org.springframework.batch.core.step.builder.FlowStepBuilder
-
Build a step that executes the flow provided, normally composed of other steps.
- build() - Method in class org.springframework.batch.core.step.builder.JobStepBuilder
-
Build a step from the job provided.
- build() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- build() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Build a step with the reader, writer, processor as provided.
C
- calculateDuration(LocalDateTime, LocalDateTime) - Static method in class org.springframework.batch.core.observability.BatchMetrics
-
Calculate the duration between two dates.
- CallableTaskletAdapter - Class in org.springframework.batch.core.step.tasklet
- CallableTaskletAdapter(Callable) - Constructor for class org.springframework.batch.core.step.tasklet.CallableTaskletAdapter
-
Create a new
CallableTaskletAdapterinstance. - canRetry(RetryContext) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- charset - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- charset - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- charset() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
The charset to use in the job repository
- checkInterrupted(StepExecution) - Method in interface org.springframework.batch.core.step.StepInterruptionPolicy
-
Has the job been interrupted?
- checkInterrupted(StepExecution) - Method in class org.springframework.batch.core.step.ThreadStepInterruptionPolicy
-
Returns if the current job lifecycle has been interrupted by checking if the current thread is interrupted.
- chunk(int) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Sets the chunk size or commit interval for this step.
- chunk(int) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Build a step that processes items in chunks with the size provided.
- chunk(int, PlatformTransactionManager) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
StepBuilder.chunk(int)instead. Scheduled for removal in 7.0. - chunk(CompletionPolicy) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Sets a completion policy for the chunk processing.
- chunk(CompletionPolicy, PlatformTransactionManager) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, use
StepBuilder.chunk(int)instead. Scheduled for removal in 7.0. - ChunkContext - Class in org.springframework.batch.core.scope.context
-
Context object for weakly typed data stored for the duration of a chunk (usually a group of items processed together in a transaction).
- ChunkContext(StepContext) - Constructor for class org.springframework.batch.core.scope.context.ChunkContext
- ChunkElementParser - Class in org.springframework.batch.core.configuration.xml
-
Internal parser for the <chunk/> element inside a step.
- ChunkElementParser() - Constructor for class org.springframework.batch.core.configuration.xml.ChunkElementParser
- ChunkListener<I,
O> - Interface in org.springframework.batch.core.listener -
Listener interface for the lifecycle of a chunk.
- chunkListeners - Variable in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- ChunkMonitor - Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 with no replacement. Scheduled for removal in 7.0.
- ChunkMonitor() - Constructor for class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- ChunkMonitor.ChunkMonitorData - Class in org.springframework.batch.core.step.item
-
Deprecated.
- ChunkMonitorData(int, int) - Constructor for class org.springframework.batch.core.step.item.ChunkMonitor.ChunkMonitorData
-
Deprecated.
- chunkOperations(RepeatOperations) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Instead of a
chunk sizeorcompletion policyyou can provide a complete repeat operations instance that handles the iteration over the item reader. - ChunkOrientedStep<I,
O> - Class in org.springframework.batch.core.step.item -
Step implementation for the chunk-oriented processing model.
- ChunkOrientedStep(String, int, ItemReader, ItemWriter, JobRepository) - Constructor for class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Create a new
ChunkOrientedStep. - ChunkOrientedStepBuilder<I,
O> - Class in org.springframework.batch.core.step.builder -
A builder for
ChunkOrientedStep. - ChunkOrientedStepBuilder(String, JobRepository, int) - Constructor for class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Create a new
ChunkOrientedStepBuilderwith the given step name, job repository and transaction manager. - ChunkOrientedStepBuilder(JobRepository, int) - Constructor for class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Create a new
ChunkOrientedStepBuilderwith the given job repository and transaction manager. - ChunkOrientedTasklet<I> - Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
ChunkOrientedStepinstead. Scheduled for removal in 7.0. - ChunkOrientedTasklet(ChunkProvider, ChunkProcessor) - Constructor for class org.springframework.batch.core.step.item.ChunkOrientedTasklet
-
Deprecated.
- ChunkProcessor<I> - Interface in org.springframework.batch.core.step.item
-
Interface defined for processing
Chunks. - ChunkProvider<T> - Interface in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 with no replacement. Scheduled for removal in 7.0.
- ChunkScanEvent - Class in org.springframework.batch.core.observability.jfr.events.step.chunk
- ChunkScanEvent(String, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkScanEvent
- chunkSize - Variable in class org.springframework.batch.core.step.item.ChunkMonitor.ChunkMonitorData
-
Deprecated.
- ChunkTransactionEvent - Class in org.springframework.batch.core.observability.jfr.events.step.chunk
- ChunkTransactionEvent(String, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkTransactionEvent
- ChunkWriteEvent - Class in org.springframework.batch.core.observability.jfr.events.step.chunk
- ChunkWriteEvent(String, long, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkWriteEvent
- chunkWriteStatus - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkWriteEvent
- ClasspathXmlApplicationContextsFactoryBean - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- ClasspathXmlApplicationContextsFactoryBean() - Constructor for class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.
- clear() - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.Unregister all the jobs and close all the contexts created by this loader.
- clear() - Method in interface org.springframework.batch.core.configuration.support.JobLoader
-
Deprecated.Unregister all the jobs and close all the contexts created by this loader.
- clobType - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- clobType() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
The type of large objects.
- close() - Method in class org.springframework.batch.core.scope.context.JobContext
-
Clean up the context at the end of a job execution.
- close() - Static method in class org.springframework.batch.core.scope.context.JobSynchronizationManager
-
Method for unregistering the current context - should always and only be used by in conjunction with a matching
JobSynchronizationManager.register(JobExecution)to ensure thatJobSynchronizationManager.getContext()always returns the correct value. - close() - Method in class org.springframework.batch.core.scope.context.StepContext
-
Clean up the context at the end of a step execution.
- close() - Static method in class org.springframework.batch.core.scope.context.StepSynchronizationManager
-
Method for unregistering the current context - should always and only be used by in conjunction with a matching
StepSynchronizationManager.register(StepExecution)to ensure thatStepSynchronizationManager.getContext()always returns the correct value. - close() - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
-
Method for unregistering the current context - should always and only be used by in conjunction with a matching
SynchronizationManagerSupport.register(Object)to ensure thatSynchronizationManagerSupport.getContext()always returns the correct value. - close() - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- close(C) - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
- close(FlowExecution) - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
-
Chance to clean up resources at the end of a flow (whether it completed successfully or not).
- close(FlowExecution) - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- close(ExecutionContext) - Method in class org.springframework.batch.core.step.AbstractStep
-
Extension point for subclasses to provide callbacks to their collaborators at the end of a step (right at the end of the finally block), to close or release resources.
- close(ExecutionContext) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
- close(ExecutionContext) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
- close(RetryContext, RetryCallback, Throwable) - Method in class org.springframework.batch.core.step.item.SimpleRetryExceptionHandler
-
Deprecated.If retry is exhausted set up some state in the context that can be used to signal that the exception should be handled.
- CommandLineJobOperator - Class in org.springframework.batch.core.launch.support
-
A command-line utility to operate Spring Batch jobs using the
JobOperator. - CommandLineJobOperator(JobOperator, JobRepository, JobRegistry) - Constructor for class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Create a new
CommandLineJobOperatorinstance. - CommandLineJobRunner - Class in org.springframework.batch.core.launch.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
CommandLineJobOperator. Scheduled for removal in 6.2 or later. - CommandLineJobRunner() - Constructor for class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.
- CommandRunner - Interface in org.springframework.batch.core.step.tasklet
-
Strategy interface for executing commands.
- CommonJobProperties() - Constructor for class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- CommonJobProperties(JobBuilderHelper.CommonJobProperties) - Constructor for class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- CommonStepProperties() - Constructor for class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- CommonStepProperties(StepBuilderHelper.CommonStepProperties) - Constructor for class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- compare(StateTransition, StateTransition) - Method in class org.springframework.batch.core.job.flow.support.DefaultStateTransitionComparator
- compareTo(ExitStatus) - Method in class org.springframework.batch.core.ExitStatus
- compareTo(FlowExecution) - Method in class org.springframework.batch.core.job.flow.FlowExecution
-
Create an ordering on
FlowExecutioninstances by comparing their statuses. - compareTo(FlowExecutionStatus) - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
-
Create an ordering on
FlowExecutionStatusinstances by comparing their statuses. - COMPLETED - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
The batch job has successfully completed its execution.
- COMPLETED - Static variable in class org.springframework.batch.core.ExitStatus
-
Convenient constant value representing finished processing.
- COMPLETED - Static variable in class org.springframework.batch.core.job.flow.FlowExecutionStatus
-
Special well-known status value.
- CompositeChunkListener<I,
O> - Class in org.springframework.batch.core.listener - CompositeChunkListener() - Constructor for class org.springframework.batch.core.listener.CompositeChunkListener
-
Default constructor
- CompositeChunkListener(List) - Constructor for class org.springframework.batch.core.listener.CompositeChunkListener
-
Convenience constructor for setting the
ChunkListeners. - CompositeChunkListener(ChunkListener...) - Constructor for class org.springframework.batch.core.listener.CompositeChunkListener
-
Convenience constructor for setting the
ChunkListeners. - CompositeItemProcessListener<T,
S> - Class in org.springframework.batch.core.listener - CompositeItemProcessListener() - Constructor for class org.springframework.batch.core.listener.CompositeItemProcessListener
- CompositeItemReadListener<T> - Class in org.springframework.batch.core.listener
- CompositeItemReadListener() - Constructor for class org.springframework.batch.core.listener.CompositeItemReadListener
- CompositeItemWriteListener<S> - Class in org.springframework.batch.core.listener
- CompositeItemWriteListener() - Constructor for class org.springframework.batch.core.listener.CompositeItemWriteListener
- CompositeJobExecutionListener - Class in org.springframework.batch.core.listener
- CompositeJobExecutionListener() - Constructor for class org.springframework.batch.core.listener.CompositeJobExecutionListener
- CompositeJobParametersValidator - Class in org.springframework.batch.core.job.parameters
-
Composite
JobParametersValidatorthat passes the job parameters through a sequence of injectedJobParametersValidators - CompositeJobParametersValidator() - Constructor for class org.springframework.batch.core.job.parameters.CompositeJobParametersValidator
- CompositeSkipListener<T,
S> - Class in org.springframework.batch.core.listener - CompositeSkipListener() - Constructor for class org.springframework.batch.core.listener.CompositeSkipListener
- CompositeSkipPolicy - Class in org.springframework.batch.core.step.skip
- CompositeSkipPolicy() - Constructor for class org.springframework.batch.core.step.skip.CompositeSkipPolicy
- CompositeSkipPolicy(SkipPolicy[]) - Constructor for class org.springframework.batch.core.step.skip.CompositeSkipPolicy
- CompositeStepExecutionListener - Class in org.springframework.batch.core.listener
- CompositeStepExecutionListener() - Constructor for class org.springframework.batch.core.listener.CompositeStepExecutionListener
- concurrent() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 with no replacement and scheduled for removal in v7.
- ConfigurableSystemProcessExitCodeMapper - Class in org.springframework.batch.core.step.tasklet
-
Maps exit codes to
ExitStatusaccording to injected map. - ConfigurableSystemProcessExitCodeMapper() - Constructor for class org.springframework.batch.core.step.tasklet.ConfigurableSystemProcessExitCodeMapper
- conversionService - Variable in class org.springframework.batch.core.converter.DefaultJobParametersConverter
- conversionService - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- conversionService - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- conversionServiceRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the conversion service to use in the job repository.
- convert(String) - Method in class org.springframework.batch.core.converter.StringToDateConverter
- convert(String) - Method in class org.springframework.batch.core.converter.StringToLocalDateConverter
- convert(String) - Method in class org.springframework.batch.core.converter.StringToLocalDateTimeConverter
- convert(String) - Method in class org.springframework.batch.core.converter.StringToLocalTimeConverter
- convert(String) - Method in class org.springframework.batch.core.converter.StringToOffsetDateTimeConverter
- convert(String) - Method in class org.springframework.batch.core.converter.StringToZonedDateTimeConverter
- convert(LocalDate) - Method in class org.springframework.batch.core.converter.LocalDateToStringConverter
- convert(LocalDateTime) - Method in class org.springframework.batch.core.converter.LocalDateTimeToStringConverter
- convert(LocalTime) - Method in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- convert(OffsetDateTime) - Method in class org.springframework.batch.core.converter.OffsetDateTimeToStringConverter
- convert(ZonedDateTime) - Method in class org.springframework.batch.core.converter.ZonedDateTimeToStringConverter
- convert(Date) - Method in class org.springframework.batch.core.converter.DateToStringConverter
- convert(Properties) - Method in class org.springframework.batch.core.step.job.DefaultJobParametersExtractor
-
Convert the given
PropertiestoJobParameters. - CoreNamespaceHandler - Class in org.springframework.batch.core.configuration.xml
- CoreNamespaceHandler() - Constructor for class org.springframework.batch.core.configuration.xml.CoreNamespaceHandler
- CoreNamespacePostProcessor - Class in org.springframework.batch.core.configuration.xml
-
Post-process jobs and steps defined using the batch namespace to inject dependencies.
- CoreNamespacePostProcessor() - Constructor for class org.springframework.batch.core.configuration.xml.CoreNamespacePostProcessor
- CoreNamespaceUtils - Class in org.springframework.batch.core.configuration.xml
-
Utility methods used in parsing of the batch core namespace.
- CoreRuntimeHints - Class in org.springframework.batch.core.aot
-
RuntimeHintsRegistrarfor Spring Batch core module. - CoreRuntimeHints() - Constructor for class org.springframework.batch.core.aot.CoreRuntimeHints
- countStepExecutions(JobInstance, String) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- countStepExecutions(JobInstance, String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- countStepExecutions(JobInstance, String) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Counts all the
StepExecutionfor a given step name. - createApplicationContext() - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Creates an
ApplicationContextfrom the provided path. - createApplicationContext() - Method in interface org.springframework.batch.core.configuration.support.ApplicationContextFactory
-
Deprecated.
- createApplicationContext(ConfigurableApplicationContext, Object...) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.
- createApplicationContext(ConfigurableApplicationContext, Object...) - Method in class org.springframework.batch.core.configuration.support.GenericApplicationContextFactory
-
Deprecated.
- createBuilder(String) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.
- createBuilder(String) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- createChunkOperations() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- createChunkProcessor() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- createChunkProvider() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- createCounter(MeterRegistry, String, String, Tag...) - Static method in class org.springframework.batch.core.observability.micrometer.MicrometerMetrics
-
Create a
Counter. - createEndStateTransition(State) - Static method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Create a new end state
StateTransitionspecification. - createEndStateTransition(State, String) - Static method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Create a new end state
StateTransitionspecification. - createExecutionContextDao() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.Creates an execution context instance data access object (DAO).
- createExecutionContextDao() - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- createExecutionContextDao() - Method in class org.springframework.batch.core.repository.explore.support.MongoJobExplorerFactoryBean
-
Deprecated.
- createExecutionContextDao() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- createExecutionContextDao() - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- createExecutionContextDao() - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- createFaultTolerantStep() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Creates a fault tolerant
Step. - createFlowStep() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Create a new
FlowStep. - createJob() - Method in interface org.springframework.batch.core.configuration.JobFactory
-
Deprecated.Create a new instance of
Job. - createJob() - Method in class org.springframework.batch.core.configuration.support.ApplicationContextJobFactory
-
Deprecated.Create an
ApplicationContextfrom the factory provided and pull out a bean with the name given during initialization. - createJob() - Method in class org.springframework.batch.core.configuration.support.ReferenceJobFactory
-
Deprecated.Return the instance that was passed in on initialization.
- createJobExecution(JobInstance, JobParameters) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- createJobExecution(JobInstance, JobParameters) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
-
Create a new job execution with an assigned id.
- createJobExecution(JobInstance, JobParameters) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- createJobExecution(JobInstance, JobParameters, ExecutionContext) - Method in interface org.springframework.batch.core.repository.JobRepository
- createJobExecution(JobInstance, JobParameters, ExecutionContext) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- createJobExecution(JobInstance, JobParameters, ExecutionContext) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
-
Create a new
JobExecutionfor the givenJobInstanceandJobParameters, and associate the providedExecutionContextwith the newJobExecution. - createJobExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.Creates a job execution data access object (DAO).
- createJobExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- createJobExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.MongoJobExplorerFactoryBean
-
Deprecated.
- createJobExecutionDao() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- createJobExecutionDao() - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- createJobExecutionDao() - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- createJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
-
In this JDBC implementation a job instance id is obtained by asking the jobInstanceIncrementer (which is likely a sequence) for the next long value, and then passing the Id and parameter values into an INSERT statement.
- createJobInstance(String, JobParameters) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Create a JobInstance with given name and parameters.
- createJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- createJobInstance(String, JobParameters) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Create a new
JobInstancewith the name and job parameters provided. - createJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- createJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- createJobInstanceDao() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.Creates a job instance data access object (DAO).
- createJobInstanceDao() - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- createJobInstanceDao() - Method in class org.springframework.batch.core.repository.explore.support.MongoJobExplorerFactoryBean
-
Deprecated.
- createJobInstanceDao() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- createJobInstanceDao() - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- createJobInstanceDao() - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- createLongTaskTimer(MeterRegistry, String, String, Tag...) - Static method in class org.springframework.batch.core.observability.micrometer.MicrometerMetrics
-
Create a new
LongTaskTimer. - createNewContext(E) - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
- createNewStepState(State, String, String) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
-
Provides an extension point to provide alternative
StepStateimplementations within aSimpleFlow. - createObservation(String, ObservationRegistry) - Static method in class org.springframework.batch.core.observability.micrometer.MicrometerMetrics
-
Create a new
Observation. - createPartitionStep() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Create a partition
Step. - createRetryOperations() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- createScopedProxy(String, BeanDefinition, BeanDefinitionRegistry, boolean) - Static method in class org.springframework.batch.core.scope.BatchScopeSupport
-
Wrap a target bean definition in a proxy that defers initialization until after the
StepContextis available. - createSemaphore() - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Extension point mainly for test purposes so that the behaviour of the lock can be manipulated to simulate various pathologies.
- createSimpleStep() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Creates a new
TaskletStep. - createSkipPolicy() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- createState(List) - Static method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- createState(List, Classifier) - Static method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- createStateTransition(State, String, String) - Static method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Create a new
StateTransitionspecification from oneStateto another (by name). - createStateTransition(State, String) - Static method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Create a new state
StateTransitionspecification with a wildcard pattern that matches all outcomes. - createStepContribution() - Method in class org.springframework.batch.core.step.StepExecution
-
Factory method for
StepContribution. - createStepExecution(String, JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- createStepExecution(String, JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- createStepExecution(String, JobExecution) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Create a new step execution with an assigned id.
- createStepExecution(String, JobExecution) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Create a
StepExecutionfor a givenJobExecutionand step name. - createStepExecution(String, JobExecution) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- createStepExecution(String, JobExecution) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
-
Create a new
StepExecutionfor the givenJobExecutionand step name, associate a newExecutionContextwith the newStepExecution, and add the newStepExecutionto theJobExecution. - createStepExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.Creates a step execution data access object (DAO).
- createStepExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- createStepExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.MongoJobExplorerFactoryBean
-
Deprecated.
- createStepExecutionDao() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- createStepExecutionDao() - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- createStepExecutionDao() - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- createTask(Step, StepExecution) - Method in class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
-
Creates the task executing the given step in the context of the given execution.
- createTasklet() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- createTasklet() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Create a new chunk oriented tasklet with reader, writer and processor as provided.
- createTasklet() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- createTasklet() - Method in class org.springframework.batch.core.step.builder.TaskletStepBuilder
- createTaskletStep() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Create a new
TaskletStep. - createTimer(MeterRegistry, String, String, Tag...) - Static method in class org.springframework.batch.core.observability.micrometer.MicrometerMetrics
-
Create a
Timer. - createTimerSample(MeterRegistry) - Static method in class org.springframework.batch.core.observability.micrometer.MicrometerMetrics
-
Create a new
Timer.Sample. - createTransition(FlowExecutionStatus, String, String, String, BeanDefinition, ParserContext, boolean) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
D
- databaseType - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- databaseType() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the type of the data source to use in the job repository.
- DataFieldMaxValueJobParametersIncrementer - Class in org.springframework.batch.core.job.parameters
-
This incrementer uses a
DataFieldMaxValueIncrementerto generate the sequence of values to use as job instance discriminator. - DataFieldMaxValueJobParametersIncrementer(DataFieldMaxValueIncrementer) - Constructor for class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
-
Create a new
DataFieldMaxValueJobParametersIncrementer. - dataSource - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- dataSource - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- dataSourceRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the data source to use in the job repository.
- DateToStringConverter - Class in org.springframework.batch.core.converter
- DateToStringConverter() - Constructor for class org.springframework.batch.core.converter.DateToStringConverter
- decide(JobExecution, StepExecution) - Method in interface org.springframework.batch.core.job.flow.JobExecutionDecider
-
Strategy for branching an execution based on the state of an ongoing
JobExecution. - DECISION_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Decision element.
- DecisionParser - Class in org.springframework.batch.core.configuration.xml
-
Internal parser for the <decision/> elements inside a job.
- DecisionParser() - Constructor for class org.springframework.batch.core.configuration.xml.DecisionParser
- DecisionState - Class in org.springframework.batch.core.job.flow.support.state
-
State that requires a decider to make the status decision.
- DecisionState(JobExecutionDecider, String) - Constructor for class org.springframework.batch.core.job.flow.support.state.DecisionState
- decode(String, String) - Method in class org.springframework.batch.core.converter.DefaultJobParametersConverter
-
Decode a job parameter from a string.
- decode(String, String) - Method in class org.springframework.batch.core.converter.JsonJobParametersConverter
- DEFAULT_EXIT_MESSAGE_LENGTH - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- DEFAULT_JOB_EXECUTION_INCREMENTER_NAME - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
-
Default name of the job execution incrementer.
- DEFAULT_JOB_INSTANCE_INCREMENTER_NAME - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
-
Default name of the job instance incrementer.
- DEFAULT_KEY - Static variable in class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
-
Default key used as a job parameter.
- DEFAULT_MAX_SKIPS_ON_READ - Static variable in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.Hard limit for number of read skips in the same chunk.
- DEFAULT_SHORT_CONTEXT_LENGTH - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- DEFAULT_STEP_EXECUTION_INCREMENTER_NAME - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
-
Default name of the step execution incrementer.
- DEFAULT_TABLE_PREFIX - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
-
Default value for the table prefix property.
- DefaultBatchConfiguration - Class in org.springframework.batch.core.configuration.support
-
Base
Configurationclass that provides common infrastructure beans for enabling and using Spring Batch. - DefaultBatchConfiguration() - Constructor for class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
- DefaultExecutionContextSerializer - Class in org.springframework.batch.core.repository.dao
-
An implementation of the
ExecutionContextSerializerthat produces/consumes Base64 content. - DefaultExecutionContextSerializer() - Constructor for class org.springframework.batch.core.repository.dao.DefaultExecutionContextSerializer
- DefaultItemFailureHandler - Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 with no replacement. Scheduled for removal in 7.0.
- DefaultItemFailureHandler() - Constructor for class org.springframework.batch.core.step.item.DefaultItemFailureHandler
-
Deprecated.
- DefaultJobKeyGenerator - Class in org.springframework.batch.core.job
-
Default implementation of the
JobKeyGeneratorinterface. - DefaultJobKeyGenerator() - Constructor for class org.springframework.batch.core.job.DefaultJobKeyGenerator
- DefaultJobLoader - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- DefaultJobLoader() - Constructor for class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.Default constructor.
- DefaultJobLoader(JobRegistry) - Constructor for class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.Creates a job loader with the job registry provided.
- DefaultJobLoader(JobRegistry, StepRegistry) - Constructor for class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.Creates a job loader with the job and step registries provided.
- DefaultJobParametersConverter - Class in org.springframework.batch.core.converter
-
Converter for
JobParametersinstances that uses a simple naming convention for converting job parameters. - DefaultJobParametersConverter() - Constructor for class org.springframework.batch.core.converter.DefaultJobParametersConverter
- DefaultJobParametersExtractor - Class in org.springframework.batch.core.step.job
-
Simple implementation of
JobParametersExtractorwhich pulls parameters with named keys out of the step execution context and the job parameters of the surrounding job. - DefaultJobParametersExtractor() - Constructor for class org.springframework.batch.core.step.job.DefaultJobParametersExtractor
- DefaultJobParametersValidator - Class in org.springframework.batch.core.job.parameters
-
Default implementation of
JobParametersValidator. - DefaultJobParametersValidator() - Constructor for class org.springframework.batch.core.job.parameters.DefaultJobParametersValidator
-
Convenient default constructor for unconstrained validation.
- DefaultJobParametersValidator(String[], String[]) - Constructor for class org.springframework.batch.core.job.parameters.DefaultJobParametersValidator
-
Create a new validator with the required and optional job parameter keys provided.
- DefaultStateTransitionComparator - Class in org.springframework.batch.core.job.flow.support
-
Sorts by descending specificity of pattern, based on counting wildcards (with ?
- DefaultStateTransitionComparator() - Constructor for class org.springframework.batch.core.job.flow.support.DefaultStateTransitionComparator
- DefaultStepExecutionAggregator - Class in org.springframework.batch.core.partition.support
-
Convenience class for aggregating a set of
StepExecutioninstances into a single result. - DefaultStepExecutionAggregator() - Constructor for class org.springframework.batch.core.partition.support.DefaultStepExecutionAggregator
- deleteExecutionContext(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
-
Delete the execution context of the given
JobExecution. - deleteExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
-
Delete the execution context of the given
JobExecution. - deleteExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- deleteExecutionContext(StepExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
-
Delete the execution context of the given
StepExecution. - deleteExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
-
Delete the execution context of the given
StepExecution. - deleteExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- deleteJobExecution(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
-
Delete the given job execution.
- deleteJobExecution(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
-
Delete the given job execution.
- deleteJobExecution(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- deleteJobExecution(JobExecution) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Delete the job execution object graph (ie the job execution with its execution context, all related step executions and their executions contexts, as well as associated job parameters)
- deleteJobExecution(JobExecution) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- deleteJobExecution(JobExecution) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- deleteJobExecutionParameters(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
-
Delete the parameters associated with the given job execution.
- deleteJobExecutionParameters(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
-
Delete the parameters associated with the given job execution.
- deleteJobExecutionParameters(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- deleteJobInstance(JobInstance) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
-
Delete the job instance.
- deleteJobInstance(JobInstance) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Delete the job instance.
- deleteJobInstance(JobInstance) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- deleteJobInstance(JobInstance) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Delete the job instance object graph (ie the job instance with all associated job executions along with their respective object graphs as specified in
JobRepository.deleteJobExecution(JobExecution)). - deleteJobInstance(JobInstance) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- deleteJobInstance(JobInstance) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- deleteStepExecution(StepExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
-
Delete the given step execution.
- deleteStepExecution(StepExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- deleteStepExecution(StepExecution) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Delete the given step execution.
- deleteStepExecution(StepExecution) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Delete the step execution along with its execution context.
- deleteStepExecution(StepExecution) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- deserialize(InputStream) - Method in class org.springframework.batch.core.repository.dao.DefaultExecutionContextSerializer
-
Deserializes an execution context from the provided
InputStream. - deserialize(InputStream) - Method in class org.springframework.batch.core.repository.dao.Jackson2ExecutionContextStringSerializer
-
Deprecated.
- deserialize(InputStream) - Method in class org.springframework.batch.core.repository.dao.JacksonExecutionContextStringSerializer
- destroy() - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.Unregister all the
Jobinstances that were registered by this smart initializing singleton. - detectStreamInReader() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- dirty() - Method in record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Returns the value of the
dirtyrecord component. - doAfterWrite(Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Call the listener's after write method.
- doAggregation(Collection, FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.SplitState
- doExecute(JobExecution) - Method in class org.springframework.batch.core.job.AbstractJob
-
Extension point for subclasses allowing them to concentrate on processing logic and ignore listeners and repository calls.
- doExecute(JobExecution) - Method in class org.springframework.batch.core.job.flow.FlowJob
- doExecute(JobExecution) - Method in class org.springframework.batch.core.job.SimpleJob
-
Handler of steps sequentially as provided, checking each one for success before moving to the next.
- doExecute(StepExecution) - Method in class org.springframework.batch.core.job.flow.FlowStep
-
Delegate to the flow provided for the execution of the step.
- doExecute(StepExecution) - Method in class org.springframework.batch.core.partition.PartitionStep
-
Delegate execution to the
PartitionHandlerprovided. - doExecute(StepExecution) - Method in class org.springframework.batch.core.step.AbstractStep
-
Extension point for subclasses to execute business logic.
- doExecute(StepExecution) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
- doExecute(StepExecution) - Method in class org.springframework.batch.core.step.job.JobStep
-
Execute the job provided by delegating to the
JobOperatorto prevent duplicate executions. - doExecute(StepExecution) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Process the step and update its context so that progress can be monitored by the caller.
- doExecutionRegistration(StepExecution) - Method in class org.springframework.batch.core.step.AbstractStep
-
Registers the
StepExecutionfor property resolution viaStepScope - doExecutionRelease() - Method in class org.springframework.batch.core.step.AbstractStep
-
Releases the most recent
StepExecution - doHandle(StepExecution, Set) - Method in class org.springframework.batch.core.partition.support.AbstractPartitionHandler
-
Executes the specified
StepExecutioninstances and returns an updated view of them. - doHandle(StepExecution, Set) - Method in class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
- doInChunkContext(RepeatContext, ChunkContext) - Method in class org.springframework.batch.core.scope.context.StepContextRepeatCallback
-
Do the work required for this chunk of the step.
- doInIteration(RepeatContext) - Method in class org.springframework.batch.core.scope.context.StepContextRepeatCallback
-
Manage the
StepContextlifecycle. - doOnWriteError(Exception, Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Call listener's writerError method.
- doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Performs the parsing for a flow definition.
- doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.AbstractListenerParser
- doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.InlineFlowParser
-
Does the parsing.
- doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.JobParser
-
Create a bean definition for a
FlowJob. - doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.JobRepositoryParser
-
Parse and create a bean definition for a
JdbcJobRepositoryFactoryBean. - doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.TopLevelFlowParser
-
Parse the flow.
- doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.TopLevelJobListenerParser
- doParse(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.batch.core.configuration.xml.TopLevelStepListenerParser
- doProcess(I) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- doRead() - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.Surrounds the read call with listener callbacks.
- doWrite(Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Surrounds the actual write call with listener callbacks.
- DuplicateJobException - Exception Class in org.springframework.batch.core.configuration
-
Checked exception that indicates a name clash when registering
Jobinstances. - DuplicateJobException(String) - Constructor for exception class org.springframework.batch.core.configuration.DuplicateJobException
-
Create an exception with the given message.
- DuplicateJobException(String, Throwable) - Constructor for exception class org.springframework.batch.core.configuration.DuplicateJobException
-
Create an exception with the given message and the given exception.
E
- ecDao - Variable in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- ELSE_KEY - Static variable in class org.springframework.batch.core.step.tasklet.ConfigurableSystemProcessExitCodeMapper
- EnableBatchProcessing - Annotation Interface in org.springframework.batch.core.configuration.annotation
-
Enable Spring Batch features and provide a base configuration for setting up batch jobs in an @Configuration class, roughly equivalent to using the
<batch:*>XML namespace. - EnableJdbcJobRepository - Annotation Interface in org.springframework.batch.core.configuration.annotation
-
Annotation to enable a JDBC-based infrastructure in a Spring Batch application.
- EnableMongoJobRepository - Annotation Interface in org.springframework.batch.core.configuration.annotation
-
* Annotation to enable a MongoDB-based job repository in a Spring Batch application.
- encode(JobParameter) - Method in class org.springframework.batch.core.converter.DefaultJobParametersConverter
-
Encode a job parameter to a string.
- encode(JobParameter) - Method in class org.springframework.batch.core.converter.JsonJobParametersConverter
- end() - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
A synonym for
FlowBuilder.build()which callers might find useful. - end() - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Signal the successful end of the flow.
- end(String) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Signal the end of the flow with the status provided.
- END_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes an End element.
- endCounter - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Used as a suffix to generate unique state names for end transitions.
- EndState - Class in org.springframework.batch.core.job.flow.support.state
-
Stateimplementation for ending a job if it is in progress and continuing if just starting. - EndState(FlowExecutionStatus, String) - Constructor for class org.springframework.batch.core.job.flow.support.state.EndState
- EndState(FlowExecutionStatus, String, String) - Constructor for class org.springframework.batch.core.job.flow.support.state.EndState
- EndState(FlowExecutionStatus, String, String, boolean) - Constructor for class org.springframework.batch.core.job.flow.support.state.EndState
- enhance(AbstractJob) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
- enhance(AbstractStep) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- enhanceCommonStep(StepBuilderHelper) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Enhances a step with attributes from the provided
StepBuilderHelper. - enhanceTaskletStepBuilder(AbstractTaskletStepBuilder) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Set the state of the
AbstractTaskletStepBuilderusing the values that were established for the factory bean. - Entity - Class in org.springframework.batch.core
-
Batch Domain Entity class.
- Entity(long) - Constructor for class org.springframework.batch.core.Entity
-
The constructor for the
Entitywhere the ID is established. - equals(Object) - Method in class org.springframework.batch.core.ExitStatus
-
Compare the fields, one by one.
- equals(Object) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.
- equals(Object) - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
- equals(Object) - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.springframework.batch.core.Entity
- equals(Object) - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
-
Check the equality of the statuses.
- equals(Object) - Method in class org.springframework.batch.core.job.flow.support.StateTransition
- equals(Object) - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- equals(Object) - Method in record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.batch.core.repository.persistence.ExitStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.springframework.batch.core.scope.context.JobContext
-
Extend the base class method to include the job execution itself as a key (i.e. two contexts are only equal if their job executions are the same).
- equals(Object) - Method in class org.springframework.batch.core.scope.context.StepContext
-
Extend the base class method to include the step execution itself as a key (i.e. two contexts are only equal if their step executions are the same).
- equals(Object) - Method in class org.springframework.batch.core.step.StepContribution
- equals(Object) - Method in class org.springframework.batch.core.step.StepExecution
- ExceptionClassifierSkipPolicy - Class in org.springframework.batch.core.step.skip
-
A
SkipPolicythat depends on an exception classifier to make its decision, and then delegates to the classifier result. - ExceptionClassifierSkipPolicy() - Constructor for class org.springframework.batch.core.step.skip.ExceptionClassifierSkipPolicy
- ExceptionElementParser - Class in org.springframework.batch.core.configuration.xml
- ExceptionElementParser() - Constructor for class org.springframework.batch.core.configuration.xml.ExceptionElementParser
- exceptionHandler(ExceptionHandler) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Sets the exception handler to use in the case of tasklet failures.
- exec(String[], String[], File) - Method in interface org.springframework.batch.core.step.tasklet.CommandRunner
-
Executes the specified string command in a separate process with the specified environment and working directory.
- exec(String[], String[], File) - Method in class org.springframework.batch.core.step.tasklet.JvmCommandRunner
-
Delegate call to
Runtime.exec(String)with the arguments provided. - execute(JobExecution) - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
- execute(JobExecution) - Method in class org.springframework.batch.core.job.AbstractJob
-
Run the specified job, handling all listener and repository calls, and delegating the actual processing to
AbstractJob.doExecute(JobExecution). - execute(JobExecution) - Method in interface org.springframework.batch.core.job.Job
-
Run the
JobExecutionand update the meta information, such as status and statistics, as necessary. - execute(Job, JobExecution) - Method in class org.springframework.batch.core.scope.context.JobScopeManager
- execute(StepContribution, ChunkContext) - Method in class org.springframework.batch.core.step.item.ChunkOrientedTasklet
-
Deprecated.
- execute(StepContribution, ChunkContext) - Method in class org.springframework.batch.core.step.tasklet.CallableTaskletAdapter
-
Execute the provided Callable and return its
RepeatStatus. - execute(StepContribution, ChunkContext) - Method in class org.springframework.batch.core.step.tasklet.MethodInvokingTaskletAdapter
-
Delegate execution to the target object and translate the return value to an
ExitStatusby invoking a method in the delegate POJO. - execute(StepContribution, ChunkContext) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Execute system command and map its exit code to
ExitStatususingSystemProcessExitCodeMapper. - execute(StepContribution, ChunkContext) - Method in interface org.springframework.batch.core.step.tasklet.Tasklet
-
Given the current context in the form of a step contribution, do whatever is necessary to process this unit inside a transaction.
- execute(StepExecution) - Method in class org.springframework.batch.core.step.AbstractStep
-
Template method for step execution logic - calls abstract methods for resource initialization (
AbstractStep.open(ExecutionContext)), execution logic (AbstractStep.doExecute(StepExecution)) and resource closing (AbstractStep.close(ExecutionContext)). - execute(StepExecution) - Method in interface org.springframework.batch.core.step.Step
-
Process the step and assign progress and status meta information to the
StepExecutionprovided. - execute(Step, StepExecution) - Method in class org.springframework.batch.core.scope.context.StepScopeManager
- execute(RetryCallback) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback, Collection) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback, RecoveryCallback) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback, RecoveryCallback, Collection) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback, RecoveryCallback, RetryState) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback, RetryState) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- executeStep(Step) - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
- executeStep(Step) - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- EXECUTING - Static variable in class org.springframework.batch.core.ExitStatus
-
Convenient constant value representing continuable state where processing is still taking place, so no further action is required.
- ExecutionContext - Record Class in org.springframework.batch.core.repository.persistence
- ExecutionContext(Map, boolean) - Constructor for record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Creates an instance of a
ExecutionContextrecord class. - ExecutionContextDao - Interface in org.springframework.batch.core.repository.dao
-
DAO interface for persisting and retrieving
ExecutionContexts. - ExecutionContextPromotionListener - Class in org.springframework.batch.core.listener
- ExecutionContextPromotionListener() - Constructor for class org.springframework.batch.core.listener.ExecutionContextPromotionListener
- ExecutionContextSerializer - Interface in org.springframework.batch.core.repository
-
A composite interface that combines both serialization and deserialization of an execution context into a single implementation.
- executionContextSerializerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the execution context serializer to use in the job repository.
- exit(int) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Delegate to the exiter to (possibly) exit the VM gracefully.
- exit(int) - Method in class org.springframework.batch.core.launch.support.JvmSystemExiter
-
Deprecated.Delegate call to System.exit() with the argument provided.
- exit(int) - Method in interface org.springframework.batch.core.launch.support.SystemExiter
-
Deprecated.Terminate the currently running Java Virtual Machine.
- EXIT_CODE_ATTR - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Exit Code element.
- exitCode() - Method in record class org.springframework.batch.core.repository.persistence.ExitStatus
-
Returns the value of the
exitCoderecord component. - ExitCodeMapper - Interface in org.springframework.batch.core.launch.support
-
This interface should be implemented when an environment calling the batch framework has specific requirements regarding the operating system process return status.
- exitDescription() - Method in record class org.springframework.batch.core.repository.persistence.ExitStatus
-
Returns the value of the
exitDescriptionrecord component. - exitStatus - Variable in class org.springframework.batch.core.job.flow.JobFlowExecutor
- exitStatus - Variable in class org.springframework.batch.core.observability.jfr.events.job.JobExecutionEvent
- exitStatus - Variable in class org.springframework.batch.core.observability.jfr.events.step.StepExecutionEvent
- ExitStatus - Class in org.springframework.batch.core
-
Value object used to carry information about the status of a job or step execution.
- ExitStatus - Record Class in org.springframework.batch.core.repository.persistence
- ExitStatus(String) - Constructor for class org.springframework.batch.core.ExitStatus
-
Constructor that accepts the exit code and sets the exit description to an empty
String. - ExitStatus(String, String) - Constructor for class org.springframework.batch.core.ExitStatus
-
Constructor that establishes the exit code and the exit description for the
ExitStatus. - ExitStatus(String, String) - Constructor for record class org.springframework.batch.core.repository.persistence.ExitStatus
-
Creates an instance of a
ExitStatusrecord class. - ExitStatus(String, String, Throwable) - Constructor for class org.springframework.batch.core.ExitStatus
-
Constructor that establishes the exit code and the exit description for the
ExitStatus.
F
- fail() - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Signal the end of the flow with an error condition.
- FAIL_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Fail element.
- FAILED - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
Status of a batch job that has failed during its execution.
- FAILED - Static variable in class org.springframework.batch.core.ExitStatus
-
Convenient constant value representing finished processing with an error.
- FAILED - Static variable in class org.springframework.batch.core.job.flow.FlowExecutionStatus
-
Special well-known status value.
- FatalStepExecutionException - Exception Class in org.springframework.batch.core.step
- FatalStepExecutionException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.FatalStepExecutionException
- faultTolerant() - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set whether the step is fault-tolerant or not.
- faultTolerant() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Override parent method to prevent creation of a new FaultTolerantStepBuilder
- faultTolerant() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- FaultTolerantChunkProcessor<I,
O> - Class in org.springframework.batch.core.step.item -
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
ChunkOrientedStepinstead. Scheduled for removal in 7.0. - FaultTolerantChunkProcessor(ItemProcessor, ItemWriter, BatchRetryTemplate) - Constructor for class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- FaultTolerantChunkProvider<I> - Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
ChunkOrientedStepinstead. Scheduled for removal in 7.0. - FaultTolerantChunkProvider(ItemReader, RepeatOperations) - Constructor for class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.
- FaultTolerantStepBuilder<I,
O> - Class in org.springframework.batch.core.step.builder -
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
ChunkOrientedStepBuilderinstead. Scheduled for removal in 7.0. - FaultTolerantStepBuilder(SimpleStepBuilder) - Constructor for class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Create a new builder initialized with any properties in the parent.
- FaultTolerantStepBuilder(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Create a new builder initialized with any properties in the parent.
- FaultTolerantStepFactoryBean<T,
S> - Class in org.springframework.batch.core.step.factory -
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 with no replacement. Scheduled for removal in 7.0.
- FaultTolerantStepFactoryBean() - Constructor for class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.
- fillJobExecutionDependencies(JobExecution) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- fillStepExecutionDependencies(StepExecution) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- findAllReachableElements(String, Map, Set) - Method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Find all of the elements that are reachable from the
startElement. - findBatchStatus(FlowExecutionStatus) - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- findJobExecutions(JobInstance) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- findJobExecutions(JobInstance) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
-
Return all
JobExecutions for givenJobInstance, sorted backwards by creation order (so the first element is the most recent). - findJobExecutions(JobInstance) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- findJobExecutions(JobInstance) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.since v6.0 and scheduled for removal in v6.2. Use
JobExplorer.getJobExecutions(JobInstance) - findJobExecutions(JobInstance) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.
- findJobInstances(String) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Fetch all
JobInstancevalues for a given job name. - findJobInstances(String) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Find all
JobInstances for a given job name. - findJobInstances(String) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
-
Fetch all
JobInstancevalues for a given job name. - findJobInstancesByJobName(String, int, int) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.Since v6.0 and scheduled for removal in v6.2. Use
JobExplorer.getJobInstances(String, int, int) - findJobInstancesByJobName(String, int, int) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.since v6.0 and scheduled for removal in v6.2. Use
SimpleJobExplorer.getJobInstances(String, int, int)instead. - findJobInstancesByName(String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- findJobInstancesByName(String, int, int) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
-
Deprecated, for removal: This API element is subject to removal in a future version.since v6.0 and scheduled for removal in v6.2. Use
JdbcJobInstanceDao.getJobInstances(String, int, int)instead. - findJobInstancesByName(String, int, int) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Deprecated, for removal: This API element is subject to removal in a future version.Since v6.0 and scheduled for removal in v6.2. Use
JobInstanceDao.getJobInstances(String) - findJobInstancesByName(String, int, int) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
-
Deprecated, for removal: This API element is subject to removal in a future version.since v6.0 and scheduled for removal in v6.2. Use
MongoJobInstanceDao.getJobInstances(String, int, int)instead. - findJobInstancesByName(String, int, int) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.since v6.0 and scheduled for removal in v6.2. Use
JobExplorer.getJobInstances(String, int, int) - findJobInstancesByName(String, int, int) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.
- findRunningJobExecutions(String) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- findRunningJobExecutions(String) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- findRunningJobExecutions(String) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
- findRunningJobExecutions(String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- findRunningJobExecutions(String) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Retrieve running job executions.
- findRunningJobExecutions(String) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Retrieve running job executions.
- flow - Variable in class org.springframework.batch.core.job.flow.FlowJob
- flow() - Method in class org.springframework.batch.core.job.builder.FlowBuilder
- flow(Flow) - Method in class org.springframework.batch.core.job.builder.FlowJobBuilder
-
Provide a single flow to execute as the job.
- flow(Flow) - Method in class org.springframework.batch.core.step.builder.FlowStepBuilder
-
Provide a flow to execute during the step.
- flow(Flow) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Create a new step builder that will execute a flow.
- flow(Step) - Method in class org.springframework.batch.core.job.builder.JobBuilder
-
Create a new job builder that will execute a step or sequence of steps.
- Flow - Interface in org.springframework.batch.core.job.flow
- FLOW_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Flow element.
- FlowBuilder<Q> - Class in org.springframework.batch.core.job.builder
-
A builder for a flow of steps that can be executed as a job or as part of a job.
- FlowBuilder(String) - Constructor for class org.springframework.batch.core.job.builder.FlowBuilder
- FlowBuilder.SplitBuilder<Q> - Class in org.springframework.batch.core.job.builder
-
A builder for building a split state.
- FlowBuilder.TransitionBuilder<Q> - Class in org.springframework.batch.core.job.builder
-
A builder for transitions within a flow.
- FlowBuilder.UnterminatedFlowBuilder<Q> - Class in org.springframework.batch.core.job.builder
-
A builder for continuing a flow from a decision state.
- FlowBuilderException - Exception Class in org.springframework.batch.core.job.builder
- FlowBuilderException(Exception) - Constructor for exception class org.springframework.batch.core.job.builder.FlowBuilderException
- FlowBuilderException(String) - Constructor for exception class org.springframework.batch.core.job.builder.FlowBuilderException
- FlowBuilderException(String, Exception) - Constructor for exception class org.springframework.batch.core.job.builder.FlowBuilderException
- FlowElementParser - Class in org.springframework.batch.core.configuration.xml
-
Internal parser for the <flow/> elements inside a job.
- FlowElementParser() - Constructor for class org.springframework.batch.core.configuration.xml.FlowElementParser
- FlowExecution - Class in org.springframework.batch.core.job.flow
- FlowExecution(String, FlowExecutionStatus) - Constructor for class org.springframework.batch.core.job.flow.FlowExecution
- FlowExecutionAggregator - Interface in org.springframework.batch.core.job.flow.support.state
-
Strategy interface for aggregating
FlowExecutioninstances into a single exit status. - FlowExecutionException - Exception Class in org.springframework.batch.core.job.flow
- FlowExecutionException(String) - Constructor for exception class org.springframework.batch.core.job.flow.FlowExecutionException
- FlowExecutionException(String, Throwable) - Constructor for exception class org.springframework.batch.core.job.flow.FlowExecutionException
- FlowExecutionStatus - Class in org.springframework.batch.core.job.flow
-
Represents the status of
FlowExecution. - FlowExecutionStatus(String) - Constructor for class org.springframework.batch.core.job.flow.FlowExecutionStatus
- FlowExecutor - Interface in org.springframework.batch.core.job.flow
-
Context and execution strategy for
FlowJobto allow it to delegate its execution step by step. - FlowHolder - Interface in org.springframework.batch.core.job.flow
-
Convenient interface for components that contain nested flows.
- FlowJob - Class in org.springframework.batch.core.job.flow
-
Implementation of the
Jobinterface that allows for complex flows of steps, rather than requiring sequential execution. - FlowJob() - Constructor for class org.springframework.batch.core.job.flow.FlowJob
-
Create a
FlowJobwith null name and no flow (invalid state). - FlowJob(String) - Constructor for class org.springframework.batch.core.job.flow.FlowJob
-
Create a
FlowJobwith provided name and no flow (invalid state). - FlowJobBuilder - Class in org.springframework.batch.core.job.builder
-
A job builder for
FlowJobinstances. - FlowJobBuilder(JobBuilderHelper) - Constructor for class org.springframework.batch.core.job.builder.FlowJobBuilder
-
Create a new builder initialized with any properties in the parent.
- FlowState - Class in org.springframework.batch.core.job.flow.support.state
-
State that delegates to a Flow
- FlowState(Flow, String) - Constructor for class org.springframework.batch.core.job.flow.support.state.FlowState
- FlowStep - Class in org.springframework.batch.core.job.flow
- FlowStep(Flow) - Constructor for class org.springframework.batch.core.job.flow.FlowStep
-
Constructor for a
FlowStepthat sets the flow and of the step explicitly. - FlowStep(JobRepository) - Constructor for class org.springframework.batch.core.job.flow.FlowStep
-
Create a new instance of a
FlowStepwith the given job repository. - FlowStepBuilder - Class in org.springframework.batch.core.step.builder
-
A step builder for
FlowStepinstances. - FlowStepBuilder(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.FlowStepBuilder
-
Create a new builder initialized with any properties in the parent.
- ForceRollbackForWriteSkipException - Exception Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 7.0.
- ForceRollbackForWriteSkipException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.item.ForceRollbackForWriteSkipException
-
Deprecated.
- forEach(Consumer) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
- formatDuration(Duration) - Static method in class org.springframework.batch.core.observability.BatchMetrics
-
Format a duration in a human readable format like: 2h32m15s10ms.
- from(Flow) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Start again from a subflow that was already registered.
- from(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Start again from a decision that was already registered.
- from(Step) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Go back to a previously registered step and start a new path.
- fromJobExecution(JobExecution) - Method in class org.springframework.batch.core.repository.persistence.converter.JobExecutionConverter
- fromJobInstance(JobInstance) - Method in class org.springframework.batch.core.repository.persistence.converter.JobInstanceConverter
- fromJobParameter(JobParameter) - Method in class org.springframework.batch.core.repository.persistence.converter.JobParameterConverter
- fromPropertyName(String) - Static method in enum class org.springframework.batch.core.listener.JobListenerMetaData
-
Return the relevant meta data for the provided property name.
- fromPropertyName(String) - Static method in enum class org.springframework.batch.core.listener.StepListenerMetaData
-
Return the relevant meta data for the provided property name.
- fromStepExecution(StepExecution) - Method in class org.springframework.batch.core.repository.persistence.converter.StepExecutionConverter
G
- generateKey(JobParameters) - Method in class org.springframework.batch.core.job.DefaultJobKeyGenerator
-
Generates the job key to be used based on the
JobParametersinstance provided. - generateKey(JobParameters) - Method in interface org.springframework.batch.core.job.JobKeyGenerator
-
Method to generate the unique key used to identify a job instance.
- GenericApplicationContextFactory - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- GenericApplicationContextFactory(Object...) - Constructor for class org.springframework.batch.core.configuration.support.GenericApplicationContextFactory
-
Deprecated.Create an application context factory for the specified resource.
- get(String, ObjectFactory) - Method in class org.springframework.batch.core.scope.JobScope
- get(String, ObjectFactory) - Method in class org.springframework.batch.core.scope.StepScope
- getAdjustedOutputs(Chunk, Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- getAdjustedOutputs(Chunk, Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Extension point for subclasses that want to adjust the outputs based on additional saved data in the inputs.
- getAggregator() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getAllFailureExceptions() - Method in class org.springframework.batch.core.job.JobExecution
-
Return all failure causing exceptions for this
JobExecution, including step executions. - getAllowStartIfComplete() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- getAnnotation() - Method in enum class org.springframework.batch.core.listener.JobListenerMetaData
- getAnnotation() - Method in interface org.springframework.batch.core.listener.ListenerMetaData
- getAnnotation() - Method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- getAttribute(String, String, ConfigurableListableBeanFactory) - Static method in class org.springframework.batch.core.configuration.xml.BeanDefinitionUtils
- getBatchStatusFromEndTransitionName(String) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Gets the batch status from the end transition name by the element.
- getBeanClass() - Method in class org.springframework.batch.core.configuration.xml.AbstractListenerParser
-
Gets the bean class.
- getBeanClass() - Method in class org.springframework.batch.core.configuration.xml.JobExecutionListenerParser
- getBeanClass() - Method in class org.springframework.batch.core.configuration.xml.StepListenerParser
- getBeanClass(Element) - Method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
- getBeanClass(Element) - Method in class org.springframework.batch.core.configuration.xml.JobParser
- getBeanClass(Element) - Method in class org.springframework.batch.core.configuration.xml.TopLevelJobListenerParser
- getBeanClass(Element) - Method in class org.springframework.batch.core.configuration.xml.TopLevelStepListenerParser
- getBeanClassName(Element) - Method in class org.springframework.batch.core.configuration.xml.JobRepositoryParser
- getBeanFactoryPostProcessorClasses() - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Protected access to the list of bean factory post processor classes that should be copied over to the context from the parent.
- getCharset() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the
Charsetto use when serializing/deserializing the execution context. - getChunkCompletionPolicy() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- getChunkMonitor() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- getChunkOperations() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the chunk operations to make them available in subclasses.
- getChunkSize() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- getClobType() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the value from
Typesclass to indicate the type to use for a CLOB - getClobTypeToUse() - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- getCode() - Method in class org.springframework.batch.core.job.flow.support.state.EndState
- getCommitCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getCommitCount() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the current number of commits for this execution.
- getCommitInterval() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getCompletionPolicy() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getCompositeListener() - Method in class org.springframework.batch.core.step.AbstractStep
- getContext() - Static method in class org.springframework.batch.core.scope.context.JobSynchronizationManager
-
Getter for the current context if there is one, otherwise returns
null. - getContext() - Static method in class org.springframework.batch.core.scope.context.StepSynchronizationManager
-
Getter for the current context if there is one, otherwise returns
null. - getContext() - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
-
Getter for the current context if there is one, otherwise returns
null. - getConversationId() - Method in class org.springframework.batch.core.scope.JobScope
- getConversationId() - Method in class org.springframework.batch.core.scope.StepScope
- getConversionService() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the conversion service to use in the job repository and job explorer.
- getConversionService() - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- getCreateTime() - Method in class org.springframework.batch.core.job.JobExecution
- getCreateTime() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getCreateTime() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getCreateTime() - Method in class org.springframework.batch.core.step.StepExecution
-
Gets the time this execution was created
- getCurrent() - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
- getDatabaseType() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the database type.
- getDataFieldMaxValueIncrementer() - Method in class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
-
Get the incrementer.
- getDataSource() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the data source to use for Batch meta-data.
- getDate(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Daterepresented by the provided key. - getDate(String, Date) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Daterepresented by the provided key. - getDefaultExitStatusForFailure(Throwable) - Method in class org.springframework.batch.core.job.AbstractJob
-
Default mapping from throwable to
ExitStatus. - getDefaultListenerClass() - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- getDefaultListenerClass() - Method in class org.springframework.batch.core.listener.JobListenerFactoryBean
- getDefaultListenerClass() - Method in class org.springframework.batch.core.listener.StepListenerFactoryBean
- getDouble(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Doublerepresented by the provided key. - getDouble(String, Double) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Doublerepresented by the provided key. - getEcDao() - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getEndTime() - Method in class org.springframework.batch.core.job.JobExecution
- getEndTime() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getEndTime() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getEndTime() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the time when this execution ended or
nullif the step is running. - getErrorMessage() - Static method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Retrieve the error message set by an instance of
CommandLineJobRunneras it exits. - getExceptionHandler() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Convenience method for subclasses to access the exception handler that was injected by user.
- getExceptionHandler() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the
ExceptionHandler. - getExecutionContext() - Method in class org.springframework.batch.core.job.JobExecution
-
Returns the
ExecutionContextfor this execution. - getExecutionContext() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getExecutionContext() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getExecutionContext() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the
ExecutionContextfor this execution. - getExecutionContext(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
- getExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- getExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- getExecutionContext(StepExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
- getExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- getExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- getExecutionContextSerializer() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
A custom implementation of the
ExecutionContextSerializer. - getExecutions(long) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobRepository.getJobExecutions(JobInstance). Scheduled for removal in 6.2 or later. - getExecutions(long) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getExitCode() - Method in class org.springframework.batch.core.ExitStatus
-
Getter for the exit code (defaults to blank).
- getExitDescription() - Method in class org.springframework.batch.core.ExitStatus
-
Getter for the exit description (defaults to blank)
- getExitException() - Method in class org.springframework.batch.core.ExitStatus
-
Public getter for the exit exception.
- getExitStatus() - Method in class org.springframework.batch.core.job.JobExecution
- getExitStatus() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getExitStatus() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getExitStatus() - Method in class org.springframework.batch.core.step.StepContribution
-
Public getter for the
ExitStatus. - getExitStatus() - Method in class org.springframework.batch.core.step.StepExecution
- getExitStatus(int) - Method in class org.springframework.batch.core.step.tasklet.ConfigurableSystemProcessExitCodeMapper
- getExitStatus(int) - Method in class org.springframework.batch.core.step.tasklet.SimpleSystemProcessExitCodeMapper
- getExitStatus(int) - Method in interface org.springframework.batch.core.step.tasklet.SystemProcessExitCodeMapper
- getFailureExceptions() - Method in class org.springframework.batch.core.job.JobExecution
-
Retrieve a list of exceptions.
- getFailureExceptions() - Method in class org.springframework.batch.core.step.StepExecution
- getFatalExceptionAwareProxy(SkipPolicy) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Wrap a
SkipPolicyand make it consistent with known fatal exceptions. - getFaultTolerantStepBuilder(String) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Creates a new
FaultTolerantStepBuilder. - getFilterCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getFilterCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Public getter for the filter counter.
- getFilterCount() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the current number of items filtered out of this execution.
- getFilterCount(Chunk, Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- getFilterCount(Chunk, Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Extension point for subclasses to calculate the filter count.
- getFlows() - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean.DelegateState
- getFlows() - Method in interface org.springframework.batch.core.job.flow.FlowHolder
- getFlows() - Method in class org.springframework.batch.core.job.flow.support.state.FlowState
- getFlows() - Method in class org.springframework.batch.core.job.flow.support.state.SplitState
- getGridSize() - Method in class org.springframework.batch.core.partition.support.AbstractPartitionHandler
-
Returns the number of step executions.
- getGridSize() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getGroupName(BeanDefinition, Job) - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.Determine a group name for the job to be registered.
- getId() - Method in class org.springframework.batch.core.Entity
- getId() - Method in class org.springframework.batch.core.scope.context.JobContext
- getId() - Method in class org.springframework.batch.core.scope.context.StepContext
- getIdentifyingParameters() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Get a set of identifying parameters.
- getIncrementerFactory() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the factory for creating
DataFieldMaxValueIncrementerimplementations used to increment entity IDs in meta-data tables. - getInstanceId() - Method in class org.springframework.batch.core.job.JobInstance
- getIsolationLevelForCreate() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the transaction isolation level when creating job executions.
- getIsolationLevelForCreate() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the transaction isolation level when creating job executions.
- getItemListeners() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- getItemProcessor() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the
ItemProcessorfor subclasses to use - getItemReader() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the
ItemReaderfor subclasses to use. - getItemWriter() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the
ItemWriterfor subclasses to use - getJdbcOperations() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the
JdbcOperations. - getJdbcTemplate() - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- getJob(String) - Method in interface org.springframework.batch.core.configuration.JobLocator
-
Deprecated.Locates a
Jobat runtime. - getJob(String) - Method in interface org.springframework.batch.core.configuration.JobRegistry
-
Returns a
Jobby name. - getJob(String) - Method in class org.springframework.batch.core.configuration.support.MapJobRegistry
- getJobExecution() - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
- getJobExecution() - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- getJobExecution() - Method in class org.springframework.batch.core.scope.context.JobContext
-
The current
JobExecutionthat is active in this context. - getJobExecution() - Method in class org.springframework.batch.core.step.StepExecution
-
Accessor for the execution context information of the enclosing job.
- getJobExecution(long) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- getJobExecution(long) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
- getJobExecution(long) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- getJobExecution(long) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Retrieve a
JobExecutionby its ID. - getJobExecution(long) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobExecution(long) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Retrieve a
JobExecutionby its ID. - getJobExecution(long) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobExecutionContext() - Method in class org.springframework.batch.core.scope.context.JobContext
- getJobExecutionContext() - Method in class org.springframework.batch.core.scope.context.StepContext
- getJobExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobExecutionId() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getJobExecutionId() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getJobExecutionId() - Method in class org.springframework.batch.core.step.StepExecution
-
Accessor for the job execution ID.
- getJobExecutionIncrementer() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the incrementer to be used to generate ids for new job executions.
- getJobExecutionIncrementerName() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the job execution incrementer name.
- getJobExecutionListeners() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- getJobExecutions() - Method in class org.springframework.batch.core.job.JobInstance
-
Returns an immutable copy of the list of
JobExecutions associated with this JobInstance. - getJobExecutions(JobInstance) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Retrieve job executions by their job instance.
- getJobExecutions(JobInstance) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobExecutions(JobInstance) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Retrieve job executions by their job instance.
- getJobExecutions(JobInstance) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobInstance() - Method in class org.springframework.batch.core.job.JobExecution
- getJobInstance(long) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- getJobInstance(long) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Fetch the job instance with the provided identifier.
- getJobInstance(long) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getJobInstance(long) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.
- getJobInstance(long) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobInstance(long) - Method in interface org.springframework.batch.core.repository.JobRepository
- getJobInstance(long) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobInstance(String, JobParameters) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobRepository.getJobInstance(String, JobParameters). Scheduled for removal in 6.2 or later. - getJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
-
The job table is queried for any jobs that match the given identifier, adding them to a list via the RowMapper callback.
- getJobInstance(String, JobParameters) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Find the job instance that matches the given name and parameters.
- getJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getJobInstance(String, JobParameters) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.
- getJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobInstance(String, JobParameters) - Method in interface org.springframework.batch.core.repository.JobRepository
- getJobInstance(String, JobParameters) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobInstance(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- getJobInstance(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Fetch the JobInstance for the provided JobExecution.
- getJobInstance(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getJobInstanceCount(String) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- getJobInstanceCount(String) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Query the repository for the number of unique
JobInstances associated with the supplied job name. - getJobInstanceCount(String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getJobInstanceCount(String) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Query the repository for the number of unique
JobInstanceobjects associated with the supplied job name. - getJobInstanceCount(String) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobInstanceCount(String) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Query the repository for the number of unique
JobInstanceobjects associated with the supplied job name. - getJobInstanceCount(String) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobInstanceDao() - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobInstanceId() - Method in class org.springframework.batch.core.job.JobExecution
-
Convenience getter for the
idof the enclosing job instance. - getJobInstanceId() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getJobInstanceId() - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- getJobInstanceId() - Method in class org.springframework.batch.core.scope.context.StepContext
-
Convenient accessor for current
JobInstanceidentifier. - getJobInstanceIds(String) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- getJobInstanceIds(String) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Fetch all job instance ids for the given job name.
- getJobInstanceIds(String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getJobInstanceIncrementer() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the incrementer to be used to generate ids for new job instances.
- getJobInstanceIncrementerName() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the job instance incrementer name.
- getJobInstances(String) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
-
Fetch all job instances for the given job name.
- getJobInstances(String) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Fetch all job instances for the given job name.
- getJobInstances(String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
-
Fetch all job instances for the given job name.
- getJobInstances(String, int, int) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobRepository.findJobInstances(String). Scheduled for removal in 6.2 or later. - getJobInstances(String, int, int) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getJobInstances(String, int, int) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- getJobInstances(String, int, int) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Fetch the last job instances with the provided name, sorted backwards by primary key.
- getJobInstances(String, int, int) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getJobInstances(String, int, int) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Fetch
JobInstancevalues in descending order of creation (and, therefore, usually, of first execution). - getJobInstances(String, int, int) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobInstances(String, int, int) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Fetch
JobInstancevalues in descending order of creation (and, therefore, usually, of first execution). - getJobInstances(String, int, int) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobKey() - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- getJobKeyGenerator() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
A custom implementation of the
JobKeyGenerator. - getJobKeyGenerator() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
A custom implementation of the
JobKeyGenerator. - getJobName() - Method in interface org.springframework.batch.core.configuration.JobFactory
-
Deprecated.
- getJobName() - Method in class org.springframework.batch.core.configuration.support.ApplicationContextJobFactory
-
Deprecated.Return the name of the instance passed in on initialization.
- getJobName() - Method in class org.springframework.batch.core.configuration.support.ReferenceJobFactory
-
Deprecated.Return the name of the instance that was passed in on initialization.
- getJobName() - Method in class org.springframework.batch.core.job.JobInstance
- getJobName() - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- getJobName() - Method in class org.springframework.batch.core.scope.context.JobContext
-
Convenient accessor for current job name identifier.
- getJobName() - Method in class org.springframework.batch.core.scope.context.StepContext
-
Convenient accessor for current job name identifier.
- getJobNames() - Method in interface org.springframework.batch.core.configuration.JobRegistry
-
Provides the currently registered job names.
- getJobNames() - Method in interface org.springframework.batch.core.configuration.ListableJobLocator
-
Deprecated.Provides the currently registered job names.
- getJobNames() - Method in class org.springframework.batch.core.configuration.support.MapJobRegistry
-
Provides an unmodifiable view of job names.
- getJobNames() - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobRegistry.getJobNames(). Scheduled for removal in 6.2 or later. - getJobNames() - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getJobNames() - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- getJobNames() - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Retrieve the names of all jobs for which job instances exist, sorted alphabetically.
- getJobNames() - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getJobNames() - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Query the repository for all unique
JobInstancenames (sorted alphabetically). - getJobNames() - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getJobNames() - Method in interface org.springframework.batch.core.repository.JobRepository
-
Query the repository for all unique
JobInstancenames (sorted alphabetically). - getJobNames() - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobParameters() - Method in class org.springframework.batch.core.job.JobExecution
- getJobParameters() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getJobParameters() - Method in class org.springframework.batch.core.scope.context.JobContext
- getJobParameters() - Method in class org.springframework.batch.core.scope.context.StepContext
- getJobParameters() - Method in class org.springframework.batch.core.step.StepExecution
-
Convenience method to get the current job parameters.
- getJobParameters(Long) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- getJobParameters(Properties) - Method in class org.springframework.batch.core.converter.DefaultJobParametersConverter
- getJobParameters(Properties) - Method in interface org.springframework.batch.core.converter.JobParametersConverter
-
Get a new
JobParametersinstance. - getJobParameters(Job, StepExecution) - Method in class org.springframework.batch.core.step.job.DefaultJobParametersExtractor
- getJobParameters(Job, StepExecution) - Method in interface org.springframework.batch.core.step.job.JobParametersExtractor
-
Extract job parameters from the step execution, for example from the execution context or other properties.
- getJobParametersConverter() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement and scheduled for removal in 6.2 or later.
- getJobParametersIncrementer() - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
- getJobParametersIncrementer() - Method in class org.springframework.batch.core.job.AbstractJob
- getJobParametersIncrementer() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- getJobParametersIncrementer() - Method in interface org.springframework.batch.core.job.Job
-
If clients need to generate new parameters for the next execution in a sequence, they can use this incrementer.
- getJobParametersValidator() - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
- getJobParametersValidator() - Method in class org.springframework.batch.core.job.AbstractJob
- getJobParametersValidator() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- getJobParametersValidator() - Method in interface org.springframework.batch.core.job.Job
-
A validator for the job parameters of a
JobExecution. - getJobRegistry() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
- getJobRepository() - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- getJobRepository() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getJobRepository() - Method in class org.springframework.batch.core.job.AbstractJob
-
Convenience method for subclasses to access the job repository.
- getJobRepository() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- getJobRepository() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
- getJobRepository() - Method in class org.springframework.batch.core.job.SimpleStepHandler
- getJobRepository() - Method in class org.springframework.batch.core.step.AbstractStep
- getJobRepository() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- getJobRepository() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- getKey() - Method in class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
-
Get the key.
- getKey(Object) - Method in interface org.springframework.batch.core.step.item.KeyGenerator
-
Deprecated.
- getLastJobExecution(String, JobParameters) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.
- getLastJobExecution(String, JobParameters) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getLastJobExecution(String, JobParameters) - Method in interface org.springframework.batch.core.repository.JobRepository
- getLastJobExecution(String, JobParameters) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getLastJobExecution(JobInstance) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- getLastJobExecution(JobInstance) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
-
Find the last
JobExecutionto have been created for a givenJobInstance. - getLastJobExecution(JobInstance) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- getLastJobExecution(JobInstance) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Find the last
JobExecutionthat has been created for a givenJobInstance. - getLastJobExecution(JobInstance) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getLastJobExecution(JobInstance) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Find the last
JobExecutionthat has been created for a givenJobInstance. - getLastJobExecution(JobInstance) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getLastJobInstance(String) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- getLastJobInstance(String) - Method in interface org.springframework.batch.core.repository.dao.JobInstanceDao
-
Fetch the last job instance by Id for the given job.
- getLastJobInstance(String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- getLastJobInstance(String) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Find the last job instance, by ID, for the given job.
- getLastJobInstance(String) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getLastJobInstance(String) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Find the last job instance, by ID, for the given job.
- getLastJobInstance(String) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getLastStepExecution(JobInstance, String) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- getLastStepExecution(JobInstance, String) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- getLastStepExecution(JobInstance, String) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Retrieve the last
StepExecutionfor a givenJobInstanceordered by creation time and then id. - getLastStepExecution(JobInstance, String) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.
- getLastStepExecution(JobInstance, String) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getLastStepExecution(JobInstance, String) - Method in interface org.springframework.batch.core.repository.JobRepository
- getLastStepExecution(JobInstance, String) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getLastUpdated() - Method in class org.springframework.batch.core.job.JobExecution
-
Get the date representing the last time this
JobExecutionwas updated in theJobRepository. - getLastUpdated() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getLastUpdated() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getLastUpdated() - Method in class org.springframework.batch.core.step.StepExecution
- getListener() - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- getListener() - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
- getListener(Object) - Static method in class org.springframework.batch.core.listener.JobListenerFactoryBean
-
Convenience method to wrap any object and expose the appropriate
JobExecutionListenerinterfaces. - getListener(Object) - Static method in class org.springframework.batch.core.listener.StepListenerFactoryBean
-
Convenience method to wrap any object and expose the appropriate
StepListenerinterfaces. - getListenerInterface() - Method in enum class org.springframework.batch.core.listener.JobListenerMetaData
- getListenerInterface() - Method in interface org.springframework.batch.core.listener.ListenerMetaData
- getListenerInterface() - Method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- getListeners() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the
StepListeners. - getLocalDate(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDaterepresented by the provided key. - getLocalDate(String, LocalDate) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDaterepresented by the provided key. - getLocalDateTime(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDateTimerepresented by the provided key. - getLocalDateTime(String, LocalDateTime) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDateTimerepresented by the provided key. - getLocalTime(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalTimerepresented by the provided key. - getLocalTime(String, LocalTime) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalTimerepresented by the provided key. - getLong(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Longrepresented by the provided key. - getLong(String, Long) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Longrepresented by the provided key. - getMapping() - Method in class org.springframework.batch.core.launch.support.SimpleJvmExitCodeMapper
- getMaxVarCharLength() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the length of long string columns in database.
- getMetaDataFromPropertyName(String) - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- getMetaDataFromPropertyName(String) - Method in class org.springframework.batch.core.listener.JobListenerFactoryBean
- getMetaDataFromPropertyName(String) - Method in class org.springframework.batch.core.listener.StepListenerFactoryBean
- getMetaDataValues() - Method in class org.springframework.batch.core.configuration.xml.AbstractListenerParser
-
Gets the metadata values.
- getMetaDataValues() - Method in class org.springframework.batch.core.configuration.xml.JobExecutionListenerParser
- getMetaDataValues() - Method in class org.springframework.batch.core.configuration.xml.StepListenerParser
- getMetaDataValues() - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- getMetaDataValues() - Method in class org.springframework.batch.core.listener.JobListenerFactoryBean
- getMetaDataValues() - Method in class org.springframework.batch.core.listener.StepListenerFactoryBean
- getMethodInvokerByName(String, Object, Class...) - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- getMethodName() - Method in enum class org.springframework.batch.core.listener.JobListenerMetaData
- getMethodName() - Method in interface org.springframework.batch.core.listener.ListenerMetaData
- getMethodName() - Method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- getMongoOperations() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
- getName() - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
-
Concatenates the group name and the delegate job name (joining with a ".").
- getName() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getName() - Method in class org.springframework.batch.core.job.AbstractJob
- getName() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- getName() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
- getName() - Method in interface org.springframework.batch.core.job.flow.Flow
- getName() - Method in class org.springframework.batch.core.job.flow.FlowExecution
- getName() - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
- getName() - Method in interface org.springframework.batch.core.job.flow.State
-
The name of the state.
- getName() - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
-
Get the name for this flow.
- getName() - Method in class org.springframework.batch.core.job.flow.support.state.AbstractState
- getName() - Method in interface org.springframework.batch.core.job.Job
-
The name of the job.
- getName() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getName() - Method in class org.springframework.batch.core.scope.BatchScopeSupport
- getName() - Method in class org.springframework.batch.core.step.AbstractStep
- getName() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- getName() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- getName() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public getter for the name of the step.
- getName() - Method in interface org.springframework.batch.core.step.Step
-
The name of the step.
- getNext() - Method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Public getter for the next State name.
- getNext(JobParameters) - Method in class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
- getNext(JobParameters) - Method in interface org.springframework.batch.core.job.parameters.JobParametersIncrementer
-
Increments the provided parameters.
- getNext(JobParameters) - Method in class org.springframework.batch.core.job.parameters.RunIdIncrementer
-
Increment the run.id parameter (starting with 1).
- getNextElements(ParserContext, String, BeanDefinition, Element) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Retrieve a list of
StateTransitioninstances from aParserContext. - getNextElements(ParserContext, BeanDefinition, Element) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
- getObject() - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.Create an
ApplicationContextFactoryfrom each resource provided inClasspathXmlApplicationContextsFactoryBean.setResources(Resource[]). - getObject() - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- getObject() - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- getObject() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Create a
Stepfrom the configuration provided. - getObject() - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
- getObject() - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- getObject() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.
- getObject() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- getObject() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Create a
Stepfrom the configuration provided. - getObject() - Method in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- getObjectType() - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.The type of object returned by this factory as an array of
ApplicationContextFactory. - getObjectType() - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- getObjectType() - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- getObjectType() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getObjectType() - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
- getObjectType() - Method in class org.springframework.batch.core.listener.JobListenerFactoryBean
- getObjectType() - Method in class org.springframework.batch.core.listener.StepListenerFactoryBean
- getObjectType() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.Returns the type of object to be returned from
AbstractJobExplorerFactoryBean.getObject(). - getObjectType() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
The type of object to be returned from
AbstractJobRepositoryFactoryBean.getObject(). - getObjectType() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- getObjectType() - Method in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.Tell clients that we are a factory for
Stepinstances. - getObservationRegistry() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
-
Return the
ObservationRegistryto use for the job operator. - getObservationRegistry() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- getObservationRegistry() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- getOffset() - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- getOrder() - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- getOrder() - Method in class org.springframework.batch.core.scope.BatchScopeSupport
- getParameter(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
- getParameters(long) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of the
getJobParameters()method ofJobRepository.getJobExecution(long). Scheduled for removal in 6.2 or later. - getParameters(long) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getParamTypes() - Method in enum class org.springframework.batch.core.listener.JobListenerMetaData
- getParamTypes() - Method in interface org.springframework.batch.core.listener.ListenerMetaData
- getParamTypes() - Method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- getPartitioner() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getPartitionHandler() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getPartitionHandler() - Method in class org.springframework.batch.core.partition.PartitionStep
- getPartitionHandler() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getPartitionNames(int) - Method in interface org.springframework.batch.core.partition.PartitionNameProvider
- getPattern() - Method in class org.springframework.batch.core.job.flow.support.StateTransition
- getPhase() - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- getProcessor() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- getProcessSkipCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getProcessSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Public getter for the process skip count.
- getProcessSkipCount() - Method in class org.springframework.batch.core.step.StepExecution
- getProperties(JobParameters) - Method in class org.springframework.batch.core.converter.DefaultJobParametersConverter
- getProperties(JobParameters) - Method in interface org.springframework.batch.core.converter.JobParametersConverter
-
The inverse operation: get a
Propertiesinstance. - getPropertyName() - Method in enum class org.springframework.batch.core.listener.JobListenerMetaData
- getPropertyName() - Method in interface org.springframework.batch.core.listener.ListenerMetaData
- getPropertyName() - Method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- getPropertyValue(String, String, ConfigurableListableBeanFactory) - Static method in class org.springframework.batch.core.configuration.xml.BeanDefinitionUtils
- getQuery(String) - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- getReadCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getReadCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Public access to the read counter.
- getReadCount() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the current number of items read for this execution.
- getReader() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- getReadSkipCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getReadSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Public getter for the read skip count.
- getReadSkipCount() - Method in class org.springframework.batch.core.step.StepExecution
- getRestartable() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- getRollbackClassifier() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Convenience method to get an exception classifier based on the provided transaction attributes.
- getRollbackCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getRollbackCount() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the current number of rollbacks for this execution.
- getRunningExecutions(String) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobRepository.findRunningJobExecutions(String). Scheduled for removal in 6.2 or later. - getRunningExecutions(String) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getSimpleStepBuilder(String) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
- getSkipCount() - Method in class org.springframework.batch.core.step.StepExecution
- getSkipLimit() - Method in exception class org.springframework.batch.core.step.skip.SkipLimitExceededException
- getSkipListeners() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- getSplitter() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getStartLimit() - Method in class org.springframework.batch.core.step.AbstractStep
- getStartLimit() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- getStartLimit() - Method in interface org.springframework.batch.core.step.Step
- getStartState() - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- getStartTime() - Method in class org.springframework.batch.core.job.JobExecution
- getStartTime() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getStartTime() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getStartTime() - Method in class org.springframework.batch.core.step.StepExecution
-
Gets the time when this execution started.
- getState() - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean.DelegateState
-
Gets the current state.
- getState() - Method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Public getter for the State.
- getState(String) - Method in interface org.springframework.batch.core.job.flow.Flow
-
Retrieve the State with the given name.
- getState(String) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
-
Retrieve the State with the given name.
- getStateMap() - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- getStates() - Method in interface org.springframework.batch.core.job.flow.Flow
-
Convenient accessor for clients needing to explore the states of this flow.
- getStates() - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
-
Convenient accessor for clients needing to explore the states of this flow.
- getStateTransitionReference(ParserContext, BeanDefinition, String, String) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Gets a reference to the state transition.
- getStatus() - Method in class org.springframework.batch.core.job.flow.FlowExecution
- getStatus() - Method in class org.springframework.batch.core.job.flow.support.state.EndState
- getStatus() - Method in class org.springframework.batch.core.job.JobExecution
- getStatus() - Method in exception class org.springframework.batch.core.job.JobInterruptedException
-
The desired status of the surrounding execution after the interruption.
- getStatus() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getStatus() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getStatus() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the current status of this step.
- getStep() - Method in class org.springframework.batch.core.job.flow.support.state.StepState
- getStep() - Method in class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
-
The step instance that will be executed in parallel by this handler.
- getStep() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getStep() - Method in interface org.springframework.batch.core.step.StepHolder
- getStep(String) - Method in class org.springframework.batch.core.job.AbstractJob
-
Retrieve the step with the given name.
- getStep(String) - Method in class org.springframework.batch.core.job.flow.FlowJob
-
Retrieve the step with the given name.
- getStep(String) - Method in class org.springframework.batch.core.job.flow.support.state.StepState
- getStep(String) - Method in class org.springframework.batch.core.job.SimpleJob
- getStep(String) - Method in interface org.springframework.batch.core.step.StepLocator
- getStep(String, String) - Method in interface org.springframework.batch.core.configuration.StepRegistry
-
Deprecated.Returns the
Stepof the specified job based on its name. - getStep(String, String) - Method in class org.springframework.batch.core.configuration.support.MapStepRegistry
-
Deprecated.
- getStepContext() - Method in class org.springframework.batch.core.scope.context.ChunkContext
- getStepExecution() - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
- getStepExecution() - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- getStepExecution() - Method in class org.springframework.batch.core.scope.context.StepContext
-
The current
StepExecutionthat is active in this context. - getStepExecution() - Method in class org.springframework.batch.core.step.StepContribution
-
Public getter for the parent step execution of this contribution.
- getStepExecution(long) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- getStepExecution(long) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- getStepExecution(long) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Retrieve a
StepExecutionfrom its id. - getStepExecution(long) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Retrieve a
StepExecutionby its ID. - getStepExecution(long) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Retrieve a
StepExecutionby its id. - getStepExecution(long) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- getStepExecution(long, long) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.Retrieve a
StepExecutionby its ID and parentJobExecutionID. - getStepExecution(long, long) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getStepExecution(long, long) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobRepository.getStepExecution(long) - getStepExecution(long, long) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getStepExecution(JobExecution, long) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getStepExecution(JobExecution, long) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getStepExecution(JobExecution, long) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
StepExecutionDao.getStepExecution(long) - getStepExecutionAggergator() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getStepExecutionContext() - Method in class org.springframework.batch.core.scope.context.StepContext
- getStepExecutionCount(JobInstance, String) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated.
- getStepExecutionCount(JobInstance, String) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getStepExecutionCount(JobInstance, String) - Method in interface org.springframework.batch.core.repository.JobRepository
- getStepExecutionCount(JobInstance, String) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getStepExecutionDao() - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getStepExecutionId() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getStepExecutionIncrementer() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the incrementer to be used to generate ids for new step executions.
- getStepExecutionIncrementerName() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the step execution incrementer name.
- getStepExecutionListeners() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- getStepExecutions() - Method in class org.springframework.batch.core.job.JobExecution
-
Accessor for the step executions.
- getStepExecutions() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- getStepExecutions(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
-
Retrieve all
StepExecutions for a givenJobExecution. - getStepExecutions(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
-
Retrieve all
StepExecutions for a givenJobExecution. - getStepExecutions(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Retrieve all
StepExecutions for a givenJobExecution. - getStepExecutionSplitter() - Method in class org.springframework.batch.core.partition.PartitionStep
- getStepExecutionSummaries(long) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of the
getStepExecutions()method ofJobRepository.getJobExecution(long). Scheduled for removal in 6.2 or later. - getStepExecutionSummaries(long) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getStepName() - Method in interface org.springframework.batch.core.partition.StepExecutionSplitter
-
The name of the step configuration that will be executed remotely.
- getStepName() - Method in class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
- getStepName() - Method in class org.springframework.batch.core.scope.context.StepContext
-
Convenient accessor for current step name identifier.
- getStepName() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getStepName() - Method in class org.springframework.batch.core.step.StepExecution
- getStepNames() - Method in class org.springframework.batch.core.job.AbstractJob
-
Retrieve the step names.
- getStepNames() - Method in class org.springframework.batch.core.job.flow.FlowJob
-
Retrieve the step names.
- getStepNames() - Method in class org.springframework.batch.core.job.flow.support.state.StepState
- getStepNames() - Method in class org.springframework.batch.core.job.SimpleJob
-
Convenience method for clients to inspect the steps for this job.
- getStepNames() - Method in interface org.springframework.batch.core.step.ListableStepLocator
- getStepOperations() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Convenience method for subclasses to access the step operations that were injected by user.
- getStepOperations() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the step operations to make them available in subclasses.
- getStepSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
- getStreams() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- getString(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Stringrepresented by the provided key. - getString(String, String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Stringrepresented by the provided key. - getSummary() - Method in class org.springframework.batch.core.step.StepExecution
- getSummary(long) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of the
toString()method ofJobRepository.getJobExecution(long). Scheduled for removal in 6.2 or later. - getSummary(long) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getSystemProperties() - Method in class org.springframework.batch.core.scope.context.JobContext
-
Convenient accessor for System properties to make it easy to access them from placeholder expressions.
- getSystemProperties() - Method in class org.springframework.batch.core.scope.context.StepContext
-
Convenient accessor for System properties to make it easy to access them from placeholder expressions.
- getTablePrefix() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the prefix of Batch meta-data tables.
- getTablePrefix() - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- getTarget() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- getTarget() - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- getTarget() - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- getTargetNamePrefix() - Method in class org.springframework.batch.core.scope.BatchScopeSupport
- getTargetNamePrefix() - Method in class org.springframework.batch.core.scope.JobScope
- getTargetNamePrefix() - Method in class org.springframework.batch.core.scope.StepScope
- getTaskExecutor() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
-
Return the
TaskExecutorto use in the job operator. - getTaskExecutor() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getTaskExecutor() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getTaskExecutor() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Make the
TaskExecutoravailable to subclasses - getTasklet() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getTasklet() - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
retrieve the tasklet - helper method for JobOperator
- getTransactionAttribute() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- getTransactionAttribute() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Getter for the
TransactionAttributefor subclasses only. - getTransactionManager() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
-
Return the transaction manager to use for the job operator.
- getTransactionManager() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
- getTransactionManager() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
- getTransactionManager() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- getTransactionManager() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.The transaction manager used in this factory.
- getTransactionManager() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
The transaction manager used in this factory.
- getTransactionManager() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- getTransitionMap() - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- getValidateTransactionState() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the value of the
validateTransactionStateparameter. - getValidateTransactionState() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the value of the
validateTransactionStateparameter. - getVersion() - Method in class org.springframework.batch.core.Entity
- getVersion() - Static method in class org.springframework.batch.core.SpringBatchVersion
-
Return the full version string of the present Spring Batch codebase, or
"N/A"if it cannot be determined. - getWriteCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getWriteCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Public access to the write counter.
- getWriteCount() - Method in class org.springframework.batch.core.step.StepExecution
-
Returns the current number of items written for this execution.
- getWriter() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- getWriteSkipCount() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- getWriteSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Public getter for the write skip count.
- getWriteSkipCount() - Method in class org.springframework.batch.core.step.StepExecution
- gridSize - Variable in class org.springframework.batch.core.partition.support.AbstractPartitionHandler
- gridSize(int) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
A hint to the
PartitionStepBuilder.splitter(StepExecutionSplitter)about how many step executions are required. - GroupAwareJob - Class in org.springframework.batch.core.configuration.support
-
A
Jobthat can optionally prepend a group name to another job's name, to make it fit a naming convention for type or origin. - GroupAwareJob(String, Job) - Constructor for class org.springframework.batch.core.configuration.support.GroupAwareJob
-
Create a new
Jobwith the given group name and delegate.
H
- handle(FlowExecutor) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean.DelegateState
- handle(FlowExecutor) - Method in interface org.springframework.batch.core.job.flow.State
-
Handle some business or processing logic and return a status that can be used to drive a flow to the next
State. - handle(FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.AbstractState
- handle(FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.DecisionState
- handle(FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.EndState
-
Return the
FlowExecutionStatusstored. - handle(FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.FlowState
- handle(FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.SplitState
-
Execute the flows in parallel by passing them to the
TaskExecutorand wait for all of them to finish before proceeding. - handle(FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.StepState
- handle(StepExecutionSplitter, StepExecution) - Method in interface org.springframework.batch.core.partition.PartitionHandler
-
Main entry point for
PartitionHandlerinterface. - handle(StepExecutionSplitter, StepExecution) - Method in class org.springframework.batch.core.partition.support.AbstractPartitionHandler
- handleException(RepeatContext, Throwable) - Method in class org.springframework.batch.core.step.item.SimpleRetryExceptionHandler
-
Deprecated.Check if the exception is going to be retried, and veto the handling if it is.
- handleListenersElement(Element, BeanDefinition, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.StepListenerParser
- handleStep(Step, JobExecution) - Method in class org.springframework.batch.core.job.AbstractJob
-
Convenience method for subclasses to delegate the handling of a specific step in the context of the current
JobExecution. - handleStep(Step, JobExecution) - Method in class org.springframework.batch.core.job.SimpleStepHandler
- handleStep(Step, JobExecution) - Method in interface org.springframework.batch.core.job.StepHandler
-
Handle a step and return the execution for it.
- hasChunkElement() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- hashCode() - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.
- hashCode() - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
- hashCode() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in class org.springframework.batch.core.Entity
- hashCode() - Method in class org.springframework.batch.core.ExitStatus
-
Compatible with the equals implementation.
- hashCode() - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
- hashCode() - Method in class org.springframework.batch.core.job.flow.support.StateTransition
- hashCode() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Returns a hash code value for this object.
- hashCode() - Method in class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- hashCode() - Method in record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.batch.core.repository.persistence.ExitStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns a hash code value for this object.
- hashCode() - Method in class org.springframework.batch.core.scope.context.JobContext
-
Overrides the default behaviour to provide a hash code based only on the job execution.
- hashCode() - Method in class org.springframework.batch.core.scope.context.StepContext
-
Overrides the default behaviour to provide a hash code based only on the step execution.
- hashCode() - Method in class org.springframework.batch.core.step.StepContribution
- hashCode() - Method in class org.springframework.batch.core.step.StepExecution
- hasPartitionElement() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- hasTasklet() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
I
- ID_ATTR - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes the ID attribute.
- ID_ATTR - Static variable in class org.springframework.batch.core.configuration.xml.AbstractStepParser
-
The ID attribute for the step parser.
- ID_KEY - Static variable in class org.springframework.batch.core.scope.JobScope
-
Context key for clients to use for conversation identifier.
- ID_KEY - Static variable in class org.springframework.batch.core.scope.StepScope
-
Context key for clients to use for conversation identifier.
- identifying() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns the value of the
identifyingrecord component. - identifying() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
identifyingrecord component. - identifying() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
identifyingrecord component. - increment() - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
- incrementCommitCount() - Method in class org.springframework.batch.core.step.StepExecution
-
Increment the number of commits.
- incrementer - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- incrementer(JobParametersIncrementer) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Add a job parameters incrementer.
- incrementerFactory - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- incrementerFactoryRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
The incrementer factory to use in various DAOs.
- incrementFilterCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the counter for the number of filtered items.
- incrementFilterCount(long) - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the counter for the number of filtered items.
- incrementOffset() - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- incrementProcessSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
- incrementProcessSkipCount(long) - Method in class org.springframework.batch.core.step.StepContribution
- incrementReadCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the counter for the number of items read.
- incrementReadSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the read skip count for this contribution.
- incrementReadSkipCount(long) - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the read skip count for this contribution.
- incrementRollbackCount() - Method in class org.springframework.batch.core.step.StepExecution
-
Increments the rollback count.
- incrementVersion() - Method in class org.springframework.batch.core.Entity
-
Increment the version number.
- incrementWriteCount(long) - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the counter for the number of items written.
- incrementWriteSkipCount() - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the write skip count for this contribution.
- incrementWriteSkipCount(long) - Method in class org.springframework.batch.core.step.StepContribution
-
Increment the write skip count for this contribution.
- init() - Method in class org.springframework.batch.core.configuration.xml.CoreNamespaceHandler
- initializeUserData(Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- initializeUserData(Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Extension point for subclasses to allow them to memorise the contents of the inputs, in case they are needed for accounting purposes later.
- InlineFlowParser - Class in org.springframework.batch.core.configuration.xml
- InlineFlowParser(String, String) - Constructor for class org.springframework.batch.core.configuration.xml.InlineFlowParser
-
Construct a
InlineFlowParserwith the specified name and using the provided job repository reference. - InlineStepParser - Class in org.springframework.batch.core.configuration.xml
-
Internal parser for the <step/> elements inside a job.
- InlineStepParser() - Constructor for class org.springframework.batch.core.configuration.xml.InlineStepParser
- instantFormatter - Variable in class org.springframework.batch.core.converter.DateToStringConverter
- instantFormatter - Variable in class org.springframework.batch.core.converter.LocalDateTimeToStringConverter
- instantFormatter - Variable in class org.springframework.batch.core.converter.LocalDateToStringConverter
- instantFormatter - Variable in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- instantFormatter - Variable in class org.springframework.batch.core.converter.StringToDateConverter
- instantFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateConverter
- instantFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateTimeConverter
- instantFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalTimeConverter
- interruptionPolicy(StepInterruptionPolicy) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set the interruption policy for the step.
- intValue(String) - Method in interface org.springframework.batch.core.launch.support.ExitCodeMapper
-
Convert the exit code from String into an integer that the calling environment as an operating system can interpret as an exit status.
- intValue(String) - Method in class org.springframework.batch.core.launch.support.SimpleJvmExitCodeMapper
-
Get the operating system exit status that matches a certain Batch Framework exit code
- InvalidJobParametersException - Exception Class in org.springframework.batch.core.job.parameters
-
Exception for
Jobto signal that someJobParametersare invalid. - InvalidJobParametersException(String) - Constructor for exception class org.springframework.batch.core.job.parameters.InvalidJobParametersException
-
Constructor that sets the message for the exception.
- invoke(MethodInvocation) - Method in class org.springframework.batch.core.launch.support.RuntimeExceptionTranslator
-
Deprecated.
- invoke(MethodInvocation) - Method in class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- isAbandon() - Method in class org.springframework.batch.core.job.flow.support.state.EndState
- isAbstract(Element) - Static method in class org.springframework.batch.core.configuration.xml.CoreNamespaceUtils
- isAllowStartIfComplete() - Method in class org.springframework.batch.core.step.AbstractStep
- isAllowStartIfComplete() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- isAllowStartIfComplete() - Method in interface org.springframework.batch.core.step.Step
- isAutoStartup() - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- isComplete() - Method in class org.springframework.batch.core.scope.context.ChunkContext
- isComplete(Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- isComplete(Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Extension point for subclasses that want to store additional data in the inputs.
- isComplete(RepeatContext) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.
- isComplete(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.
- isCopyConfiguration() - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Protected access for subclasses to the flag that determines whether configuration should be copied from the parent context.
- isEagerInit() - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- isEmpty() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
- isEnd() - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
- isEnd() - Method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Check for a special next State signalling the end of a job.
- isEndState() - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean.DelegateState
- isEndState() - Method in interface org.springframework.batch.core.job.flow.State
-
Inquire as to whether a
Stateis an end state. - isEndState() - Method in class org.springframework.batch.core.job.flow.support.state.DecisionState
- isEndState() - Method in class org.springframework.batch.core.job.flow.support.state.EndState
- isEndState() - Method in class org.springframework.batch.core.job.flow.support.state.FlowState
- isEndState() - Method in class org.springframework.batch.core.job.flow.support.state.SplitState
- isEndState() - Method in class org.springframework.batch.core.job.flow.support.state.StepState
- isFail() - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
- isFaultTolerant() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Indicates whether the step has any components that require fault tolerance.
- isFlowContinued(State, FlowExecutionStatus, StepExecution) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- isGreaterThan(BatchStatus) - Method in enum class org.springframework.batch.core.BatchStatus
- isJobInstanceExists(String, JobParameters) - Method in interface org.springframework.batch.core.repository.explore.JobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.Since v6.0 and scheduled for removal in v6.2. Use
JobExplorer.getJobInstance(String, JobParameters)and check fornullresult instead. - isJobInstanceExists(String, JobParameters) - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated, for removal: This API element is subject to removal in a future version.
- isJobInstanceExists(String, JobParameters) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Deprecated, for removal: This API element is subject to removal in a future version.
- isLessThan(BatchStatus) - Method in enum class org.springframework.batch.core.BatchStatus
- isLessThanOrEqualTo(BatchStatus) - Method in enum class org.springframework.batch.core.BatchStatus
- isListener(Object) - Static method in class org.springframework.batch.core.listener.JobListenerFactoryBean
-
Convenience method to check whether the given object is or can be made into a
JobExecutionListener. - isListener(Object) - Static method in class org.springframework.batch.core.listener.StepListenerFactoryBean
-
Convenience method to check whether the given object is or can be made into a
StepListener. - isListener(Object, Class, ListenerMetaData[]) - Static method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
-
Convenience method to check whether the given object is or can be made into a listener.
- isNonDefaultExitStatus(ExitStatus) - Static method in class org.springframework.batch.core.ExitStatus
- isolationLevelForCreate() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the isolation level for create parameter value.
- isolationLevelForCreate() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
Set the isolation level for create parameter value.
- isPrototype() - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- isReaderTransactionalQueue() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- isReaderTransactionalQueue() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Convenience method for subclasses.
- isRestart() - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
- isRestart() - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- isRestartable() - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
- isRestartable() - Method in class org.springframework.batch.core.job.AbstractJob
- isRestartable() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
- isRestartable() - Method in interface org.springframework.batch.core.job.Job
-
Flag to indicate if this job can be restarted, at least in principle.
- isRunning() - Method in enum class org.springframework.batch.core.BatchStatus
-
Convenience method to decide if a status indicates that work is in progress.
- isRunning() - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.Check whether this component has been started.
- isRunning() - Method in class org.springframework.batch.core.ExitStatus
-
Check if this status represents a running process.
- isRunning() - Method in class org.springframework.batch.core.job.JobExecution
-
Test if this
JobExecutionindicates that it is running. - isSingleton() - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.Optimization hint for bean factory.
- isSingleton() - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- isSingleton() - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- isSingleton() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- isSingleton() - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
- isSingleton() - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- isSingleton() - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.
- isSingleton() - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- isSingleton() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Returns true by default, but in most cases a
Stepshould not be treated as thread-safe. - isSingleton() - Method in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.Always return true as optimization for bean factory.
- isStop() - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
- isStopped() - Method in class org.springframework.batch.core.job.JobExecution
-
Test if this
StepExecutionindicates that it has been stopped. - isStopping() - Method in class org.springframework.batch.core.job.JobExecution
-
Test if this
JobExecutionindicates that it has been signalled to stop. - isTerminateOnly() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- isTerminateOnly() - Method in class org.springframework.batch.core.step.StepExecution
- isUnderspecified(Element) - Static method in class org.springframework.batch.core.configuration.xml.CoreNamespaceUtils
-
Should this element be treated as incomplete?
- isUnsuccessful() - Method in enum class org.springframework.batch.core.BatchStatus
-
Convenience method to decide if a status indicates execution was unsuccessful.
- itemCount - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkWriteEvent
- itemListenerMetaData() - Static method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- ItemListenerSupport<I,
O> - Class in org.springframework.batch.core.listener -
Basic no-op implementation of the
ItemReadListener,ItemProcessListener, andItemWriteListenerinterfaces. - ItemListenerSupport() - Constructor for class org.springframework.batch.core.listener.ItemListenerSupport
- ItemProcessEvent - Class in org.springframework.batch.core.observability.jfr.events.step.chunk
- ItemProcessEvent(String, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemProcessEvent
- ItemProcessListener<T,
S> - Interface in org.springframework.batch.core.listener -
Listener interface for the processing of an item.
- itemProcessStatus - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemProcessEvent
- itemReader - Variable in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
- ItemReadEvent - Class in org.springframework.batch.core.observability.jfr.events.step.chunk
- ItemReadEvent(String, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemReadEvent
- ItemReadListener<T> - Interface in org.springframework.batch.core.listener
-
Listener interface around the reading of an item.
- itemReadStatus - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemReadEvent
- ItemWriteListener<S> - Interface in org.springframework.batch.core.listener
-
Listener interface for the writing of items.
- iterator() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
J
- Jackson2ExecutionContextStringSerializer - Class in org.springframework.batch.core.repository.dao
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JacksonExecutionContextStringSerializer. Scheduled for removal in 7.0. - Jackson2ExecutionContextStringSerializer(String...) - Constructor for class org.springframework.batch.core.repository.dao.Jackson2ExecutionContextStringSerializer
-
Deprecated.Create a new
Jackson2ExecutionContextStringSerializer. - JacksonExecutionContextStringSerializer - Class in org.springframework.batch.core.repository.dao
-
An
ExecutionContextSerializerthat uses Jackson 3 to serialize/deserialize the execution context as JSON. - JacksonExecutionContextStringSerializer() - Constructor for class org.springframework.batch.core.repository.dao.JacksonExecutionContextStringSerializer
-
Create a new
JacksonExecutionContextStringSerializerwith default configuration (only classes from certain packages will be allowed to be deserialized). - JacksonExecutionContextStringSerializer(JsonMapper) - Constructor for class org.springframework.batch.core.repository.dao.JacksonExecutionContextStringSerializer
-
Create a new
JacksonExecutionContextStringSerializerwith a customJsonMapper. - JdbcDefaultBatchConfiguration - Class in org.springframework.batch.core.configuration.support
-
Base
Configurationclass that provides common JDBC-based infrastructure beans for enabling and using Spring Batch. - JdbcDefaultBatchConfiguration() - Constructor for class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
- JdbcExecutionContextDao - Class in org.springframework.batch.core.repository.dao.jdbc
-
JDBC DAO for
ExecutionContext. - JdbcExecutionContextDao() - Constructor for class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- JdbcJobExecutionDao - Class in org.springframework.batch.core.repository.dao.jdbc
-
JDBC implementation of
JobExecutionDao. - JdbcJobExecutionDao() - Constructor for class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- JdbcJobExplorerFactoryBean - Class in org.springframework.batch.core.repository.explore.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JdbcJobRepositoryFactoryBean. Scheduled for removal in 6.2 or later. - JdbcJobExplorerFactoryBean() - Constructor for class org.springframework.batch.core.repository.explore.support.JdbcJobExplorerFactoryBean
-
Deprecated.
- JdbcJobInstanceDao - Class in org.springframework.batch.core.repository.dao.jdbc
-
JDBC implementation of
JobInstanceDao. - JdbcJobInstanceDao() - Constructor for class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
- JdbcJobRepositoryFactoryBean - Class in org.springframework.batch.core.repository.support
-
A
FactoryBeanthat automates the creation of aSimpleJobRepositoryusing JDBC DAO implementations which persist batch metadata in a relational database. - JdbcJobRepositoryFactoryBean() - Constructor for class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
- jdbcOperations - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- jdbcOperations - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- jdbcOperationsRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the
JdbcOperationsto use in the job repository. - JdbcStepExecutionDao - Class in org.springframework.batch.core.repository.dao.jdbc
-
JDBC implementation of
StepExecutionDao.
Allows customization of the tables names used by Spring Batch for step meta data via a prefix property.
Uses sequences or tables (via Spring'sDataFieldMaxValueIncrementerabstraction) to create all primary keys before inserting a new row. - JdbcStepExecutionDao() - Constructor for class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- job(Job) - Method in class org.springframework.batch.core.step.builder.JobStepBuilder
-
Provide a job to execute during the step.
- job(Job) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Create a new step builder that will execute a job.
- Job - Interface in org.springframework.batch.core.job
-
Batch domain object representing a job.
- JOB_NOT_PROVIDED - Static variable in interface org.springframework.batch.core.launch.support.ExitCodeMapper
- JobBuilder - Class in org.springframework.batch.core.job.builder
-
Convenience for building jobs of various kinds.
- JobBuilder(String, JobRepository) - Constructor for class org.springframework.batch.core.job.builder.JobBuilder
-
Create a new builder for a job with the given name and job repository.
- JobBuilder(JobRepository) - Constructor for class org.springframework.batch.core.job.builder.JobBuilder
-
Create a new builder for a job with the given job repository.
- JobBuilderException - Exception Class in org.springframework.batch.core.job.builder
- JobBuilderException(Exception) - Constructor for exception class org.springframework.batch.core.job.builder.JobBuilderException
- JobBuilderHelper<B> - Class in org.springframework.batch.core.job.builder
-
A base class and utility for other job builders providing access to common properties like job repository.
- JobBuilderHelper(String, JobRepository) - Constructor for class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Create a new
JobBuilderHelper. - JobBuilderHelper(JobBuilderHelper) - Constructor for class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Create a new builder initialized with any properties in the parent.
- JobBuilderHelper(JobRepository) - Constructor for class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Create a new
JobBuilderHelper. - JobBuilderHelper.CommonJobProperties - Class in org.springframework.batch.core.job.builder
- JobContext - Class in org.springframework.batch.core.scope.context
-
A context object that can be used to interrogate the current
JobExecutionand some of its associated properties using expressions based on bean paths. - JobContext(JobExecution) - Constructor for class org.springframework.batch.core.scope.context.JobContext
- JobExecution - Class in org.springframework.batch.core.job
-
Batch domain object representing the execution of a job.
- JobExecution - Class in org.springframework.batch.core.repository.persistence
- JobExecution() - Constructor for class org.springframework.batch.core.repository.persistence.JobExecution
- JobExecution(long, JobInstance, JobParameters) - Constructor for class org.springframework.batch.core.job.JobExecution
-
Create a new
JobExecutioninstance. - JobExecutionAlreadyRunningException - Exception Class in org.springframework.batch.core.launch
- JobExecutionAlreadyRunningException(String) - Constructor for exception class org.springframework.batch.core.launch.JobExecutionAlreadyRunningException
- JobExecutionAlreadyRunningException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.JobExecutionAlreadyRunningException
- JobExecutionConverter - Class in org.springframework.batch.core.repository.persistence.converter
- JobExecutionConverter() - Constructor for class org.springframework.batch.core.repository.persistence.converter.JobExecutionConverter
- jobExecutionDao - Variable in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- JobExecutionDao - Interface in org.springframework.batch.core.repository.dao
-
Data Access Object for job executions.
- JobExecutionDecider - Interface in org.springframework.batch.core.job.flow
-
Interface allowing for programmatic access to the decision on what the status of a flow should be.
- JobExecutionEvent - Class in org.springframework.batch.core.observability.jfr.events.job
- JobExecutionEvent(String, long, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.job.JobExecutionEvent
- JobExecutionException - Exception Class in org.springframework.batch.core.job
-
Root of exception hierarchy for checked exceptions in job and step execution.
- JobExecutionException(String) - Constructor for exception class org.springframework.batch.core.job.JobExecutionException
-
Construct a
JobExecutionExceptionwith a generic message. - JobExecutionException(String, Throwable) - Constructor for exception class org.springframework.batch.core.job.JobExecutionException
-
Construct a
JobExecutionExceptionwith a generic message and a cause. - jobExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.job.JobExecutionEvent
- jobExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.StepExecutionEvent
- jobExecutionIncrementerName - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- jobExecutionIncrementerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
The incrementer that will be used to generate unique ids for job executions.
- JobExecutionListener - Interface in org.springframework.batch.core.listener
-
Provide callbacks at specific points in the lifecycle of a
Job. - JobExecutionListenerParser - Class in org.springframework.batch.core.configuration.xml
-
Parser for a step listener element.
- JobExecutionListenerParser() - Constructor for class org.springframework.batch.core.configuration.xml.JobExecutionListenerParser
- JobExecutionNotFailedException - Exception Class in org.springframework.batch.core.launch
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 in favor of
JobRestartExceptionwith a specific message. Scheduled for removal in 6.2. - JobExecutionNotFailedException(String) - Constructor for exception class org.springframework.batch.core.launch.JobExecutionNotFailedException
-
Deprecated.Create an exception with the given message.
- JobExecutionNotFailedException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.JobExecutionNotFailedException
-
Deprecated.
- JobExecutionNotRunningException - Exception Class in org.springframework.batch.core.launch
-
Checked exception indicating that a JobExecution that is not currently running has been requested to stop.
- JobExecutionNotRunningException(String) - Constructor for exception class org.springframework.batch.core.launch.JobExecutionNotRunningException
-
Create a
JobExecutionNotRunningExceptionwith a message. - JobExecutionNotStoppedException - Exception Class in org.springframework.batch.core.launch
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 in favor of
JobExecutionAlreadyRunningException. Scheduled for removal in 6.2. - JobExecutionNotStoppedException(String) - Constructor for exception class org.springframework.batch.core.launch.JobExecutionNotStoppedException
-
Deprecated.Create an exception with the given message.
- JobExecutionShutdownHook - Class in org.springframework.batch.core.launch.support
-
A shutdown hook that attempts to gracefully stop a running job execution when the JVM is exiting.
- JobExecutionShutdownHook(JobExecution, JobOperator) - Constructor for class org.springframework.batch.core.launch.support.JobExecutionShutdownHook
-
Create a new
JobExecutionShutdownHook. - JobExplorer - Interface in org.springframework.batch.core.repository.explore
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobRepository. Scheduled for removal in 6.2 or later. - JobExplorerFactoryBean - Class in org.springframework.batch.core.repository.explore.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JdbcJobRepositoryFactoryBean. Scheduled for removal in 6.2 or later. - JobExplorerFactoryBean() - Constructor for class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- JobFactory - Interface in org.springframework.batch.core.configuration
-
Deprecated, for removal: This API element is subject to removal in a future version.
- JobFactoryRegistrationListener - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- JobFactoryRegistrationListener() - Constructor for class org.springframework.batch.core.configuration.support.JobFactoryRegistrationListener
-
Deprecated.
- JobFlowBuilder - Class in org.springframework.batch.core.job.builder
- JobFlowBuilder(FlowJobBuilder) - Constructor for class org.springframework.batch.core.job.builder.JobFlowBuilder
- JobFlowBuilder(FlowJobBuilder, Flow) - Constructor for class org.springframework.batch.core.job.builder.JobFlowBuilder
- JobFlowBuilder(FlowJobBuilder, JobExecutionDecider) - Constructor for class org.springframework.batch.core.job.builder.JobFlowBuilder
- JobFlowBuilder(FlowJobBuilder, Step) - Constructor for class org.springframework.batch.core.job.builder.JobFlowBuilder
- JobFlowExecutor - Class in org.springframework.batch.core.job.flow
-
Implementation of
FlowExecutorfor use in components that need to execute a flow related to aJobExecution. - JobFlowExecutor(JobRepository, StepHandler, JobExecution) - Constructor for class org.springframework.batch.core.job.flow.JobFlowExecutor
- JobInstance - Class in org.springframework.batch.core.job
-
Batch domain object representing a uniquely identifiable job run.
- JobInstance - Class in org.springframework.batch.core.repository.persistence
- JobInstance() - Constructor for class org.springframework.batch.core.repository.persistence.JobInstance
- JobInstance(long, String) - Constructor for class org.springframework.batch.core.job.JobInstance
-
Constructor for
JobInstance. - JobInstanceAlreadyCompleteException - Exception Class in org.springframework.batch.core.launch
-
An exception indicating an illegal attempt to restart a job that was already completed successfully.
- JobInstanceAlreadyCompleteException(String) - Constructor for exception class org.springframework.batch.core.launch.JobInstanceAlreadyCompleteException
- JobInstanceAlreadyCompleteException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.JobInstanceAlreadyCompleteException
- JobInstanceAlreadyExistsException - Exception Class in org.springframework.batch.core.launch
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- JobInstanceAlreadyExistsException(String) - Constructor for exception class org.springframework.batch.core.launch.JobInstanceAlreadyExistsException
-
Deprecated.Create an exception with the given message.
- JobInstanceAlreadyExistsException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.JobInstanceAlreadyExistsException
-
Deprecated.
- JobInstanceConverter - Class in org.springframework.batch.core.repository.persistence.converter
- JobInstanceConverter() - Constructor for class org.springframework.batch.core.repository.persistence.converter.JobInstanceConverter
- jobInstanceDao - Variable in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- JobInstanceDao - Interface in org.springframework.batch.core.repository.dao
-
Data Access Object for job instances.
- jobInstanceId - Variable in class org.springframework.batch.core.observability.jfr.events.job.JobExecutionEvent
- jobInstanceIncrementerName - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- jobInstanceIncrementerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
The incrementer that will be used to generate unique ids for job instances.
- JobInterruptedException - Exception Class in org.springframework.batch.core.job
-
Exception to indicate the job has been interrupted.
- JobInterruptedException(String) - Constructor for exception class org.springframework.batch.core.job.JobInterruptedException
-
Constructor that sets the message for the exception.
- JobInterruptedException(String, BatchStatus) - Constructor for exception class org.springframework.batch.core.job.JobInterruptedException
-
Constructor that sets the message for the exception.
- jobKeyGenerator - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- jobKeyGenerator - Variable in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- JobKeyGenerator - Interface in org.springframework.batch.core.job
-
Strategy interface for the generation of the key used in identifying unique
JobInstanceobjects. - jobKeyGeneratorRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
The generator that determines a unique key for identifying job instance objects
- jobKeyGeneratorRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
The generator that determines a unique key for identifying job instance objects
- JobLauncher - Interface in org.springframework.batch.core.launch
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobOperator. Scheduled for removal in 6.2 or later. - JobLaunchEvent - Class in org.springframework.batch.core.observability.jfr.events.job
- JobLaunchEvent(String, String) - Constructor for class org.springframework.batch.core.observability.jfr.events.job.JobLaunchEvent
- JobListenerFactoryBean - Class in org.springframework.batch.core.listener
-
This
AbstractListenerFactoryBeanimplementation is used to create aJobExecutionListener. - JobListenerFactoryBean() - Constructor for class org.springframework.batch.core.listener.JobListenerFactoryBean
- JobListenerMetaData - Enum Class in org.springframework.batch.core.listener
-
Enumeration for
JobExecutionListenermeta data, which ties together the names of methods, their interfaces, annotation, and expected arguments. - JobLoader - Interface in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- JobLocator - Interface in org.springframework.batch.core.configuration
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobRegistry. Scheduled for removal in 6.2 or later. - jobName - Variable in class org.springframework.batch.core.observability.jfr.events.job.JobExecutionEvent
- jobName - Variable in class org.springframework.batch.core.observability.jfr.events.job.JobLaunchEvent
- jobName - Variable in class org.springframework.batch.core.observability.jfr.events.step.StepExecutionEvent
- jobOperator(JobRepository) - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
- JobOperator - Interface in org.springframework.batch.core.launch
-
High level interface for operating batch jobs.
- JobOperatorFactoryBean - Class in org.springframework.batch.core.launch.support
-
Convenient factory bean that creates a transactional proxy around a
JobOperator. - JobOperatorFactoryBean() - Constructor for class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
- JobParameter<T> - Record Class in org.springframework.batch.core.job.parameters
-
Domain representation of a parameter to a batch job.
- JobParameter<T> - Record Class in org.springframework.batch.core.repository.persistence
- JobParameter(String, T, Class) - Constructor for record class org.springframework.batch.core.job.parameters.JobParameter
-
Create a new identifying
JobParameter. - JobParameter(String, T, Class, boolean) - Constructor for record class org.springframework.batch.core.job.parameters.JobParameter
-
Create a new
JobParameter. - JobParameter(String, T, String, boolean) - Constructor for record class org.springframework.batch.core.repository.persistence.JobParameter
-
Creates an instance of a
JobParameterrecord class. - JobParameterConverter - Class in org.springframework.batch.core.repository.persistence.converter
- JobParameterConverter() - Constructor for class org.springframework.batch.core.repository.persistence.converter.JobParameterConverter
- JobParameterDefinition(String, String, String, String) - Constructor for record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Creates an instance of a
JobParameterDefinitionrecord class. - JobParameterExecutionContextCopyListener - Class in org.springframework.batch.core.listener
-
This class can be used to automatically copy items from the
JobParametersto theStepExecutionContext. - JobParameterExecutionContextCopyListener() - Constructor for class org.springframework.batch.core.listener.JobParameterExecutionContextCopyListener
- jobParameters - Variable in class org.springframework.batch.core.observability.jfr.events.job.JobLaunchEvent
- JobParameters - Record Class in org.springframework.batch.core.job.parameters
-
Value object representing runtime parameters of a batch job.
- JobParameters() - Constructor for record class org.springframework.batch.core.job.parameters.JobParameters
-
Create a new empty
JobParametersinstance. - JobParameters(Set) - Constructor for record class org.springframework.batch.core.job.parameters.JobParameters
-
Create a new
JobParametersinstance. - JobParametersBuilder - Class in org.springframework.batch.core.job.parameters
-
Helper class for creating
JobParameters. - JobParametersBuilder() - Constructor for class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Default constructor.
- JobParametersBuilder(JobParameters) - Constructor for class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Copy constructor.
- JobParametersConversionException - Exception Class in org.springframework.batch.core.converter
-
Exception to report an error when converting job parameters.
- JobParametersConversionException(String) - Constructor for exception class org.springframework.batch.core.converter.JobParametersConversionException
-
Create a new
JobParametersConversionException. - JobParametersConversionException(String, Throwable) - Constructor for exception class org.springframework.batch.core.converter.JobParametersConversionException
-
Create a new
JobParametersConversionException. - jobParametersConverter - Variable in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- JobParametersConverter - Interface in org.springframework.batch.core.converter
-
A factory for
JobParametersinstances. - jobParametersConverterRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableBatchProcessing
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later
- JobParametersExtractor - Interface in org.springframework.batch.core.step.job
-
Strategy interface for translating a
StepExecutionintoJobParameters. - JobParametersIncrementer - Interface in org.springframework.batch.core.job.parameters
-
Interface for obtaining the next
JobParametersobject in a sequence. - JobParametersNotFoundException - Exception Class in org.springframework.batch.core.launch
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with not replacement. Scheduled for removal in 6.2 or later.
- JobParametersNotFoundException(String) - Constructor for exception class org.springframework.batch.core.launch.JobParametersNotFoundException
-
Deprecated.Create an exception with the given message.
- JobParametersNotFoundException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.JobParametersNotFoundException
-
Deprecated.
- JobParametersValidator - Interface in org.springframework.batch.core.job.parameters
-
Strategy interface for a
Jobto use in validating its parameters for an execution. - JobParser - Class in org.springframework.batch.core.configuration.xml
-
Parser for the <job/> element in the Batch namespace.
- JobParser() - Constructor for class org.springframework.batch.core.configuration.xml.JobParser
- JobParserJobFactoryBean - Class in org.springframework.batch.core.configuration.xml
-
This
FactoryBeanis used by the batch namespace parser to createFlowJobobjects. - JobParserJobFactoryBean(String) - Constructor for class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Constructor for the factory bean that initializes the name.
- jobRegistry - Variable in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- JobRegistry - Interface in org.springframework.batch.core.configuration
-
A runtime service registry interface for registering job configurations by
name. - jobRegistryRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableBatchProcessing
-
Set the job registry to use in the job operator.
- JobRegistrySmartInitializingSingleton - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Register a
MapJobRegistryas a bean, and it will automatically register allJobbeans in the application context. - JobRegistrySmartInitializingSingleton() - Constructor for class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.Default constructor.
- JobRegistrySmartInitializingSingleton(JobRegistry) - Constructor for class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.Convenience constructor for setting the
JobRegistry. - jobRepository - Variable in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.
- jobRepository - Variable in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- jobRepository() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
- jobRepository() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
- jobRepository() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
- JobRepository - Interface in org.springframework.batch.core.repository
-
Repository responsible for persistence of batch meta-data entities.
- JobRepositoryFactoryBean - Class in org.springframework.batch.core.repository.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JdbcJobRepositoryFactoryBean. Scheduled for removal in 6.2 or later. - JobRepositoryFactoryBean() - Constructor for class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- JobRepositoryParser - Class in org.springframework.batch.core.configuration.xml
-
Parser for the <job-repository/> element in the Batch namespace.
- JobRepositoryParser() - Constructor for class org.springframework.batch.core.configuration.xml.JobRepositoryParser
- JobRestartException - Exception Class in org.springframework.batch.core.launch
-
An exception indicating an illegal attempt to restart a job.
- JobRestartException(String) - Constructor for exception class org.springframework.batch.core.launch.JobRestartException
- JobRestartException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.JobRestartException
- jobScope() - Static method in class org.springframework.batch.core.configuration.support.ScopeConfiguration
- JobScope - Class in org.springframework.batch.core.scope
-
Scope for job context.
- JobScope - Annotation Interface in org.springframework.batch.core.configuration.annotation
-
Convenient annotation for job-scoped beans that defaults the proxy mode, so that it does not have to be specified explicitly on every bean definition.
- JobScope() - Constructor for class org.springframework.batch.core.scope.JobScope
- JobScopeManager - Class in org.springframework.batch.core.scope.context
-
Convenient aspect to wrap a single threaded job execution, where the implementation of the
Jobis not job scope aware (i.e. not the ones provided by the framework). - JobScopeManager() - Constructor for class org.springframework.batch.core.scope.context.JobScopeManager
- JobStep - Class in org.springframework.batch.core.step.job
- JobStep(JobRepository) - Constructor for class org.springframework.batch.core.step.job.JobStep
-
Create a new instance of a
JobStepwith the given job repository. - JobStepBuilder - Class in org.springframework.batch.core.step.builder
-
A step builder for
JobStepinstances. - JobStepBuilder(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.JobStepBuilder
-
Create a new builder initialized with any properties in the parent.
- JobSynchronizationManager - Class in org.springframework.batch.core.scope.context
-
Central convenience class for framework use in managing the job scope context.
- JobSynchronizationManager() - Constructor for class org.springframework.batch.core.scope.context.JobSynchronizationManager
- JsonJobParametersConverter - Class in org.springframework.batch.core.converter
-
Converter for
JobParametersinstances based on Jackson 3 and that uses a JSON naming convention for converting job parameters. - JsonJobParametersConverter() - Constructor for class org.springframework.batch.core.converter.JsonJobParametersConverter
-
Create a new
JsonJobParametersConverterwith a defaultJsonMapper. - JsonJobParametersConverter(JsonMapper) - Constructor for class org.springframework.batch.core.converter.JsonJobParametersConverter
-
Create a new
JsonJobParametersConverterwith a customJsonMapper. - JsonJobParametersConverter.JobParameterDefinition - Record Class in org.springframework.batch.core.converter
- JVM_EXITCODE_COMPLETED - Static variable in interface org.springframework.batch.core.launch.support.ExitCodeMapper
- JVM_EXITCODE_GENERIC_ERROR - Static variable in interface org.springframework.batch.core.launch.support.ExitCodeMapper
- JVM_EXITCODE_JOB_ERROR - Static variable in interface org.springframework.batch.core.launch.support.ExitCodeMapper
- JvmCommandRunner - Class in org.springframework.batch.core.step.tasklet
-
Implementation of the
CommandRunnerinterface that calls the standardRuntime.exec(String)method. - JvmCommandRunner() - Constructor for class org.springframework.batch.core.step.tasklet.JvmCommandRunner
- JvmSystemExiter - Class in org.springframework.batch.core.launch.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- JvmSystemExiter() - Constructor for class org.springframework.batch.core.launch.support.JvmSystemExiter
-
Deprecated.
K
- keyGenerator(KeyGenerator) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Sets the key generator for identifying retried items.
- KeyGenerator - Interface in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of equals/hashcode in a wrapper type if needed. Scheduled for removal in 7.0.
L
- launchJobExecution(Job, JobExecution) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.Launch the job execution using the task executor.
- LEGACY_JOB_INSTANCE_INCREMENTER_NAME - Static variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Legacy (v5) name of the job instance incrementer.
- LimitCheckingExceptionHierarchySkipPolicy - Class in org.springframework.batch.core.step.skip
-
A composite
SkipPolicythat checks if the exception is assignable from one of the given skippable exceptions, and counts the number of skips to not exceed a given limit. - LimitCheckingExceptionHierarchySkipPolicy(Set, long) - Constructor for class org.springframework.batch.core.step.skip.LimitCheckingExceptionHierarchySkipPolicy
-
Create a new
LimitCheckingExceptionHierarchySkipPolicyinstance. - LimitCheckingItemSkipPolicy - Class in org.springframework.batch.core.step.skip
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
LimitCheckingExceptionHierarchySkipPolicyinstead. Scheduled for removal in 7.0. - LimitCheckingItemSkipPolicy() - Constructor for class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.Convenience constructor that assumes all exception types are fatal.
- LimitCheckingItemSkipPolicy(int, Map) - Constructor for class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.
- LimitCheckingItemSkipPolicy(int, Classifier) - Constructor for class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.
- ListableJobLocator - Interface in org.springframework.batch.core.configuration
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0, scheduled for removal in 6.2 or later. Use
JobRegistryinstead. - ListableStepLocator - Interface in org.springframework.batch.core.step
-
Interface for listing
Steps by name. - listener(Object) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Registers objects using the annotation based listener configuration.
- listener(Object) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Registers objects using the annotation based listener configuration.
- listener(Object) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Registers objects using the annotation-based listener configuration.
- listener(Object) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Registers objects using the annotation based listener configuration.
- listener(Object) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Registers objects using the annotation based listener configuration.
- listener(Object) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
-
Registers objects using the annotation based listener configuration.
- listener(ChunkListener) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Register a chunk listener.
- listener(ChunkListener) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- listener(ItemProcessListener) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Register an item processor listener.
- listener(ItemReadListener) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Register an item reader listener.
- listener(ItemWriteListener) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Register an item writer listener.
- listener(JobExecutionListener) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Register a job execution listener.
- listener(SkipListener) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Register a skip listener.
- listener(StepExecutionListener) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- listener(StepListener) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Register an item reader listener.
- listener(RetryListener) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Register a retry listener.
- ListenerMetaData - Interface in org.springframework.batch.core.listener
-
A common interface for listener meta data enumerations.
- load(ApplicationContextFactory) - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.
- load(ApplicationContextFactory) - Method in interface org.springframework.batch.core.configuration.support.JobLoader
-
Deprecated.Load an application context and register all the jobs.
- localDateFormatter - Variable in class org.springframework.batch.core.converter.DateToStringConverter
- localDateFormatter - Variable in class org.springframework.batch.core.converter.LocalDateTimeToStringConverter
- localDateFormatter - Variable in class org.springframework.batch.core.converter.LocalDateToStringConverter
- localDateFormatter - Variable in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- localDateFormatter - Variable in class org.springframework.batch.core.converter.StringToDateConverter
- localDateFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateConverter
- localDateFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateTimeConverter
- localDateFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalTimeConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.DateToStringConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalDateTimeToStringConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalDateToStringConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToDateConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateTimeConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalTimeConverter
- LocalDateTimeToStringConverter - Class in org.springframework.batch.core.converter
- LocalDateTimeToStringConverter() - Constructor for class org.springframework.batch.core.converter.LocalDateTimeToStringConverter
- LocalDateToStringConverter - Class in org.springframework.batch.core.converter
- LocalDateToStringConverter() - Constructor for class org.springframework.batch.core.converter.LocalDateToStringConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.DateToStringConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalDateTimeToStringConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalDateToStringConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToDateConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalDateTimeConverter
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.StringToLocalTimeConverter
- LocalTimeToStringConverter - Class in org.springframework.batch.core.converter
- LocalTimeToStringConverter() - Constructor for class org.springframework.batch.core.converter.LocalTimeToStringConverter
- logger - Variable in class org.springframework.batch.core.configuration.support.MapJobRegistry
- logger - Static variable in class org.springframework.batch.core.job.AbstractJob
- logger - Variable in class org.springframework.batch.core.job.builder.JobBuilderHelper
- logger - Static variable in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.
- logger - Variable in class org.springframework.batch.core.launch.support.JobExecutionShutdownHook
- logger - Static variable in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
- logger - Variable in class org.springframework.batch.core.launch.support.SimpleJvmExitCodeMapper
- logger - Static variable in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.
- logger - Static variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- logger - Variable in class org.springframework.batch.core.step.builder.StepBuilderHelper
- logger - Variable in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- logger - Static variable in class org.springframework.batch.core.step.item.DefaultItemFailureHandler
-
Deprecated.
- logger - Variable in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
- logger - Static variable in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- logger - Static variable in class org.springframework.batch.core.step.ThreadStepInterruptionPolicy
M
- main(String[]) - Static method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Main method to operate jobs from the command line.
- main(String[]) - Static method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Launch a batch job using a
CommandLineJobRunner. - map() - Method in record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Returns the value of the
maprecord component. - MapJobRegistry - Class in org.springframework.batch.core.configuration.support
-
Simple, thread-safe, map-based implementation of
JobRegistry. - MapJobRegistry() - Constructor for class org.springframework.batch.core.configuration.support.MapJobRegistry
- mapResult(Object) - Method in class org.springframework.batch.core.step.tasklet.MethodInvokingTaskletAdapter
-
If the result is an
ExitStatusalready just return that, otherwise returnExitStatus.COMPLETED. - MapStepRegistry - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- MapStepRegistry() - Constructor for class org.springframework.batch.core.configuration.support.MapStepRegistry
-
Deprecated.
- match(String) - Static method in enum class org.springframework.batch.core.BatchStatus
-
Find a
BatchStatusthat matches the beginning of the given value. - matches(String) - Method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Check if the provided status matches the pattern, signalling that the next State should be executed.
- max(BatchStatus, BatchStatus) - Static method in enum class org.springframework.batch.core.BatchStatus
-
Convenience method to return the higher value status of the statuses passed to the method.
- MaxValueFlowExecutionAggregator - Class in org.springframework.batch.core.job.flow.support.state
-
Implementation of the
FlowExecutionAggregatorinterface that aggregatesFlowExecutionStatus', using the status with the high precedence as the aggregate status. - MaxValueFlowExecutionAggregator() - Constructor for class org.springframework.batch.core.job.flow.support.state.MaxValueFlowExecutionAggregator
- maxVarCharLength() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
The maximum length of exit messages in the database.
- maxVarCharLengthForExitMessage - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- maxVarCharLengthForShortContext - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- meterRegistry - Variable in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- MethodInvokerMethodInterceptor - Class in org.springframework.batch.core.listener
-
MethodInterceptorthat, given a map of method names andMethodInvokers, will execute all methods tied to a particular method name, with the provided arguments. - MethodInvokerMethodInterceptor(Map) - Constructor for class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- MethodInvokerMethodInterceptor(Map, boolean) - Constructor for class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- MethodInvokingTaskletAdapter - Class in org.springframework.batch.core.step.tasklet
-
A
Taskletthat wraps a method in a POJO. - MethodInvokingTaskletAdapter() - Constructor for class org.springframework.batch.core.step.tasklet.MethodInvokingTaskletAdapter
- METRICS_PREFIX - Static variable in class org.springframework.batch.core.observability.BatchMetrics
- MicrometerMetrics - Class in org.springframework.batch.core.observability.micrometer
-
Central class for Micrometer metrics.
- modular() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableBatchProcessing
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of Spring's context hierarchies and
GroupAwareJobs. Scheduled for removal in 6.2 or later. - MongoDefaultBatchConfiguration - Class in org.springframework.batch.core.configuration.support
-
Base
Configurationclass that provides common MongoDB-based infrastructure beans for enabling and using Spring Batch. - MongoDefaultBatchConfiguration() - Constructor for class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
- MongoExecutionContextDao - Class in org.springframework.batch.core.repository.dao.mongodb
- MongoExecutionContextDao(MongoOperations) - Constructor for class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- MongoJobExecutionDao - Class in org.springframework.batch.core.repository.dao.mongodb
- MongoJobExecutionDao(MongoOperations) - Constructor for class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- MongoJobExplorerFactoryBean - Class in org.springframework.batch.core.repository.explore.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
MongoJobRepositoryFactoryBean. Scheduled for removal in 6.2 or later. - MongoJobExplorerFactoryBean() - Constructor for class org.springframework.batch.core.repository.explore.support.MongoJobExplorerFactoryBean
-
Deprecated.
- MongoJobInstanceDao - Class in org.springframework.batch.core.repository.dao.mongodb
- MongoJobInstanceDao(MongoOperations) - Constructor for class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- MongoJobRepositoryFactoryBean - Class in org.springframework.batch.core.repository.support
-
This factory bean creates a job repository backed by MongoDB.
- MongoJobRepositoryFactoryBean() - Constructor for class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- mongoOperationsRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
- MongoSequenceIncrementer - Class in org.springframework.batch.core.repository.dao.mongodb
- MongoSequenceIncrementer(MongoOperations, String) - Constructor for class org.springframework.batch.core.repository.dao.mongodb.MongoSequenceIncrementer
- MongoStepExecutionDao - Class in org.springframework.batch.core.repository.dao.mongodb
- MongoStepExecutionDao(MongoOperations) - Constructor for class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- MulticasterBatchListener<T,
S> - Class in org.springframework.batch.core.listener - MulticasterBatchListener() - Constructor for class org.springframework.batch.core.listener.MulticasterBatchListener
-
Initialize the listener instance.
- MultiResourcePartitioner - Class in org.springframework.batch.core.partition.support
-
Implementation of
Partitionerthat locates multiple resources and associates their file names with execution context keys. - MultiResourcePartitioner() - Constructor for class org.springframework.batch.core.partition.support.MultiResourcePartitioner
N
- name() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns the value of the
namerecord component. - name() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
namerecord component. - name() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
namerecord component. - namespaceMatchesVersion(Element) - Static method in class org.springframework.batch.core.configuration.xml.CoreNamespaceUtils
-
Check that the schema location declared in the source file being parsed matches the Spring Batch version.
- NeverSkipItemSkipPolicy - Class in org.springframework.batch.core.step.skip
-
SkipPolicyimplementation that always returns false, indicating that an item should not be skipped. - NeverSkipItemSkipPolicy() - Constructor for class org.springframework.batch.core.step.skip.NeverSkipItemSkipPolicy
- next(Flow) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Go next on successful completion to a subflow.
- next(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Transition to the decider on successful completion of the current step.
- next(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.SimpleJobBuilder
-
Continue with this decider if the previous step was successful.
- next(Step) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Transition to the next step on successful completion of the current step.
- next(Step) - Method in class org.springframework.batch.core.job.builder.SimpleJobBuilder
-
Continue or end a job with this step if the previous step was successful.
- NEXT_ATTR - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Next attribute.
- NEXT_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Next element.
- nextIntValue() - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoSequenceIncrementer
- nextLongValue() - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoSequenceIncrementer
- nextState(String, FlowExecutionStatus, StepExecution) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- nextStringValue() - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoSequenceIncrementer
- NO_SUCH_JOB - Static variable in interface org.springframework.batch.core.launch.support.ExitCodeMapper
- NonSkippableProcessException - Exception Class in org.springframework.batch.core.step.skip
-
Fatal exception to be thrown when a process operation could not be skipped.
- NonSkippableProcessException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.NonSkippableProcessException
- NonSkippableReadException - Exception Class in org.springframework.batch.core.step.skip
-
Fatal exception to be thrown when a read operation could not be skipped.
- NonSkippableReadException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.NonSkippableReadException
- NonSkippableWriteException - Exception Class in org.springframework.batch.core.step.skip
-
Fatal exception to be thrown when a process operation could not be skipped.
- NonSkippableWriteException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.NonSkippableWriteException
- NOOP - Static variable in class org.springframework.batch.core.ExitStatus
-
Convenient constant value representing a job that did no processing (for example, because it was already complete).
- noRetry(Class) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly ask for an exception (and subclasses) to be excluded from retry.
- noRollback(Class) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Mark this exception as ignorable during item read or processing operations.
- noSkip(Class) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly prevent certain exceptions (and subclasses) from being skipped.
- NoSuchJobException - Exception Class in org.springframework.batch.core.launch
-
Checked exception to indicate that a required
Jobis not available. - NoSuchJobException(String) - Constructor for exception class org.springframework.batch.core.launch.NoSuchJobException
-
Create an exception with the given message.
- NoSuchJobException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.NoSuchJobException
- NoSuchJobExecutionException - Exception Class in org.springframework.batch.core.launch
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- NoSuchJobExecutionException(String) - Constructor for exception class org.springframework.batch.core.launch.NoSuchJobExecutionException
-
Deprecated.Create an exception with the given message.
- NoSuchJobExecutionException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.NoSuchJobExecutionException
-
Deprecated.
- NoSuchJobInstanceException - Exception Class in org.springframework.batch.core.launch
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- NoSuchJobInstanceException(String) - Constructor for exception class org.springframework.batch.core.launch.NoSuchJobInstanceException
-
Deprecated.Create an exception with the given message.
- NoSuchJobInstanceException(String, Throwable) - Constructor for exception class org.springframework.batch.core.launch.NoSuchJobInstanceException
-
Deprecated.
- NoSuchObjectException - Exception Class in org.springframework.batch.core.repository.dao
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- NoSuchObjectException(String) - Constructor for exception class org.springframework.batch.core.repository.dao.NoSuchObjectException
-
Deprecated.
- NoSuchStepException - Exception Class in org.springframework.batch.core.step
-
Exception to signal that a step was requested that is unknown or does not exist.
- NoSuchStepException(String) - Constructor for exception class org.springframework.batch.core.step.NoSuchStepException
-
Create a new exception instance with the message provided.
- NoWorkFoundStepExecutionListener - Class in org.springframework.batch.core.step
-
Fails the step if no items have been processed ( item count is 0).
- NoWorkFoundStepExecutionListener() - Constructor for class org.springframework.batch.core.step.NoWorkFoundStepExecutionListener
O
- observationRegistry - Variable in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.
- observationRegistry - Variable in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- observationRegistry - Variable in class org.springframework.batch.core.step.AbstractStep
- observationRegistry - Variable in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- observationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Sets the observation registry for the job.
- observationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set the observation registry to be used for collecting metrics during step execution.
- observationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- observationRegistryRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableBatchProcessing
-
Set the observation registry to use in batch artifacts.
- offset - Variable in class org.springframework.batch.core.step.item.ChunkMonitor.ChunkMonitorData
-
Deprecated.
- OffsetDateTimeToStringConverter - Class in org.springframework.batch.core.converter
- OffsetDateTimeToStringConverter() - Constructor for class org.springframework.batch.core.converter.OffsetDateTimeToStringConverter
- on(String) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Start a transition to a new state if the exit status from the previous state matches the pattern given.
- on(String) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.UnterminatedFlowBuilder
-
Start a transition to a new state if the exit status from the previous state matches the pattern given.
- on(String) - Method in class org.springframework.batch.core.job.builder.SimpleJobBuilder
-
Branch into a flow conditional on the outcome of the current step.
- ON_ATTR - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes an On element.
- ON_PROCESS_ERROR - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- ON_READ_ERROR - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- ON_SKIP_IN_PROCESS - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- ON_SKIP_IN_READ - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- ON_SKIP_IN_WRITE - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- ON_WRITE_ERROR - Enum constant in enum class org.springframework.batch.core.listener.StepListenerMetaData
- onChunkError(Exception, Chunk) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Call the registered listeners in reverse order.
- onChunkError(Exception, Chunk) - Method in interface org.springframework.batch.core.listener.ChunkListener
-
Callback if an exception occurs while processing or writing a chunk, inside the transaction, which is about to be rolled back.
- OnChunkError - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after a chunk has failed.
- onProcessError(T, Exception) - Method in class org.springframework.batch.core.listener.CompositeItemProcessListener
-
Call the registered listeners in reverse order, respecting and prioritising those that implement
Ordered. - onProcessError(T, Exception) - Method in interface org.springframework.batch.core.listener.ItemProcessListener
-
Called if an exception was thrown from
ItemProcessor.process(Object). - onProcessError(T, Exception) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- OnProcessError - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called if an exception is thrown by an
ItemProcessor. - onReadError(Exception) - Method in class org.springframework.batch.core.listener.CompositeItemReadListener
-
Call the registered listeners in reverse order, respecting and prioritising those that implement
Ordered. - onReadError(Exception) - Method in interface org.springframework.batch.core.listener.ItemReadListener
-
Called if an error occurs while trying to read.
- onReadError(Exception) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- onReadError(Exception) - Method in class org.springframework.batch.core.step.item.DefaultItemFailureHandler
-
Deprecated.
- OnReadError - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called if an exception is thrown by an
ItemReader. - onSkipInProcess(T, Throwable) - Method in class org.springframework.batch.core.listener.CompositeSkipListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered. - onSkipInProcess(T, Throwable) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- onSkipInProcess(T, Throwable) - Method in interface org.springframework.batch.core.listener.SkipListener
-
This item failed on processing with the given exception, and a skip was called for.
- OnSkipInProcess - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called when an item is skipped due to an exception thrown in the
ItemProcessor.
Expected signature: void onSkipInProcess(T item,Throwablet) - onSkipInRead(Throwable) - Method in class org.springframework.batch.core.listener.CompositeSkipListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered. - onSkipInRead(Throwable) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- onSkipInRead(Throwable) - Method in interface org.springframework.batch.core.listener.SkipListener
-
Callback for a failure on read that is legal and, consequently, is not going to be re-thrown.
- OnSkipInRead - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called when an item is skipped due to an exception thrown in the
ItemReader. - onSkipInWrite(S, Throwable) - Method in class org.springframework.batch.core.listener.CompositeSkipListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered. - onSkipInWrite(S, Throwable) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- onSkipInWrite(S, Throwable) - Method in interface org.springframework.batch.core.listener.SkipListener
-
This item failed on write with the given exception, and a skip was called for.
- OnSkipInWrite - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called when an item is skipped due to an exception thrown in the
ItemWriter.
Expected signature: void onSkipInWrite(S item,Throwablet) - onWriteError(Exception, Chunk) - Method in class org.springframework.batch.core.step.item.DefaultItemFailureHandler
-
Deprecated.
- onWriteError(Exception, Chunk) - Method in class org.springframework.batch.core.listener.CompositeItemWriteListener
-
Call the registered listeners in reverse order, respecting and prioritising those that implement
Ordered. - onWriteError(Exception, Chunk) - Method in interface org.springframework.batch.core.listener.ItemWriteListener
-
Called if an error occurs while trying to write.
- onWriteError(Exception, Chunk) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
- OnWriteError - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called if an exception is thrown by an
ItemWriter. - open(ExecutionContext) - Method in class org.springframework.batch.core.step.AbstractStep
-
Extension point for subclasses to provide callbacks to their collaborators at the beginning of a step, to open or acquire resources.
- open(ExecutionContext) - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- open(ExecutionContext) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
- open(ExecutionContext) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
- operator(JobOperator) - Method in class org.springframework.batch.core.step.builder.JobStepBuilder
-
Add a job operator.
- org.springframework.batch.core - package org.springframework.batch.core
-
Core domain context for Spring Batch covering jobs, steps, configuration and execution abstractions.
- org.springframework.batch.core.annotation - package org.springframework.batch.core.annotation
-
Annotations for java based configuration of listeners.
- org.springframework.batch.core.aot - package org.springframework.batch.core.aot
- org.springframework.batch.core.configuration - package org.springframework.batch.core.configuration
-
Interfaces for registration and location of job configurations.
- org.springframework.batch.core.configuration.annotation - package org.springframework.batch.core.configuration.annotation
-
Annotations and builder factories for java based configuration
- org.springframework.batch.core.configuration.support - package org.springframework.batch.core.configuration.support
-
Specific implementations of configuration concerns.
- org.springframework.batch.core.configuration.xml - package org.springframework.batch.core.configuration.xml
-
Parsers for XML based configuration
- org.springframework.batch.core.converter - package org.springframework.batch.core.converter
-
Support classes for implementations of the batch APIs.
- org.springframework.batch.core.job - package org.springframework.batch.core.job
-
Specific implementations of job concerns.
- org.springframework.batch.core.job.builder - package org.springframework.batch.core.job.builder
-
Job and flow level builders for java based configuration of batch jobs
- org.springframework.batch.core.job.flow - package org.springframework.batch.core.job.flow
-
Flow related constructs including Flow interface, executors, and related exceptions
- org.springframework.batch.core.job.flow.support - package org.springframework.batch.core.job.flow.support
-
Basic implementations of flow constructs
- org.springframework.batch.core.job.flow.support.state - package org.springframework.batch.core.job.flow.support.state
-
States used in defining the underlying Spring Batch state machine
- org.springframework.batch.core.job.parameters - package org.springframework.batch.core.job.parameters
- org.springframework.batch.core.launch - package org.springframework.batch.core.launch
-
Interfaces and simple implementations of launch concerns.
- org.springframework.batch.core.launch.support - package org.springframework.batch.core.launch.support
-
Support classes for use in bootstrap and launch implementations or configurations.
- org.springframework.batch.core.listener - package org.springframework.batch.core.listener
-
Generic implementations of core batch listener interfaces.
- org.springframework.batch.core.observability - package org.springframework.batch.core.observability
-
This package contains APIs related to batch observability.
- org.springframework.batch.core.observability.jfr.events.job - package org.springframework.batch.core.observability.jfr.events.job
- org.springframework.batch.core.observability.jfr.events.step - package org.springframework.batch.core.observability.jfr.events.step
- org.springframework.batch.core.observability.jfr.events.step.chunk - package org.springframework.batch.core.observability.jfr.events.step.chunk
- org.springframework.batch.core.observability.jfr.events.step.partition - package org.springframework.batch.core.observability.jfr.events.step.partition
- org.springframework.batch.core.observability.jfr.events.step.tasklet - package org.springframework.batch.core.observability.jfr.events.step.tasklet
- org.springframework.batch.core.observability.micrometer - package org.springframework.batch.core.observability.micrometer
- org.springframework.batch.core.partition - package org.springframework.batch.core.partition
-
Interfaces for partitioning components.
- org.springframework.batch.core.partition.support - package org.springframework.batch.core.partition.support
-
Implementation of common partition components.
- org.springframework.batch.core.repository - package org.springframework.batch.core.repository
-
Interfaces and generic implementations of repository concerns.
- org.springframework.batch.core.repository.dao - package org.springframework.batch.core.repository.dao
-
Specific implementations of dao concerns.
- org.springframework.batch.core.repository.dao.jdbc - package org.springframework.batch.core.repository.dao.jdbc
- org.springframework.batch.core.repository.dao.mongodb - package org.springframework.batch.core.repository.dao.mongodb
- org.springframework.batch.core.repository.explore - package org.springframework.batch.core.repository.explore
-
Interfaces and related classes to support meta data browsing.
- org.springframework.batch.core.repository.explore.support - package org.springframework.batch.core.repository.explore.support
-
Specific implementations of explorer concerns.
- org.springframework.batch.core.repository.persistence - package org.springframework.batch.core.repository.persistence
-
This package contains the classes of the persistence model.
- org.springframework.batch.core.repository.persistence.converter - package org.springframework.batch.core.repository.persistence.converter
- org.springframework.batch.core.repository.support - package org.springframework.batch.core.repository.support
-
Specific implementations of repository concerns.
- org.springframework.batch.core.resource - package org.springframework.batch.core.resource
- org.springframework.batch.core.scope - package org.springframework.batch.core.scope
-
Implementation of Spring Batch specific bean scopes (Job and Step).
- org.springframework.batch.core.scope.context - package org.springframework.batch.core.scope.context
-
Implementation of the contexts for each of the custom bean scopes in Spring Batch (Job and Step).
- org.springframework.batch.core.step - package org.springframework.batch.core.step
-
Specific implementations of step concerns.
- org.springframework.batch.core.step.builder - package org.springframework.batch.core.step.builder
-
Step level builders for java based job configuration.
- org.springframework.batch.core.step.factory - package org.springframework.batch.core.step.factory
-
Factories for step level components.
- org.springframework.batch.core.step.item - package org.springframework.batch.core.step.item
-
Specific implementations of step concerns for item-oriented approach.
- org.springframework.batch.core.step.job - package org.springframework.batch.core.step.job
-
JobStepand related components. - org.springframework.batch.core.step.skip - package org.springframework.batch.core.step.skip
-
Specific implementations of skip concerns for items in a step.
- org.springframework.batch.core.step.tasklet - package org.springframework.batch.core.step.tasklet
-
Interfaces and generic implementations of tasklet concerns.
P
- parameters() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Get a set of all parameters.
- parametersExtractor(JobParametersExtractor) - Method in class org.springframework.batch.core.step.builder.JobStepBuilder
-
Provide a job parameters extractor.
- parse(Element, AbstractBeanDefinition, ParserContext, boolean) - Method in class org.springframework.batch.core.configuration.xml.ChunkElementParser
-
Do the parsing.
- parse(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.AbstractListenerParser
- parse(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.DecisionParser
-
Parse the decision and turn it into a list of transitions.
- parse(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.FlowElementParser
-
Parse the flow and turn it into a list of transitions.
- parse(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.SplitParser
-
Parse the split and turn it into a list of transitions.
- parse(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.StandaloneStepParser
-
Parse the step and turn it into a list of transitions.
- parse(Element, ParserContext, String) - Method in class org.springframework.batch.core.configuration.xml.ExceptionElementParser
- parse(Element, ParserContext, String) - Method in class org.springframework.batch.core.configuration.xml.InlineStepParser
-
Parse the step and turn it into a list of transitions.
- parseBeanElement(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.JobParser
-
Parse the element to retrieve
BeanMetadataElement. - parseInternal(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.TopLevelStepParser
- parseListenerElement(Element, ParserContext, BeanDefinition) - Static method in class org.springframework.batch.core.configuration.xml.AbstractListenerParser
- parseStep(Element, ParserContext, String) - Method in class org.springframework.batch.core.configuration.xml.AbstractStepParser
- parseTasklet(Element, Element, AbstractBeanDefinition, ParserContext, boolean) - Method in class org.springframework.batch.core.configuration.xml.TaskletParser
- partition(int) - Method in interface org.springframework.batch.core.partition.Partitioner
-
Create a set of distinct
ExecutionContextinstances together with a unique identifier for each one. - partition(int) - Method in class org.springframework.batch.core.partition.support.MultiResourcePartitioner
-
Assign the filename of each of the injected resources to an
ExecutionContext. - partition(int) - Method in class org.springframework.batch.core.partition.support.SimplePartitioner
- PartitionAggregateEvent - Class in org.springframework.batch.core.observability.jfr.events.step.partition
- PartitionAggregateEvent(String, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.partition.PartitionAggregateEvent
- partitionCount - Variable in class org.springframework.batch.core.observability.jfr.events.step.partition.PartitionSplitEvent
- partitioner(String, Partitioner) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Add a partitioner which can be used to create a
StepExecutionSplitter. - partitioner(String, Partitioner) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Create a partition step builder for a remote (or local) step.
- partitioner(Step) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Create a partition step builder for a remote (or local) step.
- Partitioner - Interface in org.springframework.batch.core.partition
-
Central strategy interface for creating input parameters for a partitioned step in the form of
ExecutionContextinstances. - partitionHandler(PartitionHandler) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Provide an explicit partition handler that will carry out the work of the partition step.
- PartitionHandler - Interface in org.springframework.batch.core.partition
-
Interface defining the responsibilities of controlling the execution of a partitioned
StepExecution. - PartitionNameProvider - Interface in org.springframework.batch.core.partition
-
Optional interface for
Partitionerimplementations that need to use a custom naming scheme for partitions. - PartitionSplitEvent - Class in org.springframework.batch.core.observability.jfr.events.step.partition
- PartitionSplitEvent(String, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.partition.PartitionSplitEvent
- PartitionStep - Class in org.springframework.batch.core.partition
-
Implementation of
Stepwhich partitions the execution and spreads the load using aPartitionHandler. - PartitionStep(JobRepository) - Constructor for class org.springframework.batch.core.partition.PartitionStep
-
Create a new instance of a
PartitionStepwith the given job repository. - PartitionStepBuilder - Class in org.springframework.batch.core.step.builder
-
Step builder for
PartitionStepinstances. - PartitionStepBuilder(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Create a new builder initialized with any properties in the parent.
- postProcess(StepContribution, Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.
- postProcess(StepContribution, Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
- postProcess(StepContribution, Chunk) - Method in interface org.springframework.batch.core.step.item.ChunkProvider
-
Deprecated.
- postProcessAfterInitialization(Object, String) - Method in class org.springframework.batch.core.configuration.annotation.BatchObservabilityBeanPostProcessor
- postProcessAfterInitialization(Object, String) - Method in class org.springframework.batch.core.configuration.xml.CoreNamespacePostProcessor
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.batch.core.configuration.annotation.BatchObservabilityBeanPostProcessor
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.batch.core.configuration.xml.CoreNamespacePostProcessor
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.batch.core.scope.BatchScopeSupport
-
Register this scope with the enclosing BeanFactory.
- postProcessBeforeInitialization(Object, String) - Method in class org.springframework.batch.core.configuration.xml.CoreNamespacePostProcessor
- prepareBeanFactory(ConfigurableListableBeanFactory, ConfigurableListableBeanFactory) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Extension point for special subclasses that want to do more complex things with the bean factory prior to refresh.
- prepareContext(ConfigurableApplicationContext, ConfigurableApplicationContext) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Extension point for special subclasses that want to do more complex things with the context prior to refresh.
- presetSystemExiter(SystemExiter) - Static method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Static setter for the
SystemExiterso it can be adjusted before dependency injection. - preventRestart() - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Set a flag to prevent restart an execution of this job even if it has failed.
- process(StepContribution, Chunk) - Method in interface org.springframework.batch.core.step.item.ChunkProcessor
-
Deprecated, for removal: This API element is subject to removal in a future version.
- process(Chunk, StepContribution) - Method in interface org.springframework.batch.core.step.item.ChunkProcessor
-
Process the given chunk and update the contribution.
- process(Chunk, StepContribution) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- processor(ItemProcessor) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.An item processor that processes or transforms a stream of items.
- processor(ItemProcessor) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
An item processor that processes or transforms a stream of items.
- processorNonTransactional() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Mark the item processor as non-transactional (default is the opposite).
- properties - Variable in class org.springframework.batch.core.step.builder.StepBuilderHelper
- provide(StepContribution) - Method in interface org.springframework.batch.core.step.item.ChunkProvider
-
Deprecated.
- provide(StepContribution) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
R
- read(StepContribution, Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.
- read(StepContribution, Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.Delegates to
SimpleChunkProvider.doRead(). - reader(ItemReader) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.An item reader that provides a stream of items.
- reader(ItemReader) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
An item reader that provides a stream of items.
- readerIsTransactionalQueue() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Sets a flag to say that the reader is transactional (usually a queue), which is to say that failed items might be rolled back and re-presented in a subsequent transaction.
- recover(long) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Recover the job execution with the given ID that is stuck in a
STARTEDstate due to an abrupt shutdown or failure, making it eligible for restart. - recover(JobExecution) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Marks the given
JobExecutionasFAILEDwhen it is stuck in aSTARTEDstate due to an abrupt shutdown or failure, in order to make it restartable. - recover(JobExecution) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- recover(JobExecution) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- ReferenceJobFactory - Class in org.springframework.batch.core.configuration.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- ReferenceJobFactory(Job) - Constructor for class org.springframework.batch.core.configuration.support.ReferenceJobFactory
-
Deprecated.
- register(E) - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
-
Register a context with the current thread - always put a matching
SynchronizationManagerSupport.close()call in a finally block to ensure that the correct context is available in the enclosing block. - register(String, Collection) - Method in interface org.springframework.batch.core.configuration.StepRegistry
-
Deprecated.Registers all the step instances of the given job.
- register(String, Collection) - Method in class org.springframework.batch.core.configuration.support.MapStepRegistry
-
Deprecated.
- register(Job) - Method in interface org.springframework.batch.core.configuration.JobRegistry
-
Registers a
Jobat runtime. - register(Job) - Method in class org.springframework.batch.core.configuration.support.MapJobRegistry
- register(JobExecution) - Static method in class org.springframework.batch.core.scope.context.JobSynchronizationManager
-
Register a context with the current thread - always put a matching
JobSynchronizationManager.close()call in a finally block to ensure that the correct context is available in the enclosing block. - register(ChunkListener) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Register additional listener.
- register(ItemProcessListener) - Method in class org.springframework.batch.core.listener.CompositeItemProcessListener
-
Register additional listener.
- register(ItemReadListener) - Method in class org.springframework.batch.core.listener.CompositeItemReadListener
-
Register additional listener.
- register(ItemWriteListener) - Method in class org.springframework.batch.core.listener.CompositeItemWriteListener
-
Register additional listener.
- register(JobExecutionListener) - Method in class org.springframework.batch.core.listener.CompositeJobExecutionListener
-
Register additional listener.
- register(SkipListener) - Method in class org.springframework.batch.core.listener.CompositeSkipListener
-
Register additional listener.
- register(StepExecutionListener) - Method in class org.springframework.batch.core.listener.CompositeStepExecutionListener
-
Register additional listener.
- register(StepListener) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
-
Register the listener for callbacks on the appropriate interfaces implemented.
- register(StepExecution) - Static method in class org.springframework.batch.core.scope.context.StepSynchronizationManager
-
Register a context with the current thread - always put a matching
StepSynchronizationManager.close()call in a finally block to ensure that the correct context is available in the enclosing block. - registerAsStreamsAndListeners(ItemReader, ItemProcessor, ItemWriter) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- registerChunkListener(ChunkListener) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Register a chunk listener for callbacks at the appropriate stages in a step execution.
- registerChunkListener(ChunkListener) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ChunkListenerto be notified of chunk processing events. - registerDestructionCallback(String, Runnable) - Method in class org.springframework.batch.core.scope.context.JobContext
-
Allow clients to register callbacks for clean up on close.
- registerDestructionCallback(String, Runnable) - Method in class org.springframework.batch.core.scope.context.StepContext
-
Allow clients to register callbacks for clean up on close.
- registerDestructionCallback(String, Runnable) - Method in class org.springframework.batch.core.scope.JobScope
- registerDestructionCallback(String, Runnable) - Method in class org.springframework.batch.core.scope.StepScope
- registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.batch.core.aot.CoreRuntimeHints
- registerItemListeners(SimpleStepBuilder) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- registerItemProcessListener(ItemProcessListener) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ItemProcessListenerto be notified of item processing events. - registerItemReadListener(ItemReadListener) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ItemReadListenerto be notified of item read events. - registerItemStream(ItemStream) - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- registerItemStream(ItemStream) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Register an
ItemStreamwith this step. - registerItemWriteListener(ItemWriteListener) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ItemWriteListenerto be notified of item write events. - registerJobExecutionListener(JobExecutionListener) - Method in class org.springframework.batch.core.job.AbstractJob
-
Register a single listener for the
JobExecutionListenercallbacks. - registerListener(StepListener) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Register a listener for callbacks at the appropriate stages in a process.
- registerListener(StepListener) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.Register a listener for callbacks at the appropriate stages in a process.
- registerListener(RetryListener) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- registerRetryListener(RetryListener) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Register a
RetryListenerto be notified of item retry events. - registerSkipListener(SkipListener) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
register a
SkipListenerto be notified of item skip events. - registerStepExecutionListener(StepExecutionListener) - Method in class org.springframework.batch.core.step.AbstractStep
-
Register a step listener for callbacks at the appropriate stages in a step execution.
- registerStepListenerAsChunkListener() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- registerStepListenerAsItemListener() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- registerStepListenerAsSkipListener() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- registerStream(ItemStream) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Register a single
ItemStreamfor callbacks to the stream interface. - release() - Static method in class org.springframework.batch.core.scope.context.JobSynchronizationManager
-
A convenient "deep" close operation.
- release() - Static method in class org.springframework.batch.core.scope.context.StepSynchronizationManager
-
A convenient "deep" close operation.
- release() - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
-
A convenient "deep" close operation.
- reload(ApplicationContextFactory) - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.
- reload(ApplicationContextFactory) - Method in interface org.springframework.batch.core.configuration.support.JobLoader
-
Deprecated.Load an application context and register all the jobs, having first unregistered them if already registered.
- RemoteStepExecutionAggregator - Class in org.springframework.batch.core.partition.support
-
Convenience class for aggregating a set of
StepExecutioninstances when the input comes from remote steps, so the data need to be refreshed from the repository. - RemoteStepExecutionAggregator(JobRepository) - Constructor for class org.springframework.batch.core.partition.support.RemoteStepExecutionAggregator
-
Create a new instance with a job repository that can be used to refresh the data when aggregating.
- remove(String) - Method in class org.springframework.batch.core.scope.JobScope
- remove(String) - Method in class org.springframework.batch.core.scope.StepScope
- removeAttribute(String) - Method in class org.springframework.batch.core.scope.context.JobContext
-
Override base class behaviour to ensure destruction callbacks are unregistered as well as the default behaviour.
- removeAttribute(String) - Method in class org.springframework.batch.core.scope.context.StepContext
-
Override base class behaviour to ensure destruction callbacks are unregistered as well as the default behaviour.
- replaceExitCode(String) - Method in class org.springframework.batch.core.ExitStatus
-
Add an exit code to an existing
ExitStatus. - requiresTransactionManager() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Currently, all step implementations other than
TaskletStepare instances ofAbstractStepand do not require a transaction manager. - resetOffset() - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- resolveContextualObject(String) - Method in class org.springframework.batch.core.scope.JobScope
-
This will be used to resolve expressions in job-scoped beans.
- resolveContextualObject(String) - Method in class org.springframework.batch.core.scope.StepScope
-
This will be used to resolve expressions in step-scoped beans.
- resolveId(Element, AbstractBeanDefinition, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.JobRepositoryParser
- resolveValue(Object) - Method in class org.springframework.batch.core.scope.BatchScopeSupport.Scopifier
- ResourcelessJobRepository - Class in org.springframework.batch.core.repository.support
-
A
JobRepositoryimplementation that does not use or store batch meta-data. - ResourcelessJobRepository() - Constructor for class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Create a new
ResourcelessJobRepositoryinstance with aDefaultJobKeyGenerator. - ResourcelessJobRepository(JobKeyGenerator) - Constructor for class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Create a new
ResourcelessJobRepositoryinstance with the providedJobKeyGenerator. - restart(long) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobOperator.restart(JobExecution). Scheduled for removal in 6.2 or later. - restart(long) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Restart the job execution with the given ID.
- restart(long) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- restart(JobExecution) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Restart a failed or stopped
JobExecution. - restart(JobExecution) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- restart(JobExecution) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- RESTART_ATTR - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Restart attribute.
- resume(String, FlowExecutor) - Method in interface org.springframework.batch.core.job.flow.Flow
- resume(String, FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- retry(Class) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly ask for an exception (and subclasses) to be retried.
- retry(Class...) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
- retryContextCache(RetryContextCache) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Provide an explicit retry context cache.
- retryLimit(int) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.The maximum number of times to try a failed item.
- retryLimit(long) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set the retry limit for the step.
- retryListener(RetryListener) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Add a retry listener to the step.
- retryPolicy(RetryPolicy) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set the retry policy for the step.
- retryPolicy(RetryPolicy) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Provide an explicit retry policy instead of using the
FaultTolerantStepBuilder.retryLimit(int)and retryable exceptions provided elsewhere. - ROLLBACK_EXCEPTION_KEY - Static variable in interface org.springframework.batch.core.listener.ChunkListener
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- run() - Method in class org.springframework.batch.core.launch.support.JobExecutionShutdownHook
- run(Job, JobParameters) - Method in interface org.springframework.batch.core.launch.JobLauncher
-
Deprecated.Start a job execution for the given
JobandJobParameters. - run(Job, JobParameters) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.Run the provided job with the given
JobParameters. - RunIdIncrementer - Class in org.springframework.batch.core.job.parameters
-
This incrementer increments a "run.id" parameter of type
Longfrom the given job parameters. - RunIdIncrementer() - Constructor for class org.springframework.batch.core.job.parameters.RunIdIncrementer
- RuntimeExceptionTranslator - Class in org.springframework.batch.core.launch.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement, for removal in 6.2 or later.
- RuntimeExceptionTranslator() - Constructor for class org.springframework.batch.core.launch.support.RuntimeExceptionTranslator
-
Deprecated.
S
- saveExecutionContext(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
-
Persist the execution context associated with the given jobExecution, persistent entry for the context should not exist yet.
- saveExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- saveExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- saveExecutionContext(StepExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
-
Persist the execution context associated with the given stepExecution, persistent entry for the context should not exist yet.
- saveExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- saveExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- saveExecutionContexts(Collection) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
-
Persist the execution context associated with each stepExecution in a given collection, persistent entry for the context should not exist yet.
- saveExecutionContexts(Collection) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- saveExecutionContexts(Collection) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- ScopeConfiguration - Class in org.springframework.batch.core.configuration.support
- ScopeConfiguration() - Constructor for class org.springframework.batch.core.configuration.support.ScopeConfiguration
- Scopifier(BeanDefinitionRegistry, String, boolean, boolean) - Constructor for class org.springframework.batch.core.scope.BatchScopeSupport.Scopifier
- self() - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
- self() - Method in class org.springframework.batch.core.step.builder.FlowStepBuilder
- self() - Method in class org.springframework.batch.core.step.builder.JobStepBuilder
- self() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- self() - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.
- self() - Method in class org.springframework.batch.core.step.builder.StepBuilder
- self() - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- self() - Method in class org.springframework.batch.core.step.builder.TaskletStepBuilder
- serialize(Map, OutputStream) - Method in class org.springframework.batch.core.repository.dao.DefaultExecutionContextSerializer
-
Serializes an execution context to the provided
OutputStream. - serialize(Map, OutputStream) - Method in class org.springframework.batch.core.repository.dao.Jackson2ExecutionContextStringSerializer
-
Deprecated.
- serialize(Map, OutputStream) - Method in class org.springframework.batch.core.repository.dao.JacksonExecutionContextStringSerializer
- serializer - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- serializer - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- setAllowStartIfComplete(boolean) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for the flag to indicate that the step should be replayed on a restart, even if successful the first time.
- setAllowStartIfComplete(boolean) - Method in class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
-
Flag to indicate that the partition target step is allowed to start if an execution is complete.
- setAllowStartIfComplete(boolean) - Method in class org.springframework.batch.core.step.AbstractStep
-
Public setter for flag that determines whether the step should start again if it is already complete.
- setAllowStartIfComplete(boolean) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the flag to indicate that the step should be replayed on a restart, even if successful the first time.
- setAllowStartIfComplete(Boolean) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- setApplicationContext(ApplicationContext) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Setter for the parent application context.
- setApplicationContext(ApplicationContext) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.The enclosing application context, which you can use to check whether
eventscome from the expected source. - setApplicationContext(ApplicationContext) - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.An application context that can be used as a parent context for all the factories.
- setApplicationContext(ApplicationContext) - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
- setApplicationContext(ApplicationContext) - Method in class org.springframework.batch.core.configuration.support.MapJobRegistry
- setApplicationContext(ApplicationContext) - Method in class org.springframework.batch.core.configuration.xml.CoreNamespacePostProcessor
- setApplicationContext(ApplicationContext) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
- setApplicationContextFactories(ApplicationContextFactory[]) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.Add an array of
ApplicationContextFactoryinstances to the set that is used to load contexts and jobs. - setAutoProxy(boolean) - Method in class org.springframework.batch.core.scope.BatchScopeSupport
-
Flag to indicate that bean definitions need not be auto proxied.
- setAutoStartup(boolean) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- setBackOffPolicy(BackOffPolicy) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
A backoff policy to be applied to the retry process.
- setBackOffPolicy(BackOffPolicy) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Public setter for the
BackOffPolicy. - setBackOffPolicy(BackOffPolicy) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- setBeanFactory(BeanFactory) - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.
- setBeanFactoryPostProcessorClasses(Class[]) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Determines which bean factory post processors (such as property placeholders) should be copied from the parent context.
- setBeanFactoryPostProcessorClasses(Class[]) - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.Determines which bean factory post processors (such as property placeholders) should be copied from the parent context.
- setBeanName(String) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Set the bean name property, which will become the name of the
Stepwhen it is created. - setBeanName(String) - Method in class org.springframework.batch.core.job.AbstractJob
-
Set the name property if it is not already set.
- setBeanName(String) - Method in class org.springframework.batch.core.step.AbstractStep
-
Set the name property if it is not already set.
- setBeanName(String) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Set the bean name property, which will become the name of the
Stepwhen it is created. - setBeanPostProcessorExcludeClasses(Class[]) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Determines, by exclusion, which bean post processors should be copied from the parent context.
- setBeanPostProcessorExcludeClasses(Class[]) - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.Determines, by exclusion, which bean post processors should be copied from the parent context.
- setBuffering(boolean) - Method in class org.springframework.batch.core.step.item.ChunkOrientedTasklet
-
Deprecated.Flag to indicate that items should be buffered once read.
- setBuffering(boolean) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.A flag to indicate that items have been buffered and therefore will always come back as a chunk after a rollback.
- setCacheCapacity(int) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for the capacity of the cache in the retry policy.
- setCacheCapacity(int) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Public setter for the capacity of the cache in the retry policy.
- setCallable(Callable) - Method in class org.springframework.batch.core.step.tasklet.CallableTaskletAdapter
-
Public setter for the
Callable. - setCharset(Charset) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
-
Set the
Charsetto use when serializing/deserializing the execution context. - setCharset(Charset) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.Sets the
Charsetto use when deserializing the execution context. - setCharset(Charset) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Set the
Charsetto use when serializing/deserializing the execution context. - setCharset(Charset) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Set the
Charsetto use when serializing/deserializing the execution context. - setChunk(SimpleStepBuilder) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setChunkCompletionPolicy(CompletionPolicy) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for the
CompletionPolicythat applies to the chunk level. - setChunkCompletionPolicy(CompletionPolicy) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the
CompletionPolicyapplying to the chunk level. - setChunkListeners(ChunkListener[]) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Register each of the objects as listeners.
- setChunkMonitor(ChunkMonitor) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- setChunkOperations(RepeatOperations) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the chunkOperations.
- setChunkSize(int) - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- setClobType(int) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
- setClobType(int) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- setClobTypeToUse(int) - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- setCommand(String...) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Set the command to execute along with its arguments.
- setCommandRunner(CommandRunner) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Injection setter for the
CommandRunner. - setCommitCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setCommitCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the current number of commits for this execution.
- setCommitInterval(int) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Set the commit interval.
- setCommitInterval(int) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Set the commit interval.
- setComplete() - Method in class org.springframework.batch.core.scope.context.ChunkContext
-
Setter for the flag to signal complete processing of a chunk.
- setConversionService(ConfigurableConversionService) - Method in class org.springframework.batch.core.converter.DefaultJobParametersConverter
-
Set the conversion service to use.
- setConversionService(ConfigurableConversionService) - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
-
Set the conversion service to use to convert job parameters from String literals to typed values and vice versa.
- setConversionService(ConfigurableConversionService) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.Set the conversion service to use in the job explorer.
- setConversionService(ConfigurableConversionService) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Set the conversion service to use in the job repository.
- setConversionService(ConfigurableConversionService) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Set the conversion service to use in the job repository.
- setCopyConfiguration(boolean) - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Flag to indicate that configuration, such as bean post processors and custom editors, should be copied from the parent context.
- setCopyConfiguration(boolean) - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.Flag to indicate that configuration, such as bean post processors and custom editors, should be copied from the parent context.
- setCreateTime(LocalDateTime) - Method in class org.springframework.batch.core.job.JobExecution
- setCreateTime(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setCreateTime(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setCreateTime(LocalDateTime) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the time this execution was created
- setDatabaseType(String) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Sets the database type.
- setDatabaseType(String) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Sets the database type.
- setDataFieldMaxValueIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
-
The incrementer to generate the sequence of values.
- setDataSource(DataSource) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.Sets the data source.
- setDataSource(DataSource) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Public setter for the
DataSource. - setDataSource(DataSource) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Public setter for the
DataSource. - setDelegate(Object) - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- setDelegate(StepExecutionAggregator) - Method in class org.springframework.batch.core.partition.support.RemoteStepExecutionAggregator
- setEndTime(LocalDateTime) - Method in class org.springframework.batch.core.job.JobExecution
-
Set the end time.
- setEndTime(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setEndTime(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setEndTime(LocalDateTime) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the time when this execution ended.
- setEnvironmentParams(String[]) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- setExceptionClassifier(SubclassClassifier) - Method in class org.springframework.batch.core.step.skip.ExceptionClassifierSkipPolicy
-
The classifier that will be used to choose a delegate policy.
- setExceptionHandler(ExceptionHandler) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the
ExceptionHandler. - setExecutionContext(ExecutionContext) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setExecutionContext(ExecutionContext) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setExecutionContext(ExecutionContext) - Method in class org.springframework.batch.core.job.JobExecution
-
Sets the
ExecutionContextfor this execution. - setExecutionContext(ExecutionContext) - Method in class org.springframework.batch.core.job.SimpleStepHandler
-
A context containing values to be added to the step execution before it is handled.
- setExecutionContext(ExecutionContext) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the
ExecutionContextfor this execution. - setExitCodeMapper(ExitCodeMapper) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Set the
ExitCodeMapperto use for converting job exit codes to JVM exit codes. - setExitCodeMapper(ExitCodeMapper) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Injection setter for the
ExitCodeMapper. - setExitException(Throwable) - Method in class org.springframework.batch.core.ExitStatus
-
Public setter for the exit exception.
- setExitMessageLength(int) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
-
Public setter for the exit message length in database.
- setExitMessageLength(int) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
-
Public setter for the exit message length in database.
- setExitStatus(ExitStatus) - Method in class org.springframework.batch.core.job.JobExecution
- setExitStatus(ExitStatus) - Method in class org.springframework.batch.core.step.StepContribution
-
Set the
ExitStatusfor this contribution. - setExitStatus(ExitStatus) - Method in class org.springframework.batch.core.step.StepExecution
- setExitStatus(FlowExecutor, String) - Method in class org.springframework.batch.core.job.flow.support.state.EndState
-
Performs any logic to update the exit status for the current flow.
- setExitStatus(ExitStatus) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setExitStatus(ExitStatus) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setFaultTolerant(boolean) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Mark this step as fault-tolerant.
- setFilterCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setFilterCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the number of items filtered out of this execution.
- setFlow(Flow) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Set the flow for the factory bean.
- setFlow(Flow) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setFlow(Flow) - Method in class org.springframework.batch.core.job.flow.FlowJob
-
Public setter for the flow.
- setFlow(Flow) - Method in class org.springframework.batch.core.job.flow.FlowStep
-
Public setter for the flow.
- setFlowType(Class) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- setGridSize(int) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setGridSize(int) - Method in class org.springframework.batch.core.partition.support.AbstractPartitionHandler
-
Passed to the
StepExecutionSplitterin theAbstractPartitionHandler.handle(StepExecutionSplitter, StepExecution)method, instructing it how manyStepExecutioninstances are required, ideally. - setGroupName(String) - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.The group name for jobs registered by this component.
- setHasChunkElement(boolean) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setIncrementerFactory(DataFieldMaxValueIncrementerFactory) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
- setIncrementerFactory(DataFieldMaxValueIncrementerFactory) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- setInterruptionPolicy(StepInterruptionPolicy) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the step interruption policy to use for checking if the step should be interrupted.
- setInterruptionPolicy(StepInterruptionPolicy) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Setter for the
StepInterruptionPolicy. - setInterruptOnCancel(boolean) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
If
truetasklet will attempt to interrupt the thread executing the system command ifSystemCommandTasklet.setTimeout(long)has been exceeded or user interrupts the job. - setIsolation(Isolation) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setIsolation(Isolation) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setIsolationLevelForCreate(String) - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
public setter for the isolation level to be used for the transaction when job execution entities are initially created.
- setIsolationLevelForCreateEnum(Isolation) - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
public setter for the isolation level to be used for the transaction when job execution entities are initially created.
- setIsReaderTransactionalQueue(boolean) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Flag to signal that the reader is transactional (usually a JMS consumer) so that items are re-presented after a rollback.
- setIsReaderTransactionalQueue(boolean) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Flag to signal that the reader is transactional (usually a JMS consumer) so that items are re-presented after a rollback.
- setItemProcessor(ItemProcessor) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setItemProcessor(ItemProcessor) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- setItemProcessor(ItemProcessor) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setItemProcessor(ItemProcessor) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the item processor to use for processing items.
- setItemReader(ItemReader) - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- setItemReader(ItemReader) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setItemReader(ItemReader) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setItemWriter(ItemWriter) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setItemWriter(ItemWriter) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- setItemWriter(ItemWriter) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setJdbcOperations(JdbcOperations) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.Public setter for the
JdbcOperations. - setJdbcOperations(JdbcOperations) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Public setter for the
JdbcOperations. - setJdbcOperations(JdbcOperations) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Public setter for the
JdbcOperations. - setJdbcTemplate(JdbcOperations) - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- setJob(Job) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setJob(Job) - Method in class org.springframework.batch.core.step.job.JobStep
-
The
Jobto delegate to in this step. - setJobExecutionDao(JdbcJobExecutionDao) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- setJobExecutionDao(MongoJobExecutionDao) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- setJobExecutionId(long) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setJobExecutionId(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setJobExecutionIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
-
Setter for
DataFieldMaxValueIncrementerto be used when generating primary keys forJobExecutioninstances. - setJobExecutionIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- setJobExecutionIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- setJobExecutionIncrementerName(String) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Sets the job execution incrementer name.
- setJobExecutionIncrementerName(String) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Sets the job execution incrementer name.
- setJobExecutionListeners(JobExecutionListener[]) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- setJobExecutionListeners(JobExecutionListener[]) - Method in class org.springframework.batch.core.job.AbstractJob
-
Public setter for injecting
JobExecutionListeners. - setJobExplorer(JobExplorer) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Injection setter for
JobExplorer. - setJobFactoryRef(String) - Method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Convenience method for subclasses to set the job factory reference if it is available (null is fine, but the quality of error reports is better if it is available).
- setJobInstance(JobInstance) - Method in class org.springframework.batch.core.job.JobExecution
-
Set the
JobInstanceused by theJobExecution. - setJobInstanceDao(JdbcJobInstanceDao) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- setJobInstanceDao(MongoJobInstanceDao) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- setJobInstanceId(long) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setJobInstanceId(long) - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- setJobInstanceIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
-
Setter for
DataFieldMaxValueIncrementerto be used when generating primary keys forJobInstanceinstances. - setJobInstanceIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- setJobInstanceIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- setJobInstanceIncrementerName(String) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Sets the job instance incrementer name.
- setJobInstanceIncrementerName(String) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Sets the job instance incrementer name.
- setJobKey(String) - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- setJobKeyGenerator(JobKeyGenerator) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobInstanceDao
-
Setter for
JobKeyGeneratorto be used when generating unique identifiers forJobInstanceobjects. - setJobKeyGenerator(JobKeyGenerator) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao
- setJobKeyGenerator(JobKeyGenerator) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.* Sets the generator for creating the key used in identifying unique {link JobInstance} objects
- setJobKeyGenerator(JobKeyGenerator) - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
* Sets the generator for creating the key used in identifying unique {link JobInstance} objects
- setJobKeyGenerator(JobKeyGenerator) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Set the
JobKeyGeneratorto use. - setJobLoader(JobLoader) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.The job loader that is used to load and manage jobs.
- setJobLocator(JobLocator) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of {
CommandLineJobRunner.setJobRegistry(JobRegistry)}. Scheduled for removal in 6.2 or later. - setJobName(String) - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- setJobOperator(JobOperator) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setJobOperator(JobOperator) - Method in class org.springframework.batch.core.step.job.JobStep
-
A
JobOperatoris required to be able to start the enclosedJob. - setJobParameters(Set) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setJobParametersConverter(JobParametersConverter) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Set the
JobParametersConverterto use for converting command line parameters toJobParameters. - setJobParametersConverter(JobParametersConverter) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Injection setter for
JobParametersConverter. - setJobParametersConverter(JobParametersConverter) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with nor replacement. Scheduled for removal in 6.2 or later.
- setJobParametersConverter(JobParametersConverter) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- setJobParametersConverter(JobParametersConverter) - Method in class org.springframework.batch.core.step.job.DefaultJobParametersExtractor
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
DefaultJobParametersExtractor.convert(Properties), scheduled for removal in 6.2 or later. - setJobParametersExtractor(JobParametersExtractor) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setJobParametersExtractor(JobParametersExtractor) - Method in class org.springframework.batch.core.step.job.JobStep
-
The
JobParametersExtractoris used to extractJobParametersExtractorfrom theStepExecutionto run theJob. - setJobParametersIncrementer(JobParametersIncrementer) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Set the
JobParametersIncrementerfor the factory bean. - setJobParametersIncrementer(JobParametersIncrementer) - Method in class org.springframework.batch.core.job.AbstractJob
-
Public setter for the
JobParametersIncrementer. - setJobParametersIncrementer(JobParametersIncrementer) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- setJobParametersValidator(JobParametersValidator) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Set the
JobParametersValidatorfor the factory bean. - setJobParametersValidator(JobParametersValidator) - Method in class org.springframework.batch.core.job.AbstractJob
-
A validator for job parameters.
- setJobParametersValidator(JobParametersValidator) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.The
JobRegistryto use for jobs created. - setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.configuration.support.JobFactoryRegistrationListener
-
Deprecated.Public setter for a
JobRegistryto use for all the bind and unbind events. - setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.Injection setter for
JobRegistry. - setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Set the
JobRegistry. - setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
-
Setter for the job registry.
- setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.Public setter for the
JobRegistry. - setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Set the
JobRepositoryfor the factory bean. - setJobRepository(JobRepository) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for
JobRepository. - setJobRepository(JobRepository) - Method in class org.springframework.batch.core.job.AbstractJob
-
Public setter for the
JobRepositorythat is needed to manage the state of the batch meta domain (jobs, steps, executions) during the life of a job. - setJobRepository(JobRepository) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.job.SimpleStepHandler
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
-
Setter for the job repository.
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.Set the JobRepository.
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.partition.support.RemoteStepExecutionAggregator
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
-
The job repository that will be used to manage the persistence of the delegate step executions.
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.step.AbstractStep
-
Public setter for
JobRepository. - setJobRepository(JobRepository) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- setJobRepository(JobRepository) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for
JobRepository. - setJobRepository(JobRepository) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- setKey(String) - Method in class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
-
The name of the key to use as a job parameter.
- setKey(String) - Method in class org.springframework.batch.core.job.parameters.RunIdIncrementer
-
The name of the run id in the job parameters.
- setKeyGenerator(KeyGenerator) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
A key generator that can be used to compare items with previously recorded items in a retry.
- setKeyGenerator(KeyGenerator) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.The
KeyGeneratorto use to identify failed items across rollback. - setKeyGenerator(KeyGenerator) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.The
KeyGeneratorto use to identify failed items across rollback. - setKeyName(String) - Method in class org.springframework.batch.core.partition.support.MultiResourcePartitioner
-
The name of the key for the file name in each
ExecutionContext. - setKeyName(String) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.Public setter for the key name of a Long value in the
JobParametersthat will contain a commit interval. - setKeys(String[]) - Method in class org.springframework.batch.core.listener.ExecutionContextPromotionListener
- setKeys(String[]) - Method in class org.springframework.batch.core.listener.JobParameterExecutionContextCopyListener
- setKeys(String[]) - Method in class org.springframework.batch.core.step.job.DefaultJobParametersExtractor
-
The key names to pull out of the execution context or job parameters, if they exist.
- setLastUpdated(LocalDateTime) - Method in class org.springframework.batch.core.job.JobExecution
-
Set the last time this
JobExecutionwas updated. - setLastUpdated(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setLastUpdated(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setLastUpdated(LocalDateTime) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the time when the
StepExecutionwas last updated before persisting. - setLauncher(JobLauncher) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Injection setter for the
JobLauncher. - setListeners(Object[]) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
The listeners to inject into the
Step. - setListeners(List) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Public setter for the listeners.
- setListeners(List) - Method in class org.springframework.batch.core.listener.CompositeItemProcessListener
-
Public setter for the listeners.
- setListeners(List) - Method in class org.springframework.batch.core.listener.CompositeItemReadListener
-
Public setter for the listeners.
- setListeners(List) - Method in class org.springframework.batch.core.listener.CompositeItemWriteListener
-
Public setter for the listeners.
- setListeners(List) - Method in class org.springframework.batch.core.listener.CompositeJobExecutionListener
-
Public setter for the listeners.
- setListeners(List) - Method in class org.springframework.batch.core.listener.CompositeSkipListener
-
Public setter for the listeners.
- setListeners(List) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
-
Register each of the objects as listeners.
- setListeners(List) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Register some
StepListeners with the handler. - setListeners(List) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.Register some
StepListeners with the handler. - setListeners(StepExecutionListener[]) - Method in class org.springframework.batch.core.listener.CompositeStepExecutionListener
-
Public setter for the listeners.
- setListeners(StepListener[]) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.The listeners to inject into the
Step. - setListeners(RetryListener[]) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- setMapping(Map) - Method in class org.springframework.batch.core.launch.support.SimpleJvmExitCodeMapper
-
Supply the ExitCodeMappings
- setMappings(Map) - Method in class org.springframework.batch.core.step.tasklet.ConfigurableSystemProcessExitCodeMapper
- setMaxSkipsOnRead(int) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.
- setMaxVarCharLength(int) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Public setter for the length of long string columns in database.
- setMaxVarCharLength(int) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Public setter for the length of long string columns in database.
- setMaxVarCharLengthForExitMessage(int) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Public setter for the length of the exit message in both
JdbcJobExecutionDaoandJdbcStepExecutionDao. - setMaxVarCharLengthForExitMessage(int) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Public setter for the length of the exit message in both
JdbcJobExecutionDaoandJdbcStepExecutionDao. - setMaxVarCharLengthForShortContext(int) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Public setter for the length of short context string column in database.
- setMaxVarCharLengthForShortContext(int) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Public setter for the length of short context string column in database.
- setMetaDataMap(Map) - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- setMeterRegistry(MeterRegistry) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Set the meter registry to use for metrics.
- setMeterRegistry(MeterRegistry) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.Set the meter registry to use for metrics.
- setMongoOperations(MongoOperations) - Method in class org.springframework.batch.core.repository.explore.support.MongoJobExplorerFactoryBean
-
Deprecated.
- setMongoOperations(MongoOperations) - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- setName(String) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
-
The name of the flow that is created by this factory.
- setName(String) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setName(String) - Method in class org.springframework.batch.core.job.AbstractJob
-
Set the name property.
- setName(String) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- setName(String) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setName(String) - Method in class org.springframework.batch.core.scope.BatchScopeSupport
-
Public setter for the name property.
- setName(String) - Method in class org.springframework.batch.core.step.AbstractStep
-
Set the name property.
- setName(String) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- setNoRollbackExceptionClasses(Collection) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Exception classes that may not cause a rollback if encountered in the right place.
- setNoRollbackExceptionClasses(Collection) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Exception classes that are candidates for no rollback.
- setObjectMapper(ObjectMapper) - Method in class org.springframework.batch.core.repository.dao.Jackson2ExecutionContextStringSerializer
-
Deprecated.
- setObservationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.job.AbstractJob
- setObservationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- setObservationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
-
Set the observation registry to use for metrics.
- setObservationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
-
Set the observation registry to use for observations.
- setObservationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.step.AbstractStep
- setObservationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- setObservationRegistry(ObservationRegistry) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for
ObservationRegistry. - setOptionalKeys(String[]) - Method in class org.springframework.batch.core.job.parameters.DefaultJobParametersValidator
-
The keys that are optional in the parameters.
- setOrder(int) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.The order in which to start up and shutdown.
- setOrder(int) - Method in class org.springframework.batch.core.scope.BatchScopeSupport
- setPartitioner(Partitioner) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setPartitioner(Partitioner) - Method in class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
-
The
Partitionerthat will be used to generate step execution meta data for the target step. - setPartitionHandler(PartitionHandler) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setPartitionHandler(PartitionHandler) - Method in class org.springframework.batch.core.partition.PartitionStep
-
A
PartitionHandlerwhich can send out step executions for remote processing and bring back the results. - setPhase(int) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- setPolicyMap(Map) - Method in class org.springframework.batch.core.step.skip.ExceptionClassifierSkipPolicy
-
Setter for policy map.
- setProcessorTransactional(boolean) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.
- setProcessorTransactional(boolean) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.Flag to say that the
ItemProcessoris transactional (defaults to true). - setProcessorTransactional(Boolean) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Flag to signal that the processor is transactional -- in that case, it should be called for every item in every transaction.
- setProcessSkipCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setProcessSkipCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the number of records skipped during processing.
- setProcessSkipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- setPropagation(Propagation) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setPropagation(Propagation) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setProxyTargetClass(boolean) - Method in class org.springframework.batch.core.scope.BatchScopeSupport
-
Flag to indicate that proxies should use dynamic subclassing.
- setReadCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setReadCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the current number of read items for this execution.
- setReadSkipCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setReadSkipCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Set the number of records skipped on read.
- setRequiredKeys(String[]) - Method in class org.springframework.batch.core.job.parameters.DefaultJobParametersValidator
-
The keys that are required in the parameters.
- setResources(Resource[]) - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.A set of resources to load by using a
GenericApplicationContextFactory. - setResources(Resource[]) - Method in class org.springframework.batch.core.partition.support.MultiResourcePartitioner
-
The resources to assign to each partition.
- setRestartable(boolean) - Method in class org.springframework.batch.core.job.AbstractJob
-
Boolean flag to prevent categorically a job from restarting, even if it has failed previously.
- setRestartable(boolean) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- setRestartable(Boolean) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Set the restartable flag for the factory bean.
- setRetryableExceptionClasses(Map) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for exception classes that retries the item when raised.
- setRetryableExceptionClasses(Map) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Public setter for the retryable exceptions classifier map (from throwable class to boolean, true is retryable).
- setRetryContextCache(RetryContextCache) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setRetryContextCache(RetryContextCache) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Override the default retry context cache for retry of chunk processing.
- setRetryContextCache(RetryContextCache) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- setRetryLimit(int) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for the retry limit.
- setRetryLimit(int) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Public setter for the retry limit.
- setRetryListeners(RetryListener...) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for the
RetryListenerinstances. - setRetryListeners(RetryListener...) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Public setter for the
RetryListeners. - setRetryPolicy(RetryPolicy) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
RetryPolicyfor this step. - setRetryPolicy(RetryPolicy) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
A retry policy to apply when exceptions occur.
- setRetryPolicy(RetryPolicy) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Setter for the retry policy.
- setRetryPolicy(RetryPolicy) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- setRollbackClassifier(Classifier) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.A classifier that can distinguish between exceptions that cause rollback (return true) or not (return false).
- setRollbackClassifier(Classifier) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.Classifier to determine whether exceptions have been marked as no-rollback (as opposed to skippable).
- setRollbackCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setRollbackCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the number of rollbacks for this execution.
- setSerializer(ExecutionContextSerializer) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
-
Setter for
Serializerimplementation - setSerializer(ExecutionContextSerializer) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.A custom implementation of
ExecutionContextSerializer. - setSerializer(ExecutionContextSerializer) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
A custom implementation of the
ExecutionContextSerializer. - setSerializer(ExecutionContextSerializer) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.A custom implementation of the
ExecutionContextSerializer. - setShortContextLength(int) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
-
The maximum size that an execution context can have and still be stored completely in short form in the column
SHORT_CONTEXT. - setSingleton(boolean) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the singleton flag.
- setSkipLimit(int) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for a limit that determines skip policy.
- setSkipLimit(int) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.A limit that determines skip policy.
- setSkipLimit(long) - Method in class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.The absolute number of skips (of skippable exceptions) that can be tolerated before a failure.
- setSkippableExceptionClasses(Map) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for exception classes that, when raised, do not crash the job but result in transaction rollback.
- setSkippableExceptionClasses(Map) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Exception classes that when raised won't crash the job but will result in the item which handling caused the exception being skipped.
- setSkippableExceptionClassifier(Classifier) - Method in class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.The classifier that will be used to decide on skippability.
- setSkippableExceptionMap(Map) - Method in class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.Set up the classifier through a convenient map from throwable class to boolean (true if skippable).
- setSkipPolicies(SkipPolicy[]) - Method in class org.springframework.batch.core.step.skip.CompositeSkipPolicy
- setSkipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for a skip policy.
- setSkipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.A
SkipPolicythat determines the outcome of an exception when processing an item. - setSkipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the skip policy for this step.
- setSkipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.The policy that determines whether exceptions can be skipped on read.
- setStartLimit(int) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
The number of times that the step should be allowed to start.
- setStartLimit(int) - Method in class org.springframework.batch.core.step.AbstractStep
-
Public setter for the startLimit.
- setStartLimit(int) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the start limit for the step.
- setStartLimit(Integer) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- setStartTime(LocalDateTime) - Method in class org.springframework.batch.core.job.JobExecution
-
Set the start time.
- setStartTime(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setStartTime(LocalDateTime) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setStartTime(LocalDateTime) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the time when this execution started.
- setStateTransitionComparator(Comparator) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- setStateTransitionComparator(Comparator) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- setStateTransitions(List) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
-
The raw state transitions for the flow.
- setStateTransitions(List) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
-
Public setter for the stateTransitions.
- setStatus(BatchStatus) - Method in class org.springframework.batch.core.job.JobExecution
-
Set the value of the
statusfield. - setStatus(BatchStatus) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setStatus(BatchStatus) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setStatus(BatchStatus) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the current status of this step.
- setStatuses(String[]) - Method in class org.springframework.batch.core.listener.ExecutionContextPromotionListener
- setStep(Step) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setStep(Step) - Method in class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
-
Setter for the
Stepthat will be used to execute the partitionedStepExecution. - setStepExecutionAggregator(StepExecutionAggregator) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setStepExecutionAggregator(StepExecutionAggregator) - Method in class org.springframework.batch.core.partition.PartitionStep
-
A
StepExecutionAggregatorthat can aggregate step executions when they come back from the handler. - setStepExecutionId(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setStepExecutionIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- setStepExecutionIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- setStepExecutionIncrementer(DataFieldMaxValueIncrementer) - Method in class org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean
- setStepExecutionIncrementerName(String) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Sets the step execution incrementer name.
- setStepExecutionIncrementerName(String) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Sets the step execution incrementer name.
- setStepExecutionListeners(StepExecutionListener[]) - Method in class org.springframework.batch.core.step.AbstractStep
-
Register each of the objects as listeners.
- setStepExecutions(List) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setStepExecutionSplitter(StepExecutionSplitter) - Method in class org.springframework.batch.core.partition.PartitionStep
-
Public setter for mandatory property
StepExecutionSplitter. - setStepLocator(StepLocator) - Method in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- setStepName(String) - Method in class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
-
The name of the target step that will be executed across the partitions.
- setStepName(String) - Method in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- setStepOperations(RepeatOperations) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the stepOperations.
- setStepOperations(RepeatOperations) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
The
RepeatOperationsto use for the outer loop of the batch processing. - setStepRegistry(StepRegistry) - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.The
StepRegistryto use for the steps of created jobs. - setSteps(List) - Method in class org.springframework.batch.core.job.SimpleJob
-
Public setter for the steps in this job.
- setStreams(ItemStream[]) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
The streams to inject into the
Step. - setStreams(ItemStream[]) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.The streams to inject into the
Step. - setStreams(ItemStream[]) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Register each of the streams for callbacks at the appropriate time in the step.
- setStrict(boolean) - Method in class org.springframework.batch.core.listener.ExecutionContextPromotionListener
-
If set to TRUE, the listener will throw an exception if any 'key' is not found in the Step
ExecutionContext. - setSystemExiter(SystemExiter) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Injection setter for the
SystemExiter. - setSystemProcessExitCodeMapper(SystemProcessExitCodeMapper) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- setTablePrefix(String) - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
-
Public setter for the table prefix property.
- setTablePrefix(String) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.Sets the table prefix for all the batch metadata tables.
- setTablePrefix(String) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Sets the table prefix for all the batch meta-data tables.
- setTablePrefix(String) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Sets the table prefix for all the batch meta-data tables.
- setTaskExecutor(AsyncTaskExecutor) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
AsyncTaskExecutorto use for processing items asynchronously. - setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for the
TaskExecutor. - setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.SplitState
-
Public setter for the taskExecutor.
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
-
Set the TaskExecutor.
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.Set the TaskExecutor.
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
-
Setter for the
TaskExecutorthat is used to farm out step executions to multiple threads. - setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the
TaskExecutor. - setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Sets the task executor that will be used to execute the system command NB!
- setTasklet(Tasklet) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
A preconfigured
Taskletto use. - setTasklet(Tasklet) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Public setter for the
Tasklet. - setTerminateOnly() - Method in class org.springframework.batch.core.step.StepExecution
-
Sets a flag that signals to an execution environment that this execution (and its surrounding job) wishes to exit.
- setTerminateOnly(boolean) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setTerminationCheckInterval(long) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
The time interval how often the tasklet will check for termination status.
- setTimeout(long) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Timeout in milliseconds.
- setTransactionAttribute(TransactionAttribute) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the transaction attribute for this step.
- setTransactionAttribute(TransactionAttribute) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Public setter for the
TransactionAttribute. - setTransactionAttributeSource(TransactionAttributeSource) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
-
Set the transaction attributes source to use in the created proxy.
- setTransactionAttributeSource(TransactionAttributeSource) - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.Set the transaction attributes source to use in the created proxy.
- setTransactionAttributeSource(TransactionAttributeSource) - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
Set the transaction attributes source to use in the created proxy.
- setTransactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setTransactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.launch.support.JobOperatorFactoryBean
-
Setter for the transaction manager.
- setTransactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.repository.explore.support.AbstractJobExplorerFactoryBean
-
Deprecated.Public setter for the
PlatformTransactionManager. - setTransactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
Public setter for the
PlatformTransactionManager. - setTransactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the
PlatformTransactionManager. - setTransactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
PlatformTransactionManagerto use for the chunk-oriented tasklet. - setTransactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Public setter for the
PlatformTransactionManager. - setTransactionTimeout(int) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setTransactionTimeout(int) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.The timeout for an individual transaction in the step.
- setUseAllParentParameters(boolean) - Method in class org.springframework.batch.core.step.job.DefaultJobParametersExtractor
-
setter to support switching off all parent parameters
- setValidateTransactionState(boolean) - Method in class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
-
Flag to determine whether to check for an existing transaction when a JobExecution is created.
- setValidators(List) - Method in class org.springframework.batch.core.job.parameters.CompositeJobParametersValidator
-
Public setter for the validators
- setVersion(Integer) - Method in class org.springframework.batch.core.Entity
-
Public setter for the version.
- setWorkingDirectory(String) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- setWriteCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setWriteCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Sets the current number of written items for this execution.
- setWriteSkipCount(long) - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- setWriteSkipCount(long) - Method in class org.springframework.batch.core.step.StepExecution
-
Set the number of records skipped on write.
- setWriteSkipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- shouldGenerateId() - Method in class org.springframework.batch.core.configuration.xml.InlineFlowParser
- shouldSkip(Throwable, long) - Method in class org.springframework.batch.core.step.skip.AlwaysSkipItemSkipPolicy
- shouldSkip(Throwable, long) - Method in class org.springframework.batch.core.step.skip.CompositeSkipPolicy
- shouldSkip(Throwable, long) - Method in class org.springframework.batch.core.step.skip.ExceptionClassifierSkipPolicy
-
Consult the classifier and find a delegate policy, and then use that to determine the outcome.
- shouldSkip(Throwable, long) - Method in class org.springframework.batch.core.step.skip.LimitCheckingExceptionHierarchySkipPolicy
- shouldSkip(Throwable, long) - Method in class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.Given the provided exception and skip count, determine whether or not processing should continue for the given exception.
- shouldSkip(Throwable, long) - Method in class org.springframework.batch.core.step.skip.NeverSkipItemSkipPolicy
- shouldSkip(Throwable, long) - Method in interface org.springframework.batch.core.step.skip.SkipPolicy
-
Returns true or false, indicating whether or not processing should continue with the given throwable.
- shouldStart(StepExecution, JobExecution, Step) - Method in class org.springframework.batch.core.job.SimpleStepHandler
-
Given a step and configuration, return true if the step should start, false if it should not, and throw an exception if the job should finish.
- SimpleChunkProcessor<I,
O> - Class in org.springframework.batch.core.step.item -
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
ChunkOrientedStepinstead. Scheduled for removal in 7.0. - SimpleChunkProcessor(ItemProcessor, ItemWriter) - Constructor for class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- SimpleChunkProcessor(ItemWriter) - Constructor for class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- SimpleChunkProvider<I> - Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
ChunkOrientedStepinstead. Scheduled for removal in 7.0. - SimpleChunkProvider(ItemReader, RepeatOperations) - Constructor for class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
- SimpleFlow - Class in org.springframework.batch.core.job.flow.support
- SimpleFlow(String) - Constructor for class org.springframework.batch.core.job.flow.support.SimpleFlow
-
Create a flow with the given name.
- SimpleFlowFactoryBean - Class in org.springframework.batch.core.configuration.xml
-
Convenience factory for
SimpleFlowinstances for use in the XML namespace. - SimpleFlowFactoryBean() - Constructor for class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- SimpleFlowFactoryBean.DelegateState - Class in org.springframework.batch.core.configuration.xml
-
A State that proxies a delegate and changes its name but leaves its behavior unchanged.
- SimpleJob - Class in org.springframework.batch.core.job
-
Simple implementation of
Jobinterface providing the ability to run aJobExecution. - SimpleJob() - Constructor for class org.springframework.batch.core.job.SimpleJob
-
Default constructor for job with null name
- SimpleJob(String) - Constructor for class org.springframework.batch.core.job.SimpleJob
- SimpleJobBuilder - Class in org.springframework.batch.core.job.builder
- SimpleJobBuilder(JobBuilderHelper) - Constructor for class org.springframework.batch.core.job.builder.SimpleJobBuilder
-
Create a new builder initialized with any properties in the parent.
- SimpleJobExplorer - Class in org.springframework.batch.core.repository.explore.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
SimpleJobRepository. Scheduled for removal in 6.2 or later. - SimpleJobExplorer(JobInstanceDao, JobExecutionDao, StepExecutionDao, ExecutionContextDao) - Constructor for class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.Constructor to initialize the job
SimpleJobExplorer. - SimpleJobOperator - Class in org.springframework.batch.core.launch.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
TaskExecutorJobOperator. Scheduled for removal in 6.2 or later. - SimpleJobOperator() - Constructor for class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- SimpleJobRepository - Class in org.springframework.batch.core.repository.support
-
Implementation of
JobRepositorythat stores job instances, job executions, and step executions using the injected DAOs. - SimpleJobRepository(JobInstanceDao, JobExecutionDao, StepExecutionDao, ExecutionContextDao) - Constructor for class org.springframework.batch.core.repository.support.SimpleJobRepository
- SimpleJvmExitCodeMapper - Class in org.springframework.batch.core.launch.support
-
An implementation of
ExitCodeMapperthat can be configured through a map from batch exit codes (String) to integer results. - SimpleJvmExitCodeMapper() - Constructor for class org.springframework.batch.core.launch.support.SimpleJvmExitCodeMapper
- SimplePartitioner - Class in org.springframework.batch.core.partition.support
-
Simplest possible implementation of
Partitioner. - SimplePartitioner() - Constructor for class org.springframework.batch.core.partition.support.SimplePartitioner
- SimpleRetryExceptionHandler - Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
ChunkOrientedStepinstead. Scheduled for removal in 7.0. - SimpleRetryExceptionHandler(RetryPolicy, ExceptionHandler, Collection) - Constructor for class org.springframework.batch.core.step.item.SimpleRetryExceptionHandler
-
Deprecated.Create an exception handler from its mandatory properties.
- SimpleStepBuilder<I,
O> - Class in org.springframework.batch.core.step.builder -
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
ChunkOrientedStepBuilder. Scheduled for removal in 7.0. - SimpleStepBuilder(SimpleStepBuilder) - Constructor for class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Create a new builder initialized with any properties in the parent.
- SimpleStepBuilder(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Create a new builder initialized with any properties in the parent.
- SimpleStepExecutionSplitter - Class in org.springframework.batch.core.partition.support
-
Generic implementation of
StepExecutionSplitterthat delegates to aPartitionerto generateExecutionContextinstances. - SimpleStepExecutionSplitter(JobRepository, String, Partitioner) - Constructor for class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
-
Construct a
SimpleStepExecutionSplitterfrom its mandatory properties. - SimpleStepFactoryBean<T,
S> - Class in org.springframework.batch.core.step.factory -
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 with no replacement. Scheduled for removal in 7.0.
- SimpleStepFactoryBean() - Constructor for class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Default constructor for
SimpleStepFactoryBean. - SimpleStepHandler - Class in org.springframework.batch.core.job
-
Implementation of
StepHandlerthat manages repository and restart concerns. - SimpleStepHandler(JobRepository) - Constructor for class org.springframework.batch.core.job.SimpleStepHandler
- SimpleStepHandler(JobRepository, ExecutionContext) - Constructor for class org.springframework.batch.core.job.SimpleStepHandler
- SimpleSystemProcessExitCodeMapper - Class in org.springframework.batch.core.step.tasklet
-
Simple
SystemProcessExitCodeMapperimplementation that performs following mapping: - SimpleSystemProcessExitCodeMapper() - Constructor for class org.springframework.batch.core.step.tasklet.SimpleSystemProcessExitCodeMapper
- skip(Class) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly request certain exceptions (and subclasses) to be skipped.
- skip(Class...) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
- skipCount - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkScanEvent
- SkipException - Exception Class in org.springframework.batch.core.step.skip
-
Base exception indicating that the skip has failed or caused a failure.
- SkipException(String) - Constructor for exception class org.springframework.batch.core.step.skip.SkipException
- SkipException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.SkipException
- skipLimit(int) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Sets the maximum number of failed items to skip before the step fails.
- skipLimit(long) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set the skip limit for the step.
- SkipLimitExceededException - Exception Class in org.springframework.batch.core.step.skip
-
Exception indicating that the skip limit for a particular
Stephas been exceeded. - SkipLimitExceededException(long, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.SkipLimitExceededException
- skipListener(SkipListener) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Add a skip listener to the step.
- SkipListener<T,
S> - Interface in org.springframework.batch.core.listener -
Interface for listener to skipped items.
- SkipListenerFailedException - Exception Class in org.springframework.batch.core.step.skip
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- SkipListenerFailedException(String, RuntimeException, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.SkipListenerFailedException
-
Deprecated.
- SkipListenerFailedException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.SkipListenerFailedException
-
Deprecated.Create a new
SkipListenerFailedException. - SkipOverflowException - Exception Class in org.springframework.batch.core.step.item
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 7.0.
- SkipOverflowException(String) - Constructor for exception class org.springframework.batch.core.step.item.SkipOverflowException
-
Deprecated.
- skipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set the skip policy for the step.
- skipPolicy(SkipPolicy) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Provide an explicit policy for managing skips.
- SkipPolicy - Interface in org.springframework.batch.core.step.skip
-
Policy for determining whether or not some processing should be skipped.
- SkipPolicyFailedException - Exception Class in org.springframework.batch.core.step.skip
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- SkipPolicyFailedException(String, RuntimeException, Throwable) - Constructor for exception class org.springframework.batch.core.step.skip.SkipPolicyFailedException
-
Deprecated.
- split(StepExecution, int) - Method in interface org.springframework.batch.core.partition.StepExecutionSplitter
-
Partition the provided
StepExecutioninto a set of parallel executable instances with the same parentJobExecution. - split(StepExecution, int) - Method in class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
- split(TaskExecutor) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
- split(TaskExecutor) - Method in class org.springframework.batch.core.job.builder.SimpleJobBuilder
- SPLIT_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Split element.
- SplitBuilder(FlowBuilder, TaskExecutor) - Constructor for class org.springframework.batch.core.job.builder.FlowBuilder.SplitBuilder
- SplitParser - Class in org.springframework.batch.core.configuration.xml
-
Internal parser for the <split/> elements inside a job.
- SplitParser(String) - Constructor for class org.springframework.batch.core.configuration.xml.SplitParser
-
Construct a
InlineFlowParserby using the provided job repository reference. - SplitState - Class in org.springframework.batch.core.job.flow.support.state
- SplitState(Collection, String) - Constructor for class org.springframework.batch.core.job.flow.support.state.SplitState
- SplitState(Collection, String, SplitState) - Constructor for class org.springframework.batch.core.job.flow.support.state.SplitState
- splitter(StepExecutionSplitter) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Provide an explicit
StepExecutionSplitterinstead of having one build from thePartitionStepBuilder.partitioner(String, Partitioner). - SPRING_BATCH_JDBC_SCHEMA_LEGACY - Static variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Environment variable for using the legacy (v5) jdbc schema.
- SPRING_BATCH_JDBC_SCHEMA_LEGACY_PROPERTY - Static variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.System property for using the legacy (v5) jdbc schema.
- SpringBatchVersion - Class in org.springframework.batch.core
-
Class that exposes the Spring Batch version.
- StandaloneStepParser - Class in org.springframework.batch.core.configuration.xml
-
Internal parser for the <step/> elements for a job.
- StandaloneStepParser() - Constructor for class org.springframework.batch.core.configuration.xml.StandaloneStepParser
- start() - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.Take all the contexts from the factories provided and pass them to the
JobLoader. - start(String, Properties) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobOperator.start(Job, JobParameters). Scheduled for removal in 6.2 or later. - start(String, Properties) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Start a job with the given name and parameters.
- start(String, Properties) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- start(Flow) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
If a flow should start with a subflow use this as the first state.
- start(Flow) - Method in class org.springframework.batch.core.job.builder.FlowJobBuilder
-
Start a job with this flow, but expect to transition from there to other flows or steps.
- start(Flow) - Method in class org.springframework.batch.core.job.builder.JobBuilder
-
Create a new job builder that will execute a flow.
- start(FlowExecutor) - Method in interface org.springframework.batch.core.job.flow.Flow
- start(FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- start(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
If a flow should start with a decision use this as the first state.
- start(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.FlowJobBuilder
-
Start a job with this decider, but expect to transition from there to other flows or steps.
- start(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.JobBuilder
-
Create a new job builder that will start with a decider.
- start(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.SimpleJobBuilder
-
Start with this decider.
- start(Job, JobParameters) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Start a new instance of a job with the specified parameters.
- start(Job, JobParameters) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.Start a new instance of a job with the specified parameters.
- start(Job, JobParameters) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- start(Step) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
-
Start a flow.
- start(Step) - Method in class org.springframework.batch.core.job.builder.FlowJobBuilder
-
Start a job with this step, but expect to transition from there to other flows or steps.
- start(Step) - Method in class org.springframework.batch.core.job.builder.JobBuilder
-
Create a new job builder that will execute a step or sequence of steps.
- start(Step) - Method in class org.springframework.batch.core.job.builder.SimpleJobBuilder
-
Start the job with this step.
- start(RepeatContext) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.
- STARTED - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
Status of a batch job that is running.
- STARTING - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
Status of a batch job prior to its execution.
- startLimit(int) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- StartLimitExceededException - Exception Class in org.springframework.batch.core.job
-
Indicates the step's start limit has been exceeded.
- StartLimitExceededException(String) - Constructor for exception class org.springframework.batch.core.job.StartLimitExceededException
-
Constructor that sets the message for the exception.
- startNextInstance(String) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobOperator.startNextInstance(Job). Scheduled for removal in 6.2 or later. - startNextInstance(String) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Start the next instance of the job with the given name.
- startNextInstance(String) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- startNextInstance(Job) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Launch the next in a sequence of
JobInstancedetermined by theJobParametersIncrementerattached to the specified job. - startNextInstance(Job) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- startNextInstance(Job) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- State - Interface in org.springframework.batch.core.job.flow
- STATE_TRANSITION_COMPARATOR - Static variable in class org.springframework.batch.core.job.flow.support.DefaultStateTransitionComparator
- StateTransition - Class in org.springframework.batch.core.job.flow.support
-
Value object representing a potential transition from one
Stateto another. - STATUS_COMMITTED - Static variable in class org.springframework.batch.core.observability.BatchMetrics
- STATUS_FAILURE - Static variable in class org.springframework.batch.core.observability.BatchMetrics
- STATUS_ROLLED_BACK - Static variable in class org.springframework.batch.core.observability.BatchMetrics
- STATUS_SUCCESS - Static variable in class org.springframework.batch.core.observability.BatchMetrics
- step(Step) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Provide an actual step instance to execute in parallel.
- Step - Interface in org.springframework.batch.core.step
-
Batch domain interface representing the configuration of a step.
- STEP_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Step element.
- STEP_TYPE_KEY - Static variable in interface org.springframework.batch.core.step.Step
-
The key to use when retrieving the batch step type.
- StepBuilder - Class in org.springframework.batch.core.step.builder
-
Convenient entry point for building all kinds of steps.
- StepBuilder(String, JobRepository) - Constructor for class org.springframework.batch.core.step.builder.StepBuilder
-
Initialize a step builder for a step with the given name and job repository.
- StepBuilder(JobRepository) - Constructor for class org.springframework.batch.core.step.builder.StepBuilder
-
Initialize a step builder for a step with the given job repository.
- StepBuilderException - Exception Class in org.springframework.batch.core.step.builder
-
Utility exception thrown by builders when they encounter unexpected checked exceptions.
- StepBuilderException(Exception) - Constructor for exception class org.springframework.batch.core.step.builder.StepBuilderException
- StepBuilderException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.builder.StepBuilderException
- StepBuilderHelper<B> - Class in org.springframework.batch.core.step.builder
-
A base class and utility for other step builders providing access to common properties like job repository and listeners.
- StepBuilderHelper(String, JobRepository) - Constructor for class org.springframework.batch.core.step.builder.StepBuilderHelper
-
Create a new
StepBuilderHelper. - StepBuilderHelper(JobRepository) - Constructor for class org.springframework.batch.core.step.builder.StepBuilderHelper
-
Create a new
StepBuilderHelperwith the given job repository. - StepBuilderHelper(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.StepBuilderHelper
-
Create a new builder initialized with any properties in the parent.
- StepBuilderHelper.CommonStepProperties - Class in org.springframework.batch.core.step.builder
- StepContext - Class in org.springframework.batch.core.scope.context
-
A context object that can be used to interrogate the current
StepExecutionand some of its associated properties using expressions based on bean paths. - StepContext(StepExecution) - Constructor for class org.springframework.batch.core.scope.context.StepContext
-
Create a new instance of
StepContextfor thisStepExecution. - StepContextRepeatCallback - Class in org.springframework.batch.core.scope.context
-
Convenient base class for clients who need to do something in a repeat callback inside a
Step. - StepContextRepeatCallback(StepExecution) - Constructor for class org.springframework.batch.core.scope.context.StepContextRepeatCallback
- StepContribution - Class in org.springframework.batch.core.step
-
Represents a contribution to a
StepExecution, buffering changes until they can be applied at a chunk boundary. - StepContribution(StepExecution) - Constructor for class org.springframework.batch.core.step.StepContribution
- StepExecution - Class in org.springframework.batch.core.repository.persistence
- StepExecution - Class in org.springframework.batch.core.step
-
Batch domain object representation for the execution of a step.
- StepExecution() - Constructor for class org.springframework.batch.core.repository.persistence.StepExecution
- StepExecution(long, String, JobExecution) - Constructor for class org.springframework.batch.core.step.StepExecution
-
Constructor with mandatory properties.
- StepExecution(String, JobExecution) - Constructor for class org.springframework.batch.core.step.StepExecution
-
Deprecated, for removal: This API element is subject to removal in a future version.
- StepExecutionAggregator - Interface in org.springframework.batch.core.partition
-
Strategy for aggregating step executions, usually when they are the result of partitioned or remote execution.
- StepExecutionConverter - Class in org.springframework.batch.core.repository.persistence.converter
- StepExecutionConverter() - Constructor for class org.springframework.batch.core.repository.persistence.converter.StepExecutionConverter
- stepExecutionDao - Variable in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- StepExecutionDao - Interface in org.springframework.batch.core.repository.dao
- StepExecutionEvent - Class in org.springframework.batch.core.observability.jfr.events.step
- StepExecutionEvent(String, String, long, long) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.StepExecutionEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkScanEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkTransactionEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkWriteEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemProcessEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemReadEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.partition.PartitionAggregateEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.partition.PartitionSplitEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.StepExecutionEvent
- stepExecutionId - Variable in class org.springframework.batch.core.observability.jfr.events.step.tasklet.TaskletExecutionEvent
- stepExecutionIncrementerName - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- stepExecutionIncrementerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
The incrementer that will be used to generate unique ids for step executions.
- StepExecutionListener - Interface in org.springframework.batch.core.listener
-
Listener interface for the lifecycle of a
Step. - stepExecutionListenerMetaData() - Static method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- StepExecutionSimpleCompletionPolicy - Class in org.springframework.batch.core.resource
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- StepExecutionSimpleCompletionPolicy() - Constructor for class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.
- StepExecutionSplitter - Interface in org.springframework.batch.core.partition
-
Strategy interface for generating input contexts for a partitioned step execution independent from the fabric they are going to run on.
- StepHandler - Interface in org.springframework.batch.core.job
- StepHolder - Interface in org.springframework.batch.core.step
-
Interface for holders of a
Stepas a convenience for callers who need access to the underlying instance. - StepInterruptionPolicy - Interface in org.springframework.batch.core.step
-
Strategy interface for an interruption policy.
- StepListener - Interface in org.springframework.batch.core.listener
-
Marker interface that acts as a parent to all step domain listeners, such as:
StepExecutionListener,ChunkListener,ItemReadListener, andItemWriteListener - StepListenerFactoryBean - Class in org.springframework.batch.core.listener
-
This
AbstractListenerFactoryBeanimplementation is used to create aStepListener. - StepListenerFactoryBean() - Constructor for class org.springframework.batch.core.listener.StepListenerFactoryBean
- StepListenerFailedException - Exception Class in org.springframework.batch.core.listener
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- StepListenerFailedException(String, Throwable) - Constructor for exception class org.springframework.batch.core.listener.StepListenerFailedException
-
Deprecated.
- StepListenerMetaData - Enum Class in org.springframework.batch.core.listener
-
Enumeration for
StepListenermeta data, which ties together the names of methods, their interfaces, annotation, and expected arguments. - StepListenerParser - Class in org.springframework.batch.core.configuration.xml
-
Parser for a step listener element.
- StepListenerParser() - Constructor for class org.springframework.batch.core.configuration.xml.StepListenerParser
- StepListenerParser(ListenerMetaData[]) - Constructor for class org.springframework.batch.core.configuration.xml.StepListenerParser
- StepListenerSupport<T,
S> - Class in org.springframework.batch.core.listener -
Basic no-op implementations of all
StepListenerinterfaces. - StepListenerSupport() - Constructor for class org.springframework.batch.core.listener.StepListenerSupport
- stepLocator - Variable in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- StepLocator - Interface in org.springframework.batch.core.step
-
Interface for locating a
Stepinstance by name. - StepLocatorStepFactoryBean - Class in org.springframework.batch.core.step
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 7.0.
- StepLocatorStepFactoryBean() - Constructor for class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkScanEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkTransactionEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkWriteEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemProcessEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ItemReadEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.partition.PartitionAggregateEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.partition.PartitionSplitEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.StepExecutionEvent
- stepName - Variable in class org.springframework.batch.core.observability.jfr.events.step.tasklet.TaskletExecutionEvent
- stepName - Variable in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- stepOperations(RepeatOperations) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Sets the repeat template used for iterating the tasklet execution.
- StepParserStepFactoryBean<I,
O> - Class in org.springframework.batch.core.configuration.xml -
This
FactoryBeanis used by the batch namespace parser to createStepobjects. - StepParserStepFactoryBean() - Constructor for class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- StepRegistry - Interface in org.springframework.batch.core.configuration
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 with no replacement. Scheduled for removal in 6.2.
- stepScope() - Static method in class org.springframework.batch.core.configuration.support.ScopeConfiguration
- StepScope - Class in org.springframework.batch.core.scope
-
Scope for step context.
- StepScope - Annotation Interface in org.springframework.batch.core.configuration.annotation
-
Convenient annotation for step-scoped beans.
- StepScope() - Constructor for class org.springframework.batch.core.scope.StepScope
- StepScopeManager - Class in org.springframework.batch.core.scope.context
-
Convenient aspect to wrap a single threaded step execution, where the implementation of the
Stepis not step scope aware (i.e. not the ones provided by the framework). - StepScopeManager() - Constructor for class org.springframework.batch.core.scope.context.StepScopeManager
- StepState - Class in org.springframework.batch.core.job.flow.support.state
- StepState(String, Step) - Constructor for class org.springframework.batch.core.job.flow.support.state.StepState
- StepState(Step) - Constructor for class org.springframework.batch.core.job.flow.support.state.StepState
- StepSynchronizationManager - Class in org.springframework.batch.core.scope.context
-
Central convenience class for framework use in managing the step scope context.
- StepSynchronizationManager() - Constructor for class org.springframework.batch.core.scope.context.StepSynchronizationManager
- stop() - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.Delegates to
JobLoader.clear(). - stop() - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Signal the successful end of the flow.
- stop() - Method in interface org.springframework.batch.core.step.tasklet.StoppableTasklet
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, use
StoppableTasklet.stop(StepExecution)instead. - stop() - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Will interrupt the thread executing the system command only if
SystemCommandTasklet.setInterruptOnCancel(boolean)has been set to true. - stop(long) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobOperator.stop(JobExecution). Scheduled for removal in 6.2 or later. - stop(long) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Send a stop signal to the job execution with given ID.
- stop(long) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated, for removal: This API element is subject to removal in a future version.
- stop(Runnable) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- stop(String) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
- stop(String, State) - Method in class org.springframework.batch.core.job.builder.FlowBuilder
- stop(JobExecution) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Send a stop signal to the supplied
JobExecution. - stop(JobExecution) - Method in class org.springframework.batch.core.launch.support.SimpleJobOperator
-
Deprecated.
- stop(JobExecution) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- stop(StepExecution) - Method in interface org.springframework.batch.core.step.StoppableStep
-
Callback to signal the step to stop.
- stop(StepExecution) - Method in interface org.springframework.batch.core.step.tasklet.StoppableTasklet
-
Used to signal that the job should stop, providing access to the current
StepExecutioncontext. - stop(StepExecution) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Interrupts the execution of the system command if the given
StepExecutionmatches the current execution context. - STOP_ELE - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a Stop element.
- stopAndRestart(Flow) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Stop the flow and provide a flow to start with if the flow is restarted.
- stopAndRestart(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Stop the flow and provide a decider to start with if the flow is restarted.
- stopAndRestart(Step) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Stop the flow and provide a step to start with if the flow is restarted.
- StoppableStep - Interface in org.springframework.batch.core.step
-
Extension of the
Stepinterface to be implemented by steps that support being stopped. - StoppableTasklet - Interface in org.springframework.batch.core.step.tasklet
-
An extension to the
Taskletinterface to allow users to add logic for stopping a tasklet. - STOPPED - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
Status of a batch job that has been stopped by request.
- STOPPED - Static variable in class org.springframework.batch.core.ExitStatus
-
Convenient constant value representing finished processing with interrupted status.
- STOPPED - Static variable in class org.springframework.batch.core.job.flow.FlowExecutionStatus
-
Special well-known status value.
- STOPPING - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
Status of batch job waiting for a step to complete before stopping the batch job.
- stopTimer(Timer.Sample, StepExecution, String, String, String) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- stream(ItemStream) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Register a stream for callbacks that manage restart data.
- stream(ItemStream) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Register a stream for callbacks that manage restart data.
- stream(ItemStream) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- StringToDateConverter - Class in org.springframework.batch.core.converter
- StringToDateConverter() - Constructor for class org.springframework.batch.core.converter.StringToDateConverter
- StringToLocalDateConverter - Class in org.springframework.batch.core.converter
- StringToLocalDateConverter() - Constructor for class org.springframework.batch.core.converter.StringToLocalDateConverter
- StringToLocalDateTimeConverter - Class in org.springframework.batch.core.converter
- StringToLocalDateTimeConverter() - Constructor for class org.springframework.batch.core.converter.StringToLocalDateTimeConverter
- StringToLocalTimeConverter - Class in org.springframework.batch.core.converter
- StringToLocalTimeConverter() - Constructor for class org.springframework.batch.core.converter.StringToLocalTimeConverter
- StringToOffsetDateTimeConverter - Class in org.springframework.batch.core.converter
- StringToOffsetDateTimeConverter() - Constructor for class org.springframework.batch.core.converter.StringToOffsetDateTimeConverter
- StringToZonedDateTimeConverter - Class in org.springframework.batch.core.converter
- StringToZonedDateTimeConverter() - Constructor for class org.springframework.batch.core.converter.StringToZonedDateTimeConverter
- switchOriginAndDestination(StateTransition, State, String) - Static method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Convenience method to switch the origin and destination of a transition, creating a new instance.
- SynchronizationManagerSupport<E,
C> - Class in org.springframework.batch.core.scope.context -
Central convenience class for framework use in managing the scope context.
- SynchronizationManagerSupport() - Constructor for class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
- synchronizeStatus(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
- synchronizeStatus(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
-
Because it may be possible that the status of a JobExecution is updated while running, the following method will synchronize only the status and version fields.
- synchronizeStatus(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- SystemCommandException - Exception Class in org.springframework.batch.core.step.tasklet
-
Exception indicating failed execution of system command.
- SystemCommandException(String) - Constructor for exception class org.springframework.batch.core.step.tasklet.SystemCommandException
- SystemCommandException(String, Throwable) - Constructor for exception class org.springframework.batch.core.step.tasklet.SystemCommandException
- SystemCommandTasklet - Class in org.springframework.batch.core.step.tasklet
-
Taskletthat executes a system command. - SystemCommandTasklet() - Constructor for class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- SystemExiter - Interface in org.springframework.batch.core.launch.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
- SystemProcessExitCodeMapper - Interface in org.springframework.batch.core.step.tasklet
-
Maps the exit code of a system process to ExitStatus value returned by a system command.
T
- tablePrefix - Variable in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.
- tablePrefix - Variable in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.
- tablePrefix() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
The Batch tables prefix.
- taskExecutor - Variable in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.
- taskExecutor(AsyncTaskExecutor) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Set the asynchronous task executor to be used for processing items concurrently.
- taskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0, concurrent executions of
Tasklets withTaskExecutorRepeatTemplateis deprecated and scheduled for removal in v7. Concurrency support for chunk-oriented steps is provided throughChunkOrientedStepBuilder.taskExecutor(AsyncTaskExecutor). For simple tasklet steps, consider using aTaskExecutoron the tasklet implementation instead. - taskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Provide a task executor to use when constructing a
PartitionHandlerfrom thePartitionStepBuilder.step(Step). - TaskExecutorJobLauncher - Class in org.springframework.batch.core.launch.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
TaskExecutorJobOperator. Scheduled for removal in 6.2 or later. - TaskExecutorJobLauncher() - Constructor for class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.
- TaskExecutorJobOperator - Class in org.springframework.batch.core.launch.support
-
A
TaskExecutor-based implementation of theJobOperatorinterface. - TaskExecutorJobOperator() - Constructor for class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- TaskExecutorPartitionHandler - Class in org.springframework.batch.core.partition.support
-
A
PartitionHandlerthat uses aTaskExecutorto execute the partitionedSteplocally in multiple threads. - TaskExecutorPartitionHandler() - Constructor for class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
- taskExecutorRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableBatchProcessing
-
Set the task executor to use in the job operator.
- tasklet(Tasklet) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Build a step with a custom tasklet, not necessarily item processing.
- tasklet(Tasklet) - Method in class org.springframework.batch.core.step.builder.TaskletStepBuilder
- tasklet(Tasklet, PlatformTransactionManager) - Method in class org.springframework.batch.core.step.builder.StepBuilder
-
Build a step with a custom tasklet, not necessarily item processing.
- tasklet(Tasklet, PlatformTransactionManager) - Method in class org.springframework.batch.core.step.builder.TaskletStepBuilder
- Tasklet - Interface in org.springframework.batch.core.step.tasklet
-
Strategy for processing in a step.
- TASKLET_TYPE_KEY - Static variable in class org.springframework.batch.core.step.tasklet.TaskletStep
- TaskletExecutionEvent - Class in org.springframework.batch.core.observability.jfr.events.step.tasklet
- TaskletExecutionEvent(String, long, String) - Constructor for class org.springframework.batch.core.observability.jfr.events.step.tasklet.TaskletExecutionEvent
- taskletListenerMetaData() - Static method in enum class org.springframework.batch.core.listener.StepListenerMetaData
- TaskletParser - Class in org.springframework.batch.core.configuration.xml
-
Parse a tasklet element for a step.
- TaskletParser() - Constructor for class org.springframework.batch.core.configuration.xml.TaskletParser
- taskletStatus - Variable in class org.springframework.batch.core.observability.jfr.events.step.tasklet.TaskletExecutionEvent
- TaskletStep - Class in org.springframework.batch.core.step.tasklet
-
Simple implementation of executing the step as a call to a
Tasklet, possibly repeated, and each call surrounded by a transaction. - TaskletStep() - Constructor for class org.springframework.batch.core.step.tasklet.TaskletStep
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 for removal in 7.0. Use
TaskletStep(JobRepository)instead. - TaskletStep(String) - Constructor for class org.springframework.batch.core.step.tasklet.TaskletStep
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 for removal in 7.0. Use
TaskletStep(JobRepository)instead. - TaskletStep(JobRepository) - Constructor for class org.springframework.batch.core.step.tasklet.TaskletStep
-
Create a new instance with the given name and job repository.
- TaskletStepBuilder - Class in org.springframework.batch.core.step.builder
-
Builder for tasklet step based on a custom tasklet (not item oriented).
- TaskletStepBuilder(StepBuilderHelper) - Constructor for class org.springframework.batch.core.step.builder.TaskletStepBuilder
-
Create a new builder initialized with any properties in the parent.
- taskletType - Variable in class org.springframework.batch.core.observability.jfr.events.step.tasklet.TaskletExecutionEvent
- ThreadStepInterruptionPolicy - Class in org.springframework.batch.core.step
-
Policy that checks the current thread to see if it has been interrupted.
- ThreadStepInterruptionPolicy() - Constructor for class org.springframework.batch.core.step.ThreadStepInterruptionPolicy
- to(Flow) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Specify the next state as a complete flow.
- to(JobExecutionDecider) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Specify the next state as a decision.
- to(Step) - Method in class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
-
Specify the next step.
- TO_ATTR - Static variable in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Establishes a To attribute.
- toJobExecution(JobExecution, JobInstance) - Method in class org.springframework.batch.core.repository.persistence.converter.JobExecutionConverter
- toJobInstance(JobInstance) - Method in class org.springframework.batch.core.repository.persistence.converter.JobInstanceConverter
- toJobParameter(JobParameter) - Method in class org.springframework.batch.core.repository.persistence.converter.JobParameterConverter
- toJobParameters() - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Conversion method that takes the current state of this builder and returns it as a
JobParametersobject. - TopLevelFlowParser - Class in org.springframework.batch.core.configuration.xml
- TopLevelFlowParser() - Constructor for class org.springframework.batch.core.configuration.xml.TopLevelFlowParser
- TopLevelJobListenerParser - Class in org.springframework.batch.core.configuration.xml
-
Parse <job-listener/> elements in the batch namespace.
- TopLevelJobListenerParser() - Constructor for class org.springframework.batch.core.configuration.xml.TopLevelJobListenerParser
- TopLevelStepListenerParser - Class in org.springframework.batch.core.configuration.xml
-
Parse <step-listener/> elements in the batch namespace.
- TopLevelStepListenerParser() - Constructor for class org.springframework.batch.core.configuration.xml.TopLevelStepListenerParser
- TopLevelStepParser - Class in org.springframework.batch.core.configuration.xml
-
Parser for the <step/> top level element in the Batch namespace.
- TopLevelStepParser() - Constructor for class org.springframework.batch.core.configuration.xml.TopLevelStepParser
- toStepExecution(StepExecution, JobExecution) - Method in class org.springframework.batch.core.repository.persistence.converter.StepExecutionConverter
- toString() - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.
- toString() - Method in class org.springframework.batch.core.configuration.support.GroupAwareJob
- toString() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns a string representation of this record class.
- toString() - Method in class org.springframework.batch.core.Entity
-
Creates a string representation of the
Entity, including theid,version, and class name. - toString() - Method in class org.springframework.batch.core.ExitStatus
- toString() - Method in class org.springframework.batch.core.job.AbstractJob
- toString() - Method in class org.springframework.batch.core.job.flow.FlowExecution
- toString() - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
- toString() - Method in class org.springframework.batch.core.job.flow.support.state.AbstractState
- toString() - Method in class org.springframework.batch.core.job.flow.support.state.EndState
- toString() - Method in class org.springframework.batch.core.job.flow.support.StateTransition
- toString() - Method in class org.springframework.batch.core.job.JobExecution
- toString() - Method in class org.springframework.batch.core.job.JobInstance
-
Adds the job name to the string representation of the super class (
Entity). - toString() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.batch.core.repository.persistence.ExitStatus
-
Returns a string representation of this record class.
- toString() - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- toString() - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- toString() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns a string representation of this record class.
- toString() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- toString() - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.Delegates to the wrapped
CompletionPolicyif set, otherwise returns the value ofStepExecutionSimpleCompletionPolicy.setKeyName(String). - toString() - Method in class org.springframework.batch.core.scope.context.ChunkContext
- toString() - Method in class org.springframework.batch.core.scope.context.JobContext
- toString() - Method in class org.springframework.batch.core.scope.context.StepContext
- toString() - Method in class org.springframework.batch.core.step.AbstractStep
- toString() - Method in class org.springframework.batch.core.step.StepContribution
- toString() - Method in class org.springframework.batch.core.step.StepExecution
- transactionAttribute(TransactionAttribute) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Sets the transaction attributes for the tasklet execution.
- transactionAttribute(TransactionAttribute) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Sets the transaction attributes for the tasklet execution.
- transactionAttribute(TransactionAttribute) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- transactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
-
Set the transaction manager to use for the step.
- transactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
Sets the transaction manager to use for the chunk-oriented tasklet.
- transactionManagerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableBatchProcessing
-
Set the transaction manager to use in the job operator.
- transactionManagerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the
PlatformTransactionManagerto use in the job repository. - transactionManagerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
Set the
MongoTransactionManagerto use in the job repository. - transactionStatus - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkTransactionEvent
- transform(StepContribution, Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- transform(StepContribution, Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- TransitionBuilder(FlowBuilder, String) - Constructor for class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
- type() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns the value of the
typerecord component. - type() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
typerecord component. - type() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
typerecord component.
U
- unbind(JobFactory, Map) - Method in class org.springframework.batch.core.configuration.support.JobFactoryRegistrationListener
-
Deprecated.Take the provided
JobFactoryand unregister it with theJobRegistry. - UncheckedTransactionException - Exception Class in org.springframework.batch.core.step.tasklet
-
Convenience wrapper for a checked exception so that it can cause a rollback and be extracted afterwards.
- UncheckedTransactionException(Exception) - Constructor for exception class org.springframework.batch.core.step.tasklet.UncheckedTransactionException
- UnexpectedJobExecutionException - Exception Class in org.springframework.batch.core.job
-
Indicates to the framework that a critical error has occurred and processing should immediately stop.
- UnexpectedJobExecutionException(String) - Constructor for exception class org.springframework.batch.core.job.UnexpectedJobExecutionException
-
Constructs a new instance with a message.
- UnexpectedJobExecutionException(String, Throwable) - Constructor for exception class org.springframework.batch.core.job.UnexpectedJobExecutionException
-
Constructs a new instance with a message.
- UNKNOWN - Enum constant in enum class org.springframework.batch.core.BatchStatus
-
Status of a batch job that is in an uncertain state.
- UNKNOWN - Static variable in class org.springframework.batch.core.ExitStatus
-
Convenient constant value representing unknown state - assumed to not be continuable.
- UNKNOWN - Static variable in class org.springframework.batch.core.job.flow.FlowExecutionStatus
-
Special well-known status value.
- unregister(String) - Method in interface org.springframework.batch.core.configuration.JobRegistry
-
Unregisters a previously registered
Job. - unregister(String) - Method in class org.springframework.batch.core.configuration.support.MapJobRegistry
- unregisterStepsFromJob(String) - Method in interface org.springframework.batch.core.configuration.StepRegistry
-
Deprecated.Unregisters all the steps instances of the given job.
- unregisterStepsFromJob(String) - Method in class org.springframework.batch.core.configuration.support.MapStepRegistry
-
Deprecated.
- UnterminatedFlowBuilder(FlowBuilder) - Constructor for class org.springframework.batch.core.job.builder.FlowBuilder.UnterminatedFlowBuilder
- update(JobExecution) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Update the
JobExecution(but not itsExecutionContext). - update(JobExecution) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- update(JobExecution) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- update(StepExecution) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Update the
StepExecution(but not itsExecutionContext). - update(StepExecution) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- update(StepExecution) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- update(ExecutionContext) - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- update(RepeatContext) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.
- updateExecutionContext(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
-
Persist the updates of execution context associated with the given jobExecution.
- updateExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- updateExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- updateExecutionContext(JobExecution) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Persist the updated
ExecutionContextof the givenJobExecution. - updateExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- updateExecutionContext(JobExecution) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- updateExecutionContext(StepExecution) - Method in interface org.springframework.batch.core.repository.dao.ExecutionContextDao
-
Persist the updates of execution context associated with the given stepExecution.
- updateExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- updateExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- updateExecutionContext(StepExecution) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Persist the updated
ExecutionContexts of the givenStepExecution. - updateExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- updateExecutionContext(StepExecution) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
- updateJobExecution(JobExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao
-
Update given JobExecution using a SQL UPDATE statement.
- updateJobExecution(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.JobExecutionDao
-
Update and existing JobExecution.
- updateJobExecution(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao
- updateJobExecutionStatus(FlowExecutionStatus) - Method in interface org.springframework.batch.core.job.flow.FlowExecutor
-
Handle any status changes that might be needed in the
JobExecution. - updateJobExecutionStatus(FlowExecutionStatus) - Method in class org.springframework.batch.core.job.flow.JobFlowExecutor
- updateStepExecution(StepExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- updateStepExecution(StepExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
- updateStepExecution(StepExecution) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Update the given StepExecution
- upgradeStatus(BatchStatus) - Method in class org.springframework.batch.core.job.JobExecution
-
Upgrade the
statusfield if the provided value is greater than the existing one. - upgradeStatus(BatchStatus) - Method in class org.springframework.batch.core.step.StepExecution
-
Upgrade the status field if the provided value is greater than the existing one.
- upgradeTo(BatchStatus) - Method in enum class org.springframework.batch.core.BatchStatus
-
Method used to move status values through their logical progression, and override less severe failures with more severe ones.
V
- validate(JobParameters) - Method in class org.springframework.batch.core.job.parameters.CompositeJobParametersValidator
-
Validates the JobParameters according to the injected JobParameterValidators Validation stops and exception is thrown on first validation error
- validate(JobParameters) - Method in class org.springframework.batch.core.job.parameters.DefaultJobParametersValidator
-
Check the parameters meet the specification provided.
- validate(JobParameters) - Method in interface org.springframework.batch.core.job.parameters.JobParametersValidator
-
Check that the parameters meet whatever requirements are appropriate, and throw an exception if not.
- validateFaultTolerantSettings() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Validates that all components required to build a fault tolerant step are set.
- validateTransactionState() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableJdbcJobRepository
-
Set the value of the
validateTransactionStateparameter. - validateTransactionState() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
Set the value of the
validateTransactionStateparameter. - validator(JobParametersValidator) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Add a job parameters validator.
- value() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns the value of the
valuerecord component. - value() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
valuerecord component. - value() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
valuerecord component. - valueOf(String) - Static method in enum class org.springframework.batch.core.BatchStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.batch.core.listener.JobListenerMetaData
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.batch.core.listener.StepListenerMetaData
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.batch.core.BatchStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.batch.core.listener.JobListenerMetaData
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.batch.core.listener.StepListenerMetaData
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyUniquePattern(Element, List, Element, ParserContext) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Verifies that
transitionElementis not in the list of state transition patterns.
W
- write(StepContribution, Chunk, Chunk) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- write(StepContribution, Chunk, Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Simple implementation delegates to the
SimpleChunkProcessor.doWrite(Chunk)method and increments the write count in the contribution. - writeItems(Chunk) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- writer(ItemWriter) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.An item writer that writes a chunk of items.
- writer(ItemWriter) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
An item writer that writes a chunk of items.
Z
- ZonedDateTimeToStringConverter - Class in org.springframework.batch.core.converter
- ZonedDateTimeToStringConverter() - Constructor for class org.springframework.batch.core.converter.ZonedDateTimeToStringConverter
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
JobOperator.abandon(JobExecution). Scheduled for removal in 6.2 or later.