Class RemotePartitioningManagerStepBuilder
MessageChannelPartitionHandler
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 org.springframework.batch.core.step.builder.StepBuilderHelper
StepBuilderHelper.CommonStepProperties
-
Field Summary
Fields inherited from class org.springframework.batch.core.step.builder.StepBuilderHelper
logger, properties
-
Constructor Summary
ConstructorsConstructorDescriptionRemotePartitioningManagerStepBuilder
(String stepName) Deprecated, for removal: This API element is subject to removal in a future version.RemotePartitioningManagerStepBuilder
(String stepName, JobRepository jobRepository) Create a newRemotePartitioningManagerStepBuilder
. -
Method Summary
Modifier and TypeMethodDescriptionaggregator
(StepExecutionAggregator aggregator) Provide a step execution aggregator for aggregating partitioned step executions into a single result for thePartitionStep
itself.allowStartIfComplete
(boolean allowStartIfComplete) beanFactory
(org.springframework.beans.factory.BeanFactory beanFactory) Set the bean factory.build()
gridSize
(int gridSize) A hint to thePartitionStepBuilder.splitter(StepExecutionSplitter)
about how many step executions are required.inputChannel
(org.springframework.messaging.MessageChannel inputChannel) Set the input channel on which replies from workers will be received.jobExplorer
(JobExplorer jobExplorer) Set the job explorer.Registers objects using the annotation based listener configuration.listener
(StepExecutionListener listener) messagingTemplate
(org.springframework.integration.core.MessagingTemplate messagingTemplate) Set theMessagingTemplate
to use to send data to workers.outputChannel
(org.springframework.messaging.MessageChannel outputChannel) Set the output channel on which requests to workers will be sent.partitioner
(String workerStepName, Partitioner partitioner) Add a partitioner which can be used to create aStepExecutionSplitter
.partitionHandler
(PartitionHandler partitionHandler) This method will throw aUnsupportedOperationException
since the partition handler of the manager step will be automatically set to an instance ofMessageChannelPartitionHandler
.pollInterval
(long pollInterval) How often to poll the job repository for the status of the workers.repository
(JobRepository jobRepository) Set the job repositorysplitter
(StepExecutionSplitter splitter) Provide an explicitStepExecutionSplitter
instead of having one build from thePartitionStepBuilder.partitioner(String, Partitioner)
.startLimit
(int startLimit) Provide an actual step instance to execute in parallel.timeout
(long timeout) When using job repository polling, the time limit to wait.Methods inherited from class org.springframework.batch.core.step.builder.PartitionStepBuilder
getAggregator, getGridSize, getPartitioner, getPartitionHandler, getSplitter, getStep, getStepName, getTaskExecutor, self, taskExecutor
Methods inherited from class org.springframework.batch.core.step.builder.StepBuilderHelper
enhance, getJobRepository, getName, isAllowStartIfComplete, meterRegistry, observationConvention, observationRegistry
-
Constructor Details
-
RemotePartitioningManagerStepBuilder
@Deprecated(since="5.0", forRemoval=true) public RemotePartitioningManagerStepBuilder(String stepName) Deprecated, for removal: This API element is subject to removal in a future version.Create a newRemotePartitioningManagerStepBuilder
.- Parameters:
stepName
- name of the manager step
-
RemotePartitioningManagerStepBuilder
Create a newRemotePartitioningManagerStepBuilder
.- Parameters:
stepName
- name of the manager stepjobRepository
- job repository to which the step should report to- Since:
- 5.0
-
-
Method Details
-
inputChannel
public RemotePartitioningManagerStepBuilder inputChannel(org.springframework.messaging.MessageChannel inputChannel) Set the input channel on which replies from workers will be received.- Parameters:
inputChannel
- the input channel- Returns:
- this builder instance for fluent chaining
-
outputChannel
public RemotePartitioningManagerStepBuilder outputChannel(org.springframework.messaging.MessageChannel outputChannel) 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
public RemotePartitioningManagerStepBuilder messagingTemplate(org.springframework.integration.core.MessagingTemplate messagingTemplate) Set theMessagingTemplate
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:
-
jobExplorer
Set the job explorer.- Parameters:
jobExplorer
- the job explorer to use.- Returns:
- this builder instance for fluent chaining
-
pollInterval
How often to poll the job repository for the status of the workers. Defaults to 10 seconds.- Parameters:
pollInterval
- the poll interval value in milliseconds- Returns:
- this builder instance for fluent chaining
-
timeout
When using job repository polling, the time limit to wait. Defaults to -1 (no timeout).- Parameters:
timeout
- the timeout value in milliseconds- Returns:
- this builder instance for fluent chaining
-
beanFactory
public RemotePartitioningManagerStepBuilder beanFactory(org.springframework.beans.factory.BeanFactory beanFactory) Set the bean factory.- Parameters:
beanFactory
- the bean factory to use- Returns:
- this builder instance for fluent chaining
-
build
- Overrides:
build
in classPartitionStepBuilder
-
repository
Description copied from class:StepBuilderHelper
Set the job repository- Overrides:
repository
in classStepBuilderHelper<PartitionStepBuilder>
- Parameters:
jobRepository
- the repository to set- Returns:
- this to enable fluent chaining
-
partitioner
public RemotePartitioningManagerStepBuilder partitioner(String workerStepName, Partitioner partitioner) Description copied from class:PartitionStepBuilder
Add a partitioner which can be used to create aStepExecutionSplitter
. Use either this or an explicitPartitionStepBuilder.splitter(StepExecutionSplitter)
but not both.- Overrides:
partitioner
in classPartitionStepBuilder
- Parameters:
workerStepName
- the name of the worker step (used to construct step execution names)partitioner
- a partitioner to use- Returns:
- this for fluent chaining
-
gridSize
Description copied from class:PartitionStepBuilder
A hint to thePartitionStepBuilder.splitter(StepExecutionSplitter)
about how many step executions are required. If running locally or remotely through aPartitionStepBuilder.taskExecutor(TaskExecutor)
determines precisely the number of step executions in the first attempt at a partition step execution.- Overrides:
gridSize
in classPartitionStepBuilder
- Parameters:
gridSize
- the grid size- Returns:
- this for fluent chaining
-
step
Description copied from class:PartitionStepBuilder
Provide an actual step instance to execute in parallel. If an explicitPartitionStepBuilder.partitionHandler(PartitionHandler)
is provided, the step is optional and is only used to extract configuration data (name and other basic properties of a step).- Overrides:
step
in classPartitionStepBuilder
- Parameters:
step
- a step to execute in parallel- Returns:
- this for fluent chaining
-
splitter
Description copied from class:PartitionStepBuilder
Provide an explicitStepExecutionSplitter
instead of having one build from thePartitionStepBuilder.partitioner(String, Partitioner)
. Useful if you need more control over the splitting.- Overrides:
splitter
in classPartitionStepBuilder
- Parameters:
splitter
- a step execution splitter- Returns:
- this for fluent chaining
-
aggregator
Description copied from class:PartitionStepBuilder
Provide a step execution aggregator for aggregating partitioned step executions into a single result for thePartitionStep
itself. Default is a simple implementation that works in most cases.- Overrides:
aggregator
in classPartitionStepBuilder
- Parameters:
aggregator
- a step execution aggregator- Returns:
- this for fluent chaining
-
startLimit
- Overrides:
startLimit
in classStepBuilderHelper<PartitionStepBuilder>
-
listener
Description copied from class:StepBuilderHelper
Registers objects using the annotation based listener configuration.- Overrides:
listener
in classStepBuilderHelper<PartitionStepBuilder>
- Parameters:
listener
- the object that has a method configured with listener annotation- Returns:
- this for fluent chaining
-
listener
- Overrides:
listener
in classStepBuilderHelper<PartitionStepBuilder>
-
allowStartIfComplete
- Overrides:
allowStartIfComplete
in classStepBuilderHelper<PartitionStepBuilder>
-
partitionHandler
public RemotePartitioningManagerStepBuilder partitionHandler(PartitionHandler partitionHandler) throws UnsupportedOperationException This method will throw aUnsupportedOperationException
since the partition handler of the manager step will be automatically set to an instance ofMessageChannelPartitionHandler
.When building a manager step for remote partitioning using this builder, no partition handler must be provided.
- Overrides:
partitionHandler
in classPartitionStepBuilder
- Parameters:
partitionHandler
- a partition handler- Returns:
- this builder instance for fluent chaining
- Throws:
UnsupportedOperationException
- if a partition handler is provided- See Also:
-
RemotePartitioningManagerStepBuilder(String, JobRepository)