Class RemoteChunkingManagerStepBuilder<I,O>

java.lang.Object

org.springframework.batch.core.step.builder.StepBuilderHelper<SimpleStepBuilder<I,O>>

org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder<SimpleStepBuilder<I,O>>

org.springframework.batch.core.step.builder.SimpleStepBuilder<I,O>

org.springframework.batch.core.step.builder.FaultTolerantStepBuilder<I,O>

org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder<I,O>

Type Parameters:

I - type of input items

O - type of output items

@NullUnmarked
@Deprecated(since="6.1",
            forRemoval=true)
public class RemoteChunkingManagerStepBuilder<I,O>
extends FaultTolerantStepBuilder<I,O>

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1 in favor of RemoteChunkingManagerBuilder. Scheduled for removal in 7.0.

Builder for a manager step in a remote chunking setup. This builder creates and sets a ChunkMessageChannelItemWriter on the manager step.

If no messagingTemplate is provided through messagingTemplate(MessagingTemplate), this builder will create one and set its default channel to the outputChannel provided through outputChannel(MessageChannel).

If a messagingTemplate is provided, it is assumed that it is fully configured and that its default channel is set to an output channel on which requests to workers will be sent.

Since:

4.2

Author:

Mahmoud Ben Hassine

Nested Class Summary

Nested classes/interfaces inherited from class StepBuilderHelper

StepBuilderHelper.CommonStepProperties

Field Summary

Fields inherited from class AbstractTaskletStepBuilder

chunkListeners

Fields inherited from class StepBuilderHelper

logger, properties

Constructor Summary

Constructors

Constructor	Description
RemoteChunkingManagerStepBuilder(String stepName, JobRepository jobRepository)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new RemoteChunkingManagerStepBuilder.

Method Summary

Modifier and Type	Method	Description
RemoteChunkingManagerStepBuilder<I,O>	allowStartIfComplete(boolean allowStartIfComplete)	Deprecated, for removal: This API element is subject to removal in a future version.
RemoteChunkingManagerStepBuilder<I,O>	backOffPolicy(org.springframework.retry.backoff.BackOffPolicy backOffPolicy)	Deprecated, for removal: This API element is subject to removal in a future version. 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).
TaskletStep	build()	Deprecated, for removal: This API element is subject to removal in a future version. Build a manager TaskletStep.
RemoteChunkingManagerStepBuilder<I,O>	chunk(int chunkSize)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the chunk size or commit interval for this step.
RemoteChunkingManagerStepBuilder<I,O>	chunk(CompletionPolicy completionPolicy)	Deprecated, for removal: This API element is subject to removal in a future version. Sets a completion policy for the chunk processing.
RemoteChunkingManagerStepBuilder<I,O>	chunkOperations(RepeatOperations repeatTemplate)	Deprecated, for removal: This API element is subject to removal in a future version. Instead of a chunk size or completion policy you can provide a complete repeat operations instance that handles the iteration over the item reader.
RemoteChunkingManagerStepBuilder<I,O>	exceptionHandler(ExceptionHandler exceptionHandler)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the exception handler to use in the case of tasklet failures.
RemoteChunkingManagerStepBuilder<I,O>	inputChannel(org.springframework.messaging.SubscribableChannel inputChannel)	Deprecated, for removal: This API element is subject to removal in a future version. Set the input channel on which replies from workers will be received.
RemoteChunkingManagerStepBuilder<I,O>	keyGenerator(KeyGenerator keyGenerator)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the key generator for identifying retried items.
RemoteChunkingManagerStepBuilder<I,O>	listener(Object listener)	Deprecated, for removal: This API element is subject to removal in a future version. Registers objects using the annotation based listener configuration.
RemoteChunkingManagerStepBuilder<I,O>	listener(ChunkListener listener)	Deprecated, for removal: This API element is subject to removal in a future version. Register a chunk listener.
RemoteChunkingManagerStepBuilder<I,O>	listener(ItemReadListener<? super I> listener)	Deprecated, for removal: This API element is subject to removal in a future version. Register an item reader listener.
RemoteChunkingManagerStepBuilder<I,O>	listener(ItemWriteListener<? super O> listener)	Deprecated, for removal: This API element is subject to removal in a future version. Register an item writer listener.
RemoteChunkingManagerStepBuilder<I,O>	listener(SkipListener<? super I, ? super O> listener)	Deprecated, for removal: This API element is subject to removal in a future version. Register a skip listener.
RemoteChunkingManagerStepBuilder<I,O>	listener(StepExecutionListener listener)	Deprecated, for removal: This API element is subject to removal in a future version.
RemoteChunkingManagerStepBuilder<I,O>	listener(org.springframework.retry.RetryListener listener)	Deprecated, for removal: This API element is subject to removal in a future version. Register a retry listener.
RemoteChunkingManagerStepBuilder<I,O>	maxWaitTimeouts(int maxWaitTimeouts)	Deprecated, for removal: This API element is subject to removal in a future version. The maximum number of times to wait at the end of a step for a non-null result from the remote workers.
RemoteChunkingManagerStepBuilder<I,O>	messagingTemplate(org.springframework.integration.core.MessagingTemplate messagingTemplate)	Deprecated, for removal: This API element is subject to removal in a future version. Set the MessagingTemplate to use to send data to workers.
RemoteChunkingManagerStepBuilder<I,O>	noRetry(Class<? extends Throwable> type)	Deprecated, for removal: This API element is subject to removal in a future version. Explicitly ask for an exception (and subclasses) to be excluded from retry.
RemoteChunkingManagerStepBuilder<I,O>	noRollback(Class<? extends Throwable> type)	Deprecated, for removal: This API element is subject to removal in a future version. Mark this exception as ignorable during item read or processing operations.
RemoteChunkingManagerStepBuilder<I,O>	noSkip(Class<? extends Throwable> type)	Deprecated, for removal: This API element is subject to removal in a future version. Explicitly prevent certain exceptions (and subclasses) from being skipped.
RemoteChunkingManagerStepBuilder<I,O>	outputChannel(org.springframework.messaging.MessageChannel outputChannel)	Deprecated, for removal: This API element is subject to removal in a future version. Set the output channel on which requests to workers will be sent.
RemoteChunkingManagerStepBuilder<I,O>	processor(ItemProcessor<? super I, ? extends O> itemProcessor)	Deprecated, for removal: This API element is subject to removal in a future version. An item processor that processes or transforms a stream of items.
RemoteChunkingManagerStepBuilder<I,O>	reader(ItemReader<? extends I> reader)	Deprecated, for removal: This API element is subject to removal in a future version. An item reader that provides a stream of items.
RemoteChunkingManagerStepBuilder<I,O>	readerIsTransactionalQueue()	Deprecated, for removal: This API element is subject to removal in a future version. 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.
RemoteChunkingManagerStepBuilder<I,O>	retry(Class<? extends Throwable> type)	Deprecated, for removal: This API element is subject to removal in a future version. Explicitly ask for an exception (and subclasses) to be retried.
RemoteChunkingManagerStepBuilder<I,O>	retryContextCache(org.springframework.retry.policy.RetryContextCache retryContextCache)	Deprecated, for removal: This API element is subject to removal in a future version. Provide an explicit retry context cache.
RemoteChunkingManagerStepBuilder<I,O>	retryLimit(int retryLimit)	Deprecated, for removal: This API element is subject to removal in a future version. The maximum number of times to try a failed item.
RemoteChunkingManagerStepBuilder<I,O>	retryPolicy(org.springframework.retry.RetryPolicy retryPolicy)	Deprecated, for removal: This API element is subject to removal in a future version. Provide an explicit retry policy instead of using the FaultTolerantStepBuilder.retryLimit(int) and retryable exceptions provided elsewhere.
RemoteChunkingManagerStepBuilder<I,O>	skip(Class<? extends Throwable> type)	Deprecated, for removal: This API element is subject to removal in a future version. Explicitly request certain exceptions (and subclasses) to be skipped.
RemoteChunkingManagerStepBuilder<I,O>	skipLimit(int skipLimit)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the maximum number of failed items to skip before the step fails.
RemoteChunkingManagerStepBuilder<I,O>	skipPolicy(SkipPolicy skipPolicy)	Deprecated, for removal: This API element is subject to removal in a future version. Provide an explicit policy for managing skips.
RemoteChunkingManagerStepBuilder<I,O>	startLimit(int startLimit)	Deprecated, for removal: This API element is subject to removal in a future version.
RemoteChunkingManagerStepBuilder<I,O>	stepOperations(RepeatOperations repeatTemplate)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the repeat template used for iterating the tasklet execution.
RemoteChunkingManagerStepBuilder<I,O>	stream(ItemStream stream)	Deprecated, for removal: This API element is subject to removal in a future version. Register a stream for callbacks that manage restart data.
RemoteChunkingManagerStepBuilder<I,O>	throttleLimit(long throttleLimit)	Deprecated, for removal: This API element is subject to removal in a future version. Public setter for the throttle limit.
RemoteChunkingManagerStepBuilder<I,O>	transactionAttribute(org.springframework.transaction.interceptor.TransactionAttribute transactionAttribute)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the transaction attributes for the tasklet execution.
RemoteChunkingManagerStepBuilder<I,O>	transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)	Deprecated, for removal: This API element is subject to removal in a future version. Set the transaction manager to use for the step.
RemoteChunkingManagerStepBuilder<I,O>	writer(ItemWriter<? super O> writer)	Deprecated, for removal: This API element is subject to removal in a future version. 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 of ChunkMessageChannelItemWriter.

Methods inherited from class FaultTolerantStepBuilder

createChunkProcessor, createChunkProvider, createRetryOperations, createSkipPolicy, createTasklet, detectStreamInReader, faultTolerant, getChunkMonitor, getFatalExceptionAwareProxy, getRollbackClassifier, getSkipListeners, processorNonTransactional, registerStepListenerAsSkipListener

Methods inherited from class SimpleStepBuilder

createChunkOperations, getChunkCompletionPolicy, getChunkSize, getItemListeners, getProcessor, getReader, getWriter, isReaderTransactionalQueue, listener, registerAsStreamsAndListeners, registerStepListenerAsItemListener, self

Methods inherited from class AbstractTaskletStepBuilder

concurrent, getExceptionHandler, getStepOperations, getStreams, getTaskExecutor, getTransactionAttribute, getTransactionManager, registerStepListenerAsChunkListener, taskExecutor

Methods inherited from class StepBuilderHelper

enhance, getJobRepository, getName, isAllowStartIfComplete, observationRegistry

Methods inherited from class Object

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

Constructor Details

RemoteChunkingManagerStepBuilder

public RemoteChunkingManagerStepBuilder(String stepName,
 JobRepository jobRepository)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new RemoteChunkingManagerStepBuilder.

Parameters:

stepName - name of the manager step

jobRepository - the job repository the step should report to

Since:

5.0

Method Details

inputChannel

public RemoteChunkingManagerStepBuilder<I,O> inputChannel(org.springframework.messaging.SubscribableChannel inputChannel)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the input channel on which replies from workers will be received. The provided input channel will be set as a reply channel on the ChunkMessageChannelItemWriter created by this builder.

Parameters:

inputChannel - the input channel

Returns:

this builder instance for fluent chaining

See Also:

• ChunkMessageChannelItemWriter.setReplyChannel(SubscribableChannel)

outputChannel

public RemoteChunkingManagerStepBuilder<I,O> outputChannel(org.springframework.messaging.MessageChannel outputChannel)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the output channel on which requests to workers will be sent. By using this setter, a default messaging template will be created and the output channel will be set as its default channel.

Use either this setter or messagingTemplate(MessagingTemplate) to provide a fully configured messaging template.

Parameters:

outputChannel - the output channel.

Returns:

this builder instance for fluent chaining

See Also:

• messagingTemplate(MessagingTemplate)

messagingTemplate

public RemoteChunkingManagerStepBuilder<I,O> messagingTemplate(org.springframework.integration.core.MessagingTemplate messagingTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the MessagingTemplate to use to send data to workers. The default channel of the messaging template must be set.

Use either this setter to provide a fully configured messaging template or provide an output channel through outputChannel(MessageChannel) and a default messaging template will be created.

Parameters:

messagingTemplate - the messaging template to use

Returns:

this builder instance for fluent chaining

See Also:

• outputChannel(MessageChannel)

maxWaitTimeouts

public RemoteChunkingManagerStepBuilder<I,O> maxWaitTimeouts(int maxWaitTimeouts)

Deprecated, for removal: This API element is subject to removal in a future version.

The maximum number of times to wait at the end of a step for a non-null result from the remote workers. This is a multiplier on the receive timeout set separately on the gateway. The ideal value is a compromise between allowing slow workers time to finish, and responsiveness if there is a dead worker. Defaults to 40.

Parameters:

maxWaitTimeouts - the maximum number of wait timeouts

Returns:

this builder instance for fluent chaining

See Also:

• ChunkMessageChannelItemWriter.setMaxWaitTimeouts(int)

throttleLimit

public RemoteChunkingManagerStepBuilder<I,O> throttleLimit(long throttleLimit)

Deprecated, for removal: This API element is subject to removal in a future version.

Public setter for the throttle limit. This limits the number of pending requests for chunk processing to avoid overwhelming the receivers.

Parameters:

throttleLimit - the throttle limit to set

Returns:

this builder instance for fluent chaining

See Also:

• ChunkMessageChannelItemWriter.setThrottleLimit(long)

build

public TaskletStep build()

Deprecated, for removal: This API element is subject to removal in a future version.

Build a manager TaskletStep.

Overrides:

build in class FaultTolerantStepBuilder<I,O>

Returns:

the configured manager step

See Also:

• RemoteChunkHandlerFactoryBean

reader

public RemoteChunkingManagerStepBuilder<I,O> reader(ItemReader<? extends I> reader)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

An item reader that provides a stream of items. Will be automatically registered as a AbstractTaskletStepBuilder.stream(ItemStream) or listener if it implements the corresponding interface. By default assumed to be non-transactional.

Overrides:

reader in class SimpleStepBuilder<I,O>

Parameters:

reader - an item reader

Returns:

this for fluent chaining

See Also:

• SimpleStepBuilder.readerTransactionalQueue

transactionManager

public RemoteChunkingManagerStepBuilder<I,O> transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractTaskletStepBuilder

Set the transaction manager to use for the step.

Overrides:

transactionManager in class AbstractTaskletStepBuilder<SimpleStepBuilder<I,O>>

Parameters:

transactionManager - a transaction manager

Returns:

this for fluent chaining

listener

public RemoteChunkingManagerStepBuilder<I,O> listener(Object listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Registers objects using the annotation based listener configuration.

Overrides:

listener in class FaultTolerantStepBuilder<I,O>

Parameters:

listener - the object that has a method configured with listener annotation

Returns:

this for fluent chaining

listener

public RemoteChunkingManagerStepBuilder<I,O> listener(SkipListener<? super I, ? super O> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Register a skip listener.

Overrides:

listener in class FaultTolerantStepBuilder<I,O>

Parameters:

listener - the listener to register

Returns:

this for fluent chaining

listener

public RemoteChunkingManagerStepBuilder<I,O> listener(ChunkListener listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractTaskletStepBuilder

Register a chunk listener.

Overrides:

listener in class FaultTolerantStepBuilder<I,O>

Parameters:

listener - the listener to register

Returns:

this for fluent chaining

transactionAttribute

public RemoteChunkingManagerStepBuilder<I,O> transactionAttribute(org.springframework.transaction.interceptor.TransactionAttribute transactionAttribute)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractTaskletStepBuilder

Sets the transaction attributes for the tasklet execution. Defaults to the default values for the transaction manager, but can be manipulated to provide longer timeouts for instance.

Overrides:

transactionAttribute in class FaultTolerantStepBuilder<I,O>

Parameters:

transactionAttribute - a transaction attribute set

Returns:

this for fluent chaining

listener

public RemoteChunkingManagerStepBuilder<I,O> listener(org.springframework.retry.RetryListener listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Register a retry listener.

Overrides:

listener in class FaultTolerantStepBuilder<I,O>

Parameters:

listener - the listener to register

Returns:

this for fluent chaining

keyGenerator

public RemoteChunkingManagerStepBuilder<I,O> keyGenerator(KeyGenerator keyGenerator)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Sets the key generator for identifying retried items. Retry across transaction boundaries requires items to be identified when they are encountered again. The default strategy is to use the items themselves, relying on their own implementation to ensure that they can be identified. Often a key generator is not necessary as long as the items have reliable hash code and equals implementations, or the reader is not transactional (the default) and the item processor either is itself not transactional (not the default) or does not create new items.

Overrides:

keyGenerator in class FaultTolerantStepBuilder<I,O>

Parameters:

keyGenerator - a key generator for the stateful retry

Returns:

this for fluent chaining

retryLimit

public RemoteChunkingManagerStepBuilder<I,O> retryLimit(int retryLimit)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

The maximum number of times to try a failed item. Zero and one both translate to try only once and do not retry. Ignored if an explicit FaultTolerantStepBuilder.retryPolicy is set.

Overrides:

retryLimit in class FaultTolerantStepBuilder<I,O>

Parameters:

retryLimit - the retry limit (default 0)

Returns:

this for fluent chaining

retryPolicy

public RemoteChunkingManagerStepBuilder<I,O> retryPolicy(org.springframework.retry.RetryPolicy retryPolicy)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Provide an explicit retry policy instead of using the FaultTolerantStepBuilder.retryLimit(int) and retryable exceptions provided elsewhere. Can be used to retry different exceptions a different number of times, for instance.

Overrides:

retryPolicy in class FaultTolerantStepBuilder<I,O>

Parameters:

retryPolicy - a retry policy

Returns:

this for fluent chaining

backOffPolicy

public RemoteChunkingManagerStepBuilder<I,O> backOffPolicy(org.springframework.retry.backoff.BackOffPolicy backOffPolicy)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

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). Ignored if an explicit FaultTolerantStepBuilder.retryPolicy is set.

Overrides:

backOffPolicy in class FaultTolerantStepBuilder<I,O>

Parameters:

backOffPolicy - the back off policy to use (default no backoff)

Returns:

this for fluent chaining

retryContextCache

public RemoteChunkingManagerStepBuilder<I,O> retryContextCache(org.springframework.retry.policy.RetryContextCache retryContextCache)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Provide an explicit retry context cache. Retry is stateful across transactions in the case of failures in item processing or writing, so some information about the context for subsequent retries has to be stored.

Overrides:

retryContextCache in class FaultTolerantStepBuilder<I,O>

Parameters:

retryContextCache - cache for retry contexts in between transactions (default to standard in-memory implementation)

Returns:

this for fluent chaining

skipLimit

public RemoteChunkingManagerStepBuilder<I,O> skipLimit(int skipLimit)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Sets the maximum number of failed items to skip before the step fails. The default value is 10.

This limit is enforced using the default LimitCheckingItemSkipPolicy. If a custom SkipPolicy is provided via FaultTolerantStepBuilder.skipPolicy(SkipPolicy), this limit will not be enforced by the step directly, but it can be implemented to be honored by the custom policy.

Overrides:

skipLimit in class FaultTolerantStepBuilder<I,O>

Parameters:

skipLimit - the maximum number of failed items to skip.

Returns:

this for fluent chaining.

See Also:

• SkipPolicy

noSkip

public RemoteChunkingManagerStepBuilder<I,O> noSkip(Class<? extends Throwable> type)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Explicitly prevent certain exceptions (and subclasses) from being skipped.

Overrides:

noSkip in class FaultTolerantStepBuilder<I,O>

Parameters:

type - the non-skippable exception

Returns:

this for fluent chaining

skip

public RemoteChunkingManagerStepBuilder<I,O> skip(Class<? extends Throwable> type)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Explicitly request certain exceptions (and subclasses) to be skipped. These exceptions (and their subclasses) might be thrown during any phase of the chunk processing (read, process, write) but separate counts are made of skips on read, process and write inside the step execution.

Overrides:

skip in class FaultTolerantStepBuilder<I,O>

Parameters:

type - the exception type.

Returns:

this for fluent chaining

skipPolicy

public RemoteChunkingManagerStepBuilder<I,O> skipPolicy(SkipPolicy skipPolicy)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Provide an explicit policy for managing skips. A skip policy determines which exceptions are skippable and how many times.

Note that setting a custom policy overrides the default limit-checking behavior configured via FaultTolerantStepBuilder.skipLimit(int).

Overrides:

skipPolicy in class FaultTolerantStepBuilder<I,O>

Parameters:

skipPolicy - the skip policy

Returns:

this for fluent chaining

noRollback

public RemoteChunkingManagerStepBuilder<I,O> noRollback(Class<? extends Throwable> type)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Mark this exception as ignorable during item read or processing operations. Processing continues with no additional callbacks (use skips instead if you need to be notified). Ignored during write because there is no guarantee of skip and retry without rollback.

Overrides:

noRollback in class FaultTolerantStepBuilder<I,O>

Parameters:

type - the exception to mark as no rollback

Returns:

this for fluent chaining

noRetry

public RemoteChunkingManagerStepBuilder<I,O> noRetry(Class<? extends Throwable> type)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Explicitly ask for an exception (and subclasses) to be excluded from retry.

Overrides:

noRetry in class FaultTolerantStepBuilder<I,O>

Parameters:

type - the exception to exclude from retry

Returns:

this for fluent chaining

retry

public RemoteChunkingManagerStepBuilder<I,O> retry(Class<? extends Throwable> type)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FaultTolerantStepBuilder

Explicitly ask for an exception (and subclasses) to be retried.

Overrides:

retry in class FaultTolerantStepBuilder<I,O>

Parameters:

type - the exception to retry

Returns:

this for fluent chaining

stream

public RemoteChunkingManagerStepBuilder<I,O> stream(ItemStream stream)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractTaskletStepBuilder

Register a stream for callbacks that manage restart data.

Overrides:

stream in class FaultTolerantStepBuilder<I,O>

Parameters:

stream - the stream to register

Returns:

this for fluent chaining

chunk

public RemoteChunkingManagerStepBuilder<I,O> chunk(int chunkSize)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

Sets the chunk size or commit interval for this step. This is the maximum number of items that will be read before processing starts in a single transaction. Not compatible with SimpleStepBuilder.completionPolicy .

Overrides:

chunk in class SimpleStepBuilder<I,O>

Parameters:

chunkSize - the chunk size (a.k.a commit interval)

Returns:

this for fluent chaining

chunk

public RemoteChunkingManagerStepBuilder<I,O> chunk(CompletionPolicy completionPolicy)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

Sets a completion policy for the chunk processing. Items are read until this policy determines that a chunk is complete, giving more control than with just the chunk size (or commit interval).

Overrides:

chunk in class SimpleStepBuilder<I,O>

Parameters:

completionPolicy - a completion policy for the chunk

Returns:

this for fluent chaining

writer

public RemoteChunkingManagerStepBuilder<I,O> writer(ItemWriter<? super O> writer)
                                             throws UnsupportedOperationException

Deprecated, for removal: This API element is subject to removal in a future version.

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 of ChunkMessageChannelItemWriter.

When building a manager step for remote chunking, no item writer must be provided.

Overrides:

writer in class SimpleStepBuilder<I,O>

Parameters:

writer - an item writer

Returns:

this for fluent chaining

Throws:

UnsupportedOperationException - if an item writer is provided

See Also:

• ChunkMessageChannelItemWriter
• RemoteChunkHandlerFactoryBean.setChunkWriter(ItemWriter)

readerIsTransactionalQueue

public RemoteChunkingManagerStepBuilder<I,O> readerIsTransactionalQueue()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

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. Default is false, meaning that the items are read outside a transaction and possibly cached.

Overrides:

readerIsTransactionalQueue in class SimpleStepBuilder<I,O>

Returns:

this for fluent chaining

listener

public RemoteChunkingManagerStepBuilder<I,O> listener(ItemReadListener<? super I> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

Register an item reader listener.

Overrides:

listener in class SimpleStepBuilder<I,O>

Parameters:

listener - the listener to register

Returns:

this for fluent chaining

listener

public RemoteChunkingManagerStepBuilder<I,O> listener(ItemWriteListener<? super O> listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

Register an item writer listener.

Overrides:

listener in class SimpleStepBuilder<I,O>

Parameters:

listener - the listener to register

Returns:

this for fluent chaining

chunkOperations

public RemoteChunkingManagerStepBuilder<I,O> chunkOperations(RepeatOperations repeatTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

Instead of a chunk size or completion policy you can provide a complete repeat operations instance that handles the iteration over the item reader.

Overrides:

chunkOperations in class SimpleStepBuilder<I,O>

Parameters:

repeatTemplate - a complete repeat template for the chunk

Returns:

this for fluent chaining

exceptionHandler

public RemoteChunkingManagerStepBuilder<I,O> exceptionHandler(ExceptionHandler exceptionHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractTaskletStepBuilder

Sets the exception handler to use in the case of tasklet failures. Default is to rethrow everything.

Overrides:

exceptionHandler in class AbstractTaskletStepBuilder<SimpleStepBuilder<I,O>>

Parameters:

exceptionHandler - the exception handler

Returns:

this for fluent chaining

stepOperations

public RemoteChunkingManagerStepBuilder<I,O> stepOperations(RepeatOperations repeatTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: AbstractTaskletStepBuilder

Sets the repeat template used for iterating the tasklet execution. By default it will terminate only when the tasklet returns FINISHED (or null).

Overrides:

stepOperations in class AbstractTaskletStepBuilder<SimpleStepBuilder<I,O>>

Parameters:

repeatTemplate - a repeat template with rules for iterating

Returns:

this for fluent chaining

startLimit

public RemoteChunkingManagerStepBuilder<I,O> startLimit(int startLimit)

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

startLimit in class StepBuilderHelper<SimpleStepBuilder<I,O>>

listener

public RemoteChunkingManagerStepBuilder<I,O> listener(StepExecutionListener listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

listener in class StepBuilderHelper<SimpleStepBuilder<I,O>>

allowStartIfComplete

public RemoteChunkingManagerStepBuilder<I,O> allowStartIfComplete(boolean allowStartIfComplete)

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

allowStartIfComplete in class StepBuilderHelper<SimpleStepBuilder<I,O>>

processor

public RemoteChunkingManagerStepBuilder<I,O> processor(ItemProcessor<? super I, ? extends O> itemProcessor)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: SimpleStepBuilder

An item processor that processes or transforms a stream of items. Will be automatically registered as a AbstractTaskletStepBuilder.stream(ItemStream) or listener if it implements the corresponding interface.

Overrides:

processor in class SimpleStepBuilder<I,O>

Parameters:

itemProcessor - an item processor

Returns:

this for fluent chaining