org.springframework.cloud.task.batch.partition

Class SimpleCommandLineArgsProvider

java.lang.Object

org.springframework.cloud.task.listener.TaskExecutionListenerSupport

org.springframework.cloud.task.batch.partition.SimpleCommandLineArgsProvider

All Implemented Interfaces:

CommandLineArgsProvider, TaskExecutionListener

public class SimpleCommandLineArgsProvider
extends TaskExecutionListenerSupport
implements CommandLineArgsProvider

Returns any command line arguments used with the TaskExecution provided appended with any additional arguments configured.

Since:

1.1.0

Author:

Michael Minella

Constructor Summary

Constructors

Constructor and Description
SimpleCommandLineArgsProvider()
SimpleCommandLineArgsProvider(TaskExecution taskExecution) Deprecated. use the TaskExecutionListener functionality to obtain the TaskExecution

Method Summary

Modifier and Type	Method and Description
List<String>	getCommandLineArgs(org.springframework.batch.item.ExecutionContext executionContext) Returns a unique list of command line arguements to be passed to the partition's worker for the specified ExecutionContext.
void	onTaskStartup(TaskExecution taskExecution)
void	setAppendedArgs(List<String> appendedArgs) Additional command line args to be appended.

Methods inherited from class org.springframework.cloud.task.listener.TaskExecutionListenerSupport

onTaskEnd, onTaskFailed

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleCommandLineArgsProvider

public SimpleCommandLineArgsProvider()

SimpleCommandLineArgsProvider

@Deprecated
public SimpleCommandLineArgsProvider(TaskExecution taskExecution)

Deprecated. use the TaskExecutionListener functionality to obtain the TaskExecution

Parameters:

taskExecution - task execution

Method Detail

onTaskStartup

public void onTaskStartup(TaskExecution taskExecution)

Specified by:

onTaskStartup in interface TaskExecutionListener

Overrides:

onTaskStartup in class TaskExecutionListenerSupport

setAppendedArgs

public void setAppendedArgs(List<String> appendedArgs)

Additional command line args to be appended.

Parameters:

appendedArgs - list of arguments

Since:

1.2

getCommandLineArgs

public List<String> getCommandLineArgs(org.springframework.batch.item.ExecutionContext executionContext)

Description copied from interface: CommandLineArgsProvider

Returns a unique list of command line arguements to be passed to the partition's worker for the specified ExecutionContext. Note: This method is called once per partition.

Specified by:

getCommandLineArgs in interface CommandLineArgsProvider

Parameters:

executionContext - the unique state for the step to be executed.

Returns:

a list of formatted command line arguments to be passed to the worker (the list will be joined via spaces).