org.springframework.xd.dirt.plugins

Class AbstractPlugin

java.lang.Object

org.springframework.xd.dirt.plugins.AbstractPlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractMessageBusBinderPlugin, ContainerInfoPlugin, MBeanExportingPlugin, ModuleInfoPlugin, ModuleTypeConversionPlugin, PropertiesDecryptorPlugin, ZookeeperConnectionPlugin

public abstract class AbstractPlugin
extends java.lang.Object
implements Plugin, org.springframework.core.Ordered, org.springframework.context.ApplicationContextAware

Abstract Plugin that contains no-op and common implementing methods.

Author:

Ilayaperumal Gopinathan, David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Logger.
protected static java.lang.String	PLUGIN_CONTEXT_CONFIG_ROOT

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeShutdown(Module module) Perform any cleanup necessary prior to module shutdown
protected org.springframework.context.ApplicationContext	getApplicationContext()
int	getOrder()
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	preProcessModule(Module module) Apply changes to the module before it is initialized i.e. before its context is refreshed.
void	removeModule(Module module) Take any actions necessary to remove a module from the system.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
abstract boolean	supports(Module module) Check if the module is supported by the plugin.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger.

PLUGIN_CONTEXT_CONFIG_ROOT

protected static final java.lang.String PLUGIN_CONTEXT_CONFIG_ROOT

See Also:

Constant Field Values

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

preProcessModule

public void preProcessModule(Module module)

Description copied from interface: Plugin

Apply changes to the module before it is initialized i.e. before its context is refreshed.

Specified by:

preProcessModule in interface Plugin

Parameters:

module - the module to pre-process

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

Parameters:

module - the module to post-process

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

Parameters:

module - the module to remove

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

Parameters:

module - the module to cleanup

supports

public abstract boolean supports(Module module)

Description copied from interface: Plugin

Check if the module is supported by the plugin.

Specified by:

supports in interface Plugin

Parameters:

module - the module to check for support

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext()