org.springframework.xd.dirt.module

Class ModuleDeployer

java.lang.Object

org.springframework.xd.dirt.module.ModuleDeployer

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class ModuleDeployer
extends java.lang.Object
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

Handles the creation, deployment, and un-deployment of modules. Appropriate Plugin logic is applied throughout the deployment/ un-deployment lifecycle.

In order to initialize modules with the correct application context, this class maintains a reference to the global application context. See the reference documentation for more details.

Author:

Mark Fisher, Gary Russell, Ilayaperumal Gopinathan, David Turanski, Patrick Peralta

Constructor Summary

Constructors

Constructor and Description
ModuleDeployer(ModuleFactory moduleFactory) Construct a ModuleDeployer.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
Module	createModule(ModuleDescriptor moduleDescriptor, ModuleDeploymentProperties deploymentProperties) Create a module based on the provided ModuleDescriptor and ModuleDeploymentProperties.
void	deploy(Module module, ModuleDescriptor descriptor) Deploy the given module to this container.
java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,Module>>	getDeployedModules() Return a read-only map of deployed modules.
void	setApplicationContext(org.springframework.context.ApplicationContext context)
void	undeploy(ModuleDescriptor moduleDescriptor) Shut down the module indicated by moduleDescriptor and remove its registration from the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDeployer

public ModuleDeployer(ModuleFactory moduleFactory)

Construct a ModuleDeployer.

Parameters:

moduleFactory - module factory for creating new Module instances

Method Detail

setApplicationContext

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

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Parameters:

context - the container application context

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getDeployedModules

public java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,Module>> getDeployedModules()

Return a read-only map of deployed modules. Key is the group/deployment unit name, value is a map of module index to module.

Returns:

map of deployed modules

createModule

public Module createModule(ModuleDescriptor moduleDescriptor,
                  ModuleDeploymentProperties deploymentProperties)

Create a module based on the provided ModuleDescriptor and ModuleDeploymentProperties.

Parameters:

moduleDescriptor - descriptor for the module

deploymentProperties - deployment related properties for the module

Returns:

new module instance

deploy

public void deploy(Module module,
          ModuleDescriptor descriptor)

Deploy the given module to this container. This action includes

• applying the appropriate plugins
• setting the parent application context
• starting the module
• registering the module with this container

Parameters:

module - the module to deploy

descriptor - descriptor for the module instance

undeploy

public void undeploy(ModuleDescriptor moduleDescriptor)

Shut down the module indicated by moduleDescriptor and remove its registration from the container. Lifecycle plugins are applied during undeployment.

Parameters:

moduleDescriptor - descriptor for module to be undeployed