org.springframework.xd.module

Class AbstractPlugin

java.lang.Object

org.springframework.xd.module.AbstractPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

JobPlugin

public abstract class AbstractPlugin
extends java.lang.Object
implements Plugin

Author:

Glenn Renfro, Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.util.List<java.lang.String>	componentPathsSelector(Module module) Establish the configuration file path and names required to setup the context for the type of module you are deploying.
protected abstract void	configureProperties(Module module) set the properties required for the module based on its type.
void	postProcessModule(Module module) Apply changes to the module after it is initialized (generally, this means after its context is refreshed), but before it is started.
protected void	postProcessModuleInternal(Module module) Perform any plugin-specific post-refresh initialization.
void	postProcessSharedContext(org.springframework.context.ConfigurableApplicationContext context) Make any necessary changes to the shared context.
void	preProcessModule(Module module) Process the Module and add the Application Context resources necessary to setup the Batch Job.
protected void	preProcessModuleInternal(Module module) Perform any plugin-specific pre-refresh initialization.
void	removeModule(Module module) Take any actions necessary to remove a module from the system.
protected void	setPostProcessContextPaths(java.lang.String... postProcessContextPaths)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

setPostProcessContextPaths

protected void setPostProcessContextPaths(java.lang.String... postProcessContextPaths)

preProcessModule

public final void preProcessModule(Module module)

Process the Module and add the Application Context resources necessary to setup the Batch Job.

Specified by:

preProcessModule in interface Plugin

preProcessModuleInternal

protected void preProcessModuleInternal(Module module)

Perform any plugin-specific pre-refresh initialization.

Parameters:

module -

postProcessModule

public final void postProcessModule(Module module)

Description copied from interface: Plugin

Apply changes to the module after it is initialized (generally, this means after its context is refreshed), but before it is started.

Specified by:

postProcessModule in interface Plugin

postProcessModuleInternal

protected void postProcessModuleInternal(Module module)

Perform any plugin-specific post-refresh initialization.

Parameters:

module -

componentPathsSelector

protected abstract java.util.List<java.lang.String> componentPathsSelector(Module module)

Establish the configuration file path and names required to setup the context for the type of module you are deploying.

Parameters:

module - The module that is being initialized

Returns:

The list of paths

configureProperties

protected abstract void configureProperties(Module module)

set the properties required for the module based on its type.

Parameters:

module - The module that is being initialized

postProcessSharedContext

public void postProcessSharedContext(org.springframework.context.ConfigurableApplicationContext context)

Description copied from interface: Plugin

Make any necessary changes to the shared context.

Specified by:

postProcessSharedContext in interface Plugin

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