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
JobExecution
as 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.
- AbstractCursorItemReader<T> - Class in org.springframework.batch.infrastructure.item.database
-
Abstract base class for any simple item reader that opens a database cursor and continually retrieves the next row in the ResultSet.
- AbstractCursorItemReader(DataSource) - Constructor for class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Create a new
AbstractCursorItemReader
instance with the provided data source. - AbstractFileItemWriter<T> - Class in org.springframework.batch.infrastructure.item.support
-
Base class for item writers that write data to a file or stream.
- AbstractFileItemWriter() - Constructor for class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- AbstractFileItemWriter.OutputState - Class in org.springframework.batch.infrastructure.item.support
-
Encapsulates the runtime state of the writer.
- AbstractFlowParser - Class in org.springframework.batch.core.configuration.xml
- AbstractFlowParser() - Constructor for class org.springframework.batch.core.configuration.xml.AbstractFlowParser
- AbstractItemCountingItemStreamItemReader<T> - Class in org.springframework.batch.infrastructure.item.support
-
Abstract superclass for
ItemReader
s that supports restart by storing item count in theExecutionContext
(therefore requires item ordering to be preserved between runs). - AbstractItemCountingItemStreamItemReader() - Constructor for class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
- AbstractItemStreamItemReader<T> - Class in org.springframework.batch.infrastructure.item.support
-
Base class for
ItemReader
implementations. - AbstractItemStreamItemReader() - Constructor for class org.springframework.batch.infrastructure.item.support.AbstractItemStreamItemReader
- AbstractItemStreamItemWriter<T> - Class in org.springframework.batch.infrastructure.item.support
-
Base class for
ItemWriter
implementations. - AbstractItemStreamItemWriter() - Constructor for class org.springframework.batch.infrastructure.item.support.AbstractItemStreamItemWriter
- 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
Job
interface. - 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
FactoryBean
that automates the creation of aSimpleJobRepository
. - AbstractJobRepositoryFactoryBean() - Constructor for class org.springframework.batch.core.repository.support.AbstractJobRepositoryFactoryBean
- AbstractJpaQueryProvider - Class in org.springframework.batch.infrastructure.item.database.orm
-
Abstract JPA Query Provider to serve as a base class for all JPA
Query
providers. - AbstractJpaQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.orm.AbstractJpaQueryProvider
- AbstractLineTokenizer - Class in org.springframework.batch.infrastructure.item.file.transform
-
Abstract class handling common concerns of various
LineTokenizer
implementations such as dealing with names and actual construction ofFieldSet
- AbstractLineTokenizer() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
- AbstractListenerFactoryBean<T> - Class in org.springframework.batch.core.listener
-
FactoryBean
implementation 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
- AbstractMethodInvokingDelegator<T> - Class in org.springframework.batch.infrastructure.item.adapter
-
Superclass for delegating classes which dynamically call a custom method of an injected object.
- AbstractMethodInvokingDelegator() - Constructor for class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
- AbstractMethodInvokingDelegator.InvocationTargetThrowableWrapper - Exception in org.springframework.batch.infrastructure.item.adapter
- AbstractPaginatedDataItemReader<T> - Class in org.springframework.batch.infrastructure.item.data
-
A base class that handles basic reading logic based on the paginated semantics of Spring Data's paginated facilities.
- AbstractPaginatedDataItemReader() - Constructor for class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- AbstractPagingItemReader<T> - Class in org.springframework.batch.infrastructure.item.database
-
Abstract
ItemStreamReader
for to extend when reading database records in a paging fashion. - AbstractPagingItemReader() - Constructor for class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- AbstractPartitionHandler - Class in org.springframework.batch.core.partition.support
-
Base
PartitionHandler
implementation providing common base features. - AbstractPartitionHandler() - Constructor for class org.springframework.batch.core.partition.support.AbstractPartitionHandler
- AbstractSqlPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
Abstract SQL Paging Query Provider to serve as a base class for all provided SQL paging query providers.
- AbstractSqlPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- 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
Step
implementation 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
AbstractStep
with 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 extends 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(XMLEvent) - Method in class org.springframework.batch.infrastructure.item.xml.stax.NoStartEndDocumentStreamWriter
- add(XMLEvent) - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnclosedElementCollectingEventWriter
- add(XMLEvent) - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- add(XMLEventReader) - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- 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.
- add(W) - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Add the item to the chunk.
- addAll(List<W>) - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Add all items to the chunk.
- addApplicationContextFactory(ApplicationContextFactory) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.Add a single
ApplicationContextFactory
to the set that is used to load contexts and jobs. - addColumns(Range) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
-
Add a column range to the existing list
- addColumns(Range, int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
-
Insert a column range to the existing list
- addComment(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Add a string to the list of Strings that indicate commented lines.
- addDate(String, Date) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
Date
parameter for the given key. - addDate(String, Date, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
Date
parameter for the given key. - addDouble(String, Double) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
Double
parameter for the given key. - addDouble(String, Double, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
Double
parameter 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
Throwable
to failure exceptions. - addFragmentRootElements(String...) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Adds the list of fragments to be used as the root of each chunk to the configuration.
- addFragmentRootElements(List<String>) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Adds the list of fragments to be used as the root of each chunk to the configuration.
- addIncludedField(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
Add an index to the list of fields to be included from the file
- 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<T>) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add an identifying job parameter.
- addJobParameter(String, T, Class<T>, 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
JobParameter
for 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
LocalDate
parameter for the given key. - addLocalDate(String, LocalDate, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
LocalDate
parameter for the given key. - addLocalDateTime(String, LocalDateTime) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
LocalDateTime
parameter for the given key. - addLocalDateTime(String, LocalDateTime, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
LocalDateTime
parameter for the given key. - addLocalTime(String, LocalTime) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
LocalTime
parameter for the given key. - addLocalTime(String, LocalTime, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
LocalTime
parameter for the given key. - addLong(String, Long) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new identifying
Long
parameter for the given key. - addLong(String, Long, boolean) - Method in class org.springframework.batch.core.job.parameters.JobParametersBuilder
-
Add a new
Long
parameter 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<JobExecutionListener>) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper.CommonJobProperties
- addStepExecutionListeners(List<StepExecutionListener>) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper.CommonStepProperties
- addStepExecutions(List<StepExecution>) - 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(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
- after(RepeatContext, RepeatStatus) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatListener
-
Called by the framework after each item has been processed, unless the item processing results in an exception.
- 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<O>) - 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
Job
has 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
JobRepository
have 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
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.adapter.PropertyExtractingDelegatingItemWriter
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
Checks mandatory properties
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
Checks mandatory properties
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemWriter
-
Check mandatory properties - there must be a repository.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
-
Check mandatory properties.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Check mandatory properties - there must be a NamedParameterJdbcOperations and an SQL statement plus a parameter source.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
-
Check mandatory properties.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.orm.AbstractJpaQueryProvider
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNamedQueryProvider
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNativeQueryProvider
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemWriter
-
Assert that mandatory properties (lineAggregator) are set.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Check that precisely one of type or prototype bean name is specified.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.file.mapping.DefaultLineMapper
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.json.JsonFileItemWriter
-
Assert that mandatory properties (jsonObjectMarshaller) are set.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemProcessor
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.validator.BeanValidatingItemProcessor
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.validator.SpringValidator
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.validator.ValidatingItemProcessor
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
-
Ensure that all required dependencies for the ItemReader to run are provided after all properties have been set.
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
- afterPropertiesSet() - Method in class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
Apply the provided properties to create a delegate handler.
- afterPropertiesSet() - Method in class org.springframework.batch.integration.chunk.ChunkProcessorChunkRequestHandler
- afterPropertiesSet() - Method in class org.springframework.batch.integration.chunk.MessageSourcePollerInterceptor
-
Asserts that mandatory properties are set.
- afterPropertiesSet() - Method in class org.springframework.batch.integration.config.annotation.BatchIntegrationConfiguration
- afterPropertiesSet() - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
- 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(StepExecution) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- afterStep(StepExecution) - Method in class org.springframework.batch.integration.chunk.ChunkTaskExecutorItemWriter
- AfterStep - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called after a
Step
has completed. - afterTestMethod(TestContext) - Method in class org.springframework.batch.test.JobScopeTestExecutionListener
- afterTestMethod(TestContext) - Method in class org.springframework.batch.test.StepScopeTestExecutionListener
- afterWrite(Chunk<? extends S>) - 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<? extends S>) - Method in interface org.springframework.batch.core.listener.ItemWriteListener
-
Called after
ItemWriter.write(Chunk)
. - afterWrite(Chunk<? extends S>) - 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<FlowExecution>) - Method in interface org.springframework.batch.core.job.flow.support.state.FlowExecutionAggregator
- aggregate(Collection<FlowExecution>) - Method in class org.springframework.batch.core.job.flow.support.state.MaxValueFlowExecutionAggregator
-
Aggregate all of the
FlowExecutionStatus
es of theFlowExecution
s into one status. - aggregate(Collection<T>) - Method in class org.springframework.batch.infrastructure.item.file.transform.RecursiveCollectionLineAggregator
- aggregate(List<?>) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
- aggregate(StepExecution, Collection<StepExecution>) - Method in interface org.springframework.batch.core.partition.StepExecutionAggregator
-
Take the inputs and aggregate, putting the aggregates into the result.
- aggregate(StepExecution, Collection<StepExecution>) - Method in class org.springframework.batch.core.partition.support.DefaultStepExecutionAggregator
-
Aggregates the input executions into the result
StepExecution
. - aggregate(StepExecution, Collection<StepExecution>) - Method in class org.springframework.batch.core.partition.support.RemoteStepExecutionAggregator
-
Aggregates the input executions into the result
StepExecution
delegating to the delegate aggregator once the input has been refreshed from theJobRepository
. - aggregate(T) - Method in class org.springframework.batch.infrastructure.item.file.transform.ExtractorLineAggregator
-
Extract fields from the given item using the
FieldExtractor
and then aggregate them. - aggregate(T) - Method in interface org.springframework.batch.infrastructure.item.file.transform.LineAggregator
-
Create a string from the value provided.
- aggregate(T) - Method in class org.springframework.batch.infrastructure.item.file.transform.PassThroughLineAggregator
-
Simply convert to a String with toString().
- 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
PartitionStep
itself. - aggregator(StepExecutionAggregator) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- allowStartIfComplete(boolean) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- allowStartIfComplete(boolean) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- allowStartIfComplete(boolean) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- allowStartIfComplete(boolean) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- AlwaysSkipItemSkipPolicy - Class in org.springframework.batch.core.step.skip
-
Implementation of the
SkipPolicy
interface that will always return that an item should be skipped. - AlwaysSkipItemSkipPolicy() - Constructor for class org.springframework.batch.core.step.skip.AlwaysSkipItemSkipPolicy
- AmqpItemReader<T> - Class in org.springframework.batch.infrastructure.item.amqp
-
AMQP
ItemReader
implementation using anAmqpTemplate
to receive and/or convert messages. - AmqpItemReader(AmqpTemplate) - Constructor for class org.springframework.batch.infrastructure.item.amqp.AmqpItemReader
-
Initialize the AmqpItemReader.
- AmqpItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.amqp.builder
-
A builder implementation for the
AmqpItemReader
- AmqpItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.amqp.builder.AmqpItemReaderBuilder
- AmqpItemWriter<T> - Class in org.springframework.batch.infrastructure.item.amqp
-
AMQP
ItemWriter
implementation using anAmqpTemplate
to send messages. - AmqpItemWriter(AmqpTemplate) - Constructor for class org.springframework.batch.infrastructure.item.amqp.AmqpItemWriter
- AmqpItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.amqp.builder
-
A builder implementation for the
AmqpItemWriter
- AmqpItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.amqp.builder.AmqpItemWriterBuilder
- amqpTemplate(AmqpTemplate) - Method in class org.springframework.batch.infrastructure.item.amqp.builder.AmqpItemReaderBuilder
-
Establish the amqpTemplate to be used by the AmqpItemReader.
- amqpTemplate(AmqpTemplate) - Method in class org.springframework.batch.infrastructure.item.amqp.builder.AmqpItemWriterBuilder
-
Establish the amqpTemplate to be used by the AmqpItemWriter.
- and(boolean) - Method in enum class org.springframework.batch.infrastructure.repeat.RepeatStatus
- and(ExitStatus) - Method in class org.springframework.batch.core.ExitStatus
-
Create a new
ExitStatus
with a logical combination of the exit code and a concatenation of the descriptions. - AnnotationMethodResolver - Class in org.springframework.batch.infrastructure.support
-
MethodResolver
implementation that finds a single Method on the given Class that contains the specified annotation type. - AnnotationMethodResolver(Class<? extends Annotation>) - Constructor for class org.springframework.batch.infrastructure.support.AnnotationMethodResolver
-
Create a
MethodResolver
for the specified Method-level annotation type. - append - Variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- append(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
If set to true and the file exists, the output will be appended to the existing file.
- append(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
If set to true and the file exists, the output will be appended to the existing file.
- 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<T, S>) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.
- applyConfiguration(SimpleStepBuilder<T, S>) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- applyStatementSettings(PreparedStatement) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Prepare the given JDBC Statement (or PreparedStatement or CallableStatement), applying statement settings such as fetch size, max rows, and query timeout.
- arguments(Object...) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Arguments to be passed to the data providing method.
- arguments(List<?>) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Arguments to be passed to the data providing method.
- ArrayFieldSetMapper - Class in org.springframework.batch.infrastructure.item.file.mapping
-
A basic array mapper, returning the values backing a fieldset.
- ArrayFieldSetMapper() - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.ArrayFieldSetMapper
- ASCENDING - Enum constant in enum class org.springframework.batch.infrastructure.item.database.Order
- assertUpdates - Variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- assertUpdates(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
If set to true, confirms that every insert results in the update of at least one row in the database.
- AsynchronousFailureException - Exception in org.springframework.batch.integration.chunk
-
Exception indicating that a failure or early completion condition was detected in a remote worker.
- AsynchronousFailureException(String) - Constructor for exception org.springframework.batch.integration.chunk.AsynchronousFailureException
-
Create a new
AsynchronousFailureException
based on a message. - AsynchronousFailureException(String, Throwable) - Constructor for exception org.springframework.batch.integration.chunk.AsynchronousFailureException
-
Create a new
AsynchronousFailureException
based on a message and another exception. - AsyncItemProcessor<I,
O> - Class in org.springframework.batch.integration.async -
An
ItemProcessor
that delegates to a nested processor and in the background. - AsyncItemProcessor(ItemProcessor<I, O>) - Constructor for class org.springframework.batch.integration.async.AsyncItemProcessor
-
Create a new
AsyncItemProcessor
with the delegateItemProcessor
. - AsyncItemWriter<T> - Class in org.springframework.batch.integration.async
- AsyncItemWriter(ItemWriter<T>) - Constructor for class org.springframework.batch.integration.async.AsyncItemWriter
-
Create a new instance of
AsyncItemWriter
with the provided delegate. - attributeNames() - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- 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.
- AvroItemReader<T> - Class in org.springframework.batch.infrastructure.item.avro
-
An
ItemReader
that deserializes data from aResource
containing serialized Avro objects. - AvroItemReader(Resource, Class<T>) - Constructor for class org.springframework.batch.infrastructure.item.avro.AvroItemReader
- AvroItemReader(Resource, Resource) - Constructor for class org.springframework.batch.infrastructure.item.avro.AvroItemReader
- AvroItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.avro.builder
-
A builder implementation for the
AvroItemReader
. - AvroItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
- AvroItemWriter<T> - Class in org.springframework.batch.infrastructure.item.avro
-
An
ItemWriter
that serializes data to anWritableResource
using Avro. - AvroItemWriter(WritableResource, Class<T>) - Constructor for class org.springframework.batch.infrastructure.item.avro.AvroItemWriter
-
This constructor will create an ItemWriter that does not embedded Avro schema.
- AvroItemWriter(WritableResource, Resource, Class<T>) - Constructor for class org.springframework.batch.infrastructure.item.avro.AvroItemWriter
- AvroItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.avro.builder
-
A builder implementation for the
AvroItemWriter
. - AvroItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.avro.builder.AvroItemWriterBuilder
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).
- backOffPolicy(BackOffPolicy) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- 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 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 org.springframework.batch.core.configuration.BatchConfigurationException
-
Create an exception with the given message.
- BatchConfigurationException(String, Throwable) - Constructor for exception org.springframework.batch.core.configuration.BatchConfigurationException
-
Create an exception with the given message and
Throwable
. - BatchConfigurationException(Throwable) - Constructor for exception org.springframework.batch.core.configuration.BatchConfigurationException
-
Create an exception with the given
Throwable
. - BatchIntegrationConfiguration<I,
O> - Class in org.springframework.batch.integration.config.annotation -
Base configuration class for Spring Batch Integration factory beans.
- BatchIntegrationConfiguration(JobRepository, PlatformTransactionManager) - Constructor for class org.springframework.batch.integration.config.annotation.BatchIntegrationConfiguration
- BatchIntegrationNamespaceHandler - Class in org.springframework.batch.integration.config.xml
-
The namespace handler for the Spring Batch Integration namespace.
- BatchIntegrationNamespaceHandler() - Constructor for class org.springframework.batch.integration.config.xml.BatchIntegrationNamespaceHandler
- 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.
- batchSize(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
The size of batches to use when iterating over results.
- BatchStatus - Enum Class in org.springframework.batch.core
-
Enumeration representing the status of an execution.
- BatchTestContextBeanPostProcessor - Class in org.springframework.batch.test.context
-
BeanPostProcessor
implementation that injects a job bean intoJobOperatorTestUtils
if there is a unique job bean. - BatchTestContextBeanPostProcessor() - Constructor for class org.springframework.batch.test.context.BatchTestContextBeanPostProcessor
- BatchTestContextCustomizer - Class in org.springframework.batch.test.context
-
ContextCustomizer
implementation that adds batch test utility classes (JobOperatorTestUtils
andJobRepositoryTestUtils
) as beans in the test context. - BatchTestContextCustomizer() - Constructor for class org.springframework.batch.test.context.BatchTestContextCustomizer
- BatchTestContextCustomizerFactory - Class in org.springframework.batch.test.context
-
Factory for
BatchTestContextCustomizer
. - BatchTestContextCustomizerFactory() - Constructor for class org.springframework.batch.test.context.BatchTestContextCustomizerFactory
- BeanDefinitionUtils - Class in org.springframework.batch.core.configuration.xml
- beanFactory(BeanFactory) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configures the
BeanFactory
used to create the beans that are returned as items. - beanFactory(BeanFactory) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
Set the bean factory.
- beanFactory(BeanFactory) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
-
Set the bean factory.
- BeanFactoryStepLocator - Class in org.springframework.batch.integration.partition
-
A
StepLocator
implementation that just looks in its enclosing bean factory forStep
s by name. - BeanFactoryStepLocator() - Constructor for class org.springframework.batch.integration.partition.BeanFactoryStepLocator
- beanMapped() - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
Creates a
BeanPropertyItemSqlParameterSourceProvider
to be used as yourItemSqlParameterSourceProvider
. - beanMapperStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
If set to true, mapping will fail if the
FieldSet
contains fields that cannot be mapped to the bean. - BeanPropertyItemSqlParameterSourceProvider<T> - Class in org.springframework.batch.infrastructure.item.database
-
A convenient implementation for providing BeanPropertySqlParameterSource when the item has JavaBean properties that correspond to names used for parameters in the SQL statement.
- BeanPropertyItemSqlParameterSourceProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.BeanPropertyItemSqlParameterSourceProvider
- beanRowMapper(Class<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Creates a
BeanPropertyRowMapper
to be used as yourRowMapper
. - beanRowMapper(Class<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
Creates a
BeanPropertyRowMapper
to be used as yourRowMapper
. - BeanValidatingItemProcessor<T> - Class in org.springframework.batch.infrastructure.item.validator
-
A
ValidatingItemProcessor
that uses the Bean Validation API (JSR-303) to validate items. - BeanValidatingItemProcessor() - Constructor for class org.springframework.batch.infrastructure.item.validator.BeanValidatingItemProcessor
-
Create a new instance of
BeanValidatingItemProcessor
with the default configuration. - BeanValidatingItemProcessor(LocalValidatorFactoryBean) - Constructor for class org.springframework.batch.infrastructure.item.validator.BeanValidatingItemProcessor
-
Create a new instance of
BeanValidatingItemProcessor
. - BeanWrapperFieldExtractor<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
This is a field extractor for a java bean.
- BeanWrapperFieldExtractor(String...) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.BeanWrapperFieldExtractor
-
Create a new
BeanWrapperFieldExtractor
with the provided field names. - BeanWrapperFieldSetMapper<T> - Class in org.springframework.batch.infrastructure.item.file.mapping
-
FieldSetMapper
implementation based on bean property paths. - BeanWrapperFieldSetMapper() - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
- before(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
- before(RepeatContext) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatListener
-
Called by the framework before each batch item.
- 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<I>) - Method in interface org.springframework.batch.core.listener.ChunkListener
-
Callback before the chunk 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
Job
is executed, which comes after aJobExecution
is created and persisted but before the firstStep
is 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
StepExecution
from the current scope. - beforeStep(StepExecution) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.Set up a
SimpleCompletionPolicy
with a commit interval taken from theJobParameters
. - beforeStep(StepExecution) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Get a reference to
StepExecution
for interrupt checks during system command execution. - beforeStep(StepExecution) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- beforeStep(StepExecution) - Method in class org.springframework.batch.integration.chunk.ChunkTaskExecutorItemWriter
- BeforeStep - Annotation Interface in org.springframework.batch.core.annotation
-
Marks a method to be called before a
Step
is executed, which comes after aStepExecution
is created and persisted but before the first item is read. - beforeTestMethod(TestContext) - Method in class org.springframework.batch.test.JobScopeTestExecutionListener
- beforeTestMethod(TestContext) - Method in class org.springframework.batch.test.StepScopeTestExecutionListener
- beforeWrite(Chunk<? extends S>) - Method in class org.springframework.batch.core.listener.CompositeItemWriteListener
-
Call the registered listeners in order, respecting and prioritising those that implement
Ordered
. - beforeWrite(Chunk<? extends S>) - Method in interface org.springframework.batch.core.listener.ItemWriteListener
-
Called before
ItemWriter.write(Chunk)
- beforeWrite(Chunk<? extends S>) - 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
. - begin(T) - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.Make a copy of the target that can be used inside a transaction to isolate changes from the original.
- bind(JobFactory, Map<String, ?>) - Method in class org.springframework.batch.core.configuration.support.JobFactoryRegistrationListener
-
Deprecated.Take the
JobFactory
provided and register it with theJobRegistry
. - BlockingQueueItemReader<T> - Class in org.springframework.batch.infrastructure.item.queue
-
This is an
ItemReader
that reads items from aBlockingQueue
. - BlockingQueueItemReader(BlockingQueue<T>) - Constructor for class org.springframework.batch.infrastructure.item.queue.BlockingQueueItemReader
-
Create a new
BlockingQueueItemReader
. - BlockingQueueItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.queue.builder
-
Builder for
BlockingQueueItemReader
. - BlockingQueueItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.queue.builder.BlockingQueueItemReaderBuilder
- BlockingQueueItemWriter<T> - Class in org.springframework.batch.infrastructure.item.queue
-
This is an
ItemWriter
that writes items to aBlockingQueue
. - BlockingQueueItemWriter(BlockingQueue<T>) - Constructor for class org.springframework.batch.infrastructure.item.queue.BlockingQueueItemWriter
-
Create a new
BlockingQueueItemWriter
. - BlockingQueueItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.queue.builder
-
Builder for a
BlockingQueueItemWriter
. - BlockingQueueItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.queue.builder.BlockingQueueItemWriterBuilder
- bufferedReaderFactory(BufferedReaderFactory) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configure a custom
BufferedReaderFactory
for the reader. - BufferedReaderFactory - Interface in org.springframework.batch.infrastructure.item.file
-
A factory strategy for custom extensions of
BufferedReader
allowing customisation of the standard behaviour of thejava.io
variety. - 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.
- build() - Method in class org.springframework.batch.infrastructure.item.amqp.builder.AmqpItemReaderBuilder
-
Validates and builds a
AmqpItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.amqp.builder.AmqpItemWriterBuilder
-
Validates and builds a
AmqpItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Build an instance of
AvroItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemWriterBuilder
-
Build an instance of
AvroItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
- build() - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoItemWriterBuilder
-
Validates and builds a
MongoItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- build() - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Builds the
RepositoryItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemWriterBuilder
-
Builds the
RepositoryItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
Validates configuration and builds the
JdbcBatchItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Validates configuration and builds a new reader instance.
- build() - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
Provides a completely built instance of the
JdbcPagingItemReader
- build() - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
Returns a fully constructed
JpaCursorItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaItemWriterBuilder
-
Returns a fully built
JpaItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
Returns a fully constructed
JpaPagingItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Validates configuration and builds a new reader instance
- build() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Builds the
FlatFileItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
Returns a
DelimitedLineTokenizer
- build() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
-
Returns a
FixedLengthTokenizer
- build() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
Validates and builds a
FlatFileItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.DelimitedBuilder
- build() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
- build() - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
-
Builds the
MultiResourceItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
-
Builds the
MultiResourceItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.jms.builder.JmsItemReaderBuilder
-
Returns a fully constructed
JmsItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.jms.builder.JmsItemWriterBuilder
-
Returns a fully constructed
JmsItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
Validate the configuration and build a new
JsonFileItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
Validate the configuration and build a new
JsonItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
- build() - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemWriterBuilder
-
Validates and builds a
KafkaItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
Returns a fully constructed
LdifReader
. - build() - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
Returns a fully constructed
MappingLdifReader
. - build() - Method in class org.springframework.batch.infrastructure.item.mail.builder.SimpleMailMessageItemWriterBuilder
-
Returns a fully constructed
SimpleMailMessageItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.queue.builder.BlockingQueueItemReaderBuilder
-
Create a configured
BlockingQueueItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.queue.builder.BlockingQueueItemWriterBuilder
-
Create a configured
BlockingQueueItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.redis.builder.RedisItemReaderBuilder
-
Build a new
RedisItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.redis.builder.RedisItemWriterBuilder
-
Validates and builds a
RedisItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.ClassifierCompositeItemProcessorBuilder
-
Returns a fully constructed
ClassifierCompositeItemProcessor
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.ClassifierCompositeItemWriterBuilder
-
Returns a fully constructed
ClassifierCompositeItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.CompositeItemProcessorBuilder
-
Returns a fully constructed
CompositeItemProcessor
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.CompositeItemWriterBuilder
-
Returns a fully constructed
CompositeItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.ScriptItemProcessorBuilder
-
Returns a fully constructed
ScriptItemProcessor
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.SingleItemPeekableItemReaderBuilder
-
Returns a fully constructed
SingleItemPeekableItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemReaderBuilder
-
Returns a new
SynchronizedItemReader
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemStreamReaderBuilder
-
Returns a fully constructed
SynchronizedItemStreamReader
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemStreamWriterBuilder
-
Returns a fully constructed
SynchronizedItemStreamWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemWriterBuilder
-
Returns a new
SynchronizedItemWriter
. - build() - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Validates the configuration and builds a new
StaxEventItemReader
- build() - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Returns a configured
StaxEventItemWriter
- build() - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
Build a manager
TaskletStep
. - build() - Method in class org.springframework.batch.integration.chunk.RemoteChunkingWorkerBuilder
-
Create an
IntegrationFlow
with aChunkProcessorChunkRequestHandler
configured as a service activator listening to the input channel and replying on the output channel. - build() - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- buildSortClause(Map<String, Order>) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generates ORDER BY attributes based on the sort keys.
- buildSortClause(AbstractSqlPagingQueryProvider) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generates ORDER BY attributes based on the sort keys.
- buildSortConditions(AbstractSqlPagingQueryProvider, StringBuilder) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Appends the where conditions required to query for the subsequent pages.
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<RepeatStatus>) - Constructor for class org.springframework.batch.core.step.tasklet.CallableTaskletAdapter
-
Create a new
CallableTaskletAdapter
instance. - canContinue(RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Check return value from batch operation.
- 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) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- 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(int, PlatformTransactionManager) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- chunk(CompletionPolicy) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Sets a completion policy for the chunk processing.
- chunk(CompletionPolicy) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- 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. - chunk(CompletionPolicy, PlatformTransactionManager) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- Chunk<W> - Class in org.springframework.batch.infrastructure.item
-
Encapsulation of a list of items to be processed and possibly a list of failed items to be skipped.
- Chunk(List<? extends W>, List<SkipWrapper<W>>) - Constructor for class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- Chunk(List<? extends W>) - Constructor for class org.springframework.batch.infrastructure.item.Chunk
- Chunk(W...) - Constructor for class org.springframework.batch.infrastructure.item.Chunk
- Chunk.ChunkIterator - Class in org.springframework.batch.infrastructure.item
-
Special iterator for a chunk providing the
Chunk.ChunkIterator.remove(Throwable)
method for dynamically removing an item and adding it to the skips. - 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
- ChunkIterator(List<W>) - Constructor for class org.springframework.batch.infrastructure.item.Chunk.ChunkIterator
- 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
- ChunkMessageChannelItemWriter<T> - Class in org.springframework.batch.integration.chunk
- ChunkMessageChannelItemWriter() - Constructor for class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- ChunkMessageChannelItemWriter.LocalState - Class in org.springframework.batch.integration.chunk
- 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 size
orcompletion policy
you can provide a complete repeat operations instance that handles the iteration over the item reader. - chunkOperations(RepeatOperations) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- ChunkOrientedStep<I,
O> - Class in org.springframework.batch.core.step.item -
Step implementation for the chunk-oriented processing model.
- ChunkOrientedStep(String, int, ItemReader<I>, ItemWriter<O>, 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
ChunkOrientedStepBuilder
with 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
ChunkOrientedStepBuilder
with 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
ChunkOrientedStep
instead. Scheduled for removal in 7.0. - ChunkOrientedTasklet(ChunkProvider<I>, ChunkProcessor<I>) - 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
Chunk
s. - ChunkProcessorChunkRequestHandler<S> - Class in org.springframework.batch.integration.chunk
-
A
ChunkRequestHandler
based on aChunkProcessor
. - ChunkProcessorChunkRequestHandler() - Constructor for class org.springframework.batch.integration.chunk.ChunkProcessorChunkRequestHandler
- 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.
- ChunkRequest<T> - Class in org.springframework.batch.integration.chunk
-
Encapsulation of a chunk of items to be processed remotely as part of a step execution.
- ChunkRequest(int, Chunk<? extends T>, long, StepContribution) - Constructor for class org.springframework.batch.integration.chunk.ChunkRequest
- ChunkRequestHandler<T> - Interface in org.springframework.batch.integration.chunk
-
Interface for a remote worker in the Remote Chunking pattern.
- ChunkResponse - Class in org.springframework.batch.integration.chunk
-
Encapsulates a response to processing a chunk of items, summarising the result as a
StepContribution
. - ChunkResponse(boolean, int, Long, StepContribution) - Constructor for class org.springframework.batch.integration.chunk.ChunkResponse
- ChunkResponse(boolean, int, Long, StepContribution, String) - Constructor for class org.springframework.batch.integration.chunk.ChunkResponse
- ChunkResponse(boolean, int, Long, StepContribution, String, boolean) - Constructor for class org.springframework.batch.integration.chunk.ChunkResponse
- ChunkResponse(int, Long, StepContribution) - Constructor for class org.springframework.batch.integration.chunk.ChunkResponse
- ChunkResponse(ChunkResponse, boolean) - Constructor for class org.springframework.batch.integration.chunk.ChunkResponse
- 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.
- ChunkTaskExecutorItemWriter<T> - Class in org.springframework.batch.integration.chunk
-
Similar to
ChunkMessageChannelItemWriter
, this item writer submits chunk requests to local workers from aTaskExecutor
instead of sending them over a message channel to remote workers. - ChunkTaskExecutorItemWriter(ChunkProcessor<T>, TaskExecutor) - Constructor for class org.springframework.batch.integration.chunk.ChunkTaskExecutorItemWriter
-
Create a new
ChunkTaskExecutorItemWriter
. - 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
- classifier(Classifier<? super I, ItemProcessor<?, ? extends O>>) - Method in class org.springframework.batch.infrastructure.item.support.builder.ClassifierCompositeItemProcessorBuilder
-
Establishes the classifier that will determine which
ItemProcessor
to use. - classifier(Classifier<T, ItemWriter<? super T>>) - Method in class org.springframework.batch.infrastructure.item.support.builder.ClassifierCompositeItemWriterBuilder
-
Establish the classifier to be used for the selection of which
ItemWriter
to use. - ClassifierCompositeItemProcessor<I,
O> - Class in org.springframework.batch.infrastructure.item.support -
Calls one of a collection of ItemProcessors, based on a router pattern implemented through the provided
Classifier
. - ClassifierCompositeItemProcessor() - Constructor for class org.springframework.batch.infrastructure.item.support.ClassifierCompositeItemProcessor
- ClassifierCompositeItemProcessorBuilder<I,
O> - Class in org.springframework.batch.infrastructure.item.support.builder -
Creates a fully qualified
ClassifierCompositeItemProcessor
. - ClassifierCompositeItemProcessorBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.ClassifierCompositeItemProcessorBuilder
- ClassifierCompositeItemWriter<T> - Class in org.springframework.batch.infrastructure.item.support
-
Calls one of a collection of ItemWriters for each item, based on a router pattern implemented through the provided
Classifier
. - ClassifierCompositeItemWriter() - Constructor for class org.springframework.batch.infrastructure.item.support.ClassifierCompositeItemWriter
- ClassifierCompositeItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.support.builder
-
Creates a fully qualified ClassifierCompositeItemWriter.
- ClassifierCompositeItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.ClassifierCompositeItemWriterBuilder
- 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.
- cleanupOnClose(Connection) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Clean up resources.
- cleanupOnClose(Connection) - Method in class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
-
Close the cursor and database connection.
- cleanupOnClose(Connection) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Close the cursor and database connection.
- 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.
- clear() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Clear the items down to signal that we are done.
- clear() - Static method in class org.springframework.batch.infrastructure.repeat.support.RepeatSynchronizationManager
-
Clear the current context at the end of a batch - should only be used by
RepeatOperations
implementations. - clearDirtyFlag() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Clears the dirty flag.
- clearPersistenceContext(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaItemWriterBuilder
-
If set to false, the
EntityManager
will not be cleared at the end of the chunk. defaults to true - clearSkips() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- 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 step 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() - Method in class org.springframework.batch.infrastructure.item.avro.AvroItemWriter
- close() - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
-
Close the
MultiResourceItemReader.setDelegate(ResourceAwareItemReaderItemStream)
reader and reset instance variable values. - close() - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
- close() - Method in interface org.springframework.batch.infrastructure.item.ItemStream
-
If any resources are needed for the stream to operate they need to be destroyed here.
- close() - Method in class org.springframework.batch.infrastructure.item.json.GsonJsonObjectReader
- close() - Method in class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectReader
- close() - Method in interface org.springframework.batch.infrastructure.item.json.JsonObjectReader
-
Close the input resource.
- close() - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
- close() - Method in class org.springframework.batch.infrastructure.item.redis.RedisItemReader
- close() - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- close() - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
-
Close the open resource and reset counters.
- close() - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
- close() - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemReader
-
Close all delegates.
- close() - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Broadcast the call to close.
- close() - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
-
Close all delegates.
- close() - Method in class org.springframework.batch.infrastructure.item.support.SingleItemPeekableItemReader
-
If the delegate is an
ItemStream
, just pass the call on, otherwise reset the peek cache. - close() - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamReader
- close() - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamWriter
- close() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- close() - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- close() - Method in class org.springframework.batch.infrastructure.item.xml.stax.NoStartEndDocumentStreamWriter
- close() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Flush and close the output source.
- close() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- close() - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
Allow resources to be cleared, especially in destruction callbacks.
- close() - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
- close() - Method in class org.springframework.batch.integration.async.AsyncItemWriter
- close() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- 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(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
- close(RepeatContext) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatListener
-
Called once at the end of a complete batch, after normal or abnormal completion (i.e. even after an exception).
- close(RetryContext, RetryCallback<T, E>, 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.
- collection - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- collection - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- collection(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Establish an optional collection that can be queried.
- collection(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoItemWriterBuilder
-
Set the name of the Mongo collection to be written to.
- collection(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Establish an optional collection that can be queried.
- ColumnMapItemPreparedStatementSetter - Class in org.springframework.batch.infrastructure.item.database.support
-
Implementation of the
ItemPreparedStatementSetter
interface that assumes all keys are contained within aMap
with the column name as the key. - ColumnMapItemPreparedStatementSetter() - Constructor for class org.springframework.batch.infrastructure.item.database.support.ColumnMapItemPreparedStatementSetter
- columnMapped() - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
Creates a
ColumnMapItemPreparedStatementSetter
to be used as yourItemPreparedStatementSetter
. - columns(Range...) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
-
The column ranges for each field
- 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
CommandLineJobOperator
instance. - 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.
- comments - Variable in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- comments(String...) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Set an array of Strings that indicate lines that are comments (and therefore skipped by the reader).
- commit(T, T) - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.Take the working copy state and commit it back to the original target.
- 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
- comparator(Comparator<Resource>) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
-
Used to order the injected resources, by default compares
Resource.getFilename()
values. - compare(StateTransition, StateTransition) - Method in class org.springframework.batch.core.job.flow.support.DefaultStateTransitionComparator
- compare(Resource, Resource) - Method in class org.springframework.batch.infrastructure.support.LastModifiedResourceComparator
-
Compare the two resources by last modified time, so that a sorted list of resources will have oldest first.
- 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
FlowExecution
instances by comparing their statuses. - compareTo(FlowExecutionStatus) - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
-
Create an ordering on
FlowExecutionStatus
instances by comparing their statuses. - completableFutures - Variable in class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
- 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.
- CompletionPolicy - Interface in org.springframework.batch.infrastructure.repeat
-
Interface for batch completion policies, to enable batch operations to strategise normal completion conditions.
- CompletionPolicySupport - Class in org.springframework.batch.infrastructure.repeat.policy
-
Very simple base class for
CompletionPolicy
implementations. - CompletionPolicySupport() - Constructor for class org.springframework.batch.infrastructure.repeat.policy.CompletionPolicySupport
- CompositeBatchContext(RepeatContext, List<RepeatContext>) - Constructor for class org.springframework.batch.infrastructure.repeat.policy.CompositeCompletionPolicy.CompositeBatchContext
- CompositeChunkListener<I,
O> - Class in org.springframework.batch.core.listener - CompositeChunkListener() - Constructor for class org.springframework.batch.core.listener.CompositeChunkListener
-
Default constructor
- CompositeChunkListener(List<? extends ChunkListener>) - Constructor for class org.springframework.batch.core.listener.CompositeChunkListener
-
Convenience constructor for setting the
ChunkListener
s. - CompositeChunkListener(ChunkListener...) - Constructor for class org.springframework.batch.core.listener.CompositeChunkListener
-
Convenience constructor for setting the
ChunkListener
s. - CompositeCompletionPolicy - Class in org.springframework.batch.infrastructure.repeat.policy
-
Composite policy that loops through a list of delegate policies and answers calls by a consensus.
- CompositeCompletionPolicy() - Constructor for class org.springframework.batch.infrastructure.repeat.policy.CompositeCompletionPolicy
- CompositeCompletionPolicy.CompositeBatchContext - Class in org.springframework.batch.infrastructure.repeat.policy
-
Composite context that knows about the policies and contexts is was created with.
- CompositeExceptionHandler - Class in org.springframework.batch.infrastructure.repeat.exception
-
Composite
ExceptionHandler
that loops though a list of delegates. - CompositeExceptionHandler() - Constructor for class org.springframework.batch.infrastructure.repeat.exception.CompositeExceptionHandler
- CompositeItemProcessListener<T,
S> - Class in org.springframework.batch.core.listener - CompositeItemProcessListener() - Constructor for class org.springframework.batch.core.listener.CompositeItemProcessListener
- CompositeItemProcessor<I,
O> - Class in org.springframework.batch.infrastructure.item.support -
Composite
ItemProcessor
that passes the item through a sequence of injectedItemTransformer
s (return value of previous transformation is the entry value of the next).
Note the user is responsible for injecting a chain ofItemProcessor
s that conforms to declared input and output types. - CompositeItemProcessor(List<? extends ItemProcessor<?, ?>>) - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemProcessor
-
Convenience constructor for setting the delegates.
- CompositeItemProcessor(ItemProcessor<?, ?>...) - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemProcessor
-
Convenience constructor for setting the delegates.
- CompositeItemProcessorBuilder<I,
O> - Class in org.springframework.batch.infrastructure.item.support.builder -
Creates a fully qualified
CompositeItemProcessorBuilder
. - CompositeItemProcessorBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.CompositeItemProcessorBuilder
- CompositeItemReader<T> - Class in org.springframework.batch.infrastructure.item.support
-
Composite reader that delegates reading to a list of
ItemStreamReader
s. - CompositeItemReader(List<ItemStreamReader<? extends T>>) - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemReader
-
Create a new
CompositeItemReader
. - CompositeItemReadListener<T> - Class in org.springframework.batch.core.listener
- CompositeItemReadListener() - Constructor for class org.springframework.batch.core.listener.CompositeItemReadListener
- CompositeItemStream - Class in org.springframework.batch.infrastructure.item.support
-
Simple
ItemStream
that delegates to a list of other streams. - CompositeItemStream() - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Default constructor
- CompositeItemStream(List<ItemStream>) - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Convenience constructor for setting the
ItemStream
s. - CompositeItemStream(ItemStream...) - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Convenience constructor for setting the
ItemStream
s. - CompositeItemWriteListener<S> - Class in org.springframework.batch.core.listener
- CompositeItemWriteListener() - Constructor for class org.springframework.batch.core.listener.CompositeItemWriteListener
- CompositeItemWriter<T> - Class in org.springframework.batch.infrastructure.item.support
-
Calls a collection of
ItemWriter
s in fixed-order sequence.
The implementation is thread-safe if all delegates are thread-safe. - CompositeItemWriter(List<ItemWriter<? super T>>) - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
-
Convenience constructor for setting the delegates.
- CompositeItemWriter(ItemWriter<? super T>...) - Constructor for class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
-
Convenience constructor for setting the delegates.
- CompositeItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.support.builder
-
Creates a fully qualified CompositeItemWriter.
- CompositeItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.CompositeItemWriterBuilder
- 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
JobParametersValidator
that passes the job parameters through a sequence of injectedJobParametersValidator
s - CompositeJobParametersValidator() - Constructor for class org.springframework.batch.core.job.parameters.CompositeJobParametersValidator
- CompositeRepeatListener - Class in org.springframework.batch.infrastructure.repeat.listener
-
Allows a user to register one or more RepeatListeners to be notified on batch events.
- CompositeRepeatListener() - Constructor for class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
-
Default constructor
- CompositeRepeatListener(List<RepeatListener>) - Constructor for class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
-
Convenience constructor for setting the
RepeatListener
s. - CompositeRepeatListener(RepeatListener...) - Constructor for class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
-
Convenience constructor for setting the
RepeatListener
s. - 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
-
Convenience method for subclasses to determine if the step is concurrent.
- ConfigurableSystemProcessExitCodeMapper - Class in org.springframework.batch.core.step.tasklet
-
Maps exit codes to
ExitStatus
according to injected map. - ConfigurableSystemProcessExitCodeMapper() - Constructor for class org.springframework.batch.core.step.tasklet.ConfigurableSystemProcessExitCodeMapper
- connectionAutoCommit(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Set whether "autoCommit" should be overridden for the connection used by the cursor.
- ConsumerItemWriter<T> - Class in org.springframework.batch.infrastructure.item.function
-
Adapter for a
Consumer
to anItemWriter
. - ConsumerItemWriter(Consumer<T>) - Constructor for class org.springframework.batch.infrastructure.item.function.ConsumerItemWriter
-
Create a new
ConsumerItemWriter
. - consumerProperties(Properties) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
Configure the underlying consumer properties.
- containsKey(String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Indicates whether or not a key is represented in this context.
- containsValue(Object) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Indicates whether or not a value is represented in this context.
- CONTINUABLE - Enum constant in enum class org.springframework.batch.infrastructure.repeat.RepeatStatus
-
Indicates that processing can continue.
- continueIf(boolean) - Static method in enum class org.springframework.batch.infrastructure.repeat.RepeatStatus
- ConversionException - Exception in org.springframework.batch.infrastructure.item.file.transform
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0, scheduled for removal in 6.2 or later.
- ConversionException(String) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.ConversionException
-
Deprecated.
- 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(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(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
Properties
toJobParameters
. - convert(V) - Method in class org.springframework.batch.infrastructure.item.SpELItemKeyMapper
- convertToSort(Map<String, Sort.Direction>) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- 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
-
RuntimeHintsRegistrar
for Spring Batch core module. - CoreRuntimeHints() - Constructor for class org.springframework.batch.core.aot.CoreRuntimeHints
- COUNT - Static variable in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
-
Session key for global counter.
- CountingBatchContext(RepeatContext) - Constructor for class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy.CountingBatchContext
- CountingCompletionPolicy - Class in org.springframework.batch.infrastructure.repeat.policy
-
Abstract base class for policies that need to count the number of occurrences of some event (e.g. an exception type in the context), and terminate based on a limit for the counter.
- CountingCompletionPolicy() - Constructor for class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
- CountingCompletionPolicy.CountingBatchContext - Class in org.springframework.batch.infrastructure.repeat.policy
- countParameterPlaceholders(String, List<String>) - Static method in class org.springframework.batch.infrastructure.item.database.JdbcParameterUtils
-
Count the occurrences of the character placeholder in an SQL string
sql
. - 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
StepExecution
for a given step name. - create(String[]) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSetFactory
-
Create a FieldSet with anonymous tokens.
- create(String[]) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSetFactory
-
Create a FieldSet with anonymous tokens.
- create(String[], String[]) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSetFactory
-
Create a FieldSet with named tokens.
- create(String[], String[]) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSetFactory
-
Create a FieldSet with named tokens.
- create(Resource, String) - Method in interface org.springframework.batch.infrastructure.item.file.BufferedReaderFactory
-
Create a
BufferedReader
for reading String items from the provided resource. - create(Resource, String) - Method in class org.springframework.batch.infrastructure.item.file.DefaultBufferedReaderFactory
- create(Resource, String) - Method in class org.springframework.batch.infrastructure.item.file.SimpleBinaryBufferedReaderFactory
- createAppendOnlyTransactionalList() - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createAppendOnlyTransactionalMap() - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createAppendOnlyTransactionalSet() - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createApplicationContext() - Method in class org.springframework.batch.core.configuration.support.AbstractApplicationContextFactory
-
Deprecated.Creates an
ApplicationContext
from 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.
- createBinder(Object) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Create a binder for the target object.
- 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.
- createContextCustomizer(Class<?>, List<ContextConfigurationAttributes>) - Method in class org.springframework.batch.test.context.BatchTestContextCustomizerFactory
- 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
StateTransition
specification. - createEndStateTransition(State, String) - Static method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Create a new end state
StateTransition
specification. - 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
. - createInternalState(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Create an internal state object that is used to store data needed internally in the scope of an iteration.
- createInternalState(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.support.TaskExecutorRepeatTemplate
-
Deprecated.
- 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
ApplicationContext
from 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() - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
JobExecution
with default parameters. - createJobExecution(Long) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
JobExecution
with the parameters provided. - createJobExecution(String, Long, Long) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
JobExecution
with the parameters provided. - createJobExecution(String, Long, Long, JobParameters) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
JobExecution
with the parameters provided. - 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
JobExecution
for the givenJobInstance
andJobParameters
, and associate the providedExecutionContext
with 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
- createJobExecutions(int) - Method in class org.springframework.batch.test.JobRepositoryTestUtils
-
Use the
JobRepository
to create someJobExecution
instances each with a single step execution. - createJobExecutions(String, String[], int) - Method in class org.springframework.batch.test.JobRepositoryTestUtils
-
Use the
JobRepository
to create someJobExecution
instances each with the given job name and each having step executions with the given step names. - createJobExecutionWithStepExecutions(Long, Collection<String>) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
JobExecution
with the parameters provided with attached step executions. - createJobInstance() - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
JobInstance
with default parameters. - createJobInstance(String, Long) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
JobInstance
with the parameters provided. - 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
JobInstance
with 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
- createNewFile(File) - Static method in class org.springframework.batch.infrastructure.item.util.FileUtils
-
Create a new file if it doesn't already exist.
- createNewStepState(State, String, String) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
-
Provides an extension point to provide alternative
StepState
implementations 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
. - createQuery() - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNamedQueryProvider
- createQuery() - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNativeQueryProvider
- createQuery() - Method in interface org.springframework.batch.infrastructure.item.database.orm.JpaQueryProvider
-
Create the query object.
- 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
StepContext
is 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.
- createSqlParameterSource(T) - Method in class org.springframework.batch.infrastructure.item.database.BeanPropertyItemSqlParameterSourceProvider
-
Provide parameter values in an
BeanPropertySqlParameterSource
based on values from the provided item. - createSqlParameterSource(T) - Method in interface org.springframework.batch.infrastructure.item.database.ItemSqlParameterSourceProvider
-
Provide parameter values in an
SqlParameterSource
based on values from the provided item. - createState(List<?>) - Static method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- createState(List<?>, Classifier<? super Throwable, Boolean>) - 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
StateTransition
specification from oneState
to another (by name). - createStateTransition(State, String) - Static method in class org.springframework.batch.core.job.flow.support.StateTransition
-
Create a new state
StateTransition
specification with a wildcard pattern that matches all outcomes. - createStaxResult() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Subclasses can override to customize the STAX result.
- createStepContribution() - Method in class org.springframework.batch.core.step.StepExecution
-
Factory method for
StepContribution
. - createStepContribution() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- createStepExecution() - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
StepExecution
with default parameters. - createStepExecution(String, Long) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
StepExecution
with the parameters provided. - 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
StepExecution
for a givenJobExecution
and 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
StepExecution
for the givenJobExecution
and step name, associate a newExecutionContext
with the newStepExecution
, and add the newStepExecution
to theJobExecution
. - createStepExecution(JobExecution, String, Long) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
StepExecution
with the parameters provided. - createStepExecution(JobParameters) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
StepExecution
and all its parent entities with default values, but using theJobParameters
provided. - createStepExecution(JobParameters, ExecutionContext) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
StepExecution
and all its parent entities with default values, but using theExecutionContext
andJobParameters
provided. - createStepExecution(ExecutionContext) - Static method in class org.springframework.batch.test.MetaDataInstanceFactory
-
Create a
StepExecution
and all its parent entities with default values, but using theExecutionContext
provided. - 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
. - createTransactionalList() - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createTransactionalList(List<T>) - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createTransactionalMap() - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createTransactionalMap(Map<K, V>) - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createTransactionalSet() - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createTransactionalSet(Set<T>) - Static method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareProxyFactory
-
Deprecated.
- createTransition(FlowExecutionStatus, String, String, String, BeanDefinition, ParserContext, boolean) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
- createXmlEventFactory() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Subclasses can override to customize the event factory.
- createXmlEventWriter(XMLOutputFactory, Writer) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Subclasses can override to customize the writer.
- createXmlOutputFactory() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Subclasses can override to customize the factory.
- currentItemCount - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
Index for the current item.
- currentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Index for the current item.
- customEditors(Map<Class<?>, PropertyEditor>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Register custom type converters for beans being mapped.
- customizeContext(ConfigurableApplicationContext, MergedContextConfiguration) - Method in class org.springframework.batch.test.context.BatchTestContextCustomizer
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.
- DatabaseType - Enum Class in org.springframework.batch.infrastructure.support
-
Enum representing a database type, such as DB2 or oracle.
- DataFieldMaxValueIncrementerFactory - Interface in org.springframework.batch.infrastructure.item.database.support
-
Factory for creating
DataFieldMaxValueIncrementer
implementations based upon a provided string. - DataFieldMaxValueJobParametersIncrementer - Class in org.springframework.batch.core.job.parameters
-
This incrementer uses a
DataFieldMaxValueIncrementer
to 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
. - dataRowMapper(Class<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Creates a
DataClassRowMapper
to be used as yourRowMapper
. - dataRowMapper(Class<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
Creates a
DataClassRowMapper
to be used as yourRowMapper
. - 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.
- dataSource - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- dataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
Configure the
DataSource
to be used. - dataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
The
DataSource
to read from - dataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The
DataSource
to query against. - dataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
The
DataSource
to read from - 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
- DB2 - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- DB2AS400 - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- Db2PagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
DB2 implementation of a
PagingQueryProvider
using database specific features. - Db2PagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.Db2PagingQueryProvider
- DB2VSE - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- DB2ZOS - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- DEBUG - Enum constant in enum class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler.Level
-
Key for
Classifier
signalling that the throwable should be logged at debug level. - 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_CHARSET - Static variable in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- DEFAULT_CHARSET - Static variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- DEFAULT_CHUNK_SIZE - Static variable in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
- DEFAULT_COMMENT_PREFIXES - Static variable in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- DEFAULT_ENCODING - Static variable in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- DEFAULT_ENCODING - Static variable in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
- DEFAULT_EXIT_MESSAGE_LENGTH - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- DEFAULT_JOB_EXECUTION_ID - Static variable in class org.springframework.batch.test.MetaDataInstanceFactory
-
The default id for a job execution (123L)
- DEFAULT_JOB_INSTANCE_ID - Static variable in class org.springframework.batch.test.MetaDataInstanceFactory
-
The default id for a job instance (12L)
- DEFAULT_JOB_NAME - Static variable in class org.springframework.batch.test.MetaDataInstanceFactory
-
The default name for a job ("job")
- DEFAULT_KEY - Static variable in class org.springframework.batch.core.job.parameters.DataFieldMaxValueJobParametersIncrementer
-
Default key used as a job parameter.
- DEFAULT_LINE_SEPARATOR - Static variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- 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_MAX_WAIT_TIMEOUTS - Variable in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- DEFAULT_QUOTE_CHARACTER - Static variable in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Convenient constant for the common case of a " character used to escape delimiters or line endings.
- DEFAULT_ROOT_TAG_NAME - Static variable in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
- DEFAULT_SHORT_CONTEXT_LENGTH - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- DEFAULT_STANDALONE_DOCUMENT - Static variable in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
- DEFAULT_STEP_EXECUTION_ID - Static variable in class org.springframework.batch.test.MetaDataInstanceFactory
-
The default id for a step execution (1234L)
- DEFAULT_STEP_NAME - Static variable in class org.springframework.batch.test.MetaDataInstanceFactory
-
The default name for a step ("step")
- DEFAULT_SUFFIX - Static variable in class org.springframework.batch.infrastructure.item.file.separator.SuffixRecordSeparatorPolicy
-
Default value for record terminator suffix.
- DEFAULT_TABLE_PREFIX - Static variable in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
-
Default value for the table prefix property.
- DEFAULT_THROTTLE_LIMIT - Static variable in class org.springframework.batch.infrastructure.repeat.support.TaskExecutorRepeatTemplate
-
Deprecated.Default limit for maximum number of concurrent unfinished results allowed by the template.
- DEFAULT_THROTTLE_LIMIT - Static variable in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- DEFAULT_TIMEOUT - Static variable in class org.springframework.batch.infrastructure.repeat.policy.TimeoutTerminationPolicy
-
Default timeout value in milliseconds (the value equivalent to 30 seconds).
- DEFAULT_TRANSACTIONAL - Static variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- DEFAULT_XML_VERSION - Static variable in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
- DefaultBatchConfiguration - Class in org.springframework.batch.core.configuration.support
-
Base
Configuration
class that provides common infrastructure beans for enabling and using Spring Batch. - DefaultBatchConfiguration() - Constructor for class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
- DefaultBufferedReaderFactory - Class in org.springframework.batch.infrastructure.item.file
- DefaultBufferedReaderFactory() - Constructor for class org.springframework.batch.infrastructure.item.file.DefaultBufferedReaderFactory
- DefaultDataFieldMaxValueIncrementerFactory - Class in org.springframework.batch.infrastructure.item.database.support
-
Default implementation of the
DataFieldMaxValueIncrementerFactory
interface. - DefaultDataFieldMaxValueIncrementerFactory(DataSource) - Constructor for class org.springframework.batch.infrastructure.item.database.support.DefaultDataFieldMaxValueIncrementerFactory
- DefaultExceptionHandler - Class in org.springframework.batch.infrastructure.repeat.exception
-
Default implementation of
ExceptionHandler
- just re-throws the exception it encounters. - DefaultExceptionHandler() - Constructor for class org.springframework.batch.infrastructure.repeat.exception.DefaultExceptionHandler
- DefaultExecutionContextSerializer - Class in org.springframework.batch.core.repository.dao
-
An implementation of the
ExecutionContextSerializer
that produces/consumes Base64 content. - DefaultExecutionContextSerializer() - Constructor for class org.springframework.batch.core.repository.dao.DefaultExecutionContextSerializer
- DefaultFieldSet - Class in org.springframework.batch.infrastructure.item.file.transform
-
Default implementation of
FieldSet
using Java primitive and standard types and utilities. - DefaultFieldSet(String[], String[]) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
Create a FieldSet with named tokens.
- DefaultFieldSet(String[], String[], DateFormat, NumberFormat) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
Create a FieldSet with named tokens.
- DefaultFieldSet(String[]) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
Create a FieldSet with anonymous tokens.
- DefaultFieldSet(String[], DateFormat, NumberFormat) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
Create a FieldSet with anonymous tokens.
- DefaultFieldSetFactory - Class in org.springframework.batch.infrastructure.item.file.transform
-
Default implementation of
FieldSetFactory
with no special knowledge of theFieldSet
required. - DefaultFieldSetFactory() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSetFactory
-
Default constructor.
- DefaultFieldSetFactory(DateFormat, NumberFormat) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSetFactory
-
Convenience constructor
- DefaultFragmentEventReader - Class in org.springframework.batch.infrastructure.item.xml.stax
-
Default implementation of
FragmentEventReader
- DefaultFragmentEventReader(XMLEventReader) - Constructor for class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
-
Caches the StartDocument event for later use.
- 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
JobKeyGenerator
interface. - 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
JobParameters
instances 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
JobParametersExtractor
which 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.
- DefaultLineMapper<T> - Class in org.springframework.batch.infrastructure.item.file.mapping
-
Two-phase
LineMapper
implementation consisting of tokenization of the line intoFieldSet
followed by mapping to item. - DefaultLineMapper() - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.DefaultLineMapper
- DefaultMailErrorHandler - Class in org.springframework.batch.infrastructure.item.mail
-
This
MailErrorHandler
implementation simply rethrows the exception it receives. - DefaultMailErrorHandler() - Constructor for class org.springframework.batch.infrastructure.item.mail.DefaultMailErrorHandler
- DefaultPropertyEditorRegistrar - Class in org.springframework.batch.infrastructure.support
-
A re-usable
PropertyEditorRegistrar
that can be used wherever one needs to register customPropertyEditor
instances with aPropertyEditorRegistry
(like a bean wrapper, or a type converter). - DefaultPropertyEditorRegistrar() - Constructor for class org.springframework.batch.infrastructure.support.DefaultPropertyEditorRegistrar
- DefaultRecordSeparatorPolicy - Class in org.springframework.batch.infrastructure.item.file.separator
-
A
RecordSeparatorPolicy
that treats all lines as record endings, as long as they do not have unterminated quotes, and do not end in a continuation marker. - DefaultRecordSeparatorPolicy() - Constructor for class org.springframework.batch.infrastructure.item.file.separator.DefaultRecordSeparatorPolicy
-
Default constructor.
- DefaultRecordSeparatorPolicy(String) - Constructor for class org.springframework.batch.infrastructure.item.file.separator.DefaultRecordSeparatorPolicy
-
Convenient constructor with quote character as parameter.
- DefaultRecordSeparatorPolicy(String, String) - Constructor for class org.springframework.batch.infrastructure.item.file.separator.DefaultRecordSeparatorPolicy
-
Convenient constructor with quote character and continuation marker as parameters.
- DefaultResultCompletionPolicy - Class in org.springframework.batch.infrastructure.repeat.policy
-
Very simple
CompletionPolicy
that bases its decision on the result of a batch operation. - DefaultResultCompletionPolicy() - Constructor for class org.springframework.batch.infrastructure.repeat.policy.DefaultResultCompletionPolicy
- 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
StepExecution
instances into a single result. - DefaultStepExecutionAggregator() - Constructor for class org.springframework.batch.core.partition.support.DefaultStepExecutionAggregator
- delegate(ResourceAwareItemReaderItemStream<? extends T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
-
Establishes the delegate to use for reading the resources provided.
- delegate(ResourceAwareItemWriterItemStream<? super T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
-
Delegate used for actual writing of the output.
- delegate(ItemReader<T>) - Method in class org.springframework.batch.infrastructure.item.support.builder.SingleItemPeekableItemReaderBuilder
-
The item reader to use as a delegate.
- delegate(ItemReader<T>) - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemReaderBuilder
-
The item reader to use as a delegate.
- delegate(ItemStreamReader<T>) - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemStreamReaderBuilder
-
The item stream reader to use as a delegate.
- delegate(ItemStreamWriter<T>) - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemStreamWriterBuilder
-
Set the delegate
ItemStreamWriter
. - delegate(ItemWriter<T>) - Method in class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemWriterBuilder
-
The item writer to use as a delegate.
- delegates(List<? extends ItemProcessor<?, ?>>) - Method in class org.springframework.batch.infrastructure.item.support.builder.CompositeItemProcessorBuilder
-
Establishes the
ItemProcessor
delegates that will work on the item to be processed. - delegates(List<ItemWriter<? super T>>) - Method in class org.springframework.batch.infrastructure.item.support.builder.CompositeItemWriterBuilder
-
The list of item writers to use as delegates.
- delegates(ItemProcessor<?, ?>...) - Method in class org.springframework.batch.infrastructure.item.support.builder.CompositeItemProcessorBuilder
-
Establishes the
ItemProcessor
delegates that will work on the item to be processed. - delegates(ItemWriter<? super T>...) - Method in class org.springframework.batch.infrastructure.item.support.builder.CompositeItemWriterBuilder
-
The item writers to use as delegates.
- delete - Variable in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
- delete(boolean) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemWriterBuilder
-
Indicate if the items being passed to the writer are all to be sent as delete events to the topic.
- delete(boolean) - Method in class org.springframework.batch.infrastructure.item.redis.builder.RedisItemWriterBuilder
-
Indicate if the items being passed to the writer should be deleted.
- 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(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
. - 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 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.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.
- 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 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.SimpleJobRepository
- deleteStepExecution(StepExecution) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
-
Delete the given step execution.
- 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
- delimited() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Returns an instance of a
FlatFileItemReaderBuilder.DelimitedBuilder
for building aDelimitedLineTokenizer
. - delimited() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
Returns an instance of a
FlatFileItemWriterBuilder.DelimitedBuilder
for building aDelimitedLineAggregator
. - DelimitedBuilder(FlatFileItemReaderBuilder<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
- DelimitedBuilder(FlatFileItemWriterBuilder<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.DelimitedBuilder
- DelimitedLineAggregator<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
A
LineAggregator
implementation that converts an object into a delimited list of strings. - DelimitedLineAggregator() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineAggregator
- DelimitedLineTokenizer - Class in org.springframework.batch.infrastructure.item.file.transform
-
A
LineTokenizer
implementation that splits the input String on a configurable delimiter. - DelimitedLineTokenizer() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Create a new instance of the
DelimitedLineTokenizer
class for the common case where the delimiter is acomma
. - DelimitedLineTokenizer(String) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Create a new instance of the
DelimitedLineTokenizer
class. - delimiter(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
Define the delimiter for the file.
- delimiter(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.DelimitedBuilder
-
Define the delimiter for the file.
- DELIMITER_COMMA - Static variable in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Convenient constant for the common case of a comma delimiter.
- DELIMITER_TAB - Static variable in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Convenient constant for the common case of a tab delimiter.
- DERBY - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- DerbyPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
Derby implementation of a
PagingQueryProvider
using database specific features. - DerbyPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.DerbyPagingQueryProvider
- DESCENDING - Enum constant in enum class org.springframework.batch.infrastructure.item.database.Order
- 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
Job
instances that were registered by this smart initializing singleton. - detectStreamInReader() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- determineQueryProvider(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- DirectPoller<S> - Class in org.springframework.batch.infrastructure.poller
-
A
Poller
that uses the callers thread to poll for a result as soon as it is asked for. - DirectPoller(long) - Constructor for class org.springframework.batch.infrastructure.poller.DirectPoller
- dirty() - Method in record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Returns the value of the
dirty
record component. - distanceLimit(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configures the maximum tolerance between the actual spelling of a field's name and the property's name.
- doAfterWrite(Chunk<O>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Call the listener's after write method.
- doAggregate(Object[]) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineAggregator
- doAggregate(Object[]) - Method in class org.springframework.batch.infrastructure.item.file.transform.ExtractorLineAggregator
-
Aggregate provided fields into single String.
- doAggregate(Object[]) - Method in class org.springframework.batch.infrastructure.item.file.transform.FormatterLineAggregator
- doAggregation(Collection<FlowExecution>, FlowExecutor) - Method in class org.springframework.batch.core.job.flow.support.state.SplitState
- doBegin(Object, TransactionDefinition) - Method in class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- doCleanupAfterCompletion(Object) - Method in class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- doClose() - Method in class org.springframework.batch.infrastructure.item.avro.AvroItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Close the cursor and database connection.
- doClose() - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.json.JsonItemReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
- doClose() - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
Close the resources opened in
AbstractItemCountingItemStreamItemReader.doOpen()
. - doClose() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- doCommit(DefaultTransactionStatus) - Method in class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- 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
PartitionHandler
provided. - 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
JobOperator
to 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.
- doExecute(StepExecution) - Method in class org.springframework.batch.integration.remote.RemoteStep
- doExecutionRegistration(StepExecution) - Method in class org.springframework.batch.core.step.AbstractStep
-
Registers the
StepExecution
for property resolution viaStepScope
- doExecutionRelease() - Method in class org.springframework.batch.core.step.AbstractStep
-
Releases the most recent
StepExecution
- doGetTransaction() - Method in class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- doHandle(StepExecution, Set<StepExecution>) - Method in class org.springframework.batch.core.partition.support.AbstractPartitionHandler
-
Executes the specified
StepExecution
instances and returns an updated view of them. - doHandle(StepExecution, Set<StepExecution>) - Method in class org.springframework.batch.core.partition.support.TaskExecutorPartitionHandler
- doHandle(StepExecution, Set<StepExecution>) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
-
Sends
StepExecutionRequest
objects to the request channel of theMessagingTemplate
, and then receives the result back as a list ofStepExecution
on a reply channel. - 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
StepContext
lifecycle. - doInIteration(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.callback.NestedRepeatCallback
-
Simply calls template.execute(callback).
- doInIteration(RepeatContext) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatCallback
-
Implementations return true if they can continue processing - e.g. there is a data source that is not yet exhausted.
- doInJobScope(JobExecution, Callable<T>) - Static method in class org.springframework.batch.test.JobScopeTestUtils
- doInStepScope(StepExecution, Callable<T>) - Static method in class org.springframework.batch.test.StepScopeTestUtils
- doOnWriteError(Exception, Chunk<O>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Call listener's writerError method.
- doOpen() - Method in class org.springframework.batch.infrastructure.item.avro.AvroItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Execute the statement to open the cursor.
- doOpen() - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.json.JsonItemReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
- doOpen() - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
Open resources necessary to start reading input.
- doOpen() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- doPageRead() - Method in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
-
Method this
ItemStreamReader
delegates to for the actual work of reading a page. - doPageRead() - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- doPageRead() - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
-
Performs the actual reading of a page via the repository.
- 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.
- doRead() - Method in class org.springframework.batch.infrastructure.item.avro.AvroItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Read next row and map it to item, verify cursor position if
AbstractCursorItemReader.setVerifyCursorPosition(boolean)
is true. - doRead() - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.json.JsonItemReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
- doRead() - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
Read next item from input.
- doRead() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
-
Move to next fragment and map it to item.
- doReadPage() - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- doReadPage() - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
- doReadPage() - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
- doRollback(DefaultTransactionStatus) - Method in class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- doSetRollbackOnly(DefaultTransactionStatus) - Method in class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- doTokenize(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
- doTokenize(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Yields the tokens resulting from the splitting of the supplied
line
. - doTokenize(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.FixedLengthTokenizer
-
Yields the tokens resulting from the splitting of the supplied
line
. - doTokenize(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.RegexLineTokenizer
- doUpdate(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
-
Extension point for subclasses.
- doWrite(EntityManager, Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.database.JpaItemWriter
-
Do perform the actual write operation.
- doWrite(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Performs the actual write to the store via the template.
- doWrite(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemWriter
-
Performs the actual write to the repository.
- doWrite(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemWriter
- doWrite(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.json.JsonFileItemWriter
- doWrite(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Write out a string of items followed by a "new line", where the format of the new line separator is determined by the underlying operating system.
- doWrite(Chunk<O>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Surrounds the actual write call with listener callbacks.
- driverSupportsAbsolute(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Indicates if the JDBC driver supports setting the absolute row on the
ResultSet
. - driverSupportsAbsolute(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Indicates if the JDBC driver supports setting the absolute row on the
ResultSet
. - DuplicateJobException - Exception in org.springframework.batch.core.configuration
-
Checked exception that indicates a name clash when registering
Job
instances. - DuplicateJobException(String) - Constructor for exception org.springframework.batch.core.configuration.DuplicateJobException
-
Create an exception with the given message.
- DuplicateJobException(String, Throwable) - Constructor for exception org.springframework.batch.core.configuration.DuplicateJobException
-
Create an exception with the given message and the given exception.
- DynamicMethodInvocationException - Exception in org.springframework.batch.infrastructure.item.adapter
-
Indicates an error has been encountered while trying to dynamically invoke a method e.g. using
MethodInvoker
. - DynamicMethodInvocationException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.adapter.DynamicMethodInvocationException
- DynamicMethodInvocationException(Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.adapter.DynamicMethodInvocationException
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
- embeddedSchema(boolean) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Disable or enable reading an embedded Avro schema.
- EnableBatchIntegration - Annotation Interface in org.springframework.batch.integration.config.annotation
-
Enable Spring Batch Integration features and provide a base configuration for setting up remote chunking or partitioning infrastructure beans.
- 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
- encoding(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configure the encoding used by the reader to read the input source.
- encoding(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
Encoding used for output.
- encoding(String) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
Encoding used for output.
- encoding(String) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Encoding for the input file.
- encoding(String) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Encoding for the file.
- 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.
- endDocument(XMLEventWriter) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Writes the EndDocument tag manually.
- EndState - Class in org.springframework.batch.core.job.flow.support.state
-
State
implementation 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
AbstractTaskletStepBuilder
using 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
Entity
where the ID is established. - entityManagerFactory(EntityManagerFactory) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
The
EntityManagerFactory
to be used for executing the configuredJpaCursorItemReaderBuilder.queryString
. - entityManagerFactory(EntityManagerFactory) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaItemWriterBuilder
-
The JPA
EntityManagerFactory
to obtain an entity manager from. - entityManagerFactory(EntityManagerFactory) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
The
EntityManagerFactory
to be used for executing the configuredJpaPagingItemReaderBuilder.queryString
. - entrySet() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Returns the entry set containing the contents of this context.
- 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.
- equals(Object) - Method in class org.springframework.batch.core.step.StepContribution
- equals(Object) - Method in class org.springframework.batch.core.step.StepExecution
- equals(Object) - Method in class org.springframework.batch.infrastructure.item.Chunk
- equals(Object) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
- equals(Object) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- equals(Object) - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- equals(Object) - Method in class org.springframework.batch.infrastructure.support.SimpleMethodInvoker
- equals(Object) - Method in class org.springframework.batch.test.context.BatchTestContextCustomizer
- ERROR - Enum constant in enum class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler.Level
-
Key for
Classifier
signalling that the throwable should be logged at error level. - ExceptionClassifierSkipPolicy - Class in org.springframework.batch.core.step.skip
-
A
SkipPolicy
that 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.
- exceptionHandler(ExceptionHandler) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- ExceptionHandler - Interface in org.springframework.batch.infrastructure.repeat.exception
-
Handler to allow strategies for re-throwing exceptions.
- 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(java.lang.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
JobExecution
and 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
ExitStatus
by 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
ExitStatus
usingSystemProcessExitCodeMapper
. - 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
StepExecution
provided. - execute(Step, StepExecution) - Method in class org.springframework.batch.core.scope.context.StepScopeManager
- execute(RetryCallback<T, E>) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback<T, E>, Collection<RetryState>) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback<T, E>, RecoveryCallback<T>) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback<T, E>, RecoveryCallback<T>, Collection<RetryState>) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback<T, E>, RecoveryCallback<T>, RetryState) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- execute(RetryCallback<T, E>, RetryState) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- executeAfterInterceptors(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Convenience method to execute after interceptors on a callback result.
- 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 - Class in org.springframework.batch.infrastructure.item
-
Object representing a context for an
ItemStream
. - ExecutionContext - Record Class in org.springframework.batch.core.repository.persistence
- ExecutionContext() - Constructor for class org.springframework.batch.infrastructure.item.ExecutionContext
-
Default constructor.
- ExecutionContext(Map<String, Object>) - Constructor for class org.springframework.batch.infrastructure.item.ExecutionContext
-
Initializes a new execution context with the contents of another map.
- ExecutionContext(Map<String, Object>, boolean) - Constructor for record class org.springframework.batch.core.repository.persistence.ExecutionContext
-
Creates an instance of a
ExecutionContext
record class. - ExecutionContext(ExecutionContext) - Constructor for class org.springframework.batch.infrastructure.item.ExecutionContext
-
Initializes a new
ExecutionContext
with the contents of anotherExecutionContext
. - ExecutionContextDao - Interface in org.springframework.batch.core.repository.dao
-
DAO interface for persisting and retrieving
ExecutionContext
s. - ExecutionContextPromotionListener - Class in org.springframework.batch.core.listener
-
This class can be used to automatically promote items from the
Step
ExecutionContext
to theJob
ExecutionContext
at the end of a step. - 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.
- ExecutionContextTestUtils - Class in org.springframework.batch.test
-
Convenience class for accessing
ExecutionContext
values from job and step executions. - ExecutionContextUserSupport - Class in org.springframework.batch.infrastructure.item.util
-
Facilitates assigning names to objects persisting data in
ExecutionContext
and generating keys forExecutionContext
based on the name. - ExecutionContextUserSupport() - Constructor for class org.springframework.batch.infrastructure.item.util.ExecutionContextUserSupport
- ExecutionContextUserSupport(String) - Constructor for class org.springframework.batch.infrastructure.item.util.ExecutionContextUserSupport
- 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
exitCode
record 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
exitDescription
record 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
ExitStatus
record class. - expect() - Method in class org.springframework.batch.infrastructure.repeat.support.ResultHolderResultQueue
-
Deprecated.Tell the queue to expect one more result.
- expect() - Method in class org.springframework.batch.infrastructure.repeat.support.ThrottleLimitResultQueue
-
Deprecated.Tell the queue to expect one more result.
- ExtendedConnectionDataSourceProxy - Class in org.springframework.batch.infrastructure.item.database
-
Implementation of
SmartDataSource
that is capable of keeping a single JDBC Connection which is NOT closed after each use even ifConnection.close()
is called. - ExtendedConnectionDataSourceProxy() - Constructor for class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
-
No arg constructor for use when configured using JavaBean style.
- ExtendedConnectionDataSourceProxy(DataSource) - Constructor for class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
-
Constructor that takes as a parameter with the
DataSource
to be wrapped. - extract(ChunkResponse, boolean) - Method in class org.springframework.batch.integration.chunk.JmsRedeliveredExtractor
- extract(T) - Method in class org.springframework.batch.infrastructure.item.file.transform.BeanWrapperFieldExtractor
- extract(T) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldExtractor
- extract(T) - Method in class org.springframework.batch.infrastructure.item.file.transform.PassThroughFieldExtractor
-
Get an array of fields as close as possible to the input.
- extract(T) - Method in class org.springframework.batch.infrastructure.item.file.transform.RecordFieldExtractor
- ExtractorLineAggregator<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
An abstract
LineAggregator
implementation that utilizes aFieldExtractor
to convert the incoming object to an array of its parts. - ExtractorLineAggregator() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.ExtractorLineAggregator
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 in org.springframework.batch.core.step
- FatalStepExecutionException(String, Throwable) - Constructor for exception 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
ChunkOrientedStep
instead. Scheduled for removal in 7.0. - FaultTolerantChunkProcessor(ItemProcessor<? super I, ? extends O>, ItemWriter<? super O>, 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
ChunkOrientedStep
instead. Scheduled for removal in 7.0. - FaultTolerantChunkProvider(ItemReader<? extends I>, 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
ChunkOrientedStepBuilder
instead. Scheduled for removal in 7.0. - FaultTolerantStepBuilder(SimpleStepBuilder<I, O>) - 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.
- fetchSize - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- fetchSize(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
A hint to the driver as to how many rows to return with each fetch.
- fetchSize(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
A hint to the underlying RDBMS as to how many records to return with each fetch.
- fetchSize(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
A hint to the driver as to how many rows to return with each fetch.
- fieldExtractor(FieldExtractor<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.DelimitedBuilder
-
Set the
FieldExtractor
to use to extract fields from each item. - fieldExtractor(FieldExtractor<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
-
Set the
FieldExtractor
to use to extract fields from each item. - FieldExtractor<T> - Interface in org.springframework.batch.infrastructure.item.file.transform
-
This class will convert an object to an array of its parts.
- fields - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- fields - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- fields(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
JSON defining the fields to be returned from the matching documents by MongoDB.
- fields(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
JSON defining the fields to be returned from the matching documents by MongoDB.
- FieldSet - Interface in org.springframework.batch.infrastructure.item.file.transform
-
Interface used by flat file input sources to encapsulate concerns of converting an array of Strings to Java native types.
- fieldSetFactory(FieldSetFactory) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
A factory for creating the resulting
FieldSet
. - fieldSetFactory(FieldSetFactory) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
-
A factory for creating the resulting
FieldSet
. - FieldSetFactory - Interface in org.springframework.batch.infrastructure.item.file.transform
-
Factory interface for creating
FieldSet
instances. - fieldSetMapper(FieldSetMapper<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
A
FieldSetMapper
implementation to be used. - FieldSetMapper<T> - Interface in org.springframework.batch.infrastructure.item.file.mapping
-
Interface that is used to map data obtained from a
FieldSet
into an object. - FileUtils - Class in org.springframework.batch.infrastructure.item.util
-
Utility methods for files used in batch processing.
- findAllReachableElements(String, Map<String, Set<String>>, Set<String>) - 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
JobExecution
s 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
JobInstance
values for a given job name. - findJobInstances(String) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Find all
JobInstance
s for a given job name. - findJobInstances(String) - Method in class org.springframework.batch.core.repository.support.SimpleJobRepository
-
Fetch all
JobInstance
values 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.
- findMatchingMethod() - Method in class org.springframework.batch.infrastructure.item.adapter.HippyMethodInvoker
- findMethod(Class<?>) - Method in class org.springframework.batch.infrastructure.support.AnnotationMethodResolver
-
Find a single Method on the given Class that contains the annotation type for which this resolver is searching.
- findMethod(Class<?>) - Method in interface org.springframework.batch.infrastructure.support.MethodResolver
-
Find a single Method on the given Class that matches this resolver's criteria.
- findMethod(Class<?>, Class<? extends Annotation>) - Static method in class org.springframework.batch.infrastructure.support.ReflectionUtils
- findMethod(Object) - Method in class org.springframework.batch.infrastructure.support.AnnotationMethodResolver
-
Find a single Method on the Class of the given candidate object that contains the annotation type for which this resolver is searching.
- findMethod(Object) - Method in interface org.springframework.batch.infrastructure.support.MethodResolver
-
Find a single Method on the provided Object that matches this resolver's criteria.
- 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 class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- findRunningJobExecutions(String) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Retrieve running job executions.
- FINISHED - Enum constant in enum class org.springframework.batch.infrastructure.repeat.RepeatStatus
-
Indicates that processing is finished (either successful or unsuccessful)
- fixedLength() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Returns an instance of a
FlatFileItemReaderBuilder.FixedLengthBuilder
for building aFixedLengthTokenizer
. - FixedLengthBuilder(FlatFileItemReaderBuilder<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
- FixedLengthTokenizer - Class in org.springframework.batch.infrastructure.item.file.transform
-
Tokenizer used to process data obtained from files with fixed-length format.
- FixedLengthTokenizer(Range...) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.FixedLengthTokenizer
-
Create a new
FixedLengthTokenizer
instance with the given ranges. - FlatFileFooterCallback - Interface in org.springframework.batch.infrastructure.item.file
-
Callback interface for writing a footer to a file.
- FlatFileFormatException - Exception in org.springframework.batch.infrastructure.item.file.transform
-
Exception indicating that some type of error has occurred while attempting to parse a line of input into tokens.
- FlatFileFormatException(String) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.FlatFileFormatException
-
Create a new
FlatFileFormatException
based on a message. - FlatFileFormatException(String, String) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.FlatFileFormatException
-
Create a new
FlatFileFormatException
based on a message. - FlatFileFormatException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.FlatFileFormatException
-
Create a new
FlatFileFormatException
based on a message and another exception. - FlatFileHeaderCallback - Interface in org.springframework.batch.infrastructure.item.file
-
Callback interface for writing a header to a file.
- FlatFileItemReader<T> - Class in org.springframework.batch.infrastructure.item.file
-
Restartable
ItemReader
that reads lines from inputFlatFileItemReader.setResource(Resource)
. - FlatFileItemReader(LineMapper<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Create a new
FlatFileItemReader
with aLineMapper
. - FlatFileItemReader(Resource, LineMapper<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- FlatFileItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder implementation for the
FlatFileItemReader
. - FlatFileItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
- FlatFileItemReaderBuilder.DelimitedBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder for constructing a
DelimitedLineTokenizer
- FlatFileItemReaderBuilder.FixedLengthBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder for constructing a
FixedLengthTokenizer
- FlatFileItemWriter<T> - Class in org.springframework.batch.infrastructure.item.file
-
This class is an item writer that writes data to a file or stream.
- FlatFileItemWriter(LineAggregator<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.FlatFileItemWriter
-
Create a new
FlatFileItemWriter
with theLineAggregator
specified. - FlatFileItemWriter(WritableResource, LineAggregator<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.FlatFileItemWriter
- FlatFileItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder implementation for the
FlatFileItemWriter
- FlatFileItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
- FlatFileItemWriterBuilder.DelimitedBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder for constructing a
DelimitedLineAggregator
- FlatFileItemWriterBuilder.FormattedBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder for constructing a
FormatterLineAggregator
. - FlatFileParseException - Exception in org.springframework.batch.infrastructure.item.file
-
Exception thrown when errors are encountered parsing flat files.
- FlatFileParseException(String, String) - Constructor for exception org.springframework.batch.infrastructure.item.file.FlatFileParseException
- FlatFileParseException(String, String, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.FlatFileParseException
- FlatFileParseException(String, Throwable, String, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.FlatFileParseException
- 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(Flow) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- 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 in org.springframework.batch.core.job.builder
- FlowBuilderException(Exception) - Constructor for exception org.springframework.batch.core.job.builder.FlowBuilderException
- FlowBuilderException(String) - Constructor for exception org.springframework.batch.core.job.builder.FlowBuilderException
- FlowBuilderException(String, Exception) - Constructor for exception 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
FlowExecution
instances into a single exit status. - FlowExecutionException - Exception in org.springframework.batch.core.job.flow
- FlowExecutionException(String) - Constructor for exception org.springframework.batch.core.job.flow.FlowExecutionException
- FlowExecutionException(String, Throwable) - Constructor for exception 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
FlowJob
to 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
Job
interface 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
FlowJob
with null name and no flow (invalid state). - FlowJob(String) - Constructor for class org.springframework.batch.core.job.flow.FlowJob
-
Create a
FlowJob
with provided name and no flow (invalid state). - FlowJobBuilder - Class in org.springframework.batch.core.job.builder
-
A job builder for
FlowJob
instances. - 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
FlowStep
that 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
FlowStep
with the given job repository. - FlowStepBuilder - Class in org.springframework.batch.core.step.builder
-
A step builder for
FlowStep
instances. - FlowStepBuilder(StepBuilderHelper<?>) - Constructor for class org.springframework.batch.core.step.builder.FlowStepBuilder
-
Create a new builder initialized with any properties in the parent.
- flush() - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
- flush() - Method in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
-
Flush items to the key/value store.
- flush() - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- flush() - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
- FlushFailedException - Exception in org.springframework.batch.infrastructure.support.transaction
-
Unchecked exception indicating that an error has occurred while trying to flush a buffer.
- FlushFailedException(String) - Constructor for exception org.springframework.batch.infrastructure.support.transaction.FlushFailedException
-
Create a new
FlushFailedException
based on a message. - FlushFailedException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.support.transaction.FlushFailedException
-
Create a new
FlushFailedException
based on a message and another exception. - footerCallback(FlatFileFooterCallback) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
A callback for footer processing
- footerCallback(FlatFileFooterCallback) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
A callback for footer processing.
- footerCallback(StaxWriterCallback) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
A
StaxWriterCallback
to provide any footer elements - ForceRollbackForWriteSkipException - Exception 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 org.springframework.batch.core.step.item.ForceRollbackForWriteSkipException
-
Deprecated.
- forceSync(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
A flag indicating that changes should be force-synced to disk on flush.
- forceSync(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
A flag indicating that changes should be force-synced to disk on flush.
- forceSync(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Flag to indicate that changes should be force-synced to disk on flush.
- forEach(Consumer<? super JobParameter<?>>) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
- format(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
-
Set the format string used to aggregate items
- formatDuration(Duration) - Static method in class org.springframework.batch.core.observability.BatchMetrics
-
Format a duration in a human readable format like: 2h32m15s10ms.
- formatted() - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
Returns an instance of a
FlatFileItemWriterBuilder.FormattedBuilder
for building aFormatterLineAggregator
. - FormattedBuilder(FlatFileItemWriterBuilder<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
- FormatterLineAggregator<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
A
LineAggregator
implementation which produces a String by aggregating the provided item via theFormatter
syntax. - FormatterLineAggregator(String) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.FormatterLineAggregator
-
Create a new
FormatterLineAggregator
with the provided format. - FragmentEventReader - Interface in org.springframework.batch.infrastructure.item.xml.stax
-
Interface for event readers which support treating XML fragments as standalone XML documents by wrapping the fragments with StartDocument and EndDocument events.
- 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.
- fromClause - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- fromClause(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The SQL
FROM
clause for a db specificPagingQueryProvider
. - 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<T>) - Method in class org.springframework.batch.core.repository.persistence.converter.JobParameterConverter
- fromMetaData(DataSource) - Static method in enum class org.springframework.batch.infrastructure.support.DatabaseType
-
Convenience method that pulls a database product name from the DataSource's metadata.
- fromProductName(String) - Static method in enum class org.springframework.batch.infrastructure.support.DatabaseType
-
Static method to obtain a DatabaseType from the provided product name.
- 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
- function() - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Indicates the stored procedure is a function
- FunctionItemProcessor<I,
O> - Class in org.springframework.batch.infrastructure.item.function -
An
ItemProcessor
implementation that delegates to aFunction
- FunctionItemProcessor(Function<I, O>) - Constructor for class org.springframework.batch.infrastructure.item.function.FunctionItemProcessor
G
- generateFirstPageQuery(int) - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
Generate the query that will provide the first page, limited by the page size.
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
-
Method generating the query string to be used for retrieving the first page.
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.Db2PagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.DerbyPagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.H2PagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.HanaPagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.HsqlPagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.MariaDBPagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.MySqlPagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.OraclePagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.PostgresPagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlitePagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlServerPagingQueryProvider
- generateFirstPageQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.SybasePagingQueryProvider
- generateGroupedTopSqlQuery(AbstractSqlPagingQueryProvider, String) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generate SQL query string using a TOP clause
- generateKey(JobParameters) - Method in class org.springframework.batch.core.job.DefaultJobKeyGenerator
-
Generates the job key to be used based on the
JobParameters
instance provided. - generateKey(JobParameters) - Method in interface org.springframework.batch.core.job.JobKeyGenerator
-
Method to generate the unique key used to identify a job instance.
- generateLimitGroupedSqlQuery(AbstractSqlPagingQueryProvider, String) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generate SQL query string using a LIMIT clause
- generateLimitSqlQuery(AbstractSqlPagingQueryProvider, boolean, String) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generate SQL query string using a LIMIT clause
- generateRemainingPagesQuery(int) - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
Generate the query that will provide the first page, limited by the page size.
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
-
Method generating the query string to be used for retrieving the pages following the first page.
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.Db2PagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.DerbyPagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.H2PagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.HanaPagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.HsqlPagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.MariaDBPagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.MySqlPagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.OraclePagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.PostgresPagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlitePagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlServerPagingQueryProvider
- generateRemainingPagesQuery(int) - Method in class org.springframework.batch.infrastructure.item.database.support.SybasePagingQueryProvider
- generateRowNumSqlQuery(AbstractSqlPagingQueryProvider, boolean, String) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generate SQL query string using a ROW_NUM condition
- generateRowNumSqlQuery(AbstractSqlPagingQueryProvider, String, boolean, String) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generate SQL query string using a ROW_NUM condition
- generateTopSqlQuery(AbstractSqlPagingQueryProvider, boolean, String) - Static method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryUtils
-
Generate SQL query string using a TOP clause
- 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) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Getter for the value represented by the provided key.
- get(String) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilderFactory
-
Creates a
RemoteChunkingManagerStepBuilder
and initializes its job repository and transaction manager. - get(String) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilderFactory
-
Creates a
RemotePartitioningManagerStepBuilder
and initializes its job repository, job explorer, bean factory and transaction manager. - get(String) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilderFactory
-
Creates a
RemotePartitioningWorkerStepBuilder
and initializes its job repository, job explorer, bean factory and transaction manager. - get(String, Class<V>) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe getter for the value represented by the provided key, with cast to given class.
- get(String, Class<V>, V) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe getter for the value represented by the provided key, with cast to given class.
- get(String, ObjectFactory<?>) - Method in class org.springframework.batch.core.scope.JobScope
- get(String, ObjectFactory<?>) - Method in class org.springframework.batch.core.scope.StepScope
- getActualCount() - Method in exception org.springframework.batch.infrastructure.item.file.transform.IncorrectTokenCountException
- getActualLength() - Method in exception org.springframework.batch.infrastructure.item.file.transform.IncorrectLineLengthException
-
Retrieves the actual length that was recorded for this exception.
- getAdjustedOutputs(Chunk<I>, Chunk<O>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- getAdjustedOutputs(Chunk<I>, Chunk<O>) - 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
- getArguments() - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
-
Return arguments.
- getAsText() - Method in class org.springframework.batch.infrastructure.item.file.transform.RangeArrayPropertyEditor
- getAttribute(String) - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- 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.
- getBufferSize() - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
-
Convenience method for clients to determine if there is any unflushed data.
- getCharset() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the
Charset
to 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.
- getChunkSize() - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
- getClobType() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the value from
Types
class to indicate the type to use for a CLOB - getClobTypeToUse() - Method in class org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao
- getCloseSuppressingConnectionProxy(Connection) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
-
Wrap the given Connection with a proxy that delegates every method call to it but suppresses close calls.
- getCode() - Method in class org.springframework.batch.core.job.flow.support.state.EndState
- getCollection() - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Get the Mongo collection name.
- 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
- getConnection() - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- getConnection(String, String) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- 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
. - getContext() - Static method in class org.springframework.batch.infrastructure.repeat.support.RepeatSynchronizationManager
-
Getter for the current context.
- 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
- getCount() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextCounter
- getCount(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
-
Extension point for subclasses.
- getCounter() - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy.CountingBatchContext
- 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
- getCurrentItemCount() - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
Returns the current item count.
- 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.
- getDataSource() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Public getter for the data source.
- getDate(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Date
represented by the provided key. - getDate(String, Date) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Date
represented 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
Double
represented by the provided key. - getDouble(String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the Double represented by the provided key.
- getDouble(String, double) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the Double represented by the provided key with default value to return if key is not represented.
- getDouble(String, Double) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Double
represented by the provided key. - getEcDao() - Method in class org.springframework.batch.core.repository.explore.support.SimpleJobExplorer
-
Deprecated.
- getElementText() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- getEncoding() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get used encoding.
- 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
null
if the step is running. - getEntityManager() - Method in class org.springframework.batch.infrastructure.item.database.orm.AbstractJpaQueryProvider
-
Getter for
EntityManager
- getErrorMessage() - Static method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Retrieve the error message set by an instance of
CommandLineJobRunner
as it exits. - getErrors() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getException() - Method in class org.springframework.batch.infrastructure.item.SkipWrapper
-
Deprecated.Public getter for the exception.
- 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
. - getExceptionTranslator() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Creates a default SQLErrorCodeSQLExceptionTranslator for the specified DataSource if none is set.
- getExecutionContext() - Method in class org.springframework.batch.core.job.JobExecution
-
Returns the
ExecutionContext
for 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
ExecutionContext
for 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
- getExecutionContextKey(String) - Method in class org.springframework.batch.infrastructure.item.ItemStreamSupport
- 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)
- 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
- getExpectedCount() - Method in exception org.springframework.batch.infrastructure.item.file.transform.IncorrectTokenCountException
- getExpectedLength() - Method in exception org.springframework.batch.infrastructure.item.file.transform.IncorrectLineLengthException
-
Retrieves the expected length that was recorded for this exception.
- getExpecting() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- 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
SkipPolicy
and make it consistent with known fatal exceptions. - getFaultTolerantStepBuilder(String) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Creates a new
FaultTolerantStepBuilder
. - getFieldCount() - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- getFieldCount() - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Return the number of fields in this '
FieldSet
'. - 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<I>, Chunk<O>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- getFilterCount(Chunk<I>, Chunk<O>) - 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
- getFromClause() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- 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
- getGroupClause() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
-
The getter for the group by clause
- 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.repository.persistence.JobExecution
- getId() - Method in class org.springframework.batch.core.repository.persistence.JobInstance
- getId() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- 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.
- getIncrementer(String, String) - Method in interface org.springframework.batch.infrastructure.item.database.support.DataFieldMaxValueIncrementerFactory
-
Return the
DataFieldMaxValueIncrementer
for the provided database type. - getIncrementer(String, String) - Method in class org.springframework.batch.infrastructure.item.database.support.DefaultDataFieldMaxValueIncrementerFactory
- getIncrementerFactory() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the factory for creating
DataFieldMaxValueIncrementer
implementations used to increment entity IDs in meta-data tables. - getInput() - Method in exception org.springframework.batch.infrastructure.item.file.FlatFileParseException
- getInput() - Method in exception org.springframework.batch.infrastructure.item.file.NonTransientFlatFileException
- getInput() - Method in exception org.springframework.batch.infrastructure.item.file.transform.FlatFileFormatException
-
Retrieve the input that caused this exception.
- getInputChannelAttributeName() - Method in class org.springframework.batch.integration.config.xml.JobLaunchingGatewayParser
- getInstanceId() - Method in class org.springframework.batch.core.job.JobInstance
- getInt(String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the Integer represented by the provided key.
- getInt(String, int) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the Integer represented by the provided key with default value to return if key is not represented.
- 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.
- getItem() - Method in class org.springframework.batch.infrastructure.item.SkipWrapper
-
Deprecated.Public getter for the item.
- 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
ItemProcessor
for subclasses to use - getItemReader() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the
ItemReader
for subclasses to use. - getItems() - Method in class org.springframework.batch.infrastructure.item.Chunk
- getItems() - Method in class org.springframework.batch.integration.chunk.ChunkRequest
- getItemWriter() - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Protected getter for the
ItemWriter
for 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() - Method in class org.springframework.batch.integration.launch.JobLaunchRequest
- getJob() - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- getJob(String) - Method in interface org.springframework.batch.core.configuration.JobLocator
-
Deprecated.Locates a
Job
at runtime. - getJob(String) - Method in interface org.springframework.batch.core.configuration.JobRegistry
-
Returns a
Job
by 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
JobExecution
that 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
JobExecution
by 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
JobExecution
by its ID. - getJobExecution(long) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- getJobExecution(TestContext) - Method in class org.springframework.batch.test.JobScopeTestExecutionListener
-
Discover a
JobExecution
as a field in the test case or create one if none is available. - 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.
- getJobExecutionId() - Method in class org.springframework.batch.integration.partition.StepExecutionRequest
- getJobExecutionIncrementer() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the incrementer to be used to generate ids for new job executions.
- 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
JobExecution
s 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
JobInstance
s 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
JobInstance
objects 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
JobInstance
objects 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
id
of 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
JobInstance
identifier. - getJobInstanceId() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- getJobInstanceId() - Method in class org.springframework.batch.integration.chunk.ChunkRequest
- getJobInstanceId() - Method in class org.springframework.batch.integration.chunk.ChunkResponse
- 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.
- 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
JobInstance
values 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
JobInstance
values 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
. - getJobLauncher() - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- 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 job instances sorted alphabetically - i.e. jobs that have ever been executed.
- 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
JobInstance
names (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
JobInstance
names (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() - Method in class org.springframework.batch.integration.launch.JobLaunchRequest
- 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
JobParameters
instance. - 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
- getJobRepository() - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- 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.
- getKey(Object[]) - Method in class org.springframework.batch.infrastructure.item.jms.JmsMethodArgumentsKeyGenerator
-
If the message is a
Message
then returns the JMS message ID. - getKey(String) - Method in class org.springframework.batch.infrastructure.item.util.ExecutionContextUserSupport
-
Prefix the argument with
ExecutionContextUserSupport.getName()
to create a unique key that can be safely used to identify data stored inExecutionContext
. - 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
JobExecution
to 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
JobExecution
that 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
JobExecution
that 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
StepExecution
for a givenJobInstance
ordered 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
JobExecution
was 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
- getLineNumber() - Method in exception org.springframework.batch.infrastructure.item.file.FlatFileParseException
- getLineNumber() - Method in exception org.springframework.batch.infrastructure.item.file.NonTransientFlatFileException
- getLinesWritten() - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- 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
JobExecutionListener
interfaces. - getListener(Object) - Static method in class org.springframework.batch.core.listener.StepListenerFactoryBean
-
Convenience method to wrap any object and expose the appropriate
StepListener
interfaces. - 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
StepListener
s. - getLocalDate(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDate
represented by the provided key. - getLocalDate(String, LocalDate) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDate
represented by the provided key. - getLocalDateTime(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDateTime
represented by the provided key. - getLocalDateTime(String, LocalDateTime) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalDateTime
represented by the provided key. - getLocalTime(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalTime
represented by the provided key. - getLocalTime(String, LocalTime) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
LocalTime
represented by the provided key. - getLoginTimeout() - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- getLogWriter() - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- getLong(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Long
represented by the provided key. - getLong(String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the Long represented by the provided key.
- getLong(String, long) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the Long represented by the provided key with default value to return if key is not represented.
- getLong(String, Long) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
Long
represented by the provided key. - getMapping() - Method in class org.springframework.batch.core.launch.support.SimpleJvmExitCodeMapper
- getMax() - Method in class org.springframework.batch.infrastructure.item.file.transform.Range
- getMaxVarCharLength() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the length of long string columns in database.
- getMessage() - Method in class org.springframework.batch.integration.chunk.ChunkResponse
- 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
- getMethodInvokerByAnnotation(Class<? extends Annotation>, Object) - Static method in class org.springframework.batch.infrastructure.support.MethodInvokerUtils
-
Create a
MethodInvoker
for the method with the provided annotation on the provided object. - getMethodInvokerByAnnotation(Class<? extends Annotation>, Object, Class<?>...) - Static method in class org.springframework.batch.infrastructure.support.MethodInvokerUtils
-
Create a
MethodInvoker
from the delegate based on the annotationType. - getMethodInvokerByName(Object, String, boolean, Class<?>...) - Static method in class org.springframework.batch.infrastructure.support.MethodInvokerUtils
-
Create a
MethodInvoker
using the provided method name to search. - getMethodInvokerByName(String, Object, Class<?>...) - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- getMethodInvokerForInterface(Class<?>, String, Object, Class<?>...) - Static method in class org.springframework.batch.infrastructure.support.MethodInvokerUtils
-
Create a
MethodInvoker
using the provided interface, and method name from that interface. - getMethodInvokerForSingleArgument(Object) - Static method in class org.springframework.batch.infrastructure.support.MethodInvokerUtils
-
Create a
MethodInvoker
for the delegate from a single public method. - 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
- getMin() - Method in class org.springframework.batch.infrastructure.item.file.transform.Range
- getMode() - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Get the operating
MongoItemWriter.Mode
of the item writer. - 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.
- getName() - Method in class org.springframework.batch.infrastructure.item.ItemStreamSupport
-
Get the name of the component
- getName() - Method in class org.springframework.batch.infrastructure.item.util.ExecutionContextUserSupport
- getNames() - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- getNames() - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Accessor for the names of the fields.
- getNamespaceContext() - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- 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
StateTransition
instances from aParserContext
. - getNextElements(ParserContext, BeanDefinition, Element) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
- getNextResult() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
-
Get the next result if it is available (within the timeout specified in the gateway), otherwise do nothing.
- getNextResult(RepeatContext, RepeatCallback, RepeatInternalState) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Get the next completed result, possibly executing several callbacks until one finally finishes.
- getNextResult(RepeatContext, RepeatCallback, RepeatInternalState) - Method in class org.springframework.batch.infrastructure.repeat.support.TaskExecutorRepeatTemplate
-
Deprecated.Use the
TaskExecutorRepeatTemplate.setTaskExecutor(TaskExecutor)
to generate a result. - getObject() - Method in class org.springframework.batch.core.configuration.support.ClasspathXmlApplicationContextsFactoryBean
-
Deprecated.Create an
ApplicationContextFactory
from 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
Step
from 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
Step
from the configuration provided. - getObject() - Method in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- getObject() - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
-
Get a
PagingQueryProvider
instance using the provided properties and appropriate for the given database type. - getObject() - Method in class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
- 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
Step
instances. - getObjectType() - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
-
Always returns
PagingQueryProvider
. - getObjectType() - Method in class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
-
The type of object created by this factory.
- getObservationRegistry() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
-
Return the
ObservationRegistry
to 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
- getOutputState() - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- getPage() - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
-
The current page number.
- getPageSize() - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
-
The page size configured for this reader.
- getParameter(String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
- getParameterCount() - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
The number of parameters that are declared in the query
- getParameterCount() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- 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
- getParamTypesString(Class<?>...) - Static method in class org.springframework.batch.infrastructure.support.MethodInvokerUtils
-
Create a String representation of the array of parameter types.
- getParent() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- getParent() - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
If batches are nested, then the inner batch will be created with the outer one as a parent.
- getParentLogger() - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- 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.
- getPrefix(String) - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- getPrimaryKeys() - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Get the list of primary keys associated with the document being written.
- 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
- getProductName() - Method in enum class org.springframework.batch.infrastructure.support.DatabaseType
- getProperties() - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- getProperties() - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Construct name-value pairs from the field names and string values.
- 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
Properties
instance. - getProperty(String) - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- 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
- getRequest(Chunk<? extends T>) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- 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.
- getRootElementAttributes() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get attributes of the root element.
- getRootTagName() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get the tag name of the root element.
- getRootTagNamespace() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get the namespace of the root element.
- getRootTagNamespacePrefix() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get the namespace prefix of the root element.
- 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.
- getSelectClause() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- getSequence() - Method in class org.springframework.batch.integration.chunk.ChunkRequest
- getSequence() - Method in class org.springframework.batch.integration.chunk.ChunkResponse
- 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 org.springframework.batch.core.step.skip.SkipLimitExceededException
- getSkipListeners() - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.
- getSkips() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getSkipsSize() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getSortKeyPlaceHolder(String) - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
Returns either a String to be used as the named placeholder for a sort key value (based on the column name) or a ?
- getSortKeyPlaceHolder(String) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
-
The sort key placeholder will vary depending on whether named parameters or traditional placeholders are used in query strings.
- getSortKeys() - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
The sort keys.
- getSortKeys() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
-
A Map<String, Boolean> of sort columns as the key and boolean for ascending/descending (ascending = true).
- getSortKeysWithoutAliases() - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
The sort key (unique single column name) without alias.
- getSortKeysWithoutAliases() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- getSplitter() - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
- getSql() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
- getSql() - Method in class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
- getSql() - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
- getStandalone() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get used standalone document declaration.
- getStartedCount() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- getStartedCount() - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
Public access to a counter for the number of operations attempted.
- 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 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) - Method in class org.springframework.batch.integration.partition.BeanFactoryStepLocator
-
Look up a bean with the provided name of type
Step
. - getStep(String, String) - Method in interface org.springframework.batch.core.configuration.StepRegistry
-
Deprecated.Returns the
Step
of 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
- getStepContribution() - Method in class org.springframework.batch.integration.chunk.ChunkRequest
- getStepContribution() - Method in class org.springframework.batch.integration.chunk.ChunkResponse
- getStepContributions() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- getStepContributions() - Method in interface org.springframework.batch.integration.chunk.StepContributionSource
-
Get the currently available contributions and drain the source.
- 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
StepExecution
that 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
StepExecution
from its id. - getStepExecution(long) - Method in interface org.springframework.batch.core.repository.JobRepository
-
Retrieve a
StepExecution
by its ID. - getStepExecution(long) - Method in class org.springframework.batch.core.repository.support.ResourcelessJobRepository
-
Retrieve a
StepExecution
by 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
StepExecution
by its ID and parentJobExecution
ID. - 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)
- getStepExecution(TestContext) - Method in class org.springframework.batch.test.StepScopeTestExecutionListener
-
Discover a
StepExecution
as a field in the test case or create one if none is available. - 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
- getStepExecutionId() - Method in class org.springframework.batch.integration.partition.StepExecutionRequest
- getStepExecutionIncrementer() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the incrementer to be used to generate ids for new step executions.
- 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
StepExecution
s for a givenJobExecution
. - getStepExecutions(JobExecution) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao
-
Retrieve all
StepExecution
s for a givenJobExecution
. - getStepExecutions(JobExecution) - Method in interface org.springframework.batch.core.repository.dao.StepExecutionDao
-
Retrieve all
StepExecution
s 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
- getStepName() - Method in class org.springframework.batch.integration.partition.StepExecutionRequest
- 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.
- getStepRunner() - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.Convenient method for subclasses to grab a
StepRunner
for running steps by name. - 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
String
represented by the provided key. - getString(String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the String represented by the provided key.
- getString(String, String) - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Typesafe getter for the
String
represented by the provided key. - getString(String, String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Typesafe Getter for the String represented by the provided key with default value to return if key is not represented.
- getSuffix(int) - Method in interface org.springframework.batch.infrastructure.item.file.ResourceSuffixCreator
- getSuffix(int) - Method in class org.springframework.batch.infrastructure.item.file.SimpleResourceSuffixCreator
- 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.
- getSupportedIncrementerTypes() - Method in interface org.springframework.batch.infrastructure.item.database.support.DataFieldMaxValueIncrementerFactory
-
Returns the list of supported database incrementer types
- getSupportedIncrementerTypes() - Method in class org.springframework.batch.infrastructure.item.database.support.DefaultDataFieldMaxValueIncrementerFactory
- 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
- getTargetMethod() - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
- 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
- getTargetObject() - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
- getTaskExecutor() - Method in class org.springframework.batch.core.configuration.support.DefaultBatchConfiguration
-
Return the
TaskExecutor
to use in the job operator. - getTaskExecutor() - Method in class org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder
- 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
TaskExecutor
available 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
- getTemplate() - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Get the
MongoOperations
to be used to save items to be written. - getThrowables() - Method in interface org.springframework.batch.infrastructure.repeat.support.RepeatInternalState
-
Returns a mutable collection of exceptions that have occurred in the current repeat context.
- getThrowables() - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatInternalStateSupport
- 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
TransactionAttribute
for 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
- getUnclosedElements() - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnclosedElementCollectingEventWriter
- getUniqueJobParameters() - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- getUniqueJobParameters() - Method in class org.springframework.batch.test.JobOperatorTestUtils
- getUniqueJobParametersBuilder() - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- getUniqueJobParametersBuilder() - Method in class org.springframework.batch.test.JobOperatorTestUtils
- getUserData() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getValidateTransactionState() - Method in class org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration
-
Return the value of the
validateTransactionState
parameter. - getValidateTransactionState() - Method in class org.springframework.batch.core.configuration.support.MongoDefaultBatchConfiguration
-
Return the value of the
validateTransactionState
parameter. - getValueFromJob(JobExecution, String) - Static method in class org.springframework.batch.test.ExecutionContextTestUtils
- getValueFromStep(StepExecution, String) - Static method in class org.springframework.batch.test.ExecutionContextTestUtils
- getValueFromStepInJob(JobExecution, String, String) - Static method in class org.springframework.batch.test.ExecutionContextTestUtils
- getValues() - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- getValues() - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
- 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. - getVersion() - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get XML version.
- getWhereClause() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- 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
- getWrittenItems() - Method in class org.springframework.batch.infrastructure.item.support.ListItemWriter
- 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. - gridSize(int) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- GroupAwareJob - Class in org.springframework.batch.core.configuration.support
-
A
Job
that 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
Job
with the given group name and delegate. - groupClause - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- groupClause(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The SQL
GROUP BY
clause for a db specific @PagingQueryProvider
. - GsonJsonObjectMarshaller<T> - Class in org.springframework.batch.infrastructure.item.json
-
A json object marshaller that uses Google Gson to marshal an object into a json representation.
- GsonJsonObjectMarshaller() - Constructor for class org.springframework.batch.infrastructure.item.json.GsonJsonObjectMarshaller
- GsonJsonObjectMarshaller(Gson) - Constructor for class org.springframework.batch.infrastructure.item.json.GsonJsonObjectMarshaller
- GsonJsonObjectReader<T> - Class in org.springframework.batch.infrastructure.item.json
-
Implementation of
JsonObjectReader
based on Google Gson. - GsonJsonObjectReader(Gson, Class<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.json.GsonJsonObjectReader
- GsonJsonObjectReader(Class<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.json.GsonJsonObjectReader
-
Create a new
GsonJsonObjectReader
instance.
H
- H2 - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- H2PagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
H2 implementation of a
PagingQueryProvider
using database specific features. - H2PagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.H2PagingQueryProvider
- HANA - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- HanaPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
SAP HANA implementation of a
PagingQueryProvider
using database specific features. - HanaPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.HanaPagingQueryProvider
- 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
FlowExecutionStatus
stored. - 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
TaskExecutor
and 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
PartitionHandler
interface. - handle(StepExecutionSplitter, StepExecution) - Method in class org.springframework.batch.core.partition.support.AbstractPartitionHandler
- handle(ChunkRequest<S>) - Method in class org.springframework.batch.integration.chunk.ChunkProcessorChunkRequestHandler
- handle(ChunkRequest<T>) - Method in interface org.springframework.batch.integration.chunk.ChunkRequestHandler
-
Handle the chunk request, processing all the items and returning a response summarising the result.
- handle(StepExecutionRequest) - Method in class org.springframework.batch.integration.partition.StepExecutionRequestHandler
- handle(MailMessage, Exception) - Method in class org.springframework.batch.infrastructure.item.mail.DefaultMailErrorHandler
-
Wraps the input exception with a runtime
MailException
. - handle(MailMessage, Exception) - Method in interface org.springframework.batch.infrastructure.item.mail.MailErrorHandler
-
This method will be called for each message that failed sending in the chunk.
- 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.
- handleException(RepeatContext, Throwable) - Method in class org.springframework.batch.infrastructure.repeat.exception.CompositeExceptionHandler
-
Iterate over the handlers delegating the call to each in turn.
- handleException(RepeatContext, Throwable) - Method in class org.springframework.batch.infrastructure.repeat.exception.DefaultExceptionHandler
-
Re-throw the throwable.
- handleException(RepeatContext, Throwable) - Method in interface org.springframework.batch.infrastructure.repeat.exception.ExceptionHandler
-
Deal with a Throwable during a batch - decide whether it should be re-thrown in the first place.
- handleException(RepeatContext, Throwable) - Method in class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler
-
Classify the throwables and decide whether to rethrow based on the result.
- handleException(RepeatContext, Throwable) - Method in class org.springframework.batch.infrastructure.repeat.exception.RethrowOnThresholdExceptionHandler
-
Classify the throwables and decide whether to re-throw based on the result.
- handleException(RepeatContext, Throwable) - Method in class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
Rethrows only if the limit is breached for this context on the exception type specified.
- handleLine(String) - Method in interface org.springframework.batch.infrastructure.item.file.LineCallbackHandler
- handleListenersElement(Element, BeanDefinition, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.StepListenerParser
- handleRecord(LdapAttributes) - Method in interface org.springframework.batch.infrastructure.item.ldif.RecordCallbackHandler
-
Execute operations on the supplied record.
- handleRequestMessage(Message<?>) - Method in class org.springframework.batch.integration.launch.JobLaunchingGateway
-
Launches a Batch Job using the provided request
Message
. - 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.
- handleWarnings(Statement) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Throw a SQLWarningException if we're not ignoring warnings, else log the warnings (at debug level).
- hasAttribute(String) - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- 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
- hashCode() - Method in class org.springframework.batch.infrastructure.item.Chunk
- hashCode() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
- hashCode() - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- hashCode() - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- hashCode() - Method in class org.springframework.batch.infrastructure.support.SimpleMethodInvoker
- hashCode() - Method in class org.springframework.batch.test.context.BatchTestContextCustomizer
- hasMaxValue() - Method in class org.springframework.batch.infrastructure.item.file.transform.Range
- hasNames() - Method in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
- hasNames() - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- hasNames() - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Check if there are names defined for the fields.
- hasNext() - Method in class org.springframework.batch.infrastructure.item.Chunk.ChunkIterator
- hasNext() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- hasPartitionElement() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- hasTasklet() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- headerCallback(FlatFileHeaderCallback) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
A callback for header processing.
- headerCallback(FlatFileHeaderCallback) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
A callback for header processing.
- headerCallback(StaxWriterCallback) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
A
StaxWriterCallback
to provide any header elements - hint - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- hint - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- hint(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
JSON String telling MongoDB what index to use.
- hint(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
JSON String telling MongoDB what index to use.
- hintValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
A map of hint values to be set on the query.
- hintValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
A map of hint values to be set on the query.
- HippyMethodInvoker - Class in org.springframework.batch.infrastructure.item.adapter
-
A
MethodInvoker
that is a bit relaxed about its arguments. - HippyMethodInvoker() - Constructor for class org.springframework.batch.infrastructure.item.adapter.HippyMethodInvoker
- HSQL - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- HsqlPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
HSQLDB implementation of a
PagingQueryProvider
using database specific features. - HsqlPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.HsqlPagingQueryProvider
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
identifying
record component. - identifying() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
identifying
record component. - identifying() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
identifying
record component. - ignoreItemStream(boolean) - Method in class org.springframework.batch.infrastructure.item.support.builder.CompositeItemWriterBuilder
-
Establishes the policy whether to call the open, close, or update methods for the item writer delegates associated with the CompositeItemWriter.
- ignoreWarnings(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Set whether SQLWarnings should be ignored (only logged) or exception should be thrown.
- ignoreWarnings(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Indicates if SQL warnings should be ignored or if an exception should be thrown.
- includedFields(Integer...) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
A list of indices of the fields within a delimited file to be included
- IncorrectLineLengthException - Exception in org.springframework.batch.infrastructure.item.file.transform
-
Exception indicating that the line size expected is different from what is expected.
- IncorrectLineLengthException(int, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectLineLengthException
- IncorrectLineLengthException(int, int, String) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectLineLengthException
- IncorrectLineLengthException(String, int, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectLineLengthException
- IncorrectLineLengthException(String, int, int, String) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectLineLengthException
- IncorrectTokenCountException - Exception in org.springframework.batch.infrastructure.item.file.transform
-
Exception indicating that an incorrect number of tokens have been found while parsing a file.
- IncorrectTokenCountException(int, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectTokenCountException
- IncorrectTokenCountException(int, int, String) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectTokenCountException
- IncorrectTokenCountException(String, int, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectTokenCountException
- IncorrectTokenCountException(String, int, int, String) - Constructor for exception org.springframework.batch.infrastructure.item.file.transform.IncorrectTokenCountException
- increment() - Method in class org.springframework.batch.core.scope.context.SynchronizationManagerSupport
- increment() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextCounter
-
Increment by 1.
- increment() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
-
Used by clients to increment the started count.
- increment(int) - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextCounter
-
Increment the counter.
- incrementActual() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- 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.
- incrementExpected() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- 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.
- incrementRedelivered() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- 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.
- indexOf(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
Retrieve the index of where a specified column is located based on the
name
parameter. - InfrastructureRuntimeHints - Class in org.springframework.batch.infrastructure.aot
-
RuntimeHintsRegistrar
for Spring Batch infrastructure module. - InfrastructureRuntimeHints() - Constructor for class org.springframework.batch.infrastructure.aot.InfrastructureRuntimeHints
- init() - Method in class org.springframework.batch.core.configuration.xml.CoreNamespaceHandler
- init() - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
- init() - Method in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
-
afterPropertiesSet() hook
- init() - Method in class org.springframework.batch.infrastructure.item.redis.RedisItemWriter
- init() - Method in class org.springframework.batch.integration.config.xml.BatchIntegrationNamespaceHandler
- init(DataSource) - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
Initialize the query provider using the provided
DataSource
if necessary. - init(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
-
Check mandatory properties.
- initBinder(DataBinder) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Initialize a new binder instance.
- initializeConnection() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
- initializeUserData(Chunk<I>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- initializeUserData(Chunk<I>) - 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.
- initNamespaceContext(XMLEventWriter) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Inits the namespace context of the XMLEventWriter: rootTagNamespacePrefix for rootTagName any other xmlns namespace prefix declarations in the root element attributes
- InlineFlowParser - Class in org.springframework.batch.core.configuration.xml
- InlineFlowParser(String, String) - Constructor for class org.springframework.batch.core.configuration.xml.InlineFlowParser
-
Construct a
InlineFlowParser
with 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
- inputChannel(MessageChannel) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingWorkerBuilder
-
Set the input channel on which items sent by the manager are received.
- inputChannel(MessageChannel) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
Set the input channel on which replies from workers will be received.
- inputChannel(MessageChannel) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
-
Set the input channel on which step execution requests sent by the manager are received.
- inputChannel(PollableChannel) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
Set the input channel on which replies from workers will be received.
- INSERT - Enum constant in enum class org.springframework.batch.infrastructure.item.data.MongoItemWriter.Mode
-
Insert items into the target collection using
BulkOperations.insert(Object)
. - instantFormatter - Variable in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- IntArrayPropertyEditor - Class in org.springframework.batch.infrastructure.support
- IntArrayPropertyEditor() - Constructor for class org.springframework.batch.infrastructure.support.IntArrayPropertyEditor
- IntegrationRuntimeHints - Class in org.springframework.batch.integration.aot
-
AOT hints for Spring Batch integration module.
- IntegrationRuntimeHints() - Constructor for class org.springframework.batch.integration.aot.IntegrationRuntimeHints
- 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 in org.springframework.batch.core.job.parameters
-
Exception for
Job
to signal that someJobParameters
are invalid. - InvalidJobParametersException(String) - Constructor for exception org.springframework.batch.core.job.parameters.InvalidJobParametersException
-
Constructor that sets the message for the exception.
- InvocationTargetThrowableWrapper(Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator.InvocationTargetThrowableWrapper
- invoke(MethodInvocation) - Method in class org.springframework.batch.core.launch.support.RuntimeExceptionTranslator
-
Deprecated.
- invoke(MethodInvocation) - Method in class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- invoke(MethodInvocation) - Method in class org.springframework.batch.infrastructure.repeat.interceptor.RepeatOperationsInterceptor
-
Invoke the proceeding method call repeatedly, according to the properties of the injected
RepeatOperations
. - invokeDelegateMethod() - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
-
Invoker the target method with arguments set by
AbstractMethodInvokingDelegator.setArguments(Object[])
. - invokeDelegateMethodWithArgument(Object) - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
-
Invokes the target method with given argument.
- invokeDelegateMethodWithArguments(Object[]) - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
-
Invokes the target method with given arguments.
- invokeMethod(Object...) - Method in interface org.springframework.batch.infrastructure.support.MethodInvoker
- invokeMethod(Object...) - Method in class org.springframework.batch.infrastructure.support.SimpleMethodInvoker
- 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.
- isBusy() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- isCloseSuppressionActive(Connection) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
-
Return the status of close suppression being activated for a given
Connection
- isComment(String) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- isComplete() - Method in class org.springframework.batch.core.scope.context.ChunkContext
- isComplete() - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy.SimpleTerminationContext
- isComplete() - Method in class org.springframework.batch.infrastructure.repeat.policy.TimeoutTerminationPolicy.TimeoutBatchContext
- isComplete(Chunk<I>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- isComplete(Chunk<I>) - 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) - Method in interface org.springframework.batch.infrastructure.repeat.CompletionPolicy
-
Allow policy to signal completion according to internal state, without having to wait for the callback to complete.
- isComplete(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompletionPolicySupport
-
Always true.
- isComplete(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompositeCompletionPolicy
-
This policy is complete if any of the composed policies is complete.
- isComplete(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
- isComplete(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.DefaultResultCompletionPolicy
-
Always false.
- isComplete(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
-
Terminate if the chunk size has been reached.
- isComplete(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.TimeoutTerminationPolicy
-
Check the timeout and complete gracefully if it has expires.
- isComplete(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Delegate to
CompletionPolicy
. - isComplete(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.
- isComplete(RepeatContext, RepeatStatus) - Method in interface org.springframework.batch.infrastructure.repeat.CompletionPolicy
-
Determine whether a batch is complete given the latest result from the callback.
- isComplete(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompletionPolicySupport
-
If exit status is not continuable return
true
, otherwise delegate toCompletionPolicySupport.isComplete(RepeatContext)
. - isComplete(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompositeCompletionPolicy
-
This policy is complete if any of the composed policies is complete.
- isComplete(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.policy.DefaultResultCompletionPolicy
-
True if the result is null, or a
RepeatStatus
indicating completion. - isComplete(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
-
Terminate if the chunk size has been reached, or the result is null.
- isComplete(RepeatContext, RepeatStatus) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Delegate to the
CompletionPolicy
. - isCompleteOnly() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- isCompleteOnly() - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
Public accessor for the complete flag.
- isContinuable() - Method in enum class org.springframework.batch.infrastructure.repeat.RepeatStatus
- 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.
- isDirty() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Indicates if context has been changed with a "put" operation since the dirty flag was last cleared.
- isEagerInit() - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
- isEmpty() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
- isEmpty() - Method in class org.springframework.batch.infrastructure.item.Chunk
- isEmpty() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Indicates whether or not the context is empty.
- isEmpty() - Method in class org.springframework.batch.infrastructure.repeat.support.ResultHolderResultQueue
-
Deprecated.
- isEmpty() - Method in class org.springframework.batch.infrastructure.repeat.support.ThrottleLimitResultQueue
-
Deprecated.
- 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.
- isEnd() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- isEndOfRecord(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.JsonRecordSeparatorPolicy
-
True if the line can be parsed to a JSON object.
- isEndOfRecord(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.DefaultRecordSeparatorPolicy
-
Return true if the line does not have unterminated quotes (delimited by
"
), and does not end with a continuation marker (\
). - isEndOfRecord(String) - Method in interface org.springframework.batch.infrastructure.item.file.separator.RecordSeparatorPolicy
-
Signal the end of a record based on the content of the current record.
- isEndOfRecord(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.SimpleRecordSeparatorPolicy
-
Always returns true.
- isEndOfRecord(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.SuffixRecordSeparatorPolicy
-
Return true if the line ends with the specified substring.
- 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
State
is 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
- isExistingTransaction(Object) - Method in class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- isExpecting() - Method in class org.springframework.batch.infrastructure.repeat.support.ResultHolderResultQueue
-
Deprecated.
- isExpecting() - Method in class org.springframework.batch.infrastructure.repeat.support.ThrottleLimitResultQueue
-
Deprecated.
- 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
- isFragmentRootElementName(QName) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- isGreaterThan(BatchStatus) - Method in enum class org.springframework.batch.core.BatchStatus
- isInitialized() - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- 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 fornull
result 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.
- isNew(Object[]) - Method in class org.springframework.batch.infrastructure.item.jms.JmsNewMethodArgumentsIdentifier
-
If any of the arguments is a message, check the JMS re-delivered flag and return it, otherwise return false to be on the safe side.
- 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
- isQuoteCharacter(char) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Is the supplied character a quote character?
- 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.
- isRedelivered() - Method in class org.springframework.batch.integration.chunk.ChunkResponse
- 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
JobExecution
indicates that it is running. - isSaveState() - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
-
The flag that determines whether to save internal state for restarts.
- isSaveState() - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
The flag that determines whether to save internal state for restarts.
- 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
Step
should 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.
- isSingleton() - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
-
Always returns true.
- isSingleton() - Method in class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
-
Optimization for the bean factory (always returns true).
- isStop() - Method in class org.springframework.batch.core.job.flow.FlowExecutionStatus
- isStopping() - Method in class org.springframework.batch.core.job.JobExecution
-
Test if this
JobExecution
indicates that it has been signalled to stop. - isStrict() - Method in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
-
Provides access to the strict flag for subclasses if needed.
- isSuccessful() - Method in class org.springframework.batch.integration.chunk.ChunkResponse
- isSupportedIncrementerType(String) - Method in interface org.springframework.batch.infrastructure.item.database.support.DataFieldMaxValueIncrementerFactory
-
Returns boolean indicated whether or not the provided string is supported by this factory.
- isSupportedIncrementerType(String) - Method in class org.springframework.batch.infrastructure.item.database.support.DefaultDataFieldMaxValueIncrementerFactory
- isTerminateOnly() - Method in class org.springframework.batch.core.repository.persistence.StepExecution
- isTerminateOnly() - Method in class org.springframework.batch.core.step.StepExecution
- isTerminateOnly() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- isTerminateOnly() - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
Public accessor for the termination flag.
- 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.
- isUseSharedExtendedConnection() - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
- isUsingNamedParameters() - Method in interface org.springframework.batch.infrastructure.item.database.PagingQueryProvider
-
Indicate whether the generated queries use named parameter syntax.
- isUsingNamedParameters() - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- isWrapperFor(Class<?>) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
-
Performs only a 'shallow' non-recursive check of self's and delegate's class to retain Java 5 compatibility.
- ITEM_BINDING_VARIABLE_NAME - Static variable in class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
- itemBindingVariableName(String) - Method in class org.springframework.batch.infrastructure.item.support.builder.ScriptItemProcessorBuilder
-
Provides the ability to change the key name that scripts use to obtain the current item to process if the variable represented by:
ScriptItemProcessor.ITEM_BINDING_VARIABLE_NAME
is not suitable ("item"). - itemCount - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkWriteEvent
- ItemCountAware - Interface in org.springframework.batch.infrastructure.item
-
Marker interface indicating that an item should have the item count set on it.
- itemCountLimitPerResource(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
-
After this limit is exceeded the next chunk will be written into newly created resource.
- itemKeyMapper - Variable in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
- itemKeyMapper(Converter<V, K>) - Method in class org.springframework.batch.infrastructure.item.redis.builder.RedisItemWriterBuilder
-
Set the
Converter
to use to derive the key from the item. - itemKeyMapper(Converter<V, K>) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemWriterBuilder
-
Set the
Converter
to use to derive the key from the item. - 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
, andItemWriteListener
interfaces. - ItemListenerSupport() - Constructor for class org.springframework.batch.core.listener.ItemListenerSupport
- itemPreparedStatementSetter - Variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- itemPreparedStatementSetter(ItemPreparedStatementSetter<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
Configures a
ItemPreparedStatementSetter
for use by the writer. - ItemPreparedStatementSetter<T> - Interface in org.springframework.batch.infrastructure.item.database
-
A convenient strategy for SQL updates, acting effectively as the inverse of
RowMapper
. - 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.
- itemProcessor(ItemProcessor<I, O>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingWorkerBuilder
-
Set the
ItemProcessor
to use to process items sent by the manager step. - ItemProcessor<I,
O> - Interface in org.springframework.batch.infrastructure.item -
Interface for item transformation.
- ItemProcessorAdapter<I,
O> - Class in org.springframework.batch.infrastructure.item.adapter -
Invokes a custom method on a delegate plain old Java object which itself processes an item.
- ItemProcessorAdapter() - Constructor for class org.springframework.batch.infrastructure.item.adapter.ItemProcessorAdapter
- 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.
- ItemReader<T> - Interface in org.springframework.batch.infrastructure.item
-
Strategy interface for providing the data.
- ItemReaderAdapter<T> - Class in org.springframework.batch.infrastructure.item.adapter
-
Invokes a custom method on a delegate plain old Java object which itself provides an item.
- ItemReaderAdapter() - Constructor for class org.springframework.batch.infrastructure.item.adapter.ItemReaderAdapter
- ItemReaderException - Exception in org.springframework.batch.infrastructure.item
-
A base exception class that all exceptions thrown from an
ItemReader
extend. - ItemReaderException(String) - Constructor for exception org.springframework.batch.infrastructure.item.ItemReaderException
-
Create a new
ItemReaderException
based on a message. - ItemReaderException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.ItemReaderException
-
Create a new
ItemReaderException
based on a message and another exception. - 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
- itemSqlParameterSourceProvider - Variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- itemSqlParameterSourceProvider(ItemSqlParameterSourceProvider<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
Configures a
ItemSqlParameterSourceProvider
for use by the writer. - ItemSqlParameterSourceProvider<T> - Interface in org.springframework.batch.infrastructure.item.database
-
A convenient strategy for providing SqlParameterSource for named parameter SQL updates.
- ItemStream - Interface in org.springframework.batch.infrastructure.item
-
Marker interface defining a contract for periodically storing state and restoring from that state should an error occur.
- ItemStreamException - Exception in org.springframework.batch.infrastructure.item
-
Exception representing any errors encountered while processing a stream.
- ItemStreamException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.ItemStreamException
-
Constructs a new instance with a message and nested exception.
- ItemStreamException(String) - Constructor for exception org.springframework.batch.infrastructure.item.ItemStreamException
- ItemStreamException(Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.ItemStreamException
-
Constructs a new instance with a nested exception and empty message.
- ItemStreamReader<T> - Interface in org.springframework.batch.infrastructure.item
-
Convenience interface that combines
ItemStream
andItemReader
. - ItemStreamSupport - Class in org.springframework.batch.infrastructure.item
-
Support class for
ItemStream
s. - ItemStreamSupport() - Constructor for class org.springframework.batch.infrastructure.item.ItemStreamSupport
- ItemStreamWriter<T> - Interface in org.springframework.batch.infrastructure.item
-
Convenience interface that combines
ItemStream
andItemWriter
. - itemType - Variable in class org.springframework.batch.infrastructure.item.jms.builder.JmsItemReaderBuilder
- itemType - Variable in class org.springframework.batch.infrastructure.item.jms.JmsItemReader
- itemType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.amqp.builder.AmqpItemReaderBuilder
-
Establish the itemType for the reader.
- itemType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.jms.builder.JmsItemReaderBuilder
-
Set the expected type of incoming message payloads.
- ItemWriteListener<S> - Interface in org.springframework.batch.core.listener
-
Listener interface for the writing of items.
- itemWriter(ItemWriter<O>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingWorkerBuilder
-
Set the
ItemWriter
to use to write items sent by the manager step. - ItemWriter<T> - Interface in org.springframework.batch.infrastructure.item
-
Basic interface for generic output operations.
- ItemWriterAdapter<T> - Class in org.springframework.batch.infrastructure.item.adapter
-
Delegates item processing to a custom method - passes the item as an argument for the delegate method.
- ItemWriterAdapter() - Constructor for class org.springframework.batch.infrastructure.item.adapter.ItemWriterAdapter
- ItemWriterException - Exception in org.springframework.batch.infrastructure.item
-
A base exception class that all exceptions thrown from an
ItemWriter
extend. - ItemWriterException(String) - Constructor for exception org.springframework.batch.infrastructure.item.ItemWriterException
-
Create a new
ItemWriterException
based on a message. - ItemWriterException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.ItemWriterException
-
Create a new
ItemWriterException
based on a message and another exception. - iterate(RepeatCallback) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatOperations
-
Execute the callback repeatedly, until a decision can be made to complete.
- iterate(RepeatCallback) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Execute the batch callback until the completion policy decides that we are finished.
- iterator() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
- iterator() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Get an unmodifiable iterator for the underlying items.
- IteratorItemReader<T> - Class in org.springframework.batch.infrastructure.item.support
- IteratorItemReader(Iterable<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.IteratorItemReader
-
Construct a new reader from this iterable (could be a collection), by extracting an instance of
Iterator
from it. - IteratorItemReader(Iterator<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.IteratorItemReader
-
Construct a new reader from this iterator directly.
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
ExecutionContextSerializer
that 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
JacksonExecutionContextStringSerializer
with 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
JacksonExecutionContextStringSerializer
with a customJsonMapper
. - JacksonJsonObjectMarshaller<T> - Class in org.springframework.batch.infrastructure.item.json
-
A json object marshaller that uses Jackson 3 to marshal an object into a json representation.
- JacksonJsonObjectMarshaller() - Constructor for class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectMarshaller
- JacksonJsonObjectMarshaller(JsonMapper) - Constructor for class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectMarshaller
- JacksonJsonObjectReader<T> - Class in org.springframework.batch.infrastructure.item.json
-
Implementation of
JsonObjectReader
based on Jackson 3. - JacksonJsonObjectReader(Class<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectReader
-
Create a new
JacksonJsonObjectReader
instance. - JacksonJsonObjectReader(JsonMapper, Class<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectReader
- JdbcBatchItemWriter<T> - Class in org.springframework.batch.infrastructure.item.database
-
ItemWriter
that uses the batching features fromNamedParameterJdbcTemplate
to execute a batch of statements for all items provided. - JdbcBatchItemWriter() - Constructor for class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- JdbcBatchItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.database.builder
-
A builder implementation for the
JdbcBatchItemWriter
. - JdbcBatchItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
- JdbcCursorItemReader<T> - Class in org.springframework.batch.infrastructure.item.database
-
Simple item reader implementation that opens a JDBC cursor and continually retrieves the next row in the ResultSet.
- JdbcCursorItemReader(DataSource, String, RowMapper<T>) - Constructor for class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
-
Create a new
JdbcCursorItemReader
instance. - JdbcCursorItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.database.builder
-
Builder for the
JdbcCursorItemReader
- JdbcCursorItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
- JdbcDefaultBatchConfiguration - Class in org.springframework.batch.core.configuration.support
-
Base
Configuration
class 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
FactoryBean
that automates the creation of aSimpleJobRepository
using 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
JdbcOperations
to use in the job repository. - JdbcPagingItemReader<T> - Class in org.springframework.batch.infrastructure.item.database
-
ItemReader
for reading database records using JDBC in a paging fashion. - JdbcPagingItemReader(DataSource, PagingQueryProvider) - Constructor for class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
-
Create a new
JdbcPagingItemReader
instance. - JdbcPagingItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.database.builder
-
This is a builder for the
JdbcPagingItemReader
. - JdbcPagingItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- JdbcParameterUtils - Class in org.springframework.batch.infrastructure.item.database
-
Helper methods for SQL statement parameter parsing.
- 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'sDataFieldMaxValueIncrementer
abstraction) to create all primary keys before inserting a new row. - JdbcStepExecutionDao() - Constructor for class org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao
- JmsItemReader<T> - Class in org.springframework.batch.infrastructure.item.jms
-
An
ItemReader
for JMS using aJmsTemplate
. - JmsItemReader(JmsOperations) - Constructor for class org.springframework.batch.infrastructure.item.jms.JmsItemReader
-
Create a new
JmsItemReader
with the providedJmsOperations
. - JmsItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.jms.builder
-
Creates a fully qualified JmsItemReader.
- JmsItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.jms.builder.JmsItemReaderBuilder
- JmsItemWriter<T> - Class in org.springframework.batch.infrastructure.item.jms
-
An
ItemWriter
for JMS using aJmsTemplate
. - JmsItemWriter(JmsOperations) - Constructor for class org.springframework.batch.infrastructure.item.jms.JmsItemWriter
-
Create a new
JmsItemWriter
with the providedJmsOperations
. - JmsItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.jms.builder
-
Creates a fully qualified JmsItemWriter.
- JmsItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.jms.builder.JmsItemWriterBuilder
- JmsMethodArgumentsKeyGenerator - Class in org.springframework.batch.infrastructure.item.jms
-
A
MethodArgumentsKeyGenerator
for JMS - JmsMethodArgumentsKeyGenerator() - Constructor for class org.springframework.batch.infrastructure.item.jms.JmsMethodArgumentsKeyGenerator
- JmsMethodInvocationRecoverer<T> - Class in org.springframework.batch.infrastructure.item.jms
- JmsMethodInvocationRecoverer(JmsOperations) - Constructor for class org.springframework.batch.infrastructure.item.jms.JmsMethodInvocationRecoverer
-
Create a new
JmsMethodInvocationRecoverer
with the providedJmsOperations
. - JmsNewMethodArgumentsIdentifier<T> - Class in org.springframework.batch.infrastructure.item.jms
-
A
NewMethodArgumentsIdentifier
for JMS that looks for a message in the arguments and checks its delivery status. - JmsNewMethodArgumentsIdentifier() - Constructor for class org.springframework.batch.infrastructure.item.jms.JmsNewMethodArgumentsIdentifier
- JmsRedeliveredExtractor - Class in org.springframework.batch.integration.chunk
- JmsRedeliveredExtractor() - Constructor for class org.springframework.batch.integration.chunk.JmsRedeliveredExtractor
- jmsTemplate - Variable in class org.springframework.batch.infrastructure.item.jms.builder.JmsItemReaderBuilder
- jmsTemplate - Variable in class org.springframework.batch.infrastructure.item.jms.JmsItemReader
- jmsTemplate(JmsOperations) - Method in class org.springframework.batch.infrastructure.item.jms.builder.JmsItemReaderBuilder
-
Establish the JMS template that will be used by the JmsItemReader.
- jmsTemplate(JmsOperations) - Method in class org.springframework.batch.infrastructure.item.jms.builder.JmsItemWriterBuilder
-
Establish the JMS template that will be used by the
JmsItemWriter
. - job - Variable in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- 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(Job) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- Job - Interface in org.springframework.batch.core.job
-
Batch domain object representing a job.
- JOB_NAME - Static variable in class org.springframework.batch.test.JobOperatorTestUtils
-
Name of the single-step job surrounding steps when tested individually
- JOB_NAME - Static variable in class org.springframework.batch.test.StepRunner
-
Deprecated.Name of the single-step job surrounding steps when tested individually
- 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 in org.springframework.batch.core.job.builder
- JobBuilderException(Exception) - Constructor for exception org.springframework.batch.core.job.builder.JobBuilderException
- JobBuilderHelper<B extends 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
JobExecution
and 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
JobExecution
instance. - JobExecutionAlreadyRunningException - Exception in org.springframework.batch.core.launch
- JobExecutionAlreadyRunningException(String) - Constructor for exception org.springframework.batch.core.launch.JobExecutionAlreadyRunningException
- JobExecutionAlreadyRunningException(String, Throwable) - Constructor for exception 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 in org.springframework.batch.core.job
-
Root of exception hierarchy for checked exceptions in job and step execution.
- JobExecutionException(String) - Constructor for exception org.springframework.batch.core.job.JobExecutionException
-
Construct a
JobExecutionException
with a generic message. - JobExecutionException(String, Throwable) - Constructor for exception org.springframework.batch.core.job.JobExecutionException
-
Construct a
JobExecutionException
with 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
- 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 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
JobRestartException
with a specific message. Scheduled for removal in 6.2. - JobExecutionNotFailedException(String) - Constructor for exception org.springframework.batch.core.launch.JobExecutionNotFailedException
-
Deprecated.Create an exception with the given message.
- JobExecutionNotFailedException(String, Throwable) - Constructor for exception org.springframework.batch.core.launch.JobExecutionNotFailedException
-
Deprecated.
- JobExecutionNotRunningException - Exception 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 org.springframework.batch.core.launch.JobExecutionNotRunningException
-
Create a
JobExecutionNotRunningException
with a message. - JobExecutionNotStoppedException - Exception 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 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
FlowExecutor
for 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 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 org.springframework.batch.core.launch.JobInstanceAlreadyCompleteException
- JobInstanceAlreadyCompleteException(String, Throwable) - Constructor for exception org.springframework.batch.core.launch.JobInstanceAlreadyCompleteException
- JobInstanceAlreadyExistsException - Exception 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 org.springframework.batch.core.launch.JobInstanceAlreadyExistsException
-
Deprecated.Create an exception with the given message.
- JobInstanceAlreadyExistsException(String, Throwable) - Constructor for exception 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
- 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 in org.springframework.batch.core.job
-
Exception to indicate the job has been interrupted.
- JobInterruptedException(String) - Constructor for exception org.springframework.batch.core.job.JobInterruptedException
-
Constructor that sets the message for the exception.
- JobInterruptedException(String, BatchStatus) - Constructor for exception 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
JobInstance
objects. - 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 - Variable in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- 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. - JobLauncherTestUtils - Class in org.springframework.batch.test
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobOperatorTestUtils
. Scheduled for removal in 6.2 or later. - JobLauncherTestUtils() - Constructor for class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- 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
- JobLaunchingGateway - Class in org.springframework.batch.integration.launch
-
The
JobLaunchingGateway
is used to launch Batch Jobs. - JobLaunchingGateway(JobOperator) - Constructor for class org.springframework.batch.integration.launch.JobLaunchingGateway
-
Constructor taking a
JobOperator
as parameter. - JobLaunchingGatewayParser - Class in org.springframework.batch.integration.config.xml
-
The parser for the Job-Launching Gateway, which will instantiate a
JobLaunchingGatewayParser
. - JobLaunchingGatewayParser() - Constructor for class org.springframework.batch.integration.config.xml.JobLaunchingGatewayParser
- JobLaunchingMessageHandler - Class in org.springframework.batch.integration.launch
-
Message handler which uses strategies to convert a Message into a job and a set of job parameters
- JobLaunchingMessageHandler(JobOperator) - Constructor for class org.springframework.batch.integration.launch.JobLaunchingMessageHandler
- JobLaunchRequest - Class in org.springframework.batch.integration.launch
-
Encapsulation of a
Job
and itsJobParameters
forming a request for a job to be launched. - JobLaunchRequest(Job, JobParameters) - Constructor for class org.springframework.batch.integration.launch.JobLaunchRequest
- JobLaunchRequestHandler - Interface in org.springframework.batch.integration.launch
-
Interface for handling a
JobLaunchRequest
and returning aJobExecution
. - JobListenerFactoryBean - Class in org.springframework.batch.core.listener
-
This
AbstractListenerFactoryBean
implementation 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
JobExecutionListener
meta 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 - Variable in class org.springframework.batch.test.JobOperatorTestUtils
- 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
- JobOperatorTestUtils - Class in org.springframework.batch.test
-
Utility class for testing batch jobs.
- JobOperatorTestUtils(JobOperator, JobRepository) - Constructor for class org.springframework.batch.test.JobOperatorTestUtils
-
Create a new instance of
JobOperatorTestUtils
with the provided job repository and job operator. - 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<T>) - Constructor for record class org.springframework.batch.core.job.parameters.JobParameter
-
Create a new identifying
JobParameter
. - JobParameter(String, T, Class<T>, 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
JobParameter
record 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
JobParameterDefinition
record class. - JobParameterExecutionContextCopyListener - Class in org.springframework.batch.core.listener
-
This class can be used to automatically copy items from the
JobParameters
to theStep
ExecutionContext
. - 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
JobParameters
instance. - JobParameters(Set<JobParameter<?>>) - Constructor for record class org.springframework.batch.core.job.parameters.JobParameters
-
Create a new
JobParameters
instance. - 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 in org.springframework.batch.core.converter
-
Exception to report an error when converting job parameters.
- JobParametersConversionException(String) - Constructor for exception org.springframework.batch.core.converter.JobParametersConversionException
-
Create a new
JobParametersConversionException
. - JobParametersConversionException(String, Throwable) - Constructor for exception 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
JobParameters
instances. - 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
StepExecution
intoJobParameters
. - JobParametersIncrementer - Interface in org.springframework.batch.core.job.parameters
-
Interface for obtaining the next
JobParameters
object in a sequence. - JobParametersNotFoundException - Exception 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 org.springframework.batch.core.launch.JobParametersNotFoundException
-
Deprecated.Create an exception with the given message.
- JobParametersNotFoundException(String, Throwable) - Constructor for exception org.springframework.batch.core.launch.JobParametersNotFoundException
-
Deprecated.
- JobParametersValidator - Interface in org.springframework.batch.core.job.parameters
-
Strategy interface for a
Job
to 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
FactoryBean
is used by the batch namespace parser to createFlowJob
objects. - 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
MapJobRegistry
as a bean, and it will automatically register allJob
beans 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 - Variable in class org.springframework.batch.test.JobLauncherTestUtils
-
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
- JobRepositoryTestUtils - Class in org.springframework.batch.test
-
Convenience class for creating and removing
JobExecution
instances from a database. - JobRepositoryTestUtils(JobRepository) - Constructor for class org.springframework.batch.test.JobRepositoryTestUtils
-
Create a
JobRepositoryTestUtils
with all its mandatory properties. - JobRestartException - Exception in org.springframework.batch.core.launch
-
An exception indicating an illegal attempt to restart a job.
- JobRestartException(String) - Constructor for exception org.springframework.batch.core.launch.JobRestartException
- JobRestartException(String, Throwable) - Constructor for exception 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
Job
is not job scope aware (i.e. not the ones provided by the framework). - JobScopeManager() - Constructor for class org.springframework.batch.core.scope.context.JobScopeManager
- JobScopeTestExecutionListener - Class in org.springframework.batch.test
-
A
TestExecutionListener
that sets up job-scope context for dependency injection into unit tests. - JobScopeTestExecutionListener() - Constructor for class org.springframework.batch.test.JobScopeTestExecutionListener
- JobScopeTestUtils - Class in org.springframework.batch.test
-
Utility class for creating and manipulating
JobScope
in unit tests. - 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
JobStep
with the given job repository. - JobStepBuilder - Class in org.springframework.batch.core.step.builder
-
A step builder for
JobStep
instances. - 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
- JpaCursorItemReader<T> - Class in org.springframework.batch.infrastructure.item.database
-
ItemStreamReader
implementation based on JPAQuery.getResultStream()
. - JpaCursorItemReader(EntityManagerFactory) - Constructor for class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
-
Create a new
JpaCursorItemReader
. - JpaCursorItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.database.builder
-
Builder for
JpaCursorItemReader
. - JpaCursorItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
- JpaItemWriter<T> - Class in org.springframework.batch.infrastructure.item.database
-
ItemWriter
that is using a JPA EntityManagerFactory to merge any Entities that aren't part of the persistence context. - JpaItemWriter(EntityManagerFactory) - Constructor for class org.springframework.batch.infrastructure.item.database.JpaItemWriter
-
Create a new
JpaItemWriter
instance. - JpaItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.database.builder
-
A builder for the
JpaItemWriter
. - JpaItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.database.builder.JpaItemWriterBuilder
- JpaNamedQueryProvider<E> - Class in org.springframework.batch.infrastructure.item.database.orm
-
This query provider creates JPA named
Query
s. - JpaNamedQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.orm.JpaNamedQueryProvider
- JpaNativeQueryProvider<E> - Class in org.springframework.batch.infrastructure.item.database.orm
-
This query provider creates JPA
queries
from injected native SQL queries. - JpaNativeQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.orm.JpaNativeQueryProvider
- JpaPagingItemReader<T> - Class in org.springframework.batch.infrastructure.item.database
-
ItemReader
for reading database records built on top of JPA. - JpaPagingItemReader(EntityManagerFactory) - Constructor for class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
-
Create a new
JpaPagingItemReader
instance. - JpaPagingItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.database.builder
-
Creates a fully qualified JpaPagingItemReader.
- JpaPagingItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
- JpaQueryProvider - Interface in org.springframework.batch.infrastructure.item.database.orm
-
Interface defining the functionality to be provided for generating queries for use with JPA
ItemReader
s or other custom-built artifacts. - JsonFileItemWriter<T> - Class in org.springframework.batch.infrastructure.item.json
-
Item writer that writes data in json format to an output file.
- JsonFileItemWriter(WritableResource, JsonObjectMarshaller<T>) - Constructor for class org.springframework.batch.infrastructure.item.json.JsonFileItemWriter
-
Create a new
JsonFileItemWriter
instance. - JsonFileItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.json.builder
-
Builder for
JsonFileItemWriter
. - JsonFileItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
- JsonItemReader<T> - Class in org.springframework.batch.infrastructure.item.json
-
ItemStreamReader
implementation that reads Json objects from aResource
having the following format: - JsonItemReader(Resource, JsonObjectReader<T>) - Constructor for class org.springframework.batch.infrastructure.item.json.JsonItemReader
-
Create a new
JsonItemReader
instance. - JsonItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.json.builder
-
A builder for
JsonItemReader
. - JsonItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
- JsonJobParametersConverter - Class in org.springframework.batch.core.converter
-
Converter for
JobParameters
instances 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
JsonJobParametersConverter
with a defaultJsonMapper
. - JsonJobParametersConverter(JsonMapper) - Constructor for class org.springframework.batch.core.converter.JsonJobParametersConverter
-
Create a new
JsonJobParametersConverter
with a customJsonMapper
. - JsonJobParametersConverter.JobParameterDefinition - Record Class in org.springframework.batch.core.converter
- JsonLineMapper - Class in org.springframework.batch.infrastructure.item.file.mapping
-
Interpret a line as a JSON object and parse it up to a Map.
- JsonLineMapper() - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.JsonLineMapper
-
Create a new
JsonLineMapper
with a defaultJsonMapper
. - JsonLineMapper(JsonMapper) - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.JsonLineMapper
-
Create a new
JsonLineMapper
with the providedJsonMapper
. - jsonObjectMarshaller(JsonObjectMarshaller<T>) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
Set the
JsonObjectMarshaller
to use to marshal objects to json. - JsonObjectMarshaller<T> - Interface in org.springframework.batch.infrastructure.item.json
-
Strategy interface to marshal an object into a json representation.
- jsonObjectReader(JsonObjectReader<T>) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
Set the
JsonObjectReader
to use to read and map Json objects to domain objects. - JsonObjectReader<T> - Interface in org.springframework.batch.infrastructure.item.json
-
Strategy interface for Json readers.
- jsonQuery - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- jsonQuery(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
A JSON formatted MongoDB jsonQuery.
- jsonQuery(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
A JSON formatted MongoDB jsonQuery.
- JsonRecordSeparatorPolicy - Class in org.springframework.batch.infrastructure.item.file.separator
-
JSON-based record separator.
- JsonRecordSeparatorPolicy() - Constructor for class org.springframework.batch.infrastructure.item.file.separator.JsonRecordSeparatorPolicy
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Use
ResultSet.absolute(int)
if possible, otherwise scroll by callingResultSet.next()
. - jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.json.GsonJsonObjectReader
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectReader
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.json.JsonItemReader
- jumpToItem(int) - Method in interface org.springframework.batch.infrastructure.item.json.JsonObjectReader
-
Move to the given item index.
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
Move to the given item index.
- jumpToItem(int) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- 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
CommandRunner
interface that calls the standardRuntime.exec(java.lang.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
- KafkaItemReader<K,
V> - Class in org.springframework.batch.infrastructure.item.kafka -
An
ItemReader
implementation for Apache Kafka. - KafkaItemReader(Properties, String, Integer...) - Constructor for class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
-
Create a new
KafkaItemReader
. - KafkaItemReader(Properties, String, List<Integer>) - Constructor for class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
-
Create a new
KafkaItemReader
. - KafkaItemReaderBuilder<K,
V> - Class in org.springframework.batch.infrastructure.item.kafka.builder -
A builder implementation for the
KafkaItemReader
. - KafkaItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
- KafkaItemWriter<K,
T> - Class in org.springframework.batch.infrastructure.item.kafka -
An
ItemWriter
implementation for Apache Kafka using aKafkaTemplate
with default topic configured. - KafkaItemWriter(Converter<T, K>, KafkaTemplate<K, T>) - Constructor for class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
-
Create a new
KafkaItemWriter
. - KafkaItemWriterBuilder<K,
V> - Class in org.springframework.batch.infrastructure.item.kafka.builder -
A builder implementation for the
KafkaItemWriter
- KafkaItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemWriterBuilder
- kafkaTemplate - Variable in class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
- kafkaTemplate(KafkaTemplate<K, V>) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemWriterBuilder
-
Establish the KafkaTemplate to be used by the KafkaItemWriter.
- keyGenerator(KeyGenerator) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Sets the key generator for identifying retried items.
- keyGenerator(KeyGenerator) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- 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.
- KeyValueItemWriter<K,
V> - Class in org.springframework.batch.infrastructure.item -
A base class to implement any
ItemWriter
that writes to a key value store using aConverter
to derive a key from an item. - KeyValueItemWriter(Converter<V, K>) - Constructor for class org.springframework.batch.infrastructure.item.KeyValueItemWriter
-
Create a new
KeyValueItemWriter
instance.
L
- language(String) - Method in class org.springframework.batch.infrastructure.item.support.builder.ScriptItemProcessorBuilder
-
Establishes the language of the script.
- LastModifiedResourceComparator - Class in org.springframework.batch.infrastructure.support
-
Comparator to sort resources by the file last modified time.
- LastModifiedResourceComparator() - Constructor for class org.springframework.batch.infrastructure.support.LastModifiedResourceComparator
- launch(JobLaunchRequest) - Method in class org.springframework.batch.integration.launch.JobLaunchingMessageHandler
- launch(JobLaunchRequest) - Method in interface org.springframework.batch.integration.launch.JobLaunchRequestHandler
- launchJob() - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobOperatorTestUtils.startJob()
. Scheduled for removal in 6.2 or later. - launchJob(JobParameters) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobOperatorTestUtils.startJob(JobParameters)
. Scheduled for removal in 6.2 or later. - launchJobExecution(Job, JobExecution) - Method in class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher
-
Deprecated.Launch the job execution using the task executor.
- launchStep(String) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobOperatorTestUtils.startStep(String)
. Scheduled for removal in 6.2 or later. - launchStep(String, JobParameters) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.Launch just the specified step in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - launchStep(String, JobParameters, ExecutionContext) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated, for removal: This API element is subject to removal in a future version.Since 6.0 in favor of
JobOperatorTestUtils.startStep(String, JobParameters, ExecutionContext)
. Scheduled for removal in 6.2 or later. - launchStep(String, ExecutionContext) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.Launch just the specified step in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - launchStep(Step) - Method in class org.springframework.batch.test.StepRunner
-
Deprecated.Launch just the specified step in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - launchStep(Step, JobParameters) - Method in class org.springframework.batch.test.StepRunner
-
Deprecated.Launch just the specified step in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - launchStep(Step, JobParameters, ExecutionContext) - Method in class org.springframework.batch.test.StepRunner
-
Deprecated.Launch just the specified step in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - launchStep(Step, ExecutionContext) - Method in class org.springframework.batch.test.StepRunner
-
Deprecated.Launch just the specified step in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - LdifReader - Class in org.springframework.batch.infrastructure.item.ldif
- LdifReader(Resource) - Constructor for class org.springframework.batch.infrastructure.item.ldif.LdifReader
-
Create a new
LdifReader
instance with no resource. - LdifReaderBuilder - Class in org.springframework.batch.infrastructure.item.ldif.builder
-
Creates a fully qualified LdifReader.
- LdifReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
- limit(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
The query limit
- LimitCheckingExceptionHierarchySkipPolicy - Class in org.springframework.batch.core.step.skip
-
A composite
SkipPolicy
that 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<Class<? extends Throwable>>, long) - Constructor for class org.springframework.batch.core.step.skip.LimitCheckingExceptionHierarchySkipPolicy
-
Create a new
LimitCheckingExceptionHierarchySkipPolicy
instance. - 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
LimitCheckingExceptionHierarchySkipPolicy
instead. 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<Class<? extends Throwable>, Boolean>) - Constructor for class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.
- LimitCheckingItemSkipPolicy(int, Classifier<Throwable, Boolean>) - Constructor for class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.
- lineAggregator - Variable in class org.springframework.batch.infrastructure.item.file.FlatFileItemWriter
- lineAggregator(LineAggregator<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
Line aggregator used to build the String version of each item.
- LineAggregator<T> - Interface in org.springframework.batch.infrastructure.item.file.transform
-
Interface used to create string representing object.
- LineCallbackHandler - Interface in org.springframework.batch.infrastructure.item.file
-
Callback interface for handling a line from file.
- lineMapper(LineMapper<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
A
LineMapper
implementation to be used. - LineMapper<T> - Interface in org.springframework.batch.infrastructure.item.file
-
Interface for mapping lines (strings) to domain objects typically used to map lines read from a file to domain objects on a per line basis.
- lineSeparator - Variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- lineSeparator(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
String used to separate lines in output.
- lineSeparator(String) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
String used to separate lines in output.
- linesToSkip(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
The number of lines to skip at the beginning of reading the file.
- lineTokenizer(LineTokenizer) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
A
LineTokenizer
implementation to be used. - LineTokenizer - Interface in org.springframework.batch.infrastructure.item.file.transform
-
Interface that is used by framework to split string obtained typically from a file into tokens.
- 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
JobRegistry
instead. - ListableStepLocator - Interface in org.springframework.batch.core.step
-
Interface for listing
Step
s 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(Object) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- listener(Object) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- listener(Object) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- 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(ChunkListener) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- listener(ItemProcessListener<? super I, ? super O>) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Register an item processor listener.
- listener(ItemReadListener<? super I>) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Register an item reader listener.
- listener(ItemReadListener<? super I>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- listener(ItemWriteListener<? super O>) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.Register an item writer listener.
- listener(ItemWriteListener<? super O>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- listener(JobExecutionListener) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Register a job execution listener.
- listener(SkipListener<? super I, ? super O>) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Register a skip listener.
- listener(SkipListener<? super I, ? super O>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- listener(StepExecutionListener) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- listener(StepExecutionListener) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- listener(StepExecutionListener) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- listener(StepExecutionListener) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- 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.
- listener(RetryListener) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- ListenerMetaData - Interface in org.springframework.batch.core.listener
-
A common interface for listener meta data enumerations.
- ListItemReader<T> - Class in org.springframework.batch.infrastructure.item.support
-
An
ItemReader
that pulls data from a list. - ListItemReader(List<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.ListItemReader
- ListItemWriter<T> - Class in org.springframework.batch.infrastructure.item.support
-
Item writer that writes items to a
List
. - ListItemWriter() - Constructor for class org.springframework.batch.infrastructure.item.support.ListItemWriter
- 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.LocalTimeToStringConverter
- localDateTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- 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
- locale(Locale) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
-
Set the locale.
- localState - Variable in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- LocalState() - Constructor for class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- localTimeFormatter - Variable in class org.springframework.batch.core.converter.LocalTimeToStringConverter
- LocalTimeToStringConverter - Class in org.springframework.batch.core.converter
- LocalTimeToStringConverter() - Constructor for class org.springframework.batch.core.converter.LocalTimeToStringConverter
- log - Variable in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Logger available to subclasses
- 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
- logger - Variable in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
- logger - Static variable in class org.springframework.batch.infrastructure.item.data.RepositoryItemWriter
- logger - Variable in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- logger - Static variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- logger - Static variable in class org.springframework.batch.infrastructure.item.database.JpaItemWriter
- logger - Variable in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
- logger - Variable in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
- logger - Variable in class org.springframework.batch.infrastructure.item.jms.JmsItemReader
- logger - Variable in class org.springframework.batch.infrastructure.item.jms.JmsItemWriter
- logger - Variable in class org.springframework.batch.infrastructure.item.jms.JmsMethodInvocationRecoverer
- logger - Variable in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
- logger - Static variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- logger - Variable in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
- logger - Variable in class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler
- logger - Variable in class org.springframework.batch.infrastructure.repeat.exception.RethrowOnThresholdExceptionHandler
- logger - Variable in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
- logger - Variable in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.Logger
- logger - Variable in class org.springframework.batch.test.StepRunner
-
Deprecated.Logger
- LogOrRethrowExceptionHandler - Class in org.springframework.batch.infrastructure.repeat.exception
-
Implementation of
ExceptionHandler
based on anClassifier
. - LogOrRethrowExceptionHandler() - Constructor for class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler
- LogOrRethrowExceptionHandler.Level - Enum Class in org.springframework.batch.infrastructure.repeat.exception
-
Logging levels for the handler.
M
- mailErrorHandler(MailErrorHandler) - Method in class org.springframework.batch.infrastructure.item.mail.builder.SimpleMailMessageItemWriterBuilder
-
The handler for failed messages.
- MailErrorHandler - Interface in org.springframework.batch.infrastructure.item.mail
-
This class is used to handle errors that occur when email messages are unable to be sent.
- mailSender(MailSender) - Method in class org.springframework.batch.infrastructure.item.mail.builder.SimpleMailMessageItemWriterBuilder
-
A
MailSender
to be used to send messages inSimpleMailMessageItemWriter.write(Chunk)
. - 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
map
record component. - mapFieldSet(FieldSet) - Method in class org.springframework.batch.infrastructure.item.file.mapping.ArrayFieldSetMapper
- mapFieldSet(FieldSet) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Map the
FieldSet
to an object retrieved from the enclosing Spring context, or to a new instance of the required type if no prototype is available. - mapFieldSet(FieldSet) - Method in interface org.springframework.batch.infrastructure.item.file.mapping.FieldSetMapper
-
Method used to map data obtained from a
FieldSet
into an object. - mapFieldSet(FieldSet) - Method in class org.springframework.batch.infrastructure.item.file.mapping.PassThroughFieldSetMapper
- mapFieldSet(FieldSet) - Method in class org.springframework.batch.infrastructure.item.file.mapping.RecordFieldSetMapper
- 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
- mapLine(String, int) - Method in interface org.springframework.batch.infrastructure.item.file.LineMapper
-
Implementations must implement this method to map the provided line to the parameter type T.
- mapLine(String, int) - Method in class org.springframework.batch.infrastructure.item.file.mapping.DefaultLineMapper
- mapLine(String, int) - Method in class org.springframework.batch.infrastructure.item.file.mapping.JsonLineMapper
-
Interpret the line as a Json object and create a Map from it.
- mapLine(String, int) - Method in class org.springframework.batch.infrastructure.item.file.mapping.PassThroughLineMapper
- mapLine(String, int) - Method in class org.springframework.batch.infrastructure.item.file.mapping.PatternMatchingCompositeLineMapper
- MappingLdifReader<T> - Class in org.springframework.batch.infrastructure.item.ldif
- MappingLdifReader(Resource) - Constructor for class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
-
Create a new
MappingLdifReader
instance with the provided resource. - MappingLdifReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.ldif.builder
-
Creates a fully qualified MappingLdifReader.
- MappingLdifReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
- mapRecord(LdapAttributes) - Method in interface org.springframework.batch.infrastructure.item.ldif.RecordMapper
-
Maps an
LdapAttributes
object to the specified type. - mapResult(Object) - Method in class org.springframework.batch.core.step.tasklet.MethodInvokingTaskletAdapter
-
If the result is an
ExitStatus
already 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.
- MARIADB - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- MariaDBPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
MariaDB implementation of a
PagingQueryProvider
using database specific features. - MariaDBPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.MariaDBPagingQueryProvider
- markFragmentProcessed() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
-
Finishes reading the fragment in case the fragment was processed without being read until the end.
- markFragmentProcessed() - Method in interface org.springframework.batch.infrastructure.item.xml.stax.FragmentEventReader
-
Tells the event reader the current fragment has been processed.
- markStartFragment() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- markStartFragment() - Method in interface org.springframework.batch.infrastructure.item.xml.stax.FragmentEventReader
-
Tells the event reader its cursor position is exactly before the fragment.
- marshal(T) - Method in class org.springframework.batch.infrastructure.item.json.GsonJsonObjectMarshaller
- marshal(T) - Method in class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectMarshaller
- marshal(T) - Method in interface org.springframework.batch.infrastructure.item.json.JsonObjectMarshaller
-
Marshal an object into a json representation.
- marshaller(Marshaller) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
The
Marshaller
implementation responsible for the serialization of the items to XML. - match(String) - Static method in enum class org.springframework.batch.core.BatchStatus
-
Find a
BatchStatus
that matches the beginning of the given value. - match(String) - Method in class org.springframework.batch.infrastructure.support.PatternMatcher
-
This method takes a String key and a map from Strings to values of any type.
- match(String, String) - Static method in class org.springframework.batch.infrastructure.support.PatternMatcher
-
Lifted from AntPathMatcher in Spring Core.
- 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.
- maximumLength(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
-
Set the maximum length of the formatted string.
- maxItemCount - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- maxItemCount - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
Configure the max number of items to be read.
- maxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Configure the max number of items to be read.
- maxRows(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
The max number of rows the
ResultSet
can contain - maxRows(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
The max number of rows the
ResultSet
can contain - maxTime(Duration) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
The maximum execution time for the query
- MaxValueFlowExecutionAggregator - Class in org.springframework.batch.core.job.flow.support.state
-
Implementation of the
FlowExecutionAggregator
interface 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.
- maxWaitTimeouts - Variable in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- maxWaitTimeouts(int) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
The maximum number of times to wait at the end of a step for a non-null result from the remote workers.
- MessageChannelPartitionHandler - Class in org.springframework.batch.integration.partition
-
A
PartitionHandler
that usesMessageChannel
instances to send instructions to remote workers and receive their responses. - MessageChannelPartitionHandler() - Constructor for class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
- MessageSourcePollerInterceptor - Class in org.springframework.batch.integration.chunk
-
A
ChannelInterceptor
that turns a pollable channel into a "pass-thru channel": if a client callsreceive()
on the channel it will delegate to aMessageSource
to pull the message directly from an external source. - MessageSourcePollerInterceptor(MessageSource<?>) - Constructor for class org.springframework.batch.integration.chunk.MessageSourcePollerInterceptor
- messagingGateway - Variable in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- messagingTemplate(MessagingTemplate) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
Set the
MessagingTemplate
to use to send data to workers. - messagingTemplate(MessagingTemplate) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
Set the
MessagingTemplate
to use to send data to workers. - MetaDataInstanceFactory - Class in org.springframework.batch.test
- MetaDataInstanceFactory() - Constructor for class org.springframework.batch.test.MetaDataInstanceFactory
- meterRegistry - Variable in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- MethodInvoker - Interface in org.springframework.batch.infrastructure.support
-
A strategy interface for invoking a method.
- MethodInvokerMethodInterceptor - Class in org.springframework.batch.core.listener
-
MethodInterceptor
that, given a map of method names andMethodInvoker
s, will execute all methods tied to a particular method name, with the provided arguments. - MethodInvokerMethodInterceptor(Map<String, Set<MethodInvoker>>) - Constructor for class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- MethodInvokerMethodInterceptor(Map<String, Set<MethodInvoker>>, boolean) - Constructor for class org.springframework.batch.core.listener.MethodInvokerMethodInterceptor
- MethodInvokerUtils - Class in org.springframework.batch.infrastructure.support
-
Utility methods for create MethodInvoker instances.
- MethodInvokingTaskletAdapter - Class in org.springframework.batch.core.step.tasklet
-
A
Tasklet
that wraps a method in a POJO. - MethodInvokingTaskletAdapter() - Constructor for class org.springframework.batch.core.step.tasklet.MethodInvokingTaskletAdapter
- methodIs() - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemWriterBuilder.RepositoryMethodReference
-
The proxy returned prevents actual method execution and is only used to gather information about the method.
- methodName(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Specifies what method on the repository to call.
- methodName(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemWriterBuilder
-
Specifies what method on the repository to call.
- MethodResolver - Interface in org.springframework.batch.infrastructure.support
-
Strategy interface for detecting a single Method on a Class.
- 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.
- MimeMessageItemWriter - Class in org.springframework.batch.infrastructure.item.mail.javamail
-
A simple
ItemWriter
that can send mail messages. - MimeMessageItemWriter(JavaMailSender) - Constructor for class org.springframework.batch.infrastructure.item.mail.javamail.MimeMessageItemWriter
-
Create a new
MimeMessageItemWriter
with the givenJavaMailSender
. - minimumLength(int) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
-
Set the minimum length of the formatted string.
- mode(MongoItemWriter.Mode) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoItemWriterBuilder
-
Set the operating
MongoItemWriter.Mode
to be applied by this writer. - 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
GroupAwareJob
s. Scheduled for removal in 6.2 or later. - MongoCursorItemReader<T> - Class in org.springframework.batch.infrastructure.item.data
-
Cursor-based
ItemReader
implementation for MongoDB. - MongoCursorItemReader(MongoOperations, Class<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
Create a new
MongoCursorItemReader
. - MongoCursorItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.data.builder
- MongoCursorItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
- MongoDefaultBatchConfiguration - Class in org.springframework.batch.core.configuration.support
-
Base
Configuration
class 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
- MongoItemWriter<T> - Class in org.springframework.batch.infrastructure.item.data
-
A
ItemWriter
implementation that writes to a MongoDB store using an implementation of Spring Data'sMongoOperations
. - MongoItemWriter(MongoOperations) - Constructor for class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Create a new instance of
MongoItemWriter
with the providedMongoOperations
template. - MongoItemWriter.Mode - Enum Class in org.springframework.batch.infrastructure.item.data
-
Operation mode of the item writer.
- MongoItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.data.builder
-
A builder implementation for the
MongoItemWriter
- MongoItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.data.builder.MongoItemWriterBuilder
- 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
- MongoPagingItemReader<T> - Class in org.springframework.batch.infrastructure.item.data
-
Restartable
ItemReader
that reads documents from MongoDB via a paging technique. - MongoPagingItemReader(MongoOperations, Class<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
Create a new instance of
MongoPagingItemReader
. - MongoPagingItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.data.builder
-
Builder for
MongoPagingItemReader
. - MongoPagingItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- 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
- moveCursorToNextFragment(XMLEventReader) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
-
Responsible for moving the cursor before the StartElement of the fragment root.
- MulticasterBatchListener<T,
S> - Class in org.springframework.batch.core.listener - MulticasterBatchListener() - Constructor for class org.springframework.batch.core.listener.MulticasterBatchListener
-
Initialize the listener instance.
- MultiResourceItemReader<T> - Class in org.springframework.batch.infrastructure.item.file
-
Reads items from multiple resources sequentially - resource list is given by
MultiResourceItemReader.setResources(Resource[])
, the actual reading is delegated toMultiResourceItemReader.setDelegate(ResourceAwareItemReaderItemStream)
. - MultiResourceItemReader(ResourceAwareItemReaderItemStream<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
-
Create a new
MultiResourceItemReader
instance with the given delegate. - MultiResourceItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder implementation for the
MultiResourceItemReader
. - MultiResourceItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
- MultiResourceItemWriter<T> - Class in org.springframework.batch.infrastructure.item.file
-
Wraps a
ResourceAwareItemWriterItemStream
and creates a new output resource when the count of items written in current resource exceedsMultiResourceItemWriter.setItemCountLimitPerResource(int)
. - MultiResourceItemWriter(ResourceAwareItemWriterItemStream<? super T>) - Constructor for class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
-
Create a new
MultiResourceItemWriter
instance with the delegate to use. - MultiResourceItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.file.builder
-
A builder implementation for the
MultiResourceItemWriter
. - MultiResourceItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
- MultiResourcePartitioner - Class in org.springframework.batch.core.partition.support
-
Implementation of
Partitioner
that locates multiple resources and associates their file names with execution context keys. - MultiResourcePartitioner() - Constructor for class org.springframework.batch.core.partition.support.MultiResourcePartitioner
- MYSQL - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- MySqlPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
MySQL implementation of a
PagingQueryProvider
using database specific features. - MySqlPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.MySqlPagingQueryProvider
N
- name - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- name - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- name() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns the value of the
name
record component. - name() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
name
record component. - name() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
name
record component. - name(String) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemWriterBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
The name used to calculate the key within the
ExecutionContext
. - name(String) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
The name used to calculate the key within the
ExecutionContext
. - namedParameterJdbcTemplate - Variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- namedParametersJdbcTemplate(NamedParameterJdbcOperations) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
The
NamedParameterJdbcOperations
instance to use. - names - Variable in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
- names(String...) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
Names of each of the fields within the fields that are returned in the order they occur within the delimited file.
- names(String...) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
-
The names of the fields to be parsed from the file.
- names(String...) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.DelimitedBuilder
-
Names of each of the fields within the fields that are returned in the order they occur within the delimited file.
- names(String...) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
-
Names of each of the fields within the fields that are returned in the order they occur within the formatted file.
- 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.
- NestedRepeatCallback - Class in org.springframework.batch.infrastructure.repeat.callback
-
Callback that delegates to another callback, via a
RepeatOperations
instance. - NestedRepeatCallback(RepeatOperations, RepeatCallback) - Constructor for class org.springframework.batch.infrastructure.repeat.callback.NestedRepeatCallback
-
Constructor setting mandatory fields.
- NeverSkipItemSkipPolicy - Class in org.springframework.batch.core.step.skip
-
SkipPolicy
implementation that always returns false, indicating that an item should not be skipped. - NeverSkipItemSkipPolicy() - Constructor for class org.springframework.batch.core.step.skip.NeverSkipItemSkipPolicy
- next() - Method in class org.springframework.batch.infrastructure.item.Chunk.ChunkIterator
- next() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- 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.
- nextEvent() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- 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
- nextTag() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- NO_SUCH_JOB - Static variable in interface org.springframework.batch.core.launch.support.ExitCodeMapper
- NonSkippableProcessException - Exception 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 org.springframework.batch.core.step.skip.NonSkippableProcessException
- NonSkippableReadException - Exception 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 org.springframework.batch.core.step.skip.NonSkippableReadException
- NonSkippableWriteException - Exception 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 org.springframework.batch.core.step.skip.NonSkippableWriteException
- NonTransientFlatFileException - Exception in org.springframework.batch.infrastructure.item.file
-
Exception thrown when errors are encountered with the underlying resource.
- NonTransientFlatFileException(String, String) - Constructor for exception org.springframework.batch.infrastructure.item.file.NonTransientFlatFileException
- NonTransientFlatFileException(String, String, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.NonTransientFlatFileException
- NonTransientFlatFileException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.file.NonTransientFlatFileException
- NonTransientFlatFileException(String, Throwable, String, int) - Constructor for exception org.springframework.batch.infrastructure.item.file.NonTransientFlatFileException
- NonTransientResourceException - Exception in org.springframework.batch.infrastructure.item
-
Exception indicating that an error has been encountered doing I/O from a reader, and the exception should be considered fatal.
- NonTransientResourceException(String) - Constructor for exception org.springframework.batch.infrastructure.item.NonTransientResourceException
-
Create a new
NonTransientResourceException
based on a message. - NonTransientResourceException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.NonTransientResourceException
-
Create a new
NonTransientResourceException
based on a message and another exception. - 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<? extends Throwable>) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly ask for an exception (and subclasses) to be excluded from retry.
- noRetry(Class<? extends Throwable>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- noRollback(Class<? extends Throwable>) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Mark this exception as ignorable during item read or processing operations.
- noRollback(Class<? extends Throwable>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- noSkip(Class<? extends Throwable>) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly prevent certain exceptions (and subclasses) from being skipped.
- noSkip(Class<? extends Throwable>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- NoStartEndDocumentStreamWriter - Class in org.springframework.batch.infrastructure.item.xml.stax
-
Delegating XMLEventWriter, which ignores start and end document events, but passes through everything else.
- NoStartEndDocumentStreamWriter(XMLEventWriter) - Constructor for class org.springframework.batch.infrastructure.item.xml.stax.NoStartEndDocumentStreamWriter
- NoSuchJobException - Exception in org.springframework.batch.core.launch
-
Checked exception to indicate that a required
Job
is not available. - NoSuchJobException(String) - Constructor for exception org.springframework.batch.core.launch.NoSuchJobException
-
Create an exception with the given message.
- NoSuchJobException(String, Throwable) - Constructor for exception org.springframework.batch.core.launch.NoSuchJobException
- NoSuchJobExecutionException - Exception 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 org.springframework.batch.core.launch.NoSuchJobExecutionException
-
Deprecated.Create an exception with the given message.
- NoSuchJobExecutionException(String, Throwable) - Constructor for exception org.springframework.batch.core.launch.NoSuchJobExecutionException
-
Deprecated.
- NoSuchJobInstanceException - Exception 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 org.springframework.batch.core.launch.NoSuchJobInstanceException
-
Deprecated.Create an exception with the given message.
- NoSuchJobInstanceException(String, Throwable) - Constructor for exception org.springframework.batch.core.launch.NoSuchJobInstanceException
-
Deprecated.
- NoSuchObjectException - Exception 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 org.springframework.batch.core.repository.dao.NoSuchObjectException
-
Deprecated.
- NoSuchStepException - Exception 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 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.
- of(W...) - Static method in class org.springframework.batch.infrastructure.item.Chunk
- offset - Variable in class org.springframework.batch.core.step.item.ChunkMonitor.ChunkMonitorData
-
Deprecated.
- 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<O>) - 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.
- onError(RepeatContext, Throwable) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
- onError(RepeatContext, Throwable) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatListener
-
Called when a repeat callback fails by throwing an exception.
- 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,Throwable
t) - 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,Throwable
t) - onWriteError(Exception, Chunk<?>) - Method in class org.springframework.batch.core.step.item.DefaultItemFailureHandler
-
Deprecated.
- onWriteError(Exception, Chunk<? extends S>) - 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<? extends S>) - Method in interface org.springframework.batch.core.listener.ItemWriteListener
-
Called if an error occurs while trying to write.
- onWriteError(Exception, Chunk<? extends S>) - 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(int, int) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- 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
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.avro.AvroItemWriter
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
-
Figure out which resource to start with in case of restart, open the delegate and restore delegate's position in the resource.
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.file.ResourcesItemReader
- open(ExecutionContext) - Method in interface org.springframework.batch.infrastructure.item.ItemStream
-
Open the stream for the provided
ExecutionContext
. - open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.redis.RedisItemReader
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Initialize the reader.
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemReader
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Broadcast the call to open.
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.SingleItemPeekableItemReader
-
If the delegate is an
ItemStream
, just pass the call on, otherwise reset the peek cache. - open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamReader
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamWriter
- open(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Open the output source
- open(ExecutionContext) - Method in class org.springframework.batch.integration.async.AsyncItemWriter
- open(ExecutionContext) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- open(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
- open(RepeatContext) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatListener
-
Called once at the start of a complete batch, before any items are processed.
- open(Resource) - Method in class org.springframework.batch.infrastructure.item.json.GsonJsonObjectReader
- open(Resource) - Method in class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectReader
- open(Resource) - Method in interface org.springframework.batch.infrastructure.item.json.JsonObjectReader
-
Open the Json resource for reading.
- openCursor(Connection) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
- openCursor(Connection) - Method in class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
- openCursor(Connection) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
- operator(JobOperator) - Method in class org.springframework.batch.core.step.builder.JobStepBuilder
-
Add a job operator.
- ORACLE - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- OraclePagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
Oracle implementation of a
PagingQueryProvider
using database specific features. - OraclePagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.OraclePagingQueryProvider
- Order - Enum Class in org.springframework.batch.infrastructure.item.database
-
The direction of the sort in an ORDER BY clause.
- 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
-
JobStep
and 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.
- org.springframework.batch.infrastructure - package org.springframework.batch.infrastructure
-
Infrastructure implementations of batch concerns.
- org.springframework.batch.infrastructure.aot - package org.springframework.batch.infrastructure.aot
- org.springframework.batch.infrastructure.item - package org.springframework.batch.infrastructure.item
-
Infrastructure interfaces and primary dependencies for item concerns.
- org.springframework.batch.infrastructure.item.adapter - package org.springframework.batch.infrastructure.item.adapter
-
Adapters for Plain Old Java Objects.
- org.springframework.batch.infrastructure.item.amqp - package org.springframework.batch.infrastructure.item.amqp
-
AMQP related batch components.
- org.springframework.batch.infrastructure.item.amqp.builder - package org.springframework.batch.infrastructure.item.amqp.builder
-
Builders for AMQP item reader and writer.
- org.springframework.batch.infrastructure.item.avro - package org.springframework.batch.infrastructure.item.avro
-
Avro related reader and writer.
- org.springframework.batch.infrastructure.item.avro.builder - package org.springframework.batch.infrastructure.item.avro.builder
-
Builders for Avro item reader and writer.
- org.springframework.batch.infrastructure.item.data - package org.springframework.batch.infrastructure.item.data
-
Spring Data related readers and writers.
- org.springframework.batch.infrastructure.item.data.builder - package org.springframework.batch.infrastructure.item.data.builder
-
Builders for Spring Data item readers and writers.
- org.springframework.batch.infrastructure.item.database - package org.springframework.batch.infrastructure.item.database
-
Infrastructure implementations of database based item readers and writers.
- org.springframework.batch.infrastructure.item.database.builder - package org.springframework.batch.infrastructure.item.database.builder
-
Builders for database item readers and writers.
- org.springframework.batch.infrastructure.item.database.orm - package org.springframework.batch.infrastructure.item.database.orm
-
Support classes for components using various ORM related technologies.
- org.springframework.batch.infrastructure.item.database.support - package org.springframework.batch.infrastructure.item.database.support
-
Support classes for database specific semantics.
- org.springframework.batch.infrastructure.item.file - package org.springframework.batch.infrastructure.item.file
-
Infrastructure implementations of io file concerns.
- org.springframework.batch.infrastructure.item.file.builder - package org.springframework.batch.infrastructure.item.file.builder
-
Builders for file item readers and writers.
- org.springframework.batch.infrastructure.item.file.mapping - package org.springframework.batch.infrastructure.item.file.mapping
-
Infrastructure implementations of io file support mapping concerns.
- org.springframework.batch.infrastructure.item.file.separator - package org.springframework.batch.infrastructure.item.file.separator
-
Infrastructure implementations of io file support separator concerns.
- org.springframework.batch.infrastructure.item.file.transform - package org.springframework.batch.infrastructure.item.file.transform
-
Infrastructure implementations of io file support transform concerns.
- org.springframework.batch.infrastructure.item.function - package org.springframework.batch.infrastructure.item.function
-
Adapters for
java.util.function
components. - org.springframework.batch.infrastructure.item.jms - package org.springframework.batch.infrastructure.item.jms
-
JMS based reader/writer and related components.
- org.springframework.batch.infrastructure.item.jms.builder - package org.springframework.batch.infrastructure.item.jms.builder
-
Builders for JMS item reader and writer.
- org.springframework.batch.infrastructure.item.json - package org.springframework.batch.infrastructure.item.json
-
Infrastructure implementations of JSON input and output.
- org.springframework.batch.infrastructure.item.json.builder - package org.springframework.batch.infrastructure.item.json.builder
-
Builders for JSON item reader and writer.
- org.springframework.batch.infrastructure.item.kafka - package org.springframework.batch.infrastructure.item.kafka
-
Apache Kafka related readers and writers
- org.springframework.batch.infrastructure.item.kafka.builder - package org.springframework.batch.infrastructure.item.kafka.builder
-
Builders for Apache Kafka item reader and writer.
- org.springframework.batch.infrastructure.item.ldif - package org.springframework.batch.infrastructure.item.ldif
-
This package contains the classes required for using the LdifParser in Spring LDAP.
- org.springframework.batch.infrastructure.item.ldif.builder - package org.springframework.batch.infrastructure.item.ldif.builder
-
Builders for LDIF related components.
- org.springframework.batch.infrastructure.item.mail - package org.springframework.batch.infrastructure.item.mail
-
Java Mail based components.
- org.springframework.batch.infrastructure.item.mail.builder - package org.springframework.batch.infrastructure.item.mail.builder
-
Builders for JavaMail related components.
- org.springframework.batch.infrastructure.item.mail.javamail - package org.springframework.batch.infrastructure.item.mail.javamail
-
JavaMail related components.
- org.springframework.batch.infrastructure.item.queue - package org.springframework.batch.infrastructure.item.queue
- org.springframework.batch.infrastructure.item.queue.builder - package org.springframework.batch.infrastructure.item.queue.builder
- org.springframework.batch.infrastructure.item.redis - package org.springframework.batch.infrastructure.item.redis
-
Redis related readers and writers
- org.springframework.batch.infrastructure.item.redis.builder - package org.springframework.batch.infrastructure.item.redis.builder
- org.springframework.batch.infrastructure.item.support - package org.springframework.batch.infrastructure.item.support
-
Internal support package
- org.springframework.batch.infrastructure.item.support.builder - package org.springframework.batch.infrastructure.item.support.builder
-
Builders for support classes.
- org.springframework.batch.infrastructure.item.util - package org.springframework.batch.infrastructure.item.util
-
Infrastructure utility classes.
- org.springframework.batch.infrastructure.item.validator - package org.springframework.batch.infrastructure.item.validator
-
Infrastructure implementations of item validator concerns.
- org.springframework.batch.infrastructure.item.xml - package org.springframework.batch.infrastructure.item.xml
-
Infrastructure implementations of xml input and output.
- org.springframework.batch.infrastructure.item.xml.builder - package org.springframework.batch.infrastructure.item.xml.builder
-
Builders for Stax event item reader and writer.
- org.springframework.batch.infrastructure.item.xml.stax - package org.springframework.batch.infrastructure.item.xml.stax
-
Item reader and writer based on Stax.
- org.springframework.batch.infrastructure.poller - package org.springframework.batch.infrastructure.poller
-
APIs for polling support.
- org.springframework.batch.infrastructure.repeat - package org.springframework.batch.infrastructure.repeat
-
Infrastructure implementations of repeat concerns.
- org.springframework.batch.infrastructure.repeat.callback - package org.springframework.batch.infrastructure.repeat.callback
-
Infrastructure implementations of repeat callback concerns.
- org.springframework.batch.infrastructure.repeat.context - package org.springframework.batch.infrastructure.repeat.context
-
Infrastructure implementations of repeat context concerns.
- org.springframework.batch.infrastructure.repeat.exception - package org.springframework.batch.infrastructure.repeat.exception
-
Infrastructure implementations of repeat exception handler concerns.
- org.springframework.batch.infrastructure.repeat.interceptor - package org.springframework.batch.infrastructure.repeat.interceptor
-
Infrastructure implementations of repeat aop concerns.
- org.springframework.batch.infrastructure.repeat.listener - package org.springframework.batch.infrastructure.repeat.listener
-
Infrastructure implementations of repeat interceptor concerns.
- org.springframework.batch.infrastructure.repeat.policy - package org.springframework.batch.infrastructure.repeat.policy
-
Infrastructure implementations of repeat policy concerns.
- org.springframework.batch.infrastructure.repeat.support - package org.springframework.batch.infrastructure.repeat.support
-
Infrastructure implementations of repeat support concerns.
- org.springframework.batch.infrastructure.support - package org.springframework.batch.infrastructure.support
-
Infrastructure implementations of support concerns.
- org.springframework.batch.infrastructure.support.transaction - package org.springframework.batch.infrastructure.support.transaction
-
Infrastructure implementations of support transaction concerns.
- org.springframework.batch.integration - package org.springframework.batch.integration
-
Provides integration with Spring Integration.
- org.springframework.batch.integration.aot - package org.springframework.batch.integration.aot
- org.springframework.batch.integration.async - package org.springframework.batch.integration.async
-
Components for executing item processing asynchronously and writing the results when processing is complete.
- org.springframework.batch.integration.chunk - package org.springframework.batch.integration.chunk
-
Components for remote chunking.
- org.springframework.batch.integration.config.annotation - package org.springframework.batch.integration.config.annotation
-
APIs for the configuration of Spring Integration components through annotations.
- org.springframework.batch.integration.config.xml - package org.springframework.batch.integration.config.xml
-
APIs for the configuration of Spring Integration components through XML.
- org.springframework.batch.integration.launch - package org.springframework.batch.integration.launch
-
Message based job launching components.
- org.springframework.batch.integration.partition - package org.springframework.batch.integration.partition
-
Remote partitioning components.
- org.springframework.batch.integration.remote - package org.springframework.batch.integration.remote
- org.springframework.batch.test - package org.springframework.batch.test
-
Utility classes for batch job/step testing.
- org.springframework.batch.test.context - package org.springframework.batch.test.context
-
APIs for the configuration of Spring Batch test support.
- outputChannel(MessageChannel) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
Set the output channel on which requests to workers will be sent.
- outputChannel(MessageChannel) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingWorkerBuilder
-
Set the output channel on which replies will be sent to the manager step.
- outputChannel(MessageChannel) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
Set the output channel on which requests to workers will be sent.
- outputChannel(MessageChannel) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
-
Set the output channel on which replies will be sent to the manager step.
- OutputState() - Constructor for class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- overwriteOutput(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Indicates if an existing file should be overwritten if found.
P
- page - Variable in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- pageSize - Variable in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- pageSize - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- pageSize - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- pageSize(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
The number of items to be read with each page.
- pageSize(int) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Establish the pageSize for the generated RepositoryItemReader.
- pageSize(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The number of records to request per page/query.
- pageSize(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
The number of records to request per page/query.
- PagingQueryProvider - Interface in org.springframework.batch.infrastructure.item.database
-
Interface defining the functionality to be provided for generating paging queries for use with Paging Item Readers.
- parameterCount - Variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- parameters() - Method in record class org.springframework.batch.core.job.parameters.JobParameters
-
Get a set of all parameters.
- parameters(SqlParameter...) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
SQL parameters to be set when executing the stored procedure
- parametersExtractor(JobParametersExtractor) - Method in class org.springframework.batch.core.step.builder.JobStepBuilder
-
Provide a job parameters extractor.
- parameterValues - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- parameterValues - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- parameterValues - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- parameterValues(Object...) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Values to be substituted in for each of the parameters in the query.
- parameterValues(List<Object>) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Values to be substituted in for each of the parameters in the query.
- parameterValues(List<Object>) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
List
of values to be substituted in for each of the parameters in the query. - parameterValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
A
Map
of values to set on the SQL's prepared statement. - parameterValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
A map of parameter values to be set on the query.
- parameterValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
A map of parameter values to be set on the query.
- 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
. - ParseException - Exception in org.springframework.batch.infrastructure.item
-
Exception indicating that an error has been encountered parsing IO, typically from a file.
- ParseException(String) - Constructor for exception org.springframework.batch.infrastructure.item.ParseException
-
Create a new
ParseException
based on a message. - ParseException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.ParseException
-
Create a new
ParseException
based on a message and another exception. - parseHandler(Element, ParserContext) - Method in class org.springframework.batch.integration.config.xml.JobLaunchingGatewayParser
- parseInternal(Element, ParserContext) - Method in class org.springframework.batch.core.configuration.xml.TopLevelStepParser
- parseInternal(Element, ParserContext) - Method in class org.springframework.batch.integration.config.xml.RemoteChunkingManagerParser
- parseInternal(Element, ParserContext) - Method in class org.springframework.batch.integration.config.xml.RemoteChunkingWorkerParser
- 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
ExecutionContext
instances 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(String, Partitioner) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- partitioner(String, Partitioner) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- partitioner(Step) - 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.integration.partition.RemotePartitioningWorkerStepBuilder
- Partitioner - Interface in org.springframework.batch.core.partition
-
Central strategy interface for creating input parameters for a partitioned step in the form of
ExecutionContext
instances. - 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(PartitionHandler) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
This method will throw a
UnsupportedOperationException
since the partition handler of the manager step will be automatically set to an instance ofMessageChannelPartitionHandler
. - 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
Partitioner
implementations that need to use a custom naming scheme for partitions. - partitionOffsets(Map<TopicPartition, Long>) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
Setter for partition offsets.
- partitions(Integer...) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
A list of partitions to manually assign to the consumer.
- partitions(List<Integer>) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
A list of partitions to manually assign to the consumer.
- 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
Step
which 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
PartitionStep
with the given job repository. - PartitionStepBuilder - Class in org.springframework.batch.core.step.builder
-
Step builder for
PartitionStep
instances. - PartitionStepBuilder(StepBuilderHelper<?>) - Constructor for class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Create a new builder initialized with any properties in the parent.
- PassThroughFieldExtractor<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
FieldExtractor
that just returns the original item. - PassThroughFieldExtractor() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.PassThroughFieldExtractor
- PassThroughFieldSetMapper - Class in org.springframework.batch.infrastructure.item.file.mapping
-
Pass through
FieldSetMapper
useful for passing aFieldSet
back directly rather than a mapped object. - PassThroughFieldSetMapper() - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.PassThroughFieldSetMapper
- PassThroughItemProcessor<T> - Class in org.springframework.batch.infrastructure.item.support
-
Simple
ItemProcessor
that does nothing - simply passes its argument through to the caller. - PassThroughItemProcessor() - Constructor for class org.springframework.batch.infrastructure.item.support.PassThroughItemProcessor
- PassThroughLineAggregator<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
A
LineAggregator
implementation that simply callsObject.toString()
on the given object - PassThroughLineAggregator() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.PassThroughLineAggregator
- PassThroughLineMapper - Class in org.springframework.batch.infrastructure.item.file.mapping
-
Pass through
LineMapper
useful for passing the originalString
back directly rather than a mapped object. - PassThroughLineMapper() - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.PassThroughLineMapper
- PatternMatcher<S> - Class in org.springframework.batch.infrastructure.support
- PatternMatcher(Map<String, S>) - Constructor for class org.springframework.batch.infrastructure.support.PatternMatcher
-
Initialize a new
PatternMatcher
with a map of patterns to values - PatternMatchingCompositeLineMapper<T> - Class in org.springframework.batch.infrastructure.item.file.mapping
-
A
LineMapper
implementation that stores a mapping of String patterns to delegateLineTokenizer
s as well as a mapping of String patterns to delegateFieldSetMapper
s. - PatternMatchingCompositeLineMapper(Map<String, LineTokenizer>, Map<String, FieldSetMapper<T>>) - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.PatternMatchingCompositeLineMapper
-
Construct a
PatternMatchingCompositeLineMapper
with the provided maps of tokenizers and field set mappers. - PatternMatchingCompositeLineTokenizer - Class in org.springframework.batch.infrastructure.item.file.transform
-
A
LineTokenizer
implementation that stores a mapping of String patterns to delegateLineTokenizer
s. - PatternMatchingCompositeLineTokenizer(Map<String, LineTokenizer>) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.PatternMatchingCompositeLineTokenizer
-
Construct a
PatternMatchingCompositeLineTokenizer
with the provided map of tokenizers. - peek() - Method in interface org.springframework.batch.infrastructure.item.PeekableItemReader
-
Get the next item that would be returned by
ItemReader.read()
, without affecting the result ofItemReader.read()
. - peek() - Method in class org.springframework.batch.infrastructure.item.support.SingleItemPeekableItemReader
-
Peek at the next item, ensuring that if the delegate is an
ItemStream
the state is stored for the next call toSingleItemPeekableItemReader.update(ExecutionContext)
. - peek() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- PeekableItemReader<T> - Interface in org.springframework.batch.infrastructure.item
-
A specialisation of
ItemReader
that allows the user to look ahead into the stream of items. - poll(Callable<S>) - Method in class org.springframework.batch.infrastructure.poller.DirectPoller
-
Get a future for a non-null result from the callback.
- poll(Callable<T>) - Method in interface org.springframework.batch.infrastructure.poller.Poller
-
Use the callable provided to poll for a non-null result.
- pollChunkResponses() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- Poller<T> - Interface in org.springframework.batch.infrastructure.poller
-
Interface for polling a
Callable
instance provided by the user. - pollInterval(long) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
How often to poll the job repository for the status of the workers.
- pollTimeout(Duration) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
Set the pollTimeout for the poll() operations.
- position() - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
-
Return the byte offset position of the cursor in the output file as a long integer.
- POSTGRES - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- PostgresPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
Postgres implementation of a
PagingQueryProvider
using database specific features. - PostgresPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.PostgresPagingQueryProvider
- postProcess(String) - Method in interface org.springframework.batch.infrastructure.item.file.separator.RecordSeparatorPolicy
-
Give the policy a chance to post-process a complete record, e.g. remove a suffix.
- postProcess(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.SimpleRecordSeparatorPolicy
-
Pass the record through.
- postProcess(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.SuffixRecordSeparatorPolicy
-
Remove the suffix from the end of the record.
- postProcess(StepContribution, Chunk<I>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.
- postProcess(StepContribution, Chunk<I>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
- postProcess(StepContribution, Chunk<T>) - 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
- postProcessAfterInitialization(Object, String) - Method in class org.springframework.batch.test.context.BatchTestContextBeanPostProcessor
- 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
- PredicateFilteringItemProcessor<T> - Class in org.springframework.batch.infrastructure.item.function
-
A filtering
ItemProcessor
that is based on aPredicate
. - PredicateFilteringItemProcessor(Predicate<T>) - Constructor for class org.springframework.batch.infrastructure.item.function.PredicateFilteringItemProcessor
-
Create a new
PredicateFilteringItemProcessor
. - 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.
- preparedStatementSetter(PreparedStatementSetter) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Configures the provided
PreparedStatementSetter
to be used to populate any arguments in the SQL query to be executed for the reader. - preparedStatementSetter(PreparedStatementSetter) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Configures the provided
PreparedStatementSetter
to be used to populate any arguments in the SQL query to be executed for the reader. - prepareTestInstance(TestContext) - Method in class org.springframework.batch.test.JobScopeTestExecutionListener
-
Set up a
JobExecution
as a test context attribute. - prepareTestInstance(TestContext) - Method in class org.springframework.batch.test.StepScopeTestExecutionListener
-
Set up a
StepExecution
as a test context attribute. - preProcess(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.DefaultRecordSeparatorPolicy
-
If we are in an unterminated quote, add a line separator.
- preProcess(String) - Method in interface org.springframework.batch.infrastructure.item.file.separator.RecordSeparatorPolicy
-
Pre-process a record before another line is appended, in the case of a multi-line record.
- preProcess(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.SimpleRecordSeparatorPolicy
-
Pass the line through.
- preReceive(MessageChannel) - Method in class org.springframework.batch.integration.chunk.MessageSourcePollerInterceptor
-
Receive from the
MessageSource
and send immediately to the input channel, so that the call that we are intercepting always a message to receive. - preSend(Message<?>, MessageChannel) - Method in class org.springframework.batch.integration.async.StepExecutionInterceptor
- presetSystemExiter(SystemExiter) - Static method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Static setter for the
SystemExiter
so 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.
- primaryKeys(String...) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoItemWriterBuilder
-
Set the primary keys to associate with the document being written.
- primaryKeys(List<String>) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoItemWriterBuilder
-
Set the primary keys to associate with the document being written.
- procedureName(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
The name of the stored procedure to execute
- process(I) - Method in class org.springframework.batch.infrastructure.item.adapter.ItemProcessorAdapter
-
Invoke the delegate method and return the result.
- process(I) - Method in class org.springframework.batch.infrastructure.item.function.FunctionItemProcessor
- process(I) - Method in interface org.springframework.batch.infrastructure.item.ItemProcessor
-
Process the provided item, returning a potentially modified or new item for continued processing.
- process(I) - Method in class org.springframework.batch.infrastructure.item.support.ClassifierCompositeItemProcessor
-
Delegates to injected
ItemProcessor
instances according to the classification by theClassifier
. - process(I) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemProcessor
- process(I) - Method in class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
- process(I) - Method in class org.springframework.batch.integration.async.AsyncItemProcessor
-
Transform the input by delegating to the provided item processor.
- process(StepContribution, Chunk<I>) - 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<I>, StepContribution) - Method in interface org.springframework.batch.core.step.item.ChunkProcessor
-
Process the given chunk and update the contribution.
- process(Chunk<I>, StepContribution) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- process(T) - Method in class org.springframework.batch.infrastructure.item.function.PredicateFilteringItemProcessor
- process(T) - Method in class org.springframework.batch.infrastructure.item.support.PassThroughItemProcessor
-
Just returns the item back to the caller.
- process(T) - Method in class org.springframework.batch.infrastructure.item.validator.ValidatingItemProcessor
-
Validate the item and return it unmodified
- processor(ItemProcessor<? super I, ? extends O>) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.An item processor that processes or transforms a stream of items.
- processor(ItemProcessor<? super I, ? extends O>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- processor(ItemProcessor<I, O>) - 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).
- processUpdateCounts(int[]) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Extension point to post process the update counts for each item.
- properties - Variable in class org.springframework.batch.core.step.builder.StepBuilderHelper
- PropertiesConverter - Class in org.springframework.batch.infrastructure.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.
- propertiesToString(Properties) - Static method in class org.springframework.batch.infrastructure.support.PropertiesConverter
-
Deprecated.Convert a Properties object to a String.
- PropertyExtractingDelegatingItemWriter<T> - Class in org.springframework.batch.infrastructure.item.adapter
-
Delegates processing to a custom method - extracts property values from item object and uses them as arguments for the delegate method.
- PropertyExtractingDelegatingItemWriter() - Constructor for class org.springframework.batch.infrastructure.item.adapter.PropertyExtractingDelegatingItemWriter
- prototypeBeanName(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configures the id of a prototype scoped bean to be used as the item returned by the reader.
- 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.
- pushResponse(ChunkResponse) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- put(String, Object) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Add an Object value to the context.
- put(ResultHolder) - Method in class org.springframework.batch.infrastructure.repeat.support.ResultHolderResultQueue
-
Deprecated.
- put(T) - Method in class org.springframework.batch.infrastructure.repeat.support.ThrottleLimitResultQueue
-
Deprecated.
- putDouble(String, double) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Add a Double value to the context.
- putInt(String, int) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Adds an Integer value to the context.
- putLong(String, long) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Adds a Long value to the context.
- putString(String, String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Adds a String value to the context.
Q
- query - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- query - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- query(Query) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Provide a Spring Data Mongo
Query
. - query(Query) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Provide a Spring Data Mongo
Query
. - queryArguments(Object...) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Configures a
PreparedStatementSetter
that will use the array as the values to be set on the query to be executed for this reader. - queryArguments(Object[], int[]) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Configures a
PreparedStatementSetter
that will use the Object [] as the values to be set on the query to be executed for this reader. - queryArguments(List<?>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Configures a
PreparedStatementSetter
that will use the List as the values to be set on the query to be executed for this reader. - queryProvider - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- queryProvider(JpaQueryProvider) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
A query provider.
- queryProvider(JpaQueryProvider) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
A query provider.
- queryProvider(PagingQueryProvider) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
A
PagingQueryProvider
to provide the queries required. - queryString - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- queryString(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
The JPQL query string to execute.
- queryString(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
The HQL query string to execute.
- queryTimeout(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
The time in seconds for the query to timeout
- queryTimeout(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
The time in milliseconds for the query to timeout
- queue(BlockingQueue<T>) - Method in class org.springframework.batch.infrastructure.item.queue.builder.BlockingQueueItemReaderBuilder
-
Set the queue to read items from.
- queue(BlockingQueue<T>) - Method in class org.springframework.batch.infrastructure.item.queue.builder.BlockingQueueItemWriterBuilder
-
Create a new
BlockingQueueItemWriterBuilder
- quoteCharacter(char) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
Define the character used to quote fields.
- quoteCharacter(String) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.DelimitedBuilder
-
Define the quote character for each delimited field.
R
- Range - Class in org.springframework.batch.infrastructure.item.file.transform
-
A class to represent ranges.
- Range(int) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.Range
- Range(int, int) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.Range
- RangeArrayPropertyEditor - Class in org.springframework.batch.infrastructure.item.file.transform
-
Property editor implementation which parses string and creates array of ranges.
- RangeArrayPropertyEditor() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.RangeArrayPropertyEditor
- read() - Method in class org.springframework.batch.infrastructure.item.adapter.ItemReaderAdapter
- read() - Method in class org.springframework.batch.infrastructure.item.amqp.AmqpItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
-
Reads the next item, jumping to next resource if necessary.
- read() - Method in class org.springframework.batch.infrastructure.item.file.ResourcesItemReader
-
Increments a counter and returns the next
Resource
instance from the input, ornull
if none remain. - read() - Method in class org.springframework.batch.infrastructure.item.function.SupplierItemReader
- read() - Method in interface org.springframework.batch.infrastructure.item.ItemReader
-
Reads a piece of input data and advance to the next one.
- read() - Method in class org.springframework.batch.infrastructure.item.jms.JmsItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.json.GsonJsonObjectReader
- read() - Method in class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectReader
- read() - Method in interface org.springframework.batch.infrastructure.item.json.JsonObjectReader
-
Read the next object in the Json resource if any.
- read() - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.queue.BlockingQueueItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.redis.RedisItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.support.IteratorItemReader
-
Implementation of
ItemReader.read()
that just iterates over the iterator provided. - read() - Method in class org.springframework.batch.infrastructure.item.support.ListItemReader
- read() - Method in class org.springframework.batch.infrastructure.item.support.SingleItemPeekableItemReader
-
Get the next item from the delegate (whether or not it has already been peeked at).
- read() - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemReader
-
This method delegates to the
read
method of the delegate and is synchronized with a lock. - read() - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamReader
-
This delegates to the read method of the
delegate
- read(StepContribution, Chunk<I>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.
- read(StepContribution, Chunk<I>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.Delegates to
SimpleChunkProvider.doRead()
. - readAndTrim(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
Read and trim the
String
value at 'index
'. - readBigDecimal(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBigDecimal(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
BigDecimal
value at index 'index
'. - readBigDecimal(int, BigDecimal) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBigDecimal(int, BigDecimal) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
BigDecimal
value at index 'index
', returning the supplieddefaultValue
if the trimmed string value at index 'index
' is blank. - readBigDecimal(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBigDecimal(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
BigDecimal
value from column with given 'name
. - readBigDecimal(String, BigDecimal) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBigDecimal(String, BigDecimal) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
BigDecimal
value from column with given 'name
, returning the supplieddefaultValue
if the trimmed string value at index 'index
' is blank. - readBoolean(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBoolean(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
boolean
' value at index 'index
'. - readBoolean(int, String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBoolean(int, String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
boolean
' value at index 'index
'. - readBoolean(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBoolean(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
boolean
' value from column with given 'name
'. - readBoolean(String, String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readBoolean(String, String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
boolean
' value from column with given 'name
'. - readByte(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readByte(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
byte
' value at index 'index
'. - readByte(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readByte(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
byte
' value from column with given 'name
'. - readChar(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readChar(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
char
' value at index 'index
'. - readChar(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readChar(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
char
' value from column with given 'name
'. - readCursor(ResultSet, int) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Read the cursor and map to the type of object this reader should return.
- readCursor(ResultSet, int) - Method in class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
- readCursor(ResultSet, int) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
- readDate(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.util.Date
value in default format at designated columnindex
. - readDate(int, String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(int, String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.util.Date
value in default format at designated columnindex
. - readDate(int, String, Date) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(int, String, Date) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.util.Date
value in default format at designated columnindex
. - readDate(int, Date) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(int, Date) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.util.Date
value in default format at designated columnindex
. - readDate(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.sql.Date
value in given format from column with givenname
. - readDate(String, String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(String, String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.sql.Date
value in given format from column with givenname
. - readDate(String, String, Date) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(String, String, Date) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.sql.Date
value in given format from column with givenname
. - readDate(String, Date) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDate(String, Date) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
java.sql.Date
value in given format from column with givenname
. - readDouble(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDouble(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
double
' value at index 'index
'. - readDouble(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readDouble(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
double
' value from column with given 'name
. - reader(ItemReader<? extends I>) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.An item reader that provides a stream of items.
- reader(ItemReader<? extends I>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- reader(ItemReader<I>) - 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.
- readerIsTransactionalQueue() - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- ReaderNotOpenException - Exception in org.springframework.batch.infrastructure.item
-
Exception indicating that an
ItemReader
needed to be opened before read. - ReaderNotOpenException(String) - Constructor for exception org.springframework.batch.infrastructure.item.ReaderNotOpenException
-
Create a new
ReaderNotOpenException
based on a message. - ReaderNotOpenException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.ReaderNotOpenException
-
Create a new
ReaderNotOpenException
based on a message and another exception. - readFloat(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readFloat(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
float
' value at index 'index
'. - readFloat(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readFloat(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
float
' value from column with given 'name
. - readInt(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readInt(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
int
' value at index 'index
'. - readInt(int, int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readInt(int, int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
int
' value at index 'index
', using the supplieddefaultValue
if the field value is blank. - readInt(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readInt(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
int
' value from column with given 'name
'. - readInt(String, int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readInt(String, int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
int
' value from column with given 'name
', using the supplieddefaultValue
if the field value is blank. - readLong(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readLong(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
long
' value at index 'index
'. - readLong(int, long) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readLong(int, long) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
long
' value at index 'index
', using the supplieddefaultValue
if the field value is blank. - readLong(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readLong(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
long
' value from column with given 'name
'. - readLong(String, long) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readLong(String, long) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
long
' value from column with given 'name
', using the supplieddefaultValue
if the field value is blank. - readRawString(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readRawString(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
String
value at index 'index
' including trailing whitespace (don't trim). - readRawString(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readRawString(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
String
value from column with given 'name
' including trailing whitespace (don't trim). - readShort(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readShort(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
short
' value at index 'index
'. - readShort(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readShort(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the '
short
' value from column with given 'name
'. - readString(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readString(int) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
String
value at index 'index
'. - readString(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- readString(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.FieldSet
-
Read the
String
value from column with given 'name
'. - RecordCallbackHandler - Interface in org.springframework.batch.infrastructure.item.ldif
-
This interface can be used to operate on skipped records during open in the
LdifReader
and theMappingLdifReader
. - RecordFieldExtractor<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
This is a field extractor for a Java record.
- RecordFieldExtractor(Class<? extends T>) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.RecordFieldExtractor
- RecordFieldSetMapper<T> - Class in org.springframework.batch.infrastructure.item.file.mapping
-
This is a
FieldSetMapper
that supports Java records mapping (requires JKD 14 or higher). - RecordFieldSetMapper(Class<T>) - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.RecordFieldSetMapper
-
Create a new
RecordFieldSetMapper
. - RecordFieldSetMapper(Class<T>, ConversionService) - Constructor for class org.springframework.batch.infrastructure.item.file.mapping.RecordFieldSetMapper
-
Create a new
RecordFieldSetMapper
. - recordMapper(RecordMapper<T>) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
Setter for object mapper.
- RecordMapper<T> - Interface in org.springframework.batch.infrastructure.item.ldif
-
This interface should be implemented to map
LdapAttributes
objects to POJOs. - recordSeparatorPolicy(RecordSeparatorPolicy) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configure a custom
RecordSeparatorPolicy
for the reader. - RecordSeparatorPolicy - Interface in org.springframework.batch.infrastructure.item.file.separator
-
Policy for text file-based input sources to determine the end of a record, e.g. a record might be a single line, or it might be multiple lines terminated by a semicolon.
- recordsToSkip(int) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
Public setter for the number of lines to skip at the start of a file.
- recordsToSkip(int) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
Public setter for the number of lines to skip at the start of a file.
- 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
STARTED
state due to an abrupt shutdown or failure, making it eligible for restart. - recover(Object[], Throwable) - Method in class org.springframework.batch.infrastructure.item.jms.JmsMethodInvocationRecoverer
-
Send one message per item in the argument list using the default destination of the jms template.
- recover(JobExecution) - Method in interface org.springframework.batch.core.launch.JobOperator
-
Marks the given
JobExecution
asFAILED
when it is stuck in aSTARTED
state 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
- RecursiveCollectionLineAggregator<T> - Class in org.springframework.batch.infrastructure.item.file.transform
-
An implementation of
LineAggregator
that concatenates a collection of items of a common type with a line separator. - RecursiveCollectionLineAggregator() - Constructor for class org.springframework.batch.infrastructure.item.file.transform.RecursiveCollectionLineAggregator
- RedisItemReader<K,
V> - Class in org.springframework.batch.infrastructure.item.redis -
Item reader for Redis based on Spring Data Redis.
- RedisItemReader(RedisTemplate<K, V>, ScanOptions) - Constructor for class org.springframework.batch.infrastructure.item.redis.RedisItemReader
- RedisItemReaderBuilder<K,
V> - Class in org.springframework.batch.infrastructure.item.redis.builder -
Builder for
RedisItemReader
. - RedisItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.redis.builder.RedisItemReaderBuilder
- RedisItemWriter<K,
T> - Class in org.springframework.batch.infrastructure.item.redis -
An
ItemWriter
implementation for Redis using aRedisTemplate
. - RedisItemWriter(Converter<T, K>, RedisTemplate<K, T>) - Constructor for class org.springframework.batch.infrastructure.item.redis.RedisItemWriter
-
Create a new
RedisItemWriter
. - RedisItemWriterBuilder<K,
V> - Class in org.springframework.batch.infrastructure.item.redis.builder -
Builder for
RedisItemWriter
. - RedisItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.redis.builder.RedisItemWriterBuilder
- redisTemplate(RedisTemplate<K, V>) - Method in class org.springframework.batch.infrastructure.item.redis.builder.RedisItemReaderBuilder
-
Set the
RedisTemplate
to use in the reader. - redisTemplate(RedisTemplate<K, V>) - Method in class org.springframework.batch.infrastructure.item.redis.builder.RedisItemWriterBuilder
-
Set the
RedisTemplate
to use to write items to Redis. - refCursorPosition(int) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
The parameter position of the REF CURSOR.
- 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.
- ReflectionUtils - Class in org.springframework.batch.infrastructure.support
-
Provides reflection based utilities for Spring Batch that are not available in Spring Framework.
- RegexLineTokenizer - Class in org.springframework.batch.infrastructure.item.file.transform
-
Line-tokenizer using a regular expression to filter out data (by using matching and non-matching groups).
- RegexLineTokenizer(String) - Constructor for class org.springframework.batch.infrastructure.item.file.transform.RegexLineTokenizer
-
Create a new
RegexLineTokenizer
with the provided regex. - 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<Step>) - Method in interface org.springframework.batch.core.configuration.StepRegistry
-
Deprecated.Registers all the step instances of the given job.
- register(String, Collection<Step>) - Method in class org.springframework.batch.core.configuration.support.MapStepRegistry
-
Deprecated.
- register(Job) - Method in interface org.springframework.batch.core.configuration.JobRegistry
-
Registers a
Job
at 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<? super T, ? super S>) - Method in class org.springframework.batch.core.listener.CompositeItemProcessListener
-
Register additional listener.
- register(ItemReadListener<? super T>) - Method in class org.springframework.batch.core.listener.CompositeItemReadListener
-
Register additional listener.
- register(ItemWriteListener<? super S>) - 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<? super T, ? super S>) - 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. - register(ItemStream) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Register a
ItemStream
as one of the interesting providers under the provided key. - register(RepeatContext) - Static method in class org.springframework.batch.infrastructure.repeat.support.RepeatSynchronizationManager
-
Method for registering a context - should only be used by
RepeatOperations
implementations to ensure thatRepeatSynchronizationManager.getContext()
always returns the correct value. - register(RepeatListener) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
-
Register additional listener.
- registerAsStreamsAndListeners(ItemReader<? extends I>, ItemProcessor<? super I, ? extends O>, ItemWriter<? super O>) - 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<I, O>) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ChunkListener
to be notified of chunk processing events. - registerCustomEditors(PropertyEditorRegistry) - Method in class org.springframework.batch.infrastructure.support.DefaultPropertyEditorRegistrar
-
Register the custom editors with the given registry.
- 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
- registerDestructionCallback(String, Runnable) - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- registerDestructionCallback(String, Runnable) - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
Register a callback to be executed on close, associated with the attribute having the given name.
- registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.batch.core.aot.CoreRuntimeHints
- registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.batch.infrastructure.aot.InfrastructureRuntimeHints
- registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.batch.integration.aot.IntegrationRuntimeHints
- registerItemListeners(SimpleStepBuilder<I, O>) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- registerItemProcessListener(ItemProcessListener<I, O>) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ItemProcessListener
to be notified of item processing events. - registerItemReadListener(ItemReadListener<I>) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ItemReadListener
to 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
ItemStream
with this step. - registerItemWriteListener(ItemWriteListener<O>) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
ItemWriteListener
to be notified of item write events. - registerJobExecutionListener(JobExecutionListener) - Method in class org.springframework.batch.core.job.AbstractJob
-
Register a single listener for the
JobExecutionListener
callbacks. - 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(RepeatListener) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Register an additional listener.
- 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
RetryListener
to be notified of item retry events. - registerSkipListener(SkipListener<I, O>) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
register a
SkipListener
to 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
ItemStream
for 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.
- RemoteChunkHandlerFactoryBean<T> - Class in org.springframework.batch.integration.chunk
-
Convenient factory bean for a chunk handler that also converts an existing chunk-oriented step into a remote chunk manager.
- RemoteChunkHandlerFactoryBean() - Constructor for class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
- RemoteChunkingManagerParser - Class in org.springframework.batch.integration.config.xml
-
Parser for the remote-chunking-manager namespace element.
- RemoteChunkingManagerParser() - Constructor for class org.springframework.batch.integration.config.xml.RemoteChunkingManagerParser
- RemoteChunkingManagerStepBuilder<I,
O> - Class in org.springframework.batch.integration.chunk -
Builder for a manager step in a remote chunking setup.
- RemoteChunkingManagerStepBuilder(String, JobRepository) - Constructor for class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
Create a new
RemoteChunkingManagerStepBuilder
. - remoteChunkingManagerStepBuilderFactory() - Method in class org.springframework.batch.integration.config.annotation.BatchIntegrationConfiguration
- RemoteChunkingManagerStepBuilderFactory - Class in org.springframework.batch.integration.chunk
-
Convenient factory for a
RemoteChunkingManagerStepBuilder
which sets theJobRepository
andPlatformTransactionManager
automatically. - RemoteChunkingManagerStepBuilderFactory(JobRepository, PlatformTransactionManager) - Constructor for class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilderFactory
-
Create a new
RemoteChunkingManagerStepBuilderFactory
. - remoteChunkingWorkerBuilder() - Method in class org.springframework.batch.integration.config.annotation.BatchIntegrationConfiguration
- RemoteChunkingWorkerBuilder<I,
O> - Class in org.springframework.batch.integration.chunk -
Builder for a worker in a remote chunking setup.
- RemoteChunkingWorkerBuilder() - Constructor for class org.springframework.batch.integration.chunk.RemoteChunkingWorkerBuilder
- RemoteChunkingWorkerParser - Class in org.springframework.batch.integration.config.xml
-
Parser for the remote-chunking-worker namespace element.
- RemoteChunkingWorkerParser() - Constructor for class org.springframework.batch.integration.config.xml.RemoteChunkingWorkerParser
- RemotePartitioningManagerStepBuilder - Class in org.springframework.batch.integration.partition
-
Builder for a manager step in a remote partitioning setup.
- RemotePartitioningManagerStepBuilder(String, JobRepository) - Constructor for class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
Create a new
RemotePartitioningManagerStepBuilder
. - remotePartitioningManagerStepBuilderFactory() - Method in class org.springframework.batch.integration.config.annotation.BatchIntegrationConfiguration
- RemotePartitioningManagerStepBuilderFactory - Class in org.springframework.batch.integration.partition
-
Convenient factory for a
RemotePartitioningManagerStepBuilder
which sets theJobRepository
andBeanFactory
automatically. - RemotePartitioningManagerStepBuilderFactory(JobRepository) - Constructor for class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilderFactory
-
Create a new
RemotePartitioningManagerStepBuilderFactory
. - RemotePartitioningWorkerStepBuilder - Class in org.springframework.batch.integration.partition
-
Builder for a worker step in a remote partitioning setup.
- RemotePartitioningWorkerStepBuilder(String, JobRepository) - Constructor for class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
-
Initialize a step builder for a step with the given name.
- remotePartitioningWorkerStepBuilderFactory() - Method in class org.springframework.batch.integration.config.annotation.BatchIntegrationConfiguration
- RemotePartitioningWorkerStepBuilderFactory - Class in org.springframework.batch.integration.partition
-
Convenient factory for a
RemotePartitioningWorkerStepBuilder
which sets theJobRepository
andBeanFactory
automatically. - RemotePartitioningWorkerStepBuilderFactory(JobRepository) - Constructor for class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilderFactory
-
Create a new
RemotePartitioningWorkerStepBuilderFactory
. - RemoteStep - Class in org.springframework.batch.integration.remote
-
A
Step
implementation that delegates the execution to a remote worker step through messaging. - RemoteStep(String, String, JobRepository, MessagingTemplate) - Constructor for class org.springframework.batch.integration.remote.RemoteStep
-
Create a new
RemoteStep
instance. - RemoteStepExecutionAggregator - Class in org.springframework.batch.core.partition.support
-
Convenience class for aggregating a set of
StepExecution
instances 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() - Method in class org.springframework.batch.infrastructure.item.Chunk.ChunkIterator
- remove() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- remove(String) - Method in class org.springframework.batch.core.scope.JobScope
- remove(String) - Method in class org.springframework.batch.core.scope.StepScope
- remove(String) - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Removes the mapping for a key from this context if it is present.
- remove(Throwable) - Method in class org.springframework.batch.infrastructure.item.Chunk.ChunkIterator
- REMOVE - Enum constant in enum class org.springframework.batch.infrastructure.item.data.MongoItemWriter.Mode
-
Remove items from the target collection using
BulkOperations.remove(Query)
. - 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.
- removeAttribute(String) - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- removeJobExecution(JobExecution) - Method in class org.springframework.batch.test.JobRepositoryTestUtils
-
Remove the
JobExecution
and its associatedStepExecution
instances from the standard locations used by Spring Batch. - removeJobExecutions() - Method in class org.springframework.batch.test.JobRepositoryTestUtils
-
Remove all the
JobExecution
instances, and all associatedJobInstance
andStepExecution
instances from the standard locations used by Spring Batch. - removeJobExecutions(Collection<JobExecution>) - Method in class org.springframework.batch.test.JobRepositoryTestUtils
-
Remove the
JobExecution
instances, and all associatedJobInstance
andStepExecution
instances from the standard locations used by Spring Batch. - RepeatCallback - Interface in org.springframework.batch.infrastructure.repeat
-
Callback interface for batch operations.
- RepeatContext - Interface in org.springframework.batch.infrastructure.repeat
-
Base interface for context which controls the state and completion / termination of a batch step.
- RepeatContextCounter - Class in org.springframework.batch.infrastructure.repeat.context
-
Helper class for policies that need to count the number of occurrences of some event (e.g. an exception type in the context) in the scope of a batch.
- RepeatContextCounter(RepeatContext, String) - Constructor for class org.springframework.batch.infrastructure.repeat.context.RepeatContextCounter
-
Convenience constructor with useParent=false.
- RepeatContextCounter(RepeatContext, String, boolean) - Constructor for class org.springframework.batch.infrastructure.repeat.context.RepeatContextCounter
-
Construct a new
RepeatContextCounter
. - RepeatContextSupport - Class in org.springframework.batch.infrastructure.repeat.context
- RepeatContextSupport(RepeatContext) - Constructor for class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
-
Constructor for
RepeatContextSupport
. - RepeatException - Exception in org.springframework.batch.infrastructure.repeat
- RepeatException(String) - Constructor for exception org.springframework.batch.infrastructure.repeat.RepeatException
- RepeatException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.repeat.RepeatException
- RepeatInternalState - Interface in org.springframework.batch.infrastructure.repeat.support
-
Internal interface for extensions of
RepeatTemplate
. - RepeatInternalStateSupport - Class in org.springframework.batch.infrastructure.repeat.support
- RepeatInternalStateSupport() - Constructor for class org.springframework.batch.infrastructure.repeat.support.RepeatInternalStateSupport
- RepeatListener - Interface in org.springframework.batch.infrastructure.repeat
-
Interface for listeners to the batch process.
- RepeatOperations - Interface in org.springframework.batch.infrastructure.repeat
-
The main interface providing access to batch operations.
- RepeatOperationsInterceptor - Class in org.springframework.batch.infrastructure.repeat.interceptor
-
A
MethodInterceptor
that can be used to automatically repeat calls to a method on a service. - RepeatOperationsInterceptor() - Constructor for class org.springframework.batch.infrastructure.repeat.interceptor.RepeatOperationsInterceptor
- RepeatStatus - Enum Class in org.springframework.batch.infrastructure.repeat
- RepeatSynchronizationManager - Class in org.springframework.batch.infrastructure.repeat.support
-
Global variable support for repeat clients.
- RepeatTemplate - Class in org.springframework.batch.infrastructure.repeat.support
-
Simple implementation and base class for batch templates implementing
RepeatOperations
. - RepeatTemplate() - Constructor for class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
- replaceExitCode(String) - Method in class org.springframework.batch.core.ExitStatus
-
Add an exit code to an existing
ExitStatus
. - replacePlaceholders(String, List<Object>) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- replyChannel - Variable in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- repository(RepositoryItemWriterBuilder.RepositoryMethodReference) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemWriterBuilder
-
Specifies a repository and the type-safe method to call for the writer.
- repository(CrudRepository<T, ?>) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemWriterBuilder
-
Set the
CrudRepository
implementation for persistence - repository(PagingAndSortingRepository<?, ?>) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
The
PagingAndSortingRepository
implementation used to read input from. - RepositoryItemReader<T> - Class in org.springframework.batch.infrastructure.item.data
-
A
ItemReader
that reads records utilizing aPagingAndSortingRepository
. - RepositoryItemReader(PagingAndSortingRepository<?, ?>, Map<String, Sort.Direction>) - Constructor for class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
-
Create a new
RepositoryItemReader
. - RepositoryItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.data.builder
-
A builder implementation for the
RepositoryItemReader
. - RepositoryItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
- RepositoryItemWriter<T> - Class in org.springframework.batch.infrastructure.item.data
-
A
ItemWriter
wrapper for aCrudRepository
from Spring Data. - RepositoryItemWriter(CrudRepository<T, ?>) - Constructor for class org.springframework.batch.infrastructure.item.data.RepositoryItemWriter
-
Create a new
RepositoryItemWriter
instance with the provided repository. - RepositoryItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.data.builder
-
A builder implementation for the
RepositoryItemWriter
. - RepositoryItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemWriterBuilder
- RepositoryItemWriterBuilder.RepositoryMethodReference<T> - Class in org.springframework.batch.infrastructure.item.data.builder
-
Establishes a proxy that will capture the Repository and the associated methodName that will be used by the writer.
- RepositoryMethodReference(CrudRepository<?, ?>) - Constructor for class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemWriterBuilder.RepositoryMethodReference
- requiresTransactionManager() - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Currently, all step implementations other than
TaskletStep
are instances ofAbstractStep
and do not require a transaction manager. - reset() - Method in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- reset() - Method in interface org.springframework.batch.infrastructure.item.xml.stax.FragmentEventReader
-
Reset the state of the fragment reader - make it forget it assumptions about current position of cursor (e.g. in case of rollback of the wrapped reader).
- reset() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- 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
- resource - Variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- resource(Resource) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Configure a
Resource
containing Avro serialized objects. - resource(Resource) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
The
Resource
to be used as input. - resource(Resource) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
-
Prototype for output resources.
- resource(Resource) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
The
Resource
to be used as input. - resource(Resource) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
Establishes the resource that will be used as the input for the LdifReader.
- resource(Resource) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
Establishes the resource that will be used as the input for the MappingLdifReader.
- resource(Resource) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
The
Resource
to be used as input. - resource(WritableResource) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemWriterBuilder
- resource(WritableResource) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
The
WritableResource
to be used as output. - resource(WritableResource) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
The
WritableResource
to be used as output. - resource(WritableResource) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
The
WritableResource
to be used as output. - ResourceAware - Interface in org.springframework.batch.infrastructure.item
-
Marker interface indicating that an item should have the Spring
Resource
in which it was read from, set on it. - ResourceAwareItemReaderItemStream<T> - Interface in org.springframework.batch.infrastructure.item.file
- ResourceAwareItemWriterItemStream<T> - Interface in org.springframework.batch.infrastructure.item.file
- ResourcelessJobRepository - Class in org.springframework.batch.core.repository.support
-
A
JobRepository
implementation that does not use or store batch meta-data. - ResourcelessJobRepository() - Constructor for class org.springframework.batch.core.repository.support.ResourcelessJobRepository
- ResourcelessTransactionManager - Class in org.springframework.batch.infrastructure.support.transaction
- ResourcelessTransactionManager() - Constructor for class org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager
- resources(Resource...) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
-
The array of resources that the
MultiResourceItemReader
will use to retrieve items. - ResourcesItemReader - Class in org.springframework.batch.infrastructure.item.file
-
ItemReader
which producesResource
instances from an array. - ResourcesItemReader() - Constructor for class org.springframework.batch.infrastructure.item.file.ResourcesItemReader
- resourceSuffixCreator(ResourceSuffixCreator) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
-
Allows customization of the suffix of the created resources based on the index.
- ResourceSuffixCreator - Interface in org.springframework.batch.infrastructure.item.file
-
Strategy interface for translating resource index into unique filename suffix.
- 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.
- restoreFrom(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- ResultHolderResultQueue - Class in org.springframework.batch.infrastructure.repeat.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0 with no replacement. Scheduled for removal in 7.0.
- ResultHolderResultQueue(int) - Constructor for class org.springframework.batch.infrastructure.repeat.support.ResultHolderResultQueue
-
Deprecated.
- results - Variable in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
- results - Variable in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
- 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
- RETHROW - Enum constant in enum class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler.Level
-
Key for
Classifier
signalling that the throwable should be rethrown. - RethrowOnThresholdExceptionHandler - Class in org.springframework.batch.infrastructure.repeat.exception
-
Implementation of
ExceptionHandler
that rethrows when exceptions of a given type reach a threshold. - RethrowOnThresholdExceptionHandler() - Constructor for class org.springframework.batch.infrastructure.repeat.exception.RethrowOnThresholdExceptionHandler
-
Set up the exception handler.
- retry(Class<? extends Throwable>) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly ask for an exception (and subclasses) to be retried.
- retry(Class<? extends Throwable>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- retry(Class<? extends Throwable>...) - 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.
- retryContextCache(RetryContextCache) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- retryLimit(int) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.The maximum number of times to try a failed item.
- retryLimit(int) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- retryLimit(long) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
- 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. - retryPolicy(RetryPolicy) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- 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.
- rootElementAttributes(Map<String, String>) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
A Map of attributes to be included in the document's root element.
- rootTagName(String) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
The name of the root tag for the output document.
- rowMapper - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- rowMapper(RowMapper<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
The
RowMapper
used to map the results of the cursor to each item. - rowMapper(RowMapper<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The
RowMapper
used to map the query results to objects. - rowMapper(RowMapper<T>) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
The
RowMapper
used to map the results of the cursor to each item. - rs - Variable in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
- 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
Job
andJobParameters
. - 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
Long
from 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<StepExecution>) - 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<StepExecution>) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
- saveExecutionContexts(Collection<StepExecution>) - Method in class org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao
- saveState - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- saveState - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaCursorItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemWriterBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Configure if the state of the
ItemStreamSupport
should be persisted within theExecutionContext
for restart purposes. - saveState(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Indicates if the state of the writer should be saved in the
ExecutionContext
. - scanOptions(ScanOptions) - Method in class org.springframework.batch.infrastructure.item.redis.builder.RedisItemReaderBuilder
-
Set the
ScanOptions
to select the key set. - schema(String) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Configure an Avro
Schema
from a String. - schema(String) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemWriterBuilder
- schema(Resource) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Configure an Avro
Schema
from aResource
. - schema(Resource) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemWriterBuilder
- 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
- ScriptItemProcessor<I,
O> - Class in org.springframework.batch.infrastructure.item.support -
ItemProcessor
implementation that passes the current item to process to the provided script. - ScriptItemProcessor() - Constructor for class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
- ScriptItemProcessorBuilder<I,
O> - Class in org.springframework.batch.infrastructure.item.support.builder -
Creates a fully qualified ScriptItemProcessor.
- ScriptItemProcessorBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.ScriptItemProcessorBuilder
- scriptResource(Resource) - Method in class org.springframework.batch.infrastructure.item.support.builder.ScriptItemProcessorBuilder
-
Sets the
Resource
location of the script to use. - scriptSource(String) - Method in class org.springframework.batch.infrastructure.item.support.builder.ScriptItemProcessorBuilder
-
Sets the provided
String
as the script source code to use. - secureRandom - Variable in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- selectClause - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- selectClause(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The SQL
SELECT
clause for a db specificPagingQueryProvider
. - 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<String, Object>, OutputStream) - Method in class org.springframework.batch.core.repository.dao.DefaultExecutionContextSerializer
-
Serializes an execution context to the provided
OutputStream
. - serialize(Map<String, Object>, OutputStream) - Method in class org.springframework.batch.core.repository.dao.Jackson2ExecutionContextStringSerializer
-
Deprecated.
- serialize(Map<String, Object>, 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
- setAncestorsCompleteOnly() - Static method in class org.springframework.batch.infrastructure.repeat.support.RepeatSynchronizationManager
-
Set current session and all ancestors (via parent) to complete.,
- setAppendAllowed(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- setAppendAllowed(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Flag to indicate that the target file should be appended if it already exists.
- 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
events
come 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
ApplicationContextFactory
instances to the set that is used to load contexts and jobs. - setArguments(Object[]) - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
- setArguments(List<?>) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
-
Arguments to be passed to the data providing method.
- setAssertUpdates(boolean) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Public setter for the flag that determines whether an assertion is made that all items cause at least one row to be updated.
- setAsText(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.RangeArrayPropertyEditor
- setAsText(String) - Method in class org.springframework.batch.infrastructure.support.IntArrayPropertyEditor
- setAttribute(String, Object) - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- setAttributeIfAbsent(String, Object) - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
-
Additional support for atomic put if absent.
- 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.
- setBatchSize(int) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
The size of batches to use when iterating over results.
- setBeanFactory(BeanFactory) - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.
- setBeanFactory(BeanFactory) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
- setBeanFactory(BeanFactory) - Method in class org.springframework.batch.integration.partition.BeanFactoryStepLocator
- setBeanFactory(BeanFactory) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilderFactory
- setBeanFactory(BeanFactory) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilderFactory
- setBeanFactoryPostProcessorClasses(Class<? extends BeanFactoryPostProcessor>[]) - 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<? extends BeanFactoryPostProcessor>[]) - 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
Step
when 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
Step
when it is created. - setBeanName(String) - Method in class org.springframework.batch.infrastructure.item.ItemStreamSupport
-
Set the name of the bean in the bean factory that created this bean.
- 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.
- setBufferedReaderFactory(BufferedReaderFactory) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Factory for the
BufferedReader
that will be used to extract lines from the file. - 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.
- setBusy(boolean) - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- 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<RepeatStatus>) - Method in class org.springframework.batch.core.step.tasklet.CallableTaskletAdapter
-
Public setter for the
Callable
. - setChannel(MessageChannel) - Method in class org.springframework.batch.integration.chunk.MessageSourcePollerInterceptor
-
Optional MessageChannel for injecting the message received from the source (defaults to the channel intercepted in
MessageSourcePollerInterceptor.preReceive(MessageChannel)
). - setCharset(Charset) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
-
Set the
Charset
to use when serializing/deserializing the execution context. - setCharset(Charset) - Method in class org.springframework.batch.core.repository.explore.support.JobExplorerFactoryBean
-
Deprecated.Sets the
Charset
to use when deserializing the execution context. - setCharset(Charset) - Method in class org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean
-
Set the
Charset
to use when serializing/deserializing the execution context. - setCharset(Charset) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Set the
Charset
to use when serializing/deserializing the execution context. - setChunk(SimpleStepBuilder<I, O>) - 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
CompletionPolicy
that applies to the chunk level. - setChunkCompletionPolicy(CompletionPolicy) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.Public setter for the
CompletionPolicy
applying 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.
- setChunkProcessor(ChunkProcessor<S>) - Method in class org.springframework.batch.integration.chunk.ChunkProcessorChunkRequestHandler
-
Public setter for the
ChunkProcessor
. - setChunkSize(int) - Method in class org.springframework.batch.core.step.item.ChunkMonitor
-
Deprecated.
- setChunkSize(int) - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
- setChunkWriter(ItemWriter<T>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
-
The item writer to be injected into the step.
- setClassifier(Classifier<? super I, ItemProcessor<?, ? extends O>>) - Method in class org.springframework.batch.infrastructure.item.support.ClassifierCompositeItemProcessor
-
Establishes the classifier that will determine which
ItemProcessor
to use. - setClassifier(Classifier<T, ItemWriter<? super T>>) - Method in class org.springframework.batch.infrastructure.item.support.ClassifierCompositeItemWriter
- setClearPersistenceContext(boolean) - Method in class org.springframework.batch.infrastructure.item.database.JpaItemWriter
-
Flag to indicate that the persistence context should be cleared and flushed at the end of the write (default true).
- 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
- setCollection(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Set the name of the Mongo collection to be written to.
- setCollection(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
- setCollection(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- setColumns(Range...) - Method in class org.springframework.batch.infrastructure.item.file.transform.FixedLengthTokenizer
-
Set the column ranges.
- 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
. - setComments(String[]) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Setter for comment prefixes.
- 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.
- setComparator(Comparator<Resource>) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
- setComplete() - Method in class org.springframework.batch.core.scope.context.ChunkContext
-
Setter for the flag to signal complete processing of a chunk.
- setCompleteOnly() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- setCompleteOnly() - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
Signal to the framework that the current batch should complete normally, independent of the current
CompletionPolicy
. - setCompleteOnly() - Static method in class org.springframework.batch.infrastructure.repeat.support.RepeatSynchronizationManager
-
Convenience method to set the current repeat operation to complete if it exists.
- setCompletionPolicy(CompletionPolicy) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Setter for policy to decide when the batch is complete.
- setConnectionAutoCommit(boolean) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Set whether "autoCommit" should be overridden for the connection used by the cursor.
- setContinuation(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.DefaultRecordSeparatorPolicy
-
Public setter for the continuation.
- setConversionService(ConversionService) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Public setter for the 'conversionService' property.
- 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
- setCurrentItemCount(int) - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
The index of the item to start reading from.
- setCustomEditors(Map<?, ? extends PropertyEditor>) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Specify the
custom editors
to register. - setCustomEditors(Map<?, ? extends PropertyEditor>) - Method in class org.springframework.batch.infrastructure.support.DefaultPropertyEditorRegistrar
-
Specify the
custom editors
to register. - 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.
- setDatabaseType(String) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- 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
. - setDataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Public setter for the data source for injection purposes.
- setDataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
-
Setter for the
DataSource
that is to be wrapped. - setDataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Public setter for the data source for injection purposes.
- setDataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
- setDataSource(DataSource) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- setDateFormat(DateFormat) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
The
DateFormat
to use for parsing dates. - setDateFormat(DateFormat) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSetFactory
-
The
DateFormat
to use for parsing dates. - setDefaultNamespace(String) - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- setDelegate(Object) - Method in class org.springframework.batch.core.listener.AbstractListenerFactoryBean
- setDelegate(StepExecutionAggregator) - Method in class org.springframework.batch.core.partition.support.RemoteStepExecutionAggregator
- setDelegate(ResourceAwareItemReaderItemStream<? extends T>) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
- setDelegate(ResourceAwareItemWriterItemStream<? super T>) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
-
Delegate used for actual writing of the output.
- setDelegate(LineAggregator<T>) - Method in class org.springframework.batch.infrastructure.item.file.transform.RecursiveCollectionLineAggregator
-
Public setter for the
LineAggregator
to use on single items, that are not Strings. - setDelegate(ItemProcessor<I, O>) - Method in class org.springframework.batch.integration.async.AsyncItemProcessor
-
The
ItemProcessor
to use to delegate processing to in a background thread. - setDelegate(ItemReader<T>) - Method in class org.springframework.batch.infrastructure.item.support.SingleItemPeekableItemReader
-
The item reader to use as a delegate.
- setDelegate(ItemStreamReader<T>) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamReader
- setDelegate(ItemStreamWriter<T>) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamWriter
-
Set the delegate
ItemStreamWriter
. - setDelegate(ItemWriter<T>) - Method in class org.springframework.batch.integration.async.AsyncItemWriter
- setDelegates(List<? extends ItemProcessor<?, ?>>) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemProcessor
-
Establishes the
ItemProcessor
delegates that will work on the item to be processed. - setDelegates(List<ItemWriter<? super T>>) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
-
The list of item writers to use as delegates.
- setDelete(boolean) - Method in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
-
Sets the delete flag to have the item writer perform deletes
- setDeleteIfExists(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- setDelimiter(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineAggregator
-
Public setter for the delimiter.
- setDelimiter(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Setter for the delimiter character.
- setDistanceLimit(int) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
The maximum difference that can be tolerated in spelling between input key names and bean property names.
- setDriverSupportsAbsolute(boolean) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Indicate whether the JDBC driver supports setting the absolute row on a
ResultSet
. - setEmbeddedSchema(boolean) - Method in class org.springframework.batch.infrastructure.item.avro.AvroItemReader
-
Disable or enable reading an embedded Avro schema.
- setEncoding(String) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Setter for the encoding for this input source.
- setEncoding(String) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- setEncoding(String) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Sets encoding for output template.
- setEncoding(String) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
-
Set encoding to be used for the input file.
- setEncoding(String) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set encoding to be used for output file.
- setEncoding(String) - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
- setEnd() - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- 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.
- setEntityClass(Class<E>) - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNamedQueryProvider
- setEntityClass(Class<E>) - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNativeQueryProvider
- setEntityManager(EntityManager) - Method in class org.springframework.batch.infrastructure.item.database.orm.AbstractJpaQueryProvider
-
Public setter to override the entityManager that was created by this
JpaQueryProvider
. - setEntityManager(EntityManager) - Method in interface org.springframework.batch.infrastructure.item.database.orm.JpaQueryProvider
-
Provide an
EntityManager
for the query to be built. - setEntityManagerFactory(EntityManagerFactory) - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
-
Set the JPA entity manager factory.
- setEntityManagerFactory(EntityManagerFactory) - Method in class org.springframework.batch.infrastructure.item.database.JpaItemWriter
-
Set the EntityManager to be used internally.
- setEntityManagerFactory(EntityManagerFactory) - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
- setEnvironmentParams(String[]) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
- setExceptionClasses(Collection<Class<? extends Throwable>>) - Method in class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
Setter for the exception classes that this handler counts.
- setExceptionClassifier(Classifier<Throwable, LogOrRethrowExceptionHandler.Level>) - Method in class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler
-
Setter for the
Classifier
used by this handler. - setExceptionClassifier(SubclassClassifier<Throwable, SkipPolicy>) - 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
. - setExceptionHandler(ExceptionHandler) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Setter for exception handler strategy.
- 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
ExecutionContext
for 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
ExecutionContext
for this execution. - setExecutionContextName(String) - Method in class org.springframework.batch.infrastructure.item.ItemStreamSupport
- setExitCodeMapper(ExitCodeMapper) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Set the
ExitCodeMapper
to 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
. - 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
ExitStatus
for 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
- setFatalExceptionClasses(Collection<Class<? extends Throwable>>) - Method in class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
Setter for the exception classes that shouldn't be counted, but rethrown immediately.
- setFaultTolerant(boolean) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Mark this step as fault-tolerant.
- setFetchSize(int) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this
ResultSet
object. - setFetchSize(int) - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
-
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this
ResultSet
object. - setFieldExtractor(FieldExtractor<T>) - Method in class org.springframework.batch.infrastructure.item.file.transform.ExtractorLineAggregator
-
Public setter for the field extractor responsible for splitting an input object up into an array of objects.
- setFields(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
JSON defining the fields to be returned from the matching documents by MongoDB.
- setFields(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
JSON defining the fields to be returned from the matching documents by MongoDB.
- setFieldSetFactory(FieldSetFactory) - Method in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
-
Factory for
FieldSet
instances. - setFieldSetMapper(FieldSetMapper<T>) - Method in class org.springframework.batch.infrastructure.item.file.mapping.DefaultLineMapper
- setFieldSetMappers(Map<String, FieldSetMapper<T>>) - Method in class org.springframework.batch.infrastructure.item.file.mapping.PatternMatchingCompositeLineMapper
- setFieldsUsedAsTargetMethodArguments(String[]) - Method in class org.springframework.batch.infrastructure.item.adapter.PropertyExtractingDelegatingItemWriter
- setFilter(boolean) - Method in class org.springframework.batch.infrastructure.item.validator.ValidatingItemProcessor
-
Should the processor filter invalid records instead of skipping them?
- 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<SimpleFlow>) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- setFooterCallback(FlatFileFooterCallback) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
footerCallback will be called after writing the last item to file, but before the file is closed.
- setFooterCallback(StaxWriterCallback) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
footerCallback is called after writing all items but before closing the file.
- setForceDisjointRanges(boolean) - Method in class org.springframework.batch.infrastructure.item.file.transform.RangeArrayPropertyEditor
-
Set force disjoint ranges.
- setForceSync(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Flag to indicate that changes should be force-synced to disk on flush.
- setForceSync(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Flag to indicate that changes should be force-synced to disk on flush.
- setForceSync(boolean) - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
-
Flag to indicate that changes should be force-synced to disk on flush.
- setFormat(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.FormatterLineAggregator
-
Set the format string used to aggregate items.
- setFragmentRootElementName(String) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- setFragmentRootElementNames(String[]) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- setFromClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- setFromClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- setFunction(boolean) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Set whether this stored procedure is a function.
- 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
StepExecutionSplitter
in theAbstractPartitionHandler.handle(StepExecutionSplitter, StepExecution)
method, instructing it how manyStepExecution
instances are required, ideally. - setGroupClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
-
The setter for the group by clause
- setGroupClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- setGroupName(String) - Method in class org.springframework.batch.core.configuration.support.JobRegistrySmartInitializingSingleton
-
Deprecated.The group name for jobs registered by this component.
- setGson(Gson) - Method in class org.springframework.batch.infrastructure.item.json.GsonJsonObjectMarshaller
-
Set the
Gson
object to use. - setHandlers(ExceptionHandler[]) - Method in class org.springframework.batch.infrastructure.repeat.exception.CompositeExceptionHandler
- setHasChunkElement(boolean) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setHeaderCallback(FlatFileHeaderCallback) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
headerCallback will be called before writing the first item to file.
- setHeaderCallback(StaxWriterCallback) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
headerCallback is called before writing any items.
- setHint(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
JSON String telling MongoDB what index to use.
- setHint(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
JSON String telling MongoDB what index to use.
- setHintValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
-
Set the query hint values for the JPA query.
- setHintValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
-
Set the query hint values for the JPA query.
- setIgnoreItemStream(boolean) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
-
Establishes the policy whether to call the open, close, or update methods for the item writer delegates associated with the CompositeItemWriter.
- setIgnoreWarnings(boolean) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Set whether SQLWarnings should be ignored (only logged) or exception should be thrown.
- setIgnoreWhitespace(boolean) - Method in class org.springframework.batch.infrastructure.item.file.separator.SuffixRecordSeparatorPolicy
-
Flag to indicate that the decision to terminate a record should ignore whitespace at the end of the line.
- setIncludedFields(int...) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
The fields to include in the output by position (starting at 0).
- setIncrementerColumnName(String) - Method in class org.springframework.batch.infrastructure.item.database.support.DefaultDataFieldMaxValueIncrementerFactory
-
Public setter for the column name (defaults to "ID") in the incrementer.
- 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
true
tasklet 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.
- setItemBindingVariableName(String) - Method in class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
-
Provides the ability to change the key name that scripts use to obtain the current item to process if the variable represented by:
ScriptItemProcessor.ITEM_BINDING_VARIABLE_NAME
is not suitable ("item"). - setItemCount(int) - Method in interface org.springframework.batch.infrastructure.item.ItemCountAware
-
Setter for the injection of the current item count.
- setItemCountLimitPerResource(int) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
-
After this limit is exceeded the next chunk will be written into newly created resource.
- setItemKeyMapper(Converter<V, K>) - Method in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
-
Set the
Converter
to use to derive the key from the item - setItemPreparedStatementSetter(ItemPreparedStatementSetter<T>) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Public setter for the
ItemPreparedStatementSetter
. - setItemProcessor(ItemProcessor<? super I, ? extends O>) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setItemProcessor(ItemProcessor<? super I, ? extends O>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- setItemProcessor(ItemProcessor<? super T, ? extends S>) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setItemProcessor(ItemProcessor<I, O>) - 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<? extends I>) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setItemReader(ItemReader<? extends T>) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setItemSqlParameterSourceProvider(ItemSqlParameterSourceProvider<T>) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Public setter for the
ItemSqlParameterSourceProvider
. - setItemType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.amqp.AmqpItemReader
-
Establish the itemType for the reader.
- setItemType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.jms.JmsItemReader
-
Set the expected type of incoming message payloads.
- setItemWriter(ItemWriter<? super O>) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setItemWriter(ItemWriter<? super O>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- setItemWriter(ItemWriter<? super S>) - Method in class org.springframework.batch.core.step.factory.SimpleStepFactoryBean
-
Deprecated.
- setJavaMailSender(JavaMailSender) - Method in class org.springframework.batch.infrastructure.item.mail.javamail.MimeMessageItemWriter
-
A
JavaMailSender
to be used to send messages inMimeMessageItemWriter.write(Chunk)
. - 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
- setJdbcTemplate(NamedParameterJdbcOperations) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Public setter for the
NamedParameterJdbcOperations
. - setJmsTemplate(JmsOperations) - Method in class org.springframework.batch.infrastructure.item.jms.JmsItemReader
-
Setter for JMS template.
- setJmsTemplate(JmsOperations) - Method in class org.springframework.batch.infrastructure.item.jms.JmsItemWriter
-
Setter for JMS template.
- setJmsTemplate(JmsOperations) - Method in class org.springframework.batch.infrastructure.item.jms.JmsMethodInvocationRecoverer
-
Setter for jms template.
- 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
Job
to delegate to in this step. - setJob(Job) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.The Job instance that can be manipulated (e.g. launched) in this utility.
- setJob(Job) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Set the job that can be operated by this utility.
- 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
DataFieldMaxValueIncrementer
to be used when generating primary keys forJobExecution
instances. - 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
- 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
JobExecutionListener
s. - 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
JobInstance
used 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
DataFieldMaxValueIncrementer
to be used when generating primary keys forJobInstance
instances. - 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
- 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
JobKeyGenerator
to be used when generating unique identifiers forJobInstance
objects. - 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
- setJobLauncher(JobLauncher) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.A
JobLauncher
instance that can be used to launch jobs. - 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
JobOperator
is required to be able to start the enclosedJob
. - setJobOperator(JobOperator) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Set the job operator to be used by this utility.
- setJobOperatorProvider(ObjectProvider<JobOperator>) - Method in class org.springframework.batch.test.context.BatchTestContextBeanPostProcessor
- setJobParameters(Set<JobParameter<?>>) - Method in class org.springframework.batch.core.repository.persistence.JobExecution
- setJobParametersConverter(JobParametersConverter) - Method in class org.springframework.batch.core.launch.support.CommandLineJobOperator
-
Set the
JobParametersConverter
to 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
JobParametersExtractor
is used to extractJobParametersExtractor
from theStepExecution
to run theJob
. - setJobParametersIncrementer(JobParametersIncrementer) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Set the
JobParametersIncrementer
for 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
- setJobParametersIncrementer(JobParametersIncrementer) - Method in class org.springframework.batch.test.JobRepositoryTestUtils
- setJobParametersValidator(JobParametersValidator) - Method in class org.springframework.batch.core.configuration.xml.JobParserJobFactoryBean
-
Set the
JobParametersValidator
for 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
- setJobProvider(ObjectProvider<Job>) - Method in class org.springframework.batch.test.context.BatchTestContextBeanPostProcessor
- setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.The
JobRegistry
to use for jobs created. - setJobRegistry(JobRegistry) - Method in class org.springframework.batch.core.configuration.support.JobFactoryRegistrationListener
-
Deprecated.Public setter for a
JobRegistry
to 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
JobRepository
for 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
JobRepository
that 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
- setJobRepository(JobRepository) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
-
JobRepository
to use to query the job repository. - setJobRepository(JobRepository) - Method in class org.springframework.batch.integration.partition.StepExecutionRequestHandler
-
A job repository that should be used to check for
StepExecution
completion. - setJobRepository(JobRepository) - Method in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.The
JobRepository
to use for creating newJobExecution
instances. - setJobRepository(JobRepository) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Set the job repository to be used by this utility.
- setJobRepository(JobRepository) - Method in class org.springframework.batch.test.JobRepositoryTestUtils
- setJobRepositoryProvider(ObjectProvider<JobRepository>) - Method in class org.springframework.batch.test.context.BatchTestContextBeanPostProcessor
- setJsonMapper(JsonMapper) - Method in class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectMarshaller
-
Set the
JsonMapper
to use. - setJsonObjectMarshaller(JsonObjectMarshaller<T>) - Method in class org.springframework.batch.infrastructure.item.json.JsonFileItemWriter
-
Set the
JsonObjectMarshaller
to use to marshal object to json. - setJsonObjectReader(JsonObjectReader<T>) - Method in class org.springframework.batch.infrastructure.item.json.JsonItemReader
-
Set the
JsonObjectReader
to use to read and map Json fragments to domain objects. - setKafkaTemplate(KafkaTemplate<K, T>) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
-
Set the
KafkaTemplate
to use. - 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
KeyGenerator
to use to identify failed items across rollback. - setKeyGenerator(KeyGenerator) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.The
KeyGenerator
to 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
JobParameters
that 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
JobExecution
was 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
StepExecution
was last updated before persisting. - setLauncher(JobLauncher) - Method in class org.springframework.batch.core.launch.support.CommandLineJobRunner
-
Deprecated.Injection setter for the
JobLauncher
. - setLimit(int) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
The query limit.
- setLimit(int) - Method in class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
The limit on the given exception type within a single context before it is rethrown.
- setLineAggregator(LineAggregator<T>) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemWriter
-
Public setter for the
LineAggregator
. - setLineEnding(String) - Method in class org.springframework.batch.infrastructure.item.file.SimpleBinaryBufferedReaderFactory
- setLineMapper(LineMapper<T>) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Setter for line mapper.
- setLineSeparator(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.RecursiveCollectionLineAggregator
-
Set the line separator to use.
- setLineSeparator(String) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Public setter for the line separator.
- setLinesToSkip(int) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Public setter for the number of lines to skip at the start of a file.
- setLinesWritten(long) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- setLineTokenizer(LineTokenizer) - Method in class org.springframework.batch.infrastructure.item.file.mapping.DefaultLineMapper
- setListeners(Object[]) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
The listeners to inject into the
Step
. - setListeners(List<? extends ChunkListener>) - Method in class org.springframework.batch.core.listener.CompositeChunkListener
-
Public setter for the listeners.
- setListeners(List<? extends ItemProcessListener<? super T, ? super S>>) - Method in class org.springframework.batch.core.listener.CompositeItemProcessListener
-
Public setter for the listeners.
- setListeners(List<? extends ItemReadListener<? super T>>) - Method in class org.springframework.batch.core.listener.CompositeItemReadListener
-
Public setter for the listeners.
- setListeners(List<? extends ItemWriteListener<? super S>>) - Method in class org.springframework.batch.core.listener.CompositeItemWriteListener
-
Public setter for the listeners.
- setListeners(List<? extends JobExecutionListener>) - Method in class org.springframework.batch.core.listener.CompositeJobExecutionListener
-
Public setter for the listeners.
- setListeners(List<? extends SkipListener<? super T, ? super S>>) - Method in class org.springframework.batch.core.listener.CompositeSkipListener
-
Public setter for the listeners.
- setListeners(List<? extends StepListener>) - Method in class org.springframework.batch.core.listener.MulticasterBatchListener
-
Register each of the objects as listeners.
- setListeners(List<? extends StepListener>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.Register some
StepListener
s with the handler. - setListeners(List<? extends StepListener>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.Register some
StepListener
s with the handler. - setListeners(List<RepeatListener>) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
-
Public setter for the listeners.
- 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(RepeatListener[]) - Method in class org.springframework.batch.infrastructure.repeat.listener.CompositeRepeatListener
-
Public setter for the listeners.
- setListeners(RepeatListener[]) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Set the listeners for this template, registering them for callbacks at appropriate times in the iteration.
- setListeners(RetryListener[]) - Method in class org.springframework.batch.core.step.item.BatchRetryTemplate
-
Deprecated.
- setLocale(Locale) - Method in class org.springframework.batch.infrastructure.item.file.transform.FormatterLineAggregator
-
Public setter for the locale.
- setLoginTimeout(int) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- setLogWriter(PrintWriter) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- setMailErrorHandler(MailErrorHandler) - Method in class org.springframework.batch.infrastructure.item.mail.javamail.MimeMessageItemWriter
-
The handler for failed messages.
- setMailErrorHandler(MailErrorHandler) - Method in class org.springframework.batch.infrastructure.item.mail.SimpleMailMessageItemWriter
-
The handler for failed messages.
- setMailSender(MailSender) - Method in class org.springframework.batch.infrastructure.item.mail.SimpleMailMessageItemWriter
-
A
MailSender
to be used to send messages inSimpleMailMessageItemWriter.write(Chunk)
. - setMapper(Gson) - Method in class org.springframework.batch.infrastructure.item.json.GsonJsonObjectReader
-
Set the object mapper to use to map Json objects to domain objects.
- setMapper(JsonMapper) - Method in class org.springframework.batch.infrastructure.item.json.JacksonJsonObjectReader
-
Set the json mapper to use to map Json objects to domain objects.
- setMapping(Map<String, Integer>) - Method in class org.springframework.batch.core.launch.support.SimpleJvmExitCodeMapper
-
Supply the ExitCodeMappings
- setMappings(Map<Object, ExitStatus>) - Method in class org.springframework.batch.core.step.tasklet.ConfigurableSystemProcessExitCodeMapper
- setMarshaller(Marshaller) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set Object to XML marshaller.
- setMaxCount(int) - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
-
Setter for maximum value of count before termination.
- setMaximumLength(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.FormatterLineAggregator
-
Public setter for the maximum length of the formatted string.
- setMaxItemCount(int) - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
The maximum index of the items to be read.
- setMaxMessageLength(int) - Method in class org.springframework.batch.infrastructure.item.mail.DefaultMailErrorHandler
-
The limit for the size of message that will be copied to the exception message.
- setMaxRows(int) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Sets the limit for the maximum number of rows that any
ResultSet
object can contain to the given number. - setMaxSkipsOnRead(int) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProvider
-
Deprecated.
- setMaxTime(Duration) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
The maximum execution time for the query
- 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
JdbcJobExecutionDao
andJdbcStepExecutionDao
. - setMaxVarCharLengthForExitMessage(int) - Method in class org.springframework.batch.core.repository.support.JobRepositoryFactoryBean
-
Deprecated.Public setter for the length of the exit message in both
JdbcJobExecutionDao
andJdbcStepExecutionDao
. - 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.
- setMaxWaitTimeouts(int) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
-
The maximum number of times to wait at the end of a step for a non-null result from the remote workers.
- setMessageChannel(MessageChannel) - Method in class org.springframework.batch.integration.remote.RemoteStep
- setMessageSource(MessageSource<?>) - Method in class org.springframework.batch.integration.chunk.MessageSourcePollerInterceptor
- setMessagingOperations(MessagingTemplate) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- setMessagingOperations(MessagingTemplate) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
-
A pre-configured gateway for sending and receiving messages to the remote workers.
- setMetaDataMap(Map<String, String>) - 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.
- setMethodName(String) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
-
Specifies what method on the repository to call.
- setMethodName(String) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemWriter
-
Specifies what method on the repository to call.
- setMinimumLength(int) - Method in class org.springframework.batch.infrastructure.item.file.transform.FormatterLineAggregator
-
Public setter for the minimum length of the formatted string.
- setMode(MongoItemWriter.Mode) - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Set the operating
MongoItemWriter.Mode
to be applied by this writer. - 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
- setName(String) - Method in class org.springframework.batch.infrastructure.item.ItemStreamSupport
-
The name of the component which will be used as a stem for keys in the
ExecutionContext
. - setName(String) - Method in class org.springframework.batch.infrastructure.item.util.ExecutionContextUserSupport
- setNamedQuery(String) - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNamedQueryProvider
- setNames(String...) - Method in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
-
Setter for column names.
- setNames(String[]) - Method in class org.springframework.batch.infrastructure.item.file.transform.BeanWrapperFieldExtractor
- setNames(String...) - Method in class org.springframework.batch.infrastructure.item.file.transform.RecordFieldExtractor
-
Set the names of record components to extract.
- setNamespaceContext(NamespaceContext) - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- setNoRollbackExceptionClasses(Collection<Class<? extends Throwable>>) - 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<Class<? extends Throwable>>) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Exception classes that are candidates for no rollback.
- setNumberFormat(NumberFormat) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
-
The
NumberFormat
to use for parsing numbers. - setNumberFormat(NumberFormat) - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSetFactory
-
The
NumberFormat
to use for parsing numbers. - 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
- setOverwriteOutput(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set "overwrite" flag for the output file.
- setPageSize(int) - Method in class org.springframework.batch.infrastructure.item.data.AbstractPaginatedDataItemReader
-
The number of items to be read with each page.
- setPageSize(int) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
- setPageSize(int) - Method in class org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader
-
The number of rows to retrieve at a time.
- setParameters(SqlParameter[]) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Add one or more declared parameters.
- setParameterValues(List<Object>) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
List
of values to be substituted in for each of the parameters in the query. - setParameterValues(List<Object>) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
List
of values to be substituted in for each of the parameters in the query. - setParameterValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
-
The parameter values to be used for the query execution.
- setParameterValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
-
Set the parameter values to be used for the query execution.
- setParameterValues(Map<String, Object>) - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
-
The parameter values to be used for the query execution.
- 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
Partitioner
that 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
PartitionHandler
which can send out step executions for remote processing and bring back the results. - setPartitionOffsets(Map<TopicPartition, Long>) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
-
Setter for partition offsets.
- setPattern(Pattern) - Method in class org.springframework.batch.infrastructure.item.file.transform.RegexLineTokenizer
-
Sets the regex pattern to use.
- setPhase(int) - Method in class org.springframework.batch.core.configuration.support.AutomaticJobRegistrar
-
Deprecated.
- setPolicies(CompletionPolicy[]) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompositeCompletionPolicy
-
Setter for the policies.
- setPolicyMap(Map<Class<? extends Throwable>, SkipPolicy>) - Method in class org.springframework.batch.core.step.skip.ExceptionClassifierSkipPolicy
-
Setter for policy map.
- setPollInterval(long) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
-
How often to poll the job repository for the status of the workers.
- setPollInterval(long) - Method in class org.springframework.batch.integration.remote.RemoteStep
- setPollTimeout(Duration) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
-
Set a timeout for the consumer topic polling duration.
- setPrefix(String, String) - Method in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- setPreparedStatementSetter(PreparedStatementSetter) - Method in class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
-
Set the PreparedStatementSetter to use if any parameter values that need to be set in the supplied query.
- setPreparedStatementSetter(PreparedStatementSetter) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Set the PreparedStatementSetter to use if any parameter values that need to be set in the supplied query.
- setPrimaryKeys(List<String>) - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Set the primary keys to associate with the document being written.
- setProcedureName(String) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Set the SQL statement to be used when creating the cursor.
- 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
ItemProcessor
is 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.
- setPrototypeBeanName(String) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
The bean name (id) for an object that can be populated from the field set that will be passed into
BeanWrapperFieldSetMapper.mapFieldSet(FieldSet)
. - setProxyTargetClass(boolean) - Method in class org.springframework.batch.core.scope.BatchScopeSupport
-
Flag to indicate that proxies should use dynamic subclassing.
- setQuery(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
A JSON formatted MongoDB query.
- setQuery(String) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
A JSON formatted MongoDB query.
- setQuery(Query) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
A Mongo Query to be used.
- setQuery(Query) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
A Mongo Query to be used.
- setQueryProvider(JpaQueryProvider) - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
-
Set the JPA query provider.
- setQueryProvider(JpaQueryProvider) - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
- setQueryProvider(PagingQueryProvider) - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
- setQueryString(String) - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
-
Set the JPQL query string.
- setQueryString(String) - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
- setQueryTimeout(int) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Sets the number of seconds the driver will wait for a
Statement
object to execute to the given number of seconds. - setQuoteCharacter(char) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineTokenizer
-
Public setter for the quoteCharacter.
- setQuoteCharacter(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.DefaultRecordSeparatorPolicy
-
Public setter for the quoteCharacter.
- setQuoteCharacter(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.DelimitedLineAggregator
-
Setter for the quote character.
- 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.
- setRecordMapper(RecordMapper<T>) - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
-
Setter for object mapper.
- setRecordSeparatorPolicy(RecordSeparatorPolicy) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Public setter for the recordSeparatorPolicy.
- setRecordsToSkip(int) - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
-
Public setter for the number of lines to skip at the start of a file.
- setRecordsToSkip(int) - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
-
Public setter for the number of lines to skip at the start of a file.
- setRedisTemplate(RedisTemplate<K, T>) - Method in class org.springframework.batch.infrastructure.item.redis.RedisItemWriter
-
Set the
RedisTemplate
to use. - setRefCursorPosition(int) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Set the parameter position of the REF CURSOR.
- setRegex(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.RegexLineTokenizer
-
Sets the regular expression to use.
- setRepeatOperations(RepeatOperations) - Method in class org.springframework.batch.infrastructure.repeat.interceptor.RepeatOperationsInterceptor
-
Setter for the
RepeatOperations
. - setReplyChannel(PollableChannel) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- setReplyChannel(PollableChannel) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
- setRepository(CrudRepository<T, ?>) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemWriter
-
Set the
CrudRepository
implementation for persistence - setRepository(PagingAndSortingRepository<?, ?>) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
-
The
PagingAndSortingRepository
implementation used to read input from. - setRequiredKeys(String[]) - Method in class org.springframework.batch.core.job.parameters.DefaultJobParametersValidator
-
The keys that are required in the parameters.
- setResource(Resource) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
Public setter for the input resource.
- setResource(Resource) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
-
Prototype for output resources.
- setResource(Resource) - Method in interface org.springframework.batch.infrastructure.item.file.ResourceAwareItemReaderItemStream
- setResource(Resource) - Method in class org.springframework.batch.infrastructure.item.json.JsonItemReader
- setResource(Resource) - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
-
Establishes the resource that will be used as the input for the LdifReader.
- setResource(Resource) - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
- setResource(Resource) - Method in interface org.springframework.batch.infrastructure.item.ResourceAware
- setResource(Resource) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- setResource(WritableResource) - Method in interface org.springframework.batch.infrastructure.item.file.ResourceAwareItemWriterItemStream
- setResource(WritableResource) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Setter for a writable resource.
- setResource(WritableResource) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set output file.
- 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.
- setResources(Resource[]) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
- setResources(Resource[]) - Method in class org.springframework.batch.infrastructure.item.file.ResourcesItemReader
-
The resources to serve up as items.
- setResourceSuffixCreator(ResourceSuffixCreator) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
-
Allows customization of the suffix of the created resources based on the index.
- 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<Class<? extends Throwable>, Boolean>) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
Public setter for exception classes that retries the item when raised.
- setRetryableExceptionClasses(Map<Class<? extends Throwable>, Boolean>) - 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
RetryListener
instances. - setRetryListeners(RetryListener...) - Method in class org.springframework.batch.core.step.factory.FaultTolerantStepFactoryBean
-
Deprecated.Public setter for the
RetryListener
s. - setRetryPolicy(RetryPolicy) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
RetryPolicy
for 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<Throwable, Boolean>) - 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<Throwable, Boolean>) - 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.
- setRootElementAttributes(Map<String, String>) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set the root element attributes to be written.
- setRootTagName(String) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set the tag name of the root element.
- setRowMapper(RowMapper<T>) - Method in class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
-
Set the RowMapper to be used for all calls to read().
- setRowMapper(RowMapper<T>) - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
-
The row mapper implementation to be used by this reader.
- setRowMapper(RowMapper<T>) - Method in class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Set the RowMapper to be used for all calls to read().
- setSaveState(boolean) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
-
Set the boolean indicating whether state should be saved in the provided
ExecutionContext
during theItemStream
call to update. - setSaveState(boolean) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
-
Indicates that the state of the reader will be saved after each commit.
- setSaveState(boolean) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
-
Set the flag that determines whether to save internal data for
ExecutionContext
. - setSaveState(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Set the flag indicating whether or not state should be saved in the provided
ExecutionContext
during theItemStream
call to update. - setSaveState(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
-
Set the flag that determines whether to save internal data for
ExecutionContext
. - setSaveState(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
- setScript(Resource) - Method in class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
-
Sets the
Resource
location of the script to use. - setScriptEvaluator(ScriptEvaluator) - Method in class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
-
Provides the ability to set a custom
ScriptEvaluator
implementation. - setScriptSource(String, String) - Method in class org.springframework.batch.infrastructure.item.support.ScriptItemProcessor
-
Sets the provided
String
as the script source code to use. - setSelectClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- setSelectClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- setSerializer(ExecutionContextSerializer) - Method in class org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao
-
Setter for
Serializer
implementation - 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
. - setShouldDeleteIfEmpty(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Flag to indicate that the target file should be deleted if no lines have been written (other than header and footer) on close.
- setShouldDeleteIfEmpty(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Flag to indicate that the target file should be deleted if no items have been written (other than header and footer) on close.
- setShouldDeleteIfExists(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Flag to indicate that the target file should be deleted if it already exists, otherwise it will be created.
- 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<Class<? extends Throwable>, Boolean>) - 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<Class<? extends Throwable>, Boolean>) - 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<Throwable, Boolean>) - Method in class org.springframework.batch.core.step.skip.LimitCheckingItemSkipPolicy
-
Deprecated.The classifier that will be used to decide on skippability.
- setSkippableExceptionMap(Map<Class<? extends Throwable>, Boolean>) - 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).
- setSkippedLinesCallback(LineCallbackHandler) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
- setSkippedRecordsCallback(RecordCallbackHandler) - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
-
RecordCallbackHandler
implementations can be used to take action on skipped records. - setSkippedRecordsCallback(RecordCallbackHandler) - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
-
RecordCallbackHandler
implementations can be used to take action on skipped records. - 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
SkipPolicy
that 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.
- setSort(Map<String, Sort.Direction>) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
Map
of property names/Sort.Direction
values to sort the input by. - setSort(Map<String, Sort.Direction>) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
Map
of property names/Sort.Direction
values to sort the input by. - setSortKey(String) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- setSortKeys(Map<String, Order>) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- setSortKeys(Map<String, Order>) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- setSorts(Map<String, Sort.Direction>) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemReader
-
Provides ordering of the results so that order is maintained between paged queries.
- setSql(String) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
-
Public setter for the query string to execute on write.
- setSql(String) - Method in class org.springframework.batch.infrastructure.item.database.JdbcCursorItemReader
-
Set the SQL statement to be used when creating the cursor.
- setSqlQuery(String) - Method in class org.springframework.batch.infrastructure.item.database.orm.JpaNativeQueryProvider
- setStandalone(Boolean) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set standalone document declaration to be used for output XML.
- 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<StateTransition>) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
- setStateTransitionComparator(Comparator<StateTransition>) - Method in class org.springframework.batch.core.job.flow.support.SimpleFlow
- setStateTransitions(List<StateTransition>) - Method in class org.springframework.batch.core.configuration.xml.SimpleFlowFactoryBean
-
The raw state transitions for the flow.
- setStateTransitions(List<StateTransition>) - 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
status
field. - 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
Step
that will be used to execute the partitionedStepExecution
. - setStep(TaskletStep) - Method in class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
-
The local step that is to be converted to a remote chunk manager.
- setStepContributionSource(StepContributionSource) - Method in class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
-
A source of
StepContribution
instances coming back from remote workers. - setStepExecution(StepExecution) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter.LocalState
- setStepExecutionAggregator(StepExecutionAggregator) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
- setStepExecutionAggregator(StepExecutionAggregator) - Method in class org.springframework.batch.core.partition.PartitionStep
-
A
StepExecutionAggregator
that 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
- setStepExecutionListeners(StepExecutionListener[]) - Method in class org.springframework.batch.core.step.AbstractStep
-
Register each of the objects as listeners.
- setStepExecutions(List<StepExecution>) - 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.
- setStepLocator(StepLocator) - Method in class org.springframework.batch.integration.partition.StepExecutionRequestHandler
-
Used to locate a
Step
to execute for each request. - 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.
- setStepName(String) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
-
The name of the
Step
that will be used to execute the partitionedStepExecution
. - 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
RepeatOperations
to use for the outer loop of the batch processing. - setStepRegistry(StepRegistry) - Method in class org.springframework.batch.core.configuration.support.DefaultJobLoader
-
Deprecated.The
StepRegistry
to use for the steps of created jobs. - setSteps(List<Step>) - Method in class org.springframework.batch.core.job.SimpleJob
-
Public setter for the steps in this job.
- setStreams(List<ItemStream>) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Public setter for the
ItemStream
s. - 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.
- setStreams(ItemStream[]) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Public setter for the
ItemStream
s. - 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
. - setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder
-
In strict mode the reader will throw an exception on
MultiResourceItemReader.open(ExecutionContext)
if there are no resources to read. - setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.FlatFileItemReader
-
In strict mode the reader will throw an exception on
AbstractItemCountingItemStreamItemReader.open(ExecutionContext)
if the input resource does not exist. - setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Public setter for the 'strict' property.
- setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
-
In strict mode the reader will throw an exception on
MultiResourceItemReader.open(ExecutionContext)
if there are no resources to read. - setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
-
Public setter for the strict flag.
- setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.json.JsonItemReader
-
In strict mode the reader will throw an exception on
AbstractItemCountingItemStreamItemReader.open(ExecutionContext)
if the input resource does not exist. - setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.ldif.LdifReader
-
In strict mode the reader will throw an exception on
AbstractItemCountingItemStreamItemReader.open(ExecutionContext)
if the input resource does not exist. - setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.ldif.MappingLdifReader
-
In strict mode the reader will throw an exception on
AbstractItemCountingItemStreamItemReader.open(ExecutionContext)
if the input resource does not exist. - setStrict(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
-
In strict mode the reader will throw an exception on
AbstractItemCountingItemStreamItemReader.open(ExecutionContext)
if the input resource does not exist. - setSuffix(String) - Method in class org.springframework.batch.infrastructure.item.file.separator.SuffixRecordSeparatorPolicy
-
Lines ending in this terminator String signal the end of a record.
- 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.
- setTargetMethod(String) - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
- setTargetObject(Object) - Method in class org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator
- setTargetType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
The targetType of object to be returned for each
AbstractItemCountingItemStreamItemReader.read()
call. - setTargetType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
The type of object to be returned for each
AbstractItemCountingItemStreamItemReader.read()
call. - setTargetType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.file.mapping.BeanWrapperFieldSetMapper
-
Public setter for the type of bean to create instead of using a prototype bean.
- setTaskExecutor(AsyncTaskExecutor) - Method in class org.springframework.batch.core.step.item.ChunkOrientedStep
-
Set the
AsyncTaskExecutor
to 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
TaskExecutor
that 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!
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.infrastructure.repeat.support.TaskExecutorRepeatTemplate
-
Deprecated.Setter for task executor to be used to run the individual item callbacks.
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.batch.integration.async.AsyncItemProcessor
-
The
TaskExecutor
to use to allow the item processing to proceed in the background. - setTasklet(Tasklet) - Method in class org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean
-
A preconfigured
Tasklet
to use. - setTasklet(Tasklet) - Method in class org.springframework.batch.core.step.tasklet.TaskletStep
-
Public setter for the
Tasklet
. - setTemplate(MongoOperations) - Method in class org.springframework.batch.infrastructure.item.data.MongoCursorItemReader
-
Used to perform operations against the MongoDB instance.
- setTemplate(MongoOperations) - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
Set the
MongoOperations
to be used to save items to be written. - setTemplate(MongoOperations) - Method in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
-
Used to perform operations against the MongoDB instance.
- 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() - Method in class org.springframework.batch.infrastructure.repeat.context.RepeatContextSupport
- setTerminateOnly() - Method in interface org.springframework.batch.infrastructure.repeat.RepeatContext
-
Signal to the framework that the current batch should complete abnormally, independent of the current
CompletionPolicy
. - 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.
- setThresholds(Map<Class<? extends Throwable>, Integer>) - Method in class org.springframework.batch.infrastructure.repeat.exception.RethrowOnThresholdExceptionHandler
-
A map from exception classes to a threshold value of type Integer.
- setThrottleLimit(long) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
-
Public setter for the throttle limit.
- setTimeout(long) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Timeout in milliseconds.
- setTimeout(long) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
-
The time limit to wait when flushing items to Kafka.
- setTimeout(long) - Method in class org.springframework.batch.integration.partition.MessageChannelPartitionHandler
-
When using job repository polling, the time limit to wait.
- setTimeout(long) - Method in class org.springframework.batch.integration.remote.RemoteStep
- setTimeout(long, TimeUnit) - Method in class org.springframework.batch.infrastructure.item.queue.BlockingQueueItemReader
-
Set the reading timeout and time unit.
- setTokenizers(Map<String, LineTokenizer>) - Method in class org.springframework.batch.infrastructure.item.file.mapping.PatternMatchingCompositeLineMapper
- setTokenizers(Map<String, LineTokenizer>) - Method in class org.springframework.batch.infrastructure.item.file.transform.PatternMatchingCompositeLineTokenizer
- setTransacted(boolean) - Method in class org.springframework.batch.infrastructure.item.database.JpaPagingItemReader
-
By default (true) the EntityTransaction will be started and committed around the read.
- setTransactional(boolean) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Flag to indicate that writing to the buffer should be delayed if a transaction is active.
- setTransactional(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Flag to indicate that writes should be deferred to the end of a transaction if present.
- 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
PlatformTransactionManager
to 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.
- setUnmarshaller(Unmarshaller) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
- setUpOutputFile(File, boolean, boolean, boolean) - Static method in class org.springframework.batch.infrastructure.item.util.FileUtils
-
Set up output file for batch processing.
- setUseAllParentParameters(boolean) - Method in class org.springframework.batch.core.step.job.DefaultJobParametersExtractor
-
setter to support switching off all parent parameters
- setUseParent(boolean) - Method in class org.springframework.batch.infrastructure.repeat.exception.RethrowOnThresholdExceptionHandler
-
Flag to indicate the exception counters should be shared between sibling contexts in a nested batch.
- setUseParent(boolean) - Method in class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
Flag to indicate the exception counters should be shared between sibling contexts in a nested batch (i.e. inner loop).
- setUseParent(boolean) - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
-
Flag to indicate whether the count is at the level of the parent context, or just local to the context.
- setUsePersist(boolean) - Method in class org.springframework.batch.infrastructure.item.database.JpaItemWriter
-
Set whether the EntityManager should perform a persist instead of a merge.
- setUserData(Object) - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- setUseSharedExtendedConnection(boolean) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Indicate whether the connection used for the cursor should be used by all other processing thus sharing the same transaction.
- 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.
- setValidator(Validator<? super T>) - Method in class org.springframework.batch.infrastructure.item.validator.ValidatingItemProcessor
-
Set the validator used to validate each item.
- setValidator(Validator) - Method in class org.springframework.batch.infrastructure.item.validator.SpringValidator
- setValidators(List<JobParametersValidator>) - Method in class org.springframework.batch.core.job.parameters.CompositeJobParametersValidator
-
Public setter for the validators
- setValues(Map<String, Object>, PreparedStatement) - Method in class org.springframework.batch.infrastructure.item.database.support.ColumnMapItemPreparedStatementSetter
- setValues(T, PreparedStatement) - Method in interface org.springframework.batch.infrastructure.item.database.ItemPreparedStatementSetter
-
Set parameter values on the given PreparedStatement as determined from the provided item.
- setVerifyCursorPosition(boolean) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
-
Allow verification of cursor position after current row is processed by RowMapper or RowCallbackHandler.
- setVersion(Integer) - Method in class org.springframework.batch.core.Entity
-
Public setter for the version.
- setVersion(String) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Set XML version to be used for output XML.
- setWhereClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.AbstractSqlPagingQueryProvider
- setWhereClause(String) - Method in class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- 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.
- setXmlInputFactory(XMLInputFactory) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
-
Set the
XMLInputFactory
. - shouldClose(Connection) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- shouldDeleteIfEmpty(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
If set to true, once the step is complete, if the resource previously provided is empty, it will be deleted.
- shouldDeleteIfEmpty(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
If set to true, once the step is complete, if the resource previously provided is empty, it will be deleted.
- shouldDeleteIfEmpty(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Flag to indicate that the output file should be deleted if no results were written to it.
- shouldDeleteIfExists - Variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- shouldDeleteIfExists(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
If set to true, upon the start of the step, if the resource already exists, it will be deleted and recreated.
- shouldDeleteIfExists(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
If set to true, upon the start of the step, if the resource already exists, it will be deleted and recreated.
- 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.
- SimpleBinaryBufferedReaderFactory - Class in org.springframework.batch.infrastructure.item.file
-
A
BufferedReaderFactory
useful for reading simple binary (or text) files with no line endings, such as those produced by mainframe copy books. - SimpleBinaryBufferedReaderFactory() - Constructor for class org.springframework.batch.infrastructure.item.file.SimpleBinaryBufferedReaderFactory
- 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
ChunkOrientedStep
instead. Scheduled for removal in 7.0. - SimpleChunkProcessor(ItemProcessor<? super I, ? extends O>, ItemWriter<? super O>) - Constructor for class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- SimpleChunkProcessor(ItemWriter<? super O>) - 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
ChunkOrientedStep
instead. Scheduled for removal in 7.0. - SimpleChunkProvider(ItemReader<? extends I>, RepeatOperations) - Constructor for class org.springframework.batch.core.step.item.SimpleChunkProvider
-
Deprecated.
- SimpleCompletionPolicy - Class in org.springframework.batch.infrastructure.repeat.policy
-
Policy for terminating a batch after a fixed number of operations.
- SimpleCompletionPolicy() - Constructor for class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
- SimpleCompletionPolicy(int) - Constructor for class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
- SimpleCompletionPolicy.SimpleTerminationContext - Class in org.springframework.batch.infrastructure.repeat.policy
- 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
SimpleFlow
instances 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
Job
interface 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
JobRepository
that 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
ExitCodeMapper
that 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
- SimpleLimitExceptionHandler - Class in org.springframework.batch.infrastructure.repeat.exception
-
Simple implementation of exception handler which looks for given exception types.
- SimpleLimitExceptionHandler() - Constructor for class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
Default constructor for the
SimpleLimitExceptionHandler
. - SimpleLimitExceptionHandler(int) - Constructor for class org.springframework.batch.infrastructure.repeat.exception.SimpleLimitExceptionHandler
-
Convenience constructor for the
SimpleLimitExceptionHandler
to set the limit. - SimpleMailMessageItemWriter - Class in org.springframework.batch.infrastructure.item.mail
-
A simple
ItemWriter
that can send mail messages. - SimpleMailMessageItemWriter(MailSender) - Constructor for class org.springframework.batch.infrastructure.item.mail.SimpleMailMessageItemWriter
-
Create a new
SimpleMailMessageItemWriter
with the givenMailSender
. - SimpleMailMessageItemWriterBuilder - Class in org.springframework.batch.infrastructure.item.mail.builder
-
Creates a fully qualified SimpleMailMessageItemWriter.
- SimpleMailMessageItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.mail.builder.SimpleMailMessageItemWriterBuilder
- SimpleMethodInvoker - Class in org.springframework.batch.infrastructure.support
-
Simple implementation of the
MethodInvoker
interface that invokes a method on an object. - SimpleMethodInvoker(Object, Method) - Constructor for class org.springframework.batch.infrastructure.support.SimpleMethodInvoker
- SimpleMethodInvoker(Object, String, Class<?>...) - Constructor for class org.springframework.batch.infrastructure.support.SimpleMethodInvoker
- 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
- SimpleRecordSeparatorPolicy - Class in org.springframework.batch.infrastructure.item.file.separator
-
Simplest possible
RecordSeparatorPolicy
- treats all lines as record endings. - SimpleRecordSeparatorPolicy() - Constructor for class org.springframework.batch.infrastructure.item.file.separator.SimpleRecordSeparatorPolicy
- SimpleResourceSuffixCreator - Class in org.springframework.batch.infrastructure.item.file
-
Trivial implementation of
ResourceSuffixCreator
that uses the index itself as suffix, separated by dot. - SimpleResourceSuffixCreator() - Constructor for class org.springframework.batch.infrastructure.item.file.SimpleResourceSuffixCreator
- 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
ChunkOrientedStep
instead. Scheduled for removal in 7.0. - SimpleRetryExceptionHandler(RetryPolicy, ExceptionHandler, Collection<Class<? extends Throwable>>) - 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<I, O>) - 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
StepExecutionSplitter
that delegates to aPartitioner
to generateExecutionContext
instances. - SimpleStepExecutionSplitter(JobRepository, String, Partitioner) - Constructor for class org.springframework.batch.core.partition.support.SimpleStepExecutionSplitter
-
Construct a
SimpleStepExecutionSplitter
from 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
StepHandler
that 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
SystemProcessExitCodeMapper
implementation that performs following mapping: - SimpleSystemProcessExitCodeMapper() - Constructor for class org.springframework.batch.core.step.tasklet.SimpleSystemProcessExitCodeMapper
- SimpleTerminationContext(RepeatContext) - Constructor for class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy.SimpleTerminationContext
- SingleItemPeekableItemReader<T> - Class in org.springframework.batch.infrastructure.item.support
-
A
PeekableItemReader
that allows the user to peek one item ahead. - SingleItemPeekableItemReader(ItemReader<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.SingleItemPeekableItemReader
-
Create a new
SingleItemPeekableItemReader
with the given delegate. - SingleItemPeekableItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.support.builder
-
Creates a fully qualified SingleItemPeekeableItemReader.
- SingleItemPeekableItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.SingleItemPeekableItemReaderBuilder
- size() - Method in class org.springframework.batch.infrastructure.item.Chunk
- size() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Returns number of entries in the context
- skip(Class<? extends Throwable>) - Method in class org.springframework.batch.core.step.builder.FaultTolerantStepBuilder
-
Deprecated.Explicitly request certain exceptions (and subclasses) to be skipped.
- skip(Class<? extends Throwable>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- skip(Class<? extends Throwable>...) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
- skip(Exception) - Method in class org.springframework.batch.infrastructure.item.Chunk
-
Deprecated, for removal: This API element is subject to removal in a future version.
- skipCount - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkScanEvent
- SkipException - Exception in org.springframework.batch.core.step.skip
-
Base exception indicating that the skip has failed or caused a failure.
- SkipException(String) - Constructor for exception org.springframework.batch.core.step.skip.SkipException
- SkipException(String, Throwable) - Constructor for exception 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(int) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- skipLimit(long) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
- SkipLimitExceededException - Exception in org.springframework.batch.core.step.skip
-
Exception indicating that the skip limit for a particular
Step
has been exceeded. - SkipLimitExceededException(long, Throwable) - Constructor for exception org.springframework.batch.core.step.skip.SkipLimitExceededException
- skipListener(SkipListener<I, O>) - 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 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 org.springframework.batch.core.step.skip.SkipListenerFailedException
-
Deprecated.
- SkipListenerFailedException(String, Throwable) - Constructor for exception org.springframework.batch.core.step.skip.SkipListenerFailedException
-
Deprecated.Create a new
SkipListenerFailedException
. - SkipOverflowException - Exception 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 org.springframework.batch.core.step.item.SkipOverflowException
-
Deprecated.
- skippedLinesCallback(LineCallbackHandler) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
A callback to be called for each line that is skipped.
- skippedRecordsCallback(RecordCallbackHandler) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
RecordCallbackHandler
implementations can be used to take action on skipped records. - skippedRecordsCallback(RecordCallbackHandler) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
RecordCallbackHandler
implementations can be used to take action on skipped records. - 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(SkipPolicy) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- SkipPolicy - Interface in org.springframework.batch.core.step.skip
-
Policy for determining whether or not some processing should be skipped.
- SkipPolicyFailedException - Exception 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 org.springframework.batch.core.step.skip.SkipPolicyFailedException
-
Deprecated.
- SkipWrapper<T> - Class in org.springframework.batch.infrastructure.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.
- SkipWrapper(T) - Constructor for class org.springframework.batch.infrastructure.item.SkipWrapper
-
Deprecated.
- SkipWrapper(T, Throwable) - Constructor for class org.springframework.batch.infrastructure.item.SkipWrapper
-
Deprecated.
- sort - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- sortKeys - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- sortKeys(Map<String, Order>) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The keys to sort by.
- sorts - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- sorts(Map<String, Sort.Direction>) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Map
of property names/Sort.Direction
values to sort the input by. - sorts(Map<String, Sort.Direction>) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Map
of property names/Sort.Direction
values to sort the input by. - sorts(Map<String, Sort.Direction>) - Method in class org.springframework.batch.infrastructure.item.data.builder.RepositoryItemReaderBuilder
-
Provides ordering of the results so that order is maintained between paged queries.
- sourceType(Class<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.DelimitedBuilder
-
Specify the type of items from which fields will be extracted.
- sourceType(Class<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder.FormattedBuilder
-
Specify the type of items from which fields will be extracted.
- SpELItemKeyMapper<K,
V> - Class in org.springframework.batch.infrastructure.item -
An implementation of
Converter
that uses SpEL to map a Value to a key - SpELItemKeyMapper(String) - Constructor for class org.springframework.batch.infrastructure.item.SpELItemKeyMapper
- split(StepExecution, int) - Method in interface org.springframework.batch.core.partition.StepExecutionSplitter
-
Partition the provided
StepExecution
into 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<Q>, 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
InlineFlowParser
by using the provided job repository reference. - SplitState - Class in org.springframework.batch.core.job.flow.support.state
- SplitState(Collection<Flow>, String) - Constructor for class org.springframework.batch.core.job.flow.support.state.SplitState
- SplitState(Collection<Flow>, 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
StepExecutionSplitter
instead of having one build from thePartitionStepBuilder.partitioner(String, Partitioner)
. - splitter(StepExecutionSplitter) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- SpringBatchTest - Annotation Interface in org.springframework.batch.test.context
-
Annotation that can be specified on a test class that runs Spring Batch based tests.
- SpringBatchVersion - Class in org.springframework.batch.core
-
Class that exposes the Spring Batch version.
- SpringValidator<T> - Class in org.springframework.batch.infrastructure.item.validator
-
Adapts the
Validator
interface toValidator
. - SpringValidator() - Constructor for class org.springframework.batch.infrastructure.item.validator.SpringValidator
- sql - Variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- sql(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcBatchItemWriterBuilder
-
Set the SQL statement to be used for each item's updates.
- sql(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
The query to be executed for this reader
- SQLITE - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- SqlitePagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
SQLite implementation of a
PagingQueryProvider
using database specific features. - SqlitePagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.SqlitePagingQueryProvider
- SqlPagingQueryProviderFactoryBean - Class in org.springframework.batch.infrastructure.item.database.support
-
Factory bean for
PagingQueryProvider
interface. - SqlPagingQueryProviderFactoryBean() - Constructor for class org.springframework.batch.infrastructure.item.database.support.SqlPagingQueryProviderFactoryBean
- SqlPagingQueryUtils - Class in org.springframework.batch.infrastructure.item.database.support
-
Utility class that generates the actual SQL statements used by query providers.
- SQLSERVER - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- SqlServerPagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
SQL Server implementation of a
PagingQueryProvider
using database specific features. - SqlServerPagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.SqlServerPagingQueryProvider
- standalone(Boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Standalone document declaration for the output document.
- 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() - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Delegate to the
CompletionPolicy
. - 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.
- start(RepeatContext) - Method in interface org.springframework.batch.infrastructure.repeat.CompletionPolicy
-
Create a new context for the execution of a batch.
- start(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompletionPolicySupport
-
Build a new
RepeatContextSupport
and return it. - start(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompositeCompletionPolicy
-
Create a new composite context from all the available policies.
- start(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
- start(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
-
Reset the counter.
- start(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.TimeoutTerminationPolicy
-
Start the clock on the timeout.
- startCloseSuppression(Connection) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- startDocument(XMLEventWriter) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Writes simple XML header containing: xml declaration - defines encoding and XML version opening tag of the root element and its attributes If this is not sufficient for you, simply override this method.
- 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.
- startJob() - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Start the entire job, including all steps, with a set of unique random job parameters.
- startJob(JobParameters) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Start the entire job, including all steps, with the provided set of job parameters.
- startLimit(int) - Method in class org.springframework.batch.core.step.builder.StepBuilderHelper
- startLimit(int) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- startLimit(int) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- startLimit(int) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- StartLimitExceededException - Exception in org.springframework.batch.core.job
-
Indicates the step's start limit has been exceeded.
- StartLimitExceededException(String) - Constructor for exception 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
JobInstance
determined by theJobParametersIncrementer
attached 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
- startStep(String) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Start just the specified step in a surrounding single-step job of type
SimpleJob
namedJobOperatorTestUtils.JOB_NAME
. - startStep(String, JobParameters, ExecutionContext) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Extract the step from the injected job and start it in a surrounding single-step job of type
SimpleJob
namedJobOperatorTestUtils.JOB_NAME
. - startStep(Step) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Start just the specified step with a unique set of job parameters in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - startStep(Step, JobParameters, ExecutionContext) - Method in class org.springframework.batch.test.JobOperatorTestUtils
-
Start just the specified step in a surrounding single-step job of type
SimpleJob
namedStepRunner.JOB_NAME
. - state - Variable in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- 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
State
to 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
- StaxEventItemReader<T> - Class in org.springframework.batch.infrastructure.item.xml
-
Item reader for reading XML input based on StAX.
- StaxEventItemReader(Unmarshaller) - Constructor for class org.springframework.batch.infrastructure.item.xml.StaxEventItemReader
-
Create a new
StaxEventItemReader
instance. - StaxEventItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.xml.builder
-
A fluent builder for the
StaxEventItemReader
- StaxEventItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
- StaxEventItemWriter<T> - Class in org.springframework.batch.infrastructure.item.xml
-
An implementation of
ItemWriter
which uses StAX andMarshaller
for serializing object to XML. - StaxEventItemWriter(WritableResource, Marshaller) - Constructor for class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
- StaxEventItemWriter(Marshaller) - Constructor for class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Create a new
StaxEventItemWriter
instance. - StaxEventItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.xml.builder
-
A builder for the
StaxEventItemWriter
. - StaxEventItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
- StaxWriterCallback - Interface in org.springframework.batch.infrastructure.item.xml
-
Callback interface for writing to an XML file - useful e.g. for handling headers and footers.
- step(Step) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Provide an actual step instance to execute in parallel.
- step(Step) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
- 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_EXECUTION - Static variable in class org.springframework.batch.integration.async.StepExecutionInterceptor
-
The name of the header
- 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 in org.springframework.batch.core.step.builder
-
Utility exception thrown by builders when they encounter unexpected checked exceptions.
- StepBuilderException(Exception) - Constructor for exception org.springframework.batch.core.step.builder.StepBuilderException
- StepBuilderException(String, Throwable) - Constructor for exception org.springframework.batch.core.step.builder.StepBuilderException
- StepBuilderHelper<B extends 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
StepBuilderHelper
with 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
StepExecution
and 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
StepContext
for 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
- StepContributionSource - Interface in org.springframework.batch.integration.chunk
-
A source of
StepContribution
instances that can be aggregated and used to update an ongoingStepExecution
. - 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
- 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.
- StepExecutionInterceptor - Class in org.springframework.batch.integration.async
-
A
ChannelInterceptor
that adds the currentStepExecution
(if there is one) as a header to the message. - StepExecutionInterceptor() - Constructor for class org.springframework.batch.integration.async.StepExecutionInterceptor
- 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
- StepExecutionRequest - Class in org.springframework.batch.integration.partition
-
Class encapsulating information required to request a step execution in a remote partitioning setup.
- StepExecutionRequest(String, Long, Long) - Constructor for class org.springframework.batch.integration.partition.StepExecutionRequest
-
Create a new
StepExecutionRequest
instance. - StepExecutionRequestHandler - Class in org.springframework.batch.integration.partition
- StepExecutionRequestHandler() - Constructor for class org.springframework.batch.integration.partition.StepExecutionRequestHandler
- 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
Step
as 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
AbstractListenerFactoryBean
implementation is used to create aStepListener
. - StepListenerFactoryBean() - Constructor for class org.springframework.batch.core.listener.StepListenerFactoryBean
- StepListenerFailedException - Exception 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 org.springframework.batch.core.listener.StepListenerFailedException
-
Deprecated.
- StepListenerMetaData - Enum Class in org.springframework.batch.core.listener
-
Enumeration for
StepListener
meta 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
StepListener
interfaces. - StepListenerSupport() - Constructor for class org.springframework.batch.core.listener.StepListenerSupport
- stepLocator - Variable in class org.springframework.batch.core.step.StepLocatorStepFactoryBean
-
Deprecated.
- stepLocator(StepLocator) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
-
Set the step locator used to locate the worker step to execute.
- StepLocator - Interface in org.springframework.batch.core.step
-
Interface for locating a
Step
instance 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.
- stepOperations(RepeatOperations) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- StepParserStepFactoryBean<I,
O> - Class in org.springframework.batch.core.configuration.xml -
This
FactoryBean
is used by the batch namespace parser to createStep
objects. - 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.
- stepRunner - Variable in class org.springframework.batch.test.JobLauncherTestUtils
-
Deprecated.
- StepRunner - Class in org.springframework.batch.test
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.0 in favor of
JobOperatorTestUtils.startStep(String, JobParameters, ExecutionContext)
. Scheduled for removal in 6.2 or later - StepRunner(JobLauncher, JobRepository) - Constructor for class org.springframework.batch.test.StepRunner
-
Deprecated.
- 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
Step
is not step scope aware (i.e. not the ones provided by the framework). - StepScopeManager() - Constructor for class org.springframework.batch.core.scope.context.StepScopeManager
- StepScopeTestExecutionListener - Class in org.springframework.batch.test
-
A
TestExecutionListener
that sets up step-scope context for dependency injection into unit tests. - StepScopeTestExecutionListener() - Constructor for class org.springframework.batch.test.StepScopeTestExecutionListener
- StepScopeTestUtils - Class in org.springframework.batch.test
-
Utility class for creating and manipulating
StepScope
in unit tests. - 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
StepExecution
context. - stop(StepExecution) - Method in class org.springframework.batch.core.step.tasklet.SystemCommandTasklet
-
Interrupts the execution of the system command if the given
StepExecution
matches 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.
- stopCloseSuppression(Connection) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
- StoppableStep - Interface in org.springframework.batch.core.step
-
Extension of the
Step
interface to be implemented by steps that support being stopped. - StoppableTasklet - Interface in org.springframework.batch.core.step.tasklet
-
An extension to the
Tasklet
interface 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.
- StoredProcedureItemReader<T> - Class in org.springframework.batch.infrastructure.item.database
-
Item reader implementation that executes a stored procedure and then reads the returned cursor and continually retrieves the next row in the
ResultSet
. - StoredProcedureItemReader(DataSource, String, RowMapper<T>) - Constructor for class org.springframework.batch.infrastructure.item.database.StoredProcedureItemReader
-
Create a new instance of the
StoredProcedureItemReader
class. - StoredProcedureItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.database.builder
-
A fluent builder API for the configuration of a
StoredProcedureItemReader
. - StoredProcedureItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
- 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.
- stream(ItemStream) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- strict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.DelimitedBuilder
-
If true (the default) then the number of tokens in line must match the number of tokens defined (by
Range
, columns, etc.) inLineTokenizer
. - strict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder.FixedLengthBuilder
-
Boolean indicating if the number of tokens in a line must match the number of fields (ranges) configured.
- strict(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
Configure if the reader should be in strict mode (require the input
Resource
to exist). - strict(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonItemReaderBuilder
-
Setting this value to true indicates that it is an error if the input does not exist and an exception will be thrown.
- strict(boolean) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.LdifReaderBuilder
-
In strict mode the reader will throw an exception on
AbstractItemCountingItemStreamItemReader.open(ExecutionContext)
if the input resource does not exist. - strict(boolean) - Method in class org.springframework.batch.infrastructure.item.ldif.builder.MappingLdifReaderBuilder
-
In strict mode the reader will throw an exception on
AbstractItemCountingItemStreamItemReader.open(ExecutionContext)
if the input resource does not exist. - strict(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Setting this value to true indicates that it is an error if the input does not exist and an exception will be thrown.
- 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
- stringToProperties(String) - Static method in class org.springframework.batch.infrastructure.support.PropertiesConverter
-
Deprecated.Parse a String to a Properties object.
- SuffixRecordSeparatorPolicy - Class in org.springframework.batch.infrastructure.item.file.separator
-
A
RecordSeparatorPolicy
that looks for an exact match for a String at the end of a line (e.g. a semicolon). - SuffixRecordSeparatorPolicy() - Constructor for class org.springframework.batch.infrastructure.item.file.separator.SuffixRecordSeparatorPolicy
- SupplierItemReader<T> - Class in org.springframework.batch.infrastructure.item.function
-
Adapter for a
Supplier
to anItemReader
. - SupplierItemReader(Supplier<T>) - Constructor for class org.springframework.batch.infrastructure.item.function.SupplierItemReader
-
Create a new
SupplierItemReader
. - 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.
- SYBASE - Enum constant in enum class org.springframework.batch.infrastructure.support.DatabaseType
- SybasePagingQueryProvider - Class in org.springframework.batch.infrastructure.item.database.support
-
Sybase implementation of a
PagingQueryProvider
using database specific features. - SybasePagingQueryProvider() - Constructor for class org.springframework.batch.infrastructure.item.database.support.SybasePagingQueryProvider
- 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
- SynchronizedAttributeAccessor - Class in org.springframework.batch.infrastructure.repeat.context
-
An
AttributeAccessor
that synchronizes on a mutex (not this) before modifying or accessing the underlying attributes. - SynchronizedAttributeAccessor() - Constructor for class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- SynchronizedItemReader<T> - Class in org.springframework.batch.infrastructure.item.support
-
This is an
ItemReader
decorator with a synchronizedItemReader.read()
method. - SynchronizedItemReader(ItemReader<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.SynchronizedItemReader
- SynchronizedItemReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.support.builder
-
Builder for
SynchronizedItemReader
. - SynchronizedItemReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemReaderBuilder
- SynchronizedItemStreamReader<T> - Class in org.springframework.batch.infrastructure.item.support
-
This is a simple ItemStreamReader decorator with a synchronized ItemReader.read() method - which makes a non-thread-safe ItemReader thread-safe.
- SynchronizedItemStreamReader(ItemStreamReader<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamReader
-
Create a new
SynchronizedItemStreamReader
with the given delegate. - SynchronizedItemStreamReaderBuilder<T> - Class in org.springframework.batch.infrastructure.item.support.builder
-
Creates a fully qualified SynchronizedItemStreamReader.
- SynchronizedItemStreamReaderBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemStreamReaderBuilder
- SynchronizedItemStreamWriter<T> - Class in org.springframework.batch.infrastructure.item.support
-
An
ItemStreamWriter
decorator with a synchronizedwrite()
method. - SynchronizedItemStreamWriter(ItemStreamWriter<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamWriter
-
Create a new
SynchronizedItemStreamWriter
with the given delegate. - SynchronizedItemStreamWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.support.builder
-
Creates a fully qualified
SynchronizedItemStreamWriter
. - SynchronizedItemStreamWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemStreamWriterBuilder
- SynchronizedItemWriter<T> - Class in org.springframework.batch.infrastructure.item.support
-
This is an
ItemWriter
decorator with a synchronizedItemWriter.write(org.springframework.batch.infrastructure.item.Chunk<? extends T>)
method. - SynchronizedItemWriter(ItemWriter<T>) - Constructor for class org.springframework.batch.infrastructure.item.support.SynchronizedItemWriter
- SynchronizedItemWriterBuilder<T> - Class in org.springframework.batch.infrastructure.item.support.builder
-
Builder for
SynchronizedItemWriter
. - SynchronizedItemWriterBuilder() - Constructor for class org.springframework.batch.infrastructure.item.support.builder.SynchronizedItemWriterBuilder
- 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 in org.springframework.batch.core.step.tasklet
-
Exception indicating failed execution of system command.
- SystemCommandException(String) - Constructor for exception org.springframework.batch.core.step.tasklet.SystemCommandException
- SystemCommandException(String, Throwable) - Constructor for exception org.springframework.batch.core.step.tasklet.SystemCommandException
- SystemCommandTasklet - Class in org.springframework.batch.core.step.tasklet
-
Tasklet
that 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.
- take() - Method in class org.springframework.batch.infrastructure.repeat.support.ResultHolderResultQueue
-
Deprecated.Get the next result as soon as it becomes available.
- take() - Method in class org.springframework.batch.infrastructure.repeat.support.ThrottleLimitResultQueue
-
Deprecated.
- targetType - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- targetType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
The targetType of object to be returned for each
AbstractItemCountingItemStreamItemReader.read()
call. - targetType(Class<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
The type of object to be returned for each
AbstractItemCountingItemStreamItemReader.read()
call. - targetType(Class<T>) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemReaderBuilder
-
The class that will represent the "item" to be returned from the reader.
- 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
-
Provide a task executor to use when executing the tasklet.
- taskExecutor(TaskExecutor) - Method in class org.springframework.batch.core.step.builder.PartitionStepBuilder
-
Provide a task executor to use when constructing a
PartitionHandler
from 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 theJobOperator
interface. - TaskExecutorJobOperator() - Constructor for class org.springframework.batch.core.launch.support.TaskExecutorJobOperator
- TaskExecutorPartitionHandler - Class in org.springframework.batch.core.partition.support
-
A
PartitionHandler
that uses aTaskExecutor
to execute the partitionedStep
locally 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.
- TaskExecutorRepeatTemplate - Class in org.springframework.batch.infrastructure.repeat.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 7.0.
- TaskExecutorRepeatTemplate() - Constructor for class org.springframework.batch.infrastructure.repeat.support.TaskExecutorRepeatTemplate
-
Deprecated.
- 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(Tasklet, PlatformTransactionManager) - Method in class org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder
- 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
- template - Variable in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
- template - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- template(MongoOperations) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoCursorItemReaderBuilder
-
Used to perform operations against the MongoDB instance.
- template(MongoOperations) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoItemWriterBuilder
-
Set the
MongoOperations
to be used to save items to be written. - template(MongoOperations) - Method in class org.springframework.batch.infrastructure.item.data.builder.MongoPagingItemReaderBuilder
-
Used to perform operations against the MongoDB instance.
- 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
- throttleLimit - Variable in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- throttleLimit(long) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
Public setter for the throttle limit.
- ThrottleLimitResultQueue<T> - Class in org.springframework.batch.infrastructure.repeat.support
-
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0 with no replacement. Scheduled for removal in 7.0.
- ThrottleLimitResultQueue(int) - Constructor for class org.springframework.batch.infrastructure.repeat.support.ThrottleLimitResultQueue
-
Deprecated.
- timeout(long) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemWriterBuilder
-
The time limit to wait when flushing items to Kafka.
- timeout(long) - Method in class org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder
-
When using job repository polling, the time limit to wait.
- timeout(long, TimeUnit) - Method in class org.springframework.batch.infrastructure.item.queue.builder.BlockingQueueItemReaderBuilder
-
Set the reading timeout.
- TimeoutBatchContext(RepeatContext) - Constructor for class org.springframework.batch.infrastructure.repeat.policy.TimeoutTerminationPolicy.TimeoutBatchContext
- TimeoutTerminationPolicy - Class in org.springframework.batch.infrastructure.repeat.policy
-
Termination policy that times out after a fixed period.
- TimeoutTerminationPolicy() - Constructor for class org.springframework.batch.infrastructure.repeat.policy.TimeoutTerminationPolicy
-
Default constructor.
- TimeoutTerminationPolicy(long) - Constructor for class org.springframework.batch.infrastructure.repeat.policy.TimeoutTerminationPolicy
-
Construct a
TimeoutTerminationPolicy
with the specified timeout value (in milliseconds). - TimeoutTerminationPolicy.TimeoutBatchContext - Class in org.springframework.batch.infrastructure.repeat.policy
- 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<T>) - 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
JobParameters
object. - tokenize(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.AbstractLineTokenizer
-
Yields the tokens resulting from the splitting of the supplied
line
. - tokenize(String) - Method in interface org.springframework.batch.infrastructure.item.file.transform.LineTokenizer
-
Yields the tokens resulting from the splitting of the supplied
line
. - tokenize(String) - Method in class org.springframework.batch.infrastructure.item.file.transform.PatternMatchingCompositeLineTokenizer
- toMap() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
-
Returns the internal map as read-only.
- topic(String) - Method in class org.springframework.batch.infrastructure.item.kafka.builder.KafkaItemReaderBuilder
-
A topic name to manually assign to the consumer.
- 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
CompletionPolicy
if 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
- toString() - Method in class org.springframework.batch.infrastructure.item.Chunk.ChunkIterator
- toString() - Method in class org.springframework.batch.infrastructure.item.Chunk
- toString() - Method in class org.springframework.batch.infrastructure.item.ExecutionContext
- toString() - Method in class org.springframework.batch.infrastructure.item.file.transform.DefaultFieldSet
- toString() - Method in class org.springframework.batch.infrastructure.item.file.transform.Range
- toString() - Method in class org.springframework.batch.infrastructure.item.SkipWrapper
-
Deprecated.
- toString() - Method in class org.springframework.batch.infrastructure.repeat.context.SynchronizedAttributeAccessor
- toString() - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
- toString() - Method in class org.springframework.batch.integration.chunk.ChunkRequest
- toString() - Method in class org.springframework.batch.integration.chunk.ChunkResponse
- toString() - Method in class org.springframework.batch.integration.launch.JobLaunchRequest
- toString() - Method in class org.springframework.batch.integration.partition.StepExecutionRequest
- transacted(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaPagingItemReaderBuilder
-
Indicates if a transaction should be created around the read (true by default).
- transactional(boolean) - Method in class org.springframework.batch.infrastructure.item.file.builder.FlatFileItemWriterBuilder
-
If set to true, the flushing of the buffer is delayed while a transaction is active.
- transactional(boolean) - Method in class org.springframework.batch.infrastructure.item.json.builder.JsonFileItemWriterBuilder
-
If set to true, the flushing of the buffer is delayed while a transaction is active.
- transactional(boolean) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
The resulting writer is participating in a transaction and writes should be delayed as late as possible.
- 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.
- transactionAttribute(TransactionAttribute) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- TransactionAwareBufferedWriter - Class in org.springframework.batch.infrastructure.support.transaction
-
Wrapper for a
FileChannel
that delays actually writing to or closing the buffer if a transaction is active. - TransactionAwareBufferedWriter(FileChannel, Runnable) - Constructor for class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
-
Create a new instance with the underlying file channel provided, and a callback to execute on close.
- TransactionAwareProxyFactory<T> - Class in org.springframework.batch.infrastructure.support.transaction
-
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.
- 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.
- transactionManager(PlatformTransactionManager) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
- 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
PlatformTransactionManager
to use in the job repository. - transactionManagerRef() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
Set the
MongoTransactionManager
to use in the job repository. - transactionStatus - Variable in class org.springframework.batch.core.observability.jfr.events.step.chunk.ChunkTransactionEvent
- transform(StepContribution, Chunk<I>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- transform(StepContribution, Chunk<I>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- TransitionBuilder(FlowBuilder<Q>, String) - Constructor for class org.springframework.batch.core.job.builder.FlowBuilder.TransitionBuilder
- translateSqlException(String, String, SQLException) - Method in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
- truncate() - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
-
Truncate the output at the last known good point.
- type - Variable in class org.springframework.batch.infrastructure.item.data.MongoPagingItemReader
- type() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns the value of the
type
record component. - type() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
type
record component. - type() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
type
record component. - type(Class<T>) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemReaderBuilder
-
Configure a type to be deserialized.
- type(Class<T>) - Method in class org.springframework.batch.infrastructure.item.avro.builder.AvroItemWriterBuilder
U
- unbind(JobFactory, Map<String, ?>) - Method in class org.springframework.batch.core.configuration.support.JobFactoryRegistrationListener
-
Deprecated.Take the provided
JobFactory
and unregister it with theJobRegistry
. - UncheckedTransactionException - Exception 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 org.springframework.batch.core.step.tasklet.UncheckedTransactionException
- UnclosedElementCollectingEventWriter - Class in org.springframework.batch.infrastructure.item.xml.stax
-
Delegating XMLEventWriter, which collects the QNames of elements that were opened but not closed.
- UnclosedElementCollectingEventWriter(XMLEventWriter) - Constructor for class org.springframework.batch.infrastructure.item.xml.stax.UnclosedElementCollectingEventWriter
- UnexpectedInputException - Exception in org.springframework.batch.infrastructure.item
-
Used to signal an unexpected end of an input or message stream.
- UnexpectedInputException(String) - Constructor for exception org.springframework.batch.infrastructure.item.UnexpectedInputException
-
Create a new
UnexpectedInputException
based on a message. - UnexpectedInputException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.UnexpectedInputException
-
Create a new
UnexpectedInputException
based on a message and another exception. - UnexpectedJobExecutionException - Exception 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 org.springframework.batch.core.job.UnexpectedJobExecutionException
-
Constructs a new instance with a message.
- UnexpectedJobExecutionException(String, Throwable) - Constructor for exception 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.
- unmarshaller(Unmarshaller) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
An implementation of the
Unmarshaller
from Spring's OXM module. - UnopenedElementClosingEventWriter - Class in org.springframework.batch.infrastructure.item.xml.stax
-
Delegating XMLEventWriter, which writes EndElement events that match a given collection of QNames directly to the underlying java.io.Writer instead of to the delegate XMLEventWriter.
- UnopenedElementClosingEventWriter(XMLEventWriter, Writer, List<QName>) - Constructor for class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- 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<Q>) - Constructor for class org.springframework.batch.core.job.builder.FlowBuilder.UnterminatedFlowBuilder
- unwrap(Class<T>) - Method in class org.springframework.batch.infrastructure.item.database.ExtendedConnectionDataSourceProxy
-
Returns either self or delegate (in this order) if one of them can be cast to supplied parameter class.
- update() - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy.SimpleTerminationContext
- 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(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.database.JpaCursorItemReader
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemReader
-
Store the current resource index and position in the resource.
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.file.ResourcesItemReader
- update(ExecutionContext) - Method in interface org.springframework.batch.infrastructure.item.ItemStream
-
Indicates that the execution context provided during open is about to be saved.
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemReader
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemReader
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemStream
-
Simple aggregate
ExecutionContext
provider for the contributions registered under the given key. - update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.SingleItemPeekableItemReader
-
If there is a cached peek, then retrieve the execution context state from that point.
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamReader
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamWriter
- update(ExecutionContext) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Get the restart data.
- update(ExecutionContext) - Method in class org.springframework.batch.integration.async.AsyncItemWriter
- update(ExecutionContext) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- update(RepeatContext) - Method in class org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
-
Deprecated.
- update(RepeatContext) - Method in interface org.springframework.batch.infrastructure.repeat.CompletionPolicy
-
Give implementations the opportunity to update the state of the current batch.
- update(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompletionPolicySupport
-
Increment the context so the counter is up to date.
- update(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CompositeCompletionPolicy
-
Update all the composed contexts, and also increment the parent context.
- update(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.CountingCompletionPolicy
- update(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy
-
Increment the counter in the context.
- update(RepeatContext) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
Delegate to the
CompletionPolicy
. - 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
ExecutionContext
of 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
ExecutionContext
s 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
- updateStepContribution(StepContribution, StepContributionSource) - Method in class org.springframework.batch.integration.chunk.RemoteChunkHandlerFactoryBean
-
Update a StepContribution with all the data from a StepContributionSource.
- 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
status
field 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.
- UPPER_BORDER_NOT_DEFINED - Static variable in class org.springframework.batch.infrastructure.item.file.transform.Range
- UPSERT - Enum constant in enum class org.springframework.batch.infrastructure.item.data.MongoItemWriter.Mode
-
Insert or update items into the target collection using
BulkOperations.replaceOne(Query, Object, FindAndReplaceOptions)
. - usePersist(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JpaItemWriterBuilder
-
Set whether the entity manager should perform a persist instead of a merge.
- useSharedExtendedConnection(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Indicates that the connection used for the cursor is being used by all other processing, therefor part of the same transaction.
- useSharedExtendedConnection(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Indicates that the connection used for the cursor is being used by all other processing, therefor part of the same transaction.
- usingNamedParameters - Variable in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
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.
- validate(T) - Method in class org.springframework.batch.infrastructure.item.validator.SpringValidator
- validate(T) - Method in interface org.springframework.batch.infrastructure.item.validator.Validator
-
Method used to validate if the value is valid.
- 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
validateTransactionState
parameter. - validateTransactionState() - Element in annotation interface org.springframework.batch.core.configuration.annotation.EnableMongoJobRepository
-
Set the value of the
validateTransactionState
parameter. - ValidatingItemProcessor<T> - Class in org.springframework.batch.infrastructure.item.validator
-
Simple implementation of
ItemProcessor
that validates input and returns it without modifications. - ValidatingItemProcessor() - Constructor for class org.springframework.batch.infrastructure.item.validator.ValidatingItemProcessor
-
Default constructor
- ValidatingItemProcessor(Validator<? super T>) - Constructor for class org.springframework.batch.infrastructure.item.validator.ValidatingItemProcessor
-
Creates a ValidatingItemProcessor based on the given Validator.
- ValidationException - Exception in org.springframework.batch.infrastructure.item.validator
-
This exception should be thrown when there are validation errors.
- ValidationException(String) - Constructor for exception org.springframework.batch.infrastructure.item.validator.ValidationException
-
Create a new
ValidationException
based on a message. - ValidationException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.validator.ValidationException
-
Create a new
ValidationException
based on a message and another exception. - validator(JobParametersValidator) - Method in class org.springframework.batch.core.job.builder.JobBuilderHelper
-
Add a job parameters validator.
- Validator<T> - Interface in org.springframework.batch.infrastructure.item.validator
-
Interface used to validate objects.
- value() - Method in record class org.springframework.batch.core.converter.JsonJobParametersConverter.JobParameterDefinition
-
Returns the value of the
value
record component. - value() - Method in record class org.springframework.batch.core.job.parameters.JobParameter
-
Returns the value of the
value
record component. - value() - Method in record class org.springframework.batch.core.repository.persistence.JobParameter
-
Returns the value of the
value
record component. - VALUE_NOT_SET - Static variable in class org.springframework.batch.infrastructure.item.database.AbstractCursorItemReader
- VALUE_NOT_SET - Static variable in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
- VALUE_NOT_SET - Static variable in class org.springframework.batch.infrastructure.item.database.JdbcPagingItemReader
- 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.
- valueOf(String) - Static method in enum class org.springframework.batch.infrastructure.item.data.MongoItemWriter.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.batch.infrastructure.item.database.Order
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler.Level
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.batch.infrastructure.repeat.RepeatStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.batch.infrastructure.support.DatabaseType
-
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.
- values() - Static method in enum class org.springframework.batch.infrastructure.item.data.MongoItemWriter.Mode
-
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.infrastructure.item.database.Order
-
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.infrastructure.repeat.exception.LogOrRethrowExceptionHandler.Level
-
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.infrastructure.repeat.RepeatStatus
-
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.infrastructure.support.DatabaseType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyCursorPosition(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcCursorItemReaderBuilder
-
Indicates if the reader should verify the current position of the
ResultSet
after being passed to theRowMapper
. - verifyCursorPosition(boolean) - Method in class org.springframework.batch.infrastructure.item.database.builder.StoredProcedureItemReaderBuilder
-
Indicates if the reader should verify the current position of the
ResultSet
after being passed to theRowMapper
. - verifyUniquePattern(Element, List<String>, Element, ParserContext) - Static method in class org.springframework.batch.core.configuration.xml.AbstractFlowParser
-
Verifies that
transitionElement
is not in the list of state transition patterns. - version(String) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemWriterBuilder
-
Version of XML to be generated.
W
- waitForResults() - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
-
Wait until all the results that are in the pipeline come back to the reply channel.
- waitForResults(RepeatInternalState) - Method in class org.springframework.batch.infrastructure.repeat.support.RepeatTemplate
-
If necessary, wait for results to come back from remote or concurrent processes.
- waitForResults(RepeatInternalState) - Method in class org.springframework.batch.infrastructure.repeat.support.TaskExecutorRepeatTemplate
-
Deprecated.Wait for all the results to appear on the queue and execute the after interceptors for each one.
- WARN - Enum constant in enum class org.springframework.batch.infrastructure.repeat.exception.LogOrRethrowExceptionHandler.Level
-
Key for
Classifier
signalling that the throwable should be logged at warn level. - whereClause - Variable in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
- whereClause(String) - Method in class org.springframework.batch.infrastructure.item.database.builder.JdbcPagingItemReaderBuilder
-
The SQL
WHERE
clause for a db specificPagingQueryProvider
. - wrapIfNecessary(Throwable) - Static method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
-
Re-throws the original throwable if it is unchecked, wraps checked exceptions into
AsynchronousFailureException
. - wrappedEventReader - Variable in class org.springframework.batch.infrastructure.item.xml.stax.DefaultFragmentEventReader
- wrappedEventWriter - Variable in class org.springframework.batch.infrastructure.item.xml.stax.UnopenedElementClosingEventWriter
- write(char[], int, int) - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
- write(String) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter.OutputState
- write(String, int, int) - Method in class org.springframework.batch.infrastructure.support.transaction.TransactionAwareBufferedWriter
- write(XMLEventWriter) - Method in interface org.springframework.batch.infrastructure.item.xml.StaxWriterCallback
-
Write contents using the supplied
XMLEventWriter
. - write(StepContribution, Chunk<I>, Chunk<O>) - Method in class org.springframework.batch.core.step.item.FaultTolerantChunkProcessor
-
Deprecated.
- write(StepContribution, Chunk<I>, Chunk<O>) - 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. - write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.queue.BlockingQueueItemWriter
- write(Chunk<? extends MimeMessage>) - Method in class org.springframework.batch.infrastructure.item.mail.javamail.MimeMessageItemWriter
- write(Chunk<? extends Future<T>>) - Method in class org.springframework.batch.integration.async.AsyncItemWriter
-
In the processing of the
Future
s passed, nulls are not passed to the delegate since they are considered filtered out by theAsyncItemProcessor
's delegatedItemProcessor
. - write(Chunk<? extends SimpleMailMessage>) - Method in class org.springframework.batch.infrastructure.item.mail.SimpleMailMessageItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.adapter.ItemWriterAdapter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.adapter.PropertyExtractingDelegatingItemWriter
-
Extracts values from item's fields named in fieldsUsedAsTargetMethodArguments and passes them as arguments to the delegate method.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.amqp.AmqpItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.avro.AvroItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.MongoItemWriter
-
If a transaction is active, buffer items to be written just before commit.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.data.RepositoryItemWriter
-
Write all items to the data store via a Spring Data repository.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.database.JdbcBatchItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.database.JpaItemWriter
-
Merge all provided items that aren't already in the persistence context and then flush the entity manager.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.file.MultiResourceItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.function.ConsumerItemWriter
- write(Chunk<? extends T>) - Method in interface org.springframework.batch.infrastructure.item.ItemWriter
-
Process the supplied data element.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.jms.JmsItemWriter
-
Send the items one-by-one to the default destination of the JMS template.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter
-
Writes out a string followed by a "new line", where the format of the new line separator is determined by the underlying operating system.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.support.ClassifierCompositeItemWriter
-
Delegates to injected
ItemWriter
instances according to their classification by theClassifier
. - write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.support.CompositeItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.support.ListItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemStreamWriter
-
This method delegates to the
write
method of thedelegate
. - write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.support.SynchronizedItemWriter
-
This method delegates to the
write
method of the delegate and is synchronized with a lock. - write(Chunk<? extends T>) - Method in class org.springframework.batch.infrastructure.item.xml.StaxEventItemWriter
-
Write the value objects and flush them to the file.
- write(Chunk<? extends T>) - Method in class org.springframework.batch.integration.chunk.ChunkMessageChannelItemWriter
- write(Chunk<? extends T>) - Method in class org.springframework.batch.integration.chunk.ChunkTaskExecutorItemWriter
- write(Chunk<? extends V>) - Method in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
- WriteFailedException - Exception in org.springframework.batch.infrastructure.item
-
Unchecked exception indicating that an error has occurred while trying to clear a buffer on a rollback.
- WriteFailedException(String) - Constructor for exception org.springframework.batch.infrastructure.item.WriteFailedException
-
Create a new
WriteFailedException
based on a message. - WriteFailedException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.WriteFailedException
-
Create a new
WriteFailedException
based on a message and another exception. - writeFooter(Writer) - Method in interface org.springframework.batch.infrastructure.item.file.FlatFileFooterCallback
-
Write contents to a file using the supplied
Writer
. - writeHeader(Writer) - Method in interface org.springframework.batch.infrastructure.item.file.FlatFileHeaderCallback
-
Write contents to a file using the supplied
Writer
. - writeItems(Chunk<O>) - Method in class org.springframework.batch.core.step.item.SimpleChunkProcessor
-
Deprecated.
- writeKeyValue(K, T) - Method in class org.springframework.batch.infrastructure.item.kafka.KafkaItemWriter
- writeKeyValue(K, T) - Method in class org.springframework.batch.infrastructure.item.redis.RedisItemWriter
- writeKeyValue(K, V) - Method in class org.springframework.batch.infrastructure.item.KeyValueItemWriter
-
Subclasses implement this method to write each item to key value store
- writer(ItemWriter<? super O>) - Method in class org.springframework.batch.core.step.builder.SimpleStepBuilder
-
Deprecated.An item writer that writes a chunk of items.
- writer(ItemWriter<? super O>) - Method in class org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder
-
This method will throw a
UnsupportedOperationException
since the item writer of the manager step in a remote chunking setup will be automatically set to an instance ofChunkMessageChannelItemWriter
. - writer(ItemWriter<O>) - Method in class org.springframework.batch.core.step.builder.ChunkOrientedStepBuilder
-
An item writer that writes a chunk of items.
- WriterNotOpenException - Exception in org.springframework.batch.infrastructure.item
-
Exception indicating that an
ItemWriter
needed to be opened before being written to. - WriterNotOpenException(String) - Constructor for exception org.springframework.batch.infrastructure.item.WriterNotOpenException
-
Create a new
WriterNotOpenException
based on a message. - WriterNotOpenException(String, Throwable) - Constructor for exception org.springframework.batch.infrastructure.item.WriterNotOpenException
-
Create a new
WriterNotOpenException
based on a message and another exception.
X
- xmlInputFactory(XMLInputFactory) - Method in class org.springframework.batch.infrastructure.item.xml.builder.StaxEventItemReaderBuilder
-
Set the
XMLInputFactory
.
Z
- ZERO - Static variable in class org.springframework.batch.infrastructure.repeat.exception.RethrowOnThresholdExceptionHandler
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
JobOperator.abandon(JobExecution)
. Scheduled for removal in 6.2 or later.