org.springframework.xd.dirt.plugins

Class AbstractMessageBusBinderPlugin

java.lang.Object

org.springframework.xd.dirt.plugins.AbstractPlugin

org.springframework.xd.dirt.plugins.AbstractMessageBusBinderPlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractJobPlugin, AbstractStreamPlugin

public abstract class AbstractMessageBusBinderPlugin
extends AbstractPlugin

Abstract Plugin that has common implementation methods to bind/unbind Module's message producers and consumers to/from MessageBus.

Author:

Mark Fisher, Gary Russell, David Turanski, Jennifer Hickey, Glenn Renfro, Ilayaperumal Gopinathan

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	JOB_CHANNEL_PREFIX
protected MessageBus	messageBus
protected static java.lang.String	MODULE_INPUT_CHANNEL
protected static java.lang.String	MODULE_OUTPUT_CHANNEL
protected static java.lang.String	TAP_CHANNEL_PREFIX
protected static java.lang.String	TOPIC_CHANNEL_PREFIX

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

logger, PLUGIN_CONTEXT_CONFIG_ROOT

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractMessageBusBinderPlugin(MessageBus messageBus)
AbstractMessageBusBinderPlugin(MessageBus messageBus, ZooKeeperConnection zkConnection)

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeShutdown(Module module) Perform any cleanup necessary prior to module shutdown
protected void	bindConsumerAndProducers(Module module) Bind input/output channel of the module's message consumer/producers to MessageBus's message source/target entities.
protected abstract java.lang.String	buildTapChannelName(Module module)
protected java.util.Properties[]	extractConsumerProducerProperties(Module module)
protected abstract java.lang.String	getInputChannelName(Module module)
int	getOrder()
protected abstract java.lang.String	getOutputChannelName(Module module)
void	removeModule(Module module) Take any actions necessary to remove a module from the system.
protected void	unbindConsumer(Module module) Unbind the input channel of the module from the MessageBus (stop sending new messages to the module so it can be stopped).
protected void	unbindProducers(Module module) Unbind the output channel of the module (and tap if present) from the MessageBus (after it has been stopped).

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

getApplicationContext, postProcessModule, preProcessModule, setApplicationContext, supports

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_INPUT_CHANNEL

protected static final java.lang.String MODULE_INPUT_CHANNEL

See Also:

Constant Field Values

MODULE_OUTPUT_CHANNEL

protected static final java.lang.String MODULE_OUTPUT_CHANNEL

See Also:

Constant Field Values

TAP_CHANNEL_PREFIX

protected static final java.lang.String TAP_CHANNEL_PREFIX

See Also:

Constant Field Values

TOPIC_CHANNEL_PREFIX

protected static final java.lang.String TOPIC_CHANNEL_PREFIX

See Also:

Constant Field Values

JOB_CHANNEL_PREFIX

protected static final java.lang.String JOB_CHANNEL_PREFIX

See Also:

Constant Field Values

messageBus

protected final MessageBus messageBus

Constructor Detail

AbstractMessageBusBinderPlugin

public AbstractMessageBusBinderPlugin(MessageBus messageBus)

AbstractMessageBusBinderPlugin

public AbstractMessageBusBinderPlugin(MessageBus messageBus,
                              ZooKeeperConnection zkConnection)

Method Detail

bindConsumerAndProducers

protected final void bindConsumerAndProducers(Module module)

Bind input/output channel of the module's message consumer/producers to MessageBus's message source/target entities. The producer must be bound first so that messages can immediately start flowing from the consumer.

Parameters:

module - the module whose consumer and producers to bind to the MessageBus.

extractConsumerProducerProperties

protected final java.util.Properties[] extractConsumerProducerProperties(Module module)

beforeShutdown

public void beforeShutdown(Module module)

Description copied from interface: Plugin

Perform any cleanup necessary prior to module shutdown

Specified by:

beforeShutdown in interface Plugin

Overrides:

beforeShutdown in class AbstractPlugin

Parameters:

module - the module to cleanup

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 AbstractPlugin

Parameters:

module - the module to remove

getInputChannelName

protected abstract java.lang.String getInputChannelName(Module module)

getOutputChannelName

protected abstract java.lang.String getOutputChannelName(Module module)

buildTapChannelName

protected abstract java.lang.String buildTapChannelName(Module module)

unbindConsumer

protected void unbindConsumer(Module module)

Unbind the input channel of the module from the MessageBus (stop sending new messages to the module so it can be stopped).

Parameters:

module - the module for which the consumer is to be unbound from the MessageBus.

unbindProducers

protected void unbindProducers(Module module)

Unbind the output channel of the module (and tap if present) from the MessageBus (after it has been stopped).

Parameters:

module - the module for which producers are to be unbound from the MessageBus.

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class AbstractPlugin