org.springframework.xd.dirt.batch.tasklet

Class JobLaunchingTasklet

java.lang.Object

org.springframework.xd.dirt.batch.tasklet.JobLaunchingTasklet

All Implemented Interfaces:

org.springframework.batch.core.step.tasklet.Tasklet

public class JobLaunchingTasklet
extends java.lang.Object
implements org.springframework.batch.core.step.tasklet.Tasklet

A Tasklet implementation that uses the Spring XD MessageBus to launch jobs deployed within the same Spring XD cluster. This tasklet also receives the results of the job from the same message bus. The result of the step executing this tasklet should match that of the job that was executed by this job. So if the tasklet executes the job foo and foo returns an ExitStatus of "BAR", the ExitStatus of this step will also be "BAR".

Since:

1.3.0

Author:

Michael Minella, Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	XD_ORCHESTRATION_ID
static java.lang.String	XD_PARENT_JOB_EXECUTION_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
	JobLaunchingTasklet(MessageBus messageBus, JobDefinitionRepository jobDefinitionRepository, DomainRepository instanceRepository, java.lang.String jobName, java.lang.Long timeout)
protected	JobLaunchingTasklet(MessageBus messageBus, JobDefinitionRepository jobDefinitionRepository, DomainRepository instanceRepository, java.lang.String jobName, java.lang.Long timeout, org.springframework.messaging.MessageChannel launchingChannel, org.springframework.messaging.PollableChannel listeningChannel) Provided for testing to be able to inject the channels for mocking.

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.batch.repeat.RepeatStatus	execute(org.springframework.batch.core.StepContribution contribution, org.springframework.batch.core.scope.context.ChunkContext chunkContext) Uses the MessageBus to execute a job deployed in a Spring XD cluster.
org.springframework.batch.core.JobExecution	getResult(org.springframework.messaging.Message<?> message)

Methods inherited from class java.lang.Object

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

Field Detail

XD_ORCHESTRATION_ID

public static final java.lang.String XD_ORCHESTRATION_ID

See Also:

Constant Field Values

XD_PARENT_JOB_EXECUTION_ID

public static final java.lang.String XD_PARENT_JOB_EXECUTION_ID

See Also:

Constant Field Values

Constructor Detail

JobLaunchingTasklet

public JobLaunchingTasklet(MessageBus messageBus,
                   JobDefinitionRepository jobDefinitionRepository,
                   DomainRepository instanceRepository,
                   java.lang.String jobName,
                   java.lang.Long timeout)

JobLaunchingTasklet

protected JobLaunchingTasklet(MessageBus messageBus,
                   JobDefinitionRepository jobDefinitionRepository,
                   DomainRepository instanceRepository,
                   java.lang.String jobName,
                   java.lang.Long timeout,
                   org.springframework.messaging.MessageChannel launchingChannel,
                   org.springframework.messaging.PollableChannel listeningChannel)

Provided for testing to be able to inject the channels for mocking.

Parameters:

messageBus - Message bus reference to launch a job and receive it's results

jobDefinitionRepository - Repository used to look up the child job definition

instanceRepository - Repository used to look up that the child job is deployed

jobName - The name of the child job definition

launchingChannel - The channel used to send the launch request

listeningChannel - The channel used to listen for the job results

Method Detail

execute

public org.springframework.batch.repeat.RepeatStatus execute(org.springframework.batch.core.StepContribution contribution,
                                                    org.springframework.batch.core.scope.context.ChunkContext chunkContext)
                                                      throws java.lang.Exception

Uses the MessageBus to execute a job deployed in a Spring XD cluster.

Specified by:

execute in interface org.springframework.batch.core.step.tasklet.Tasklet

Parameters:

contribution - The contribution to the step's metrics. Not used in this case

chunkContext - Used to get a handle on the JobExecution and JobInstance

Returns:

RepeatStatus.FINISHED

Throws:

java.lang.Exception

getResult

public org.springframework.batch.core.JobExecution getResult(org.springframework.messaging.Message<?> message)
                                                      throws org.springframework.messaging.MessagingException

Throws:

org.springframework.messaging.MessagingException