org.springframework.xd.dirt.plugins.job

Class JobEventsListenerPlugin

java.lang.Object

org.springframework.xd.dirt.plugins.AbstractPlugin

org.springframework.xd.dirt.plugins.AbstractMessageBusBinderPlugin

org.springframework.xd.dirt.plugins.AbstractJobPlugin

org.springframework.xd.dirt.plugins.job.JobEventsListenerPlugin

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, XDJobListenerConstants, Plugin

public class JobEventsListenerPlugin
extends AbstractJobPlugin
implements XDJobListenerConstants

Plugin to enable the registration of out of the box job listeners.

Since:

1.0

Author:

Ilayaperumal Gopinathan, Gary Russell

Field Summary

Fields inherited from class org.springframework.xd.dirt.plugins.AbstractMessageBusBinderPlugin

JOB_CHANNEL_PREFIX, messageBus, MODULE_INPUT_CHANNEL, MODULE_OUTPUT_CHANNEL

Fields inherited from class org.springframework.xd.dirt.plugins.AbstractPlugin

logger, PLUGIN_CONTEXT_CONFIG_ROOT

Fields inherited from interface org.springframework.xd.dirt.plugins.job.support.listener.XDJobListenerConstants

CHUNK_EVENTS_SUFFIX, ITEM_EVENTS_SUFFIX, JOB_EXECUTION_EVENTS_SUFFIX, SKIP_EVENTS_SUFFIX, STEP_EXECUTION_EVENTS_SUFFIX, XD_AGGREGATED_EVENTS_CHANNEL, XD_CHUNK_EVENTS_CHANNEL, XD_CHUNK_LISTENER_BEAN, XD_ITEM_EVENTS_CHANNEL, XD_ITEM_LISTENER_BEAN, XD_JOB_EXECUTION_EVENTS_CHANNEL, XD_JOB_EXECUTION_LISTENER_BEAN, XD_JOB_LISTENERS_SUFFIXES, XD_SKIP_EVENTS_CHANNEL, XD_SKIP_LISTENER_BEAN, XD_STEP_EXECUTION_EVENTS_CHANNEL, XD_STEP_EXECUTION_LISTENER_BEAN

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
JobEventsListenerPlugin(MessageBus messageBus)

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getEventListenerChannelName(java.lang.String jobName)
static java.util.Map<java.lang.String,java.lang.String>	getEventListenerChannels(java.lang.String jobName)
void	postProcessModule(Module module) Apply changes to the module after it is initialized i.e. after its context is refreshed, but before it is started.
void	removeModule(Module module) Take any actions necessary to remove a module from the system.

Methods inherited from class org.springframework.xd.dirt.plugins.AbstractJobPlugin

buildTapChannelName, getInputChannelName, getJobChannelName, getOutputChannelName, supports

Methods inherited from class org.springframework.xd.dirt.plugins.AbstractMessageBusBinderPlugin

beforeShutdown, bindConsumerAndProducers, extractConsumerProducerProperties, extractHistoryProperties, getOrder, unbindConsumer, unbindProducers

Methods inherited from class org.springframework.xd.dirt.plugins.AbstractPlugin

getApplicationContext, preProcessModule, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

JobEventsListenerPlugin

public JobEventsListenerPlugin(MessageBus messageBus)

Method Detail

postProcessModule

public void postProcessModule(Module module)

Description copied from interface: Plugin

Apply changes to the module after it is initialized i.e. after its context is refreshed, but before it is started.

Specified by:

postProcessModule in interface Plugin

Overrides:

postProcessModule in class AbstractPlugin

Parameters:

module - the module to post-process

getEventListenerChannels

public static java.util.Map<java.lang.String,java.lang.String> getEventListenerChannels(java.lang.String jobName)

Parameters:

jobName - the job name.

Returns:

the map containing the entries for the channels used by the job listeners with bean name of the channel as the key and channel name as the value.

getEventListenerChannelName

public static java.lang.String getEventListenerChannelName(java.lang.String jobName)

Parameters:

jobName - the job name.

Returns:

the aggregated event channel name.

removeModule

public void removeModule(Module module)

Description copied from interface: Plugin

Take any actions necessary to remove a module from the system.

Specified by:

removeModule in interface Plugin

Overrides:

removeModule in class AbstractMessageBusBinderPlugin

Parameters:

module - the module to remove