Package org.springframework.batch.integration.partition

Class RemotePartitioningWorkerStepBuilder

java.lang.Object

org.springframework.batch.core.step.builder.StepBuilderHelper<StepBuilder>

org.springframework.batch.core.step.builder.StepBuilder

org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder

public class RemotePartitioningWorkerStepBuilder
extends StepBuilder

Builder for a worker step in a remote partitioning setup. This builder creates an IntegrationFlow that:

• listens to StepExecutionRequests coming from the manager on the input channel
• invokes the StepExecutionRequestHandler to execute the worker step for each incoming request. The worker step is located using the provided StepLocator. If no StepLocator is provided, a BeanFactoryStepLocator configured with the current BeanFactory will be used
• replies to the manager on the output channel (when the manager step is configured to aggregate replies from workers). If no output channel is provided, a NullChannel will be used (assuming the manager side is configured to poll the job repository for workers status)

Since:

4.1

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

properties

Constructor Summary

Constructors

Constructor	Description
RemotePartitioningWorkerStepBuilder(String name)	Deprecated, for removal: This API element is subject to removal in a future version. use RemotePartitioningWorkerStepBuilder(String, JobRepository)
RemotePartitioningWorkerStepBuilder(String name, JobRepository jobRepository)	Initialize a step builder for a step with the given name.

Method Summary

Modifier and Type	Method	Description
RemotePartitioningWorkerStepBuilder	allowStartIfComplete(boolean allowStartIfComplete)
RemotePartitioningWorkerStepBuilder	beanFactory(org.springframework.beans.factory.BeanFactory beanFactory)	Set the bean factory.
<I, O> SimpleStepBuilder<I,O>	chunk(int chunkSize)	Deprecated, for removal: This API element is subject to removal in a future version.
<I, O> SimpleStepBuilder<I,O>	chunk(int chunkSize, org.springframework.transaction.PlatformTransactionManager transactionManager)
<I, O> SimpleStepBuilder<I,O>	chunk(org.springframework.batch.repeat.CompletionPolicy completionPolicy)	Deprecated, for removal: This API element is subject to removal in a future version.
<I, O> SimpleStepBuilder<I,O>	chunk(org.springframework.batch.repeat.CompletionPolicy completionPolicy, org.springframework.transaction.PlatformTransactionManager transactionManager)
FlowStepBuilder	flow(Flow flow)
RemotePartitioningWorkerStepBuilder	inputChannel(org.springframework.messaging.MessageChannel inputChannel)	Set the input channel on which step execution requests sent by the manager are received.
JobStepBuilder	job(Job job)
RemotePartitioningWorkerStepBuilder	jobExplorer(JobExplorer jobExplorer)	Set the job explorer.
RemotePartitioningWorkerStepBuilder	listener(Object listener)
RemotePartitioningWorkerStepBuilder	listener(StepExecutionListener listener)
RemotePartitioningWorkerStepBuilder	outputChannel(org.springframework.messaging.MessageChannel outputChannel)	Set the output channel on which replies will be sent to the manager step.
PartitionStepBuilder	partitioner(String stepName, Partitioner partitioner)
PartitionStepBuilder	partitioner(Step step)
RemotePartitioningWorkerStepBuilder	repository(JobRepository jobRepository)
RemotePartitioningWorkerStepBuilder	startLimit(int startLimit)
RemotePartitioningWorkerStepBuilder	stepLocator(StepLocator stepLocator)	Set the step locator used to locate the worker step to execute.
TaskletStepBuilder	tasklet(Tasklet tasklet)	Deprecated, for removal: This API element is subject to removal in a future version.
TaskletStepBuilder	tasklet(Tasklet tasklet, org.springframework.transaction.PlatformTransactionManager transactionManager)

Methods inherited from class org.springframework.batch.core.step.builder.StepBuilder

self

Methods inherited from class org.springframework.batch.core.step.builder.StepBuilderHelper

enhance, getJobRepository, getName, isAllowStartIfComplete, meterRegistry, observationRegistry

Methods inherited from class java.lang.Object

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

Constructor Details

RemotePartitioningWorkerStepBuilder

@Deprecated(since="5.0",
            forRemoval=true)
public RemotePartitioningWorkerStepBuilder(String name)

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

use RemotePartitioningWorkerStepBuilder(String, JobRepository)

Initialize a step builder for a step with the given name.

Parameters:

name - the name of the step

RemotePartitioningWorkerStepBuilder

public RemotePartitioningWorkerStepBuilder(String name,
 JobRepository jobRepository)

Initialize a step builder for a step with the given name.

Parameters:

name - the name of the step

jobRepository - the job repository to which the step should report to

Since:

5.0

Method Details

inputChannel

public RemotePartitioningWorkerStepBuilder inputChannel(org.springframework.messaging.MessageChannel inputChannel)

Set the input channel on which step execution requests sent by the manager are received.

Parameters:

inputChannel - the input channel

Returns:

this builder instance for fluent chaining

outputChannel

public RemotePartitioningWorkerStepBuilder outputChannel(org.springframework.messaging.MessageChannel outputChannel)

Set the output channel on which replies will be sent to the manager step.

Parameters:

outputChannel - the input channel

Returns:

this builder instance for fluent chaining

jobExplorer

public RemotePartitioningWorkerStepBuilder jobExplorer(JobExplorer jobExplorer)

Set the job explorer.

Parameters:

jobExplorer - the job explorer to use

Returns:

this builder instance for fluent chaining

stepLocator

public RemotePartitioningWorkerStepBuilder stepLocator(StepLocator stepLocator)

Set the step locator used to locate the worker step to execute.

Parameters:

stepLocator - the step locator to use

Returns:

this builder instance for fluent chaining

beanFactory

public RemotePartitioningWorkerStepBuilder beanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

Set the bean factory.

Parameters:

beanFactory - the bean factory

Returns:

this builder instance for fluent chaining

repository

public RemotePartitioningWorkerStepBuilder repository(JobRepository jobRepository)

Overrides:

repository in class StepBuilderHelper<StepBuilder>

startLimit

public RemotePartitioningWorkerStepBuilder startLimit(int startLimit)

Overrides:

startLimit in class StepBuilderHelper<StepBuilder>

listener

public RemotePartitioningWorkerStepBuilder listener(Object listener)

Overrides:

listener in class StepBuilderHelper<StepBuilder>

listener

public RemotePartitioningWorkerStepBuilder listener(StepExecutionListener listener)

Overrides:

listener in class StepBuilderHelper<StepBuilder>

allowStartIfComplete

public RemotePartitioningWorkerStepBuilder allowStartIfComplete(boolean allowStartIfComplete)

Overrides:

allowStartIfComplete in class StepBuilderHelper<StepBuilder>

tasklet

@Deprecated(since="5.0",
            forRemoval=true)
public TaskletStepBuilder tasklet(Tasklet tasklet)

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

Overrides:

tasklet in class StepBuilder

tasklet

public TaskletStepBuilder tasklet(Tasklet tasklet,
 org.springframework.transaction.PlatformTransactionManager transactionManager)

Overrides:

tasklet in class StepBuilder

chunk

@Deprecated(since="5.0",
            forRemoval=true)
public <I,
O> SimpleStepBuilder<I,O> chunk(int chunkSize)

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

Overrides:

chunk in class StepBuilder

chunk

public <I,
O> SimpleStepBuilder<I,O> chunk(int chunkSize,
 org.springframework.transaction.PlatformTransactionManager transactionManager)

Overrides:

chunk in class StepBuilder

chunk

@Deprecated(since="5.0",
            forRemoval=true)
public <I,
O> SimpleStepBuilder<I,O> chunk(org.springframework.batch.repeat.CompletionPolicy completionPolicy)

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

Overrides:

chunk in class StepBuilder

chunk

public <I,
O> SimpleStepBuilder<I,O> chunk(org.springframework.batch.repeat.CompletionPolicy completionPolicy,
 org.springframework.transaction.PlatformTransactionManager transactionManager)

Overrides:

chunk in class StepBuilder

partitioner

public PartitionStepBuilder partitioner(String stepName,
 Partitioner partitioner)

Overrides:

partitioner in class StepBuilder

partitioner

public PartitionStepBuilder partitioner(Step step)

Overrides:

partitioner in class StepBuilder

job

public JobStepBuilder job(Job job)

Overrides:

job in class StepBuilder

flow

public FlowStepBuilder flow(Flow flow)

Overrides:

flow in class StepBuilder