org.springframework.xd.dirt.server

Class ModuleRedeployer

java.lang.Object

org.springframework.xd.dirt.server.ModuleRedeployer

Direct Known Subclasses:

ArrivingContainerModuleRedeployer, DepartingContainerModuleRedeployer

public abstract class ModuleRedeployer
extends java.lang.Object

Abstract ModuleRedeployer that deploy/re-deploys the unallocated/orphaned modules.

Author:

Patrick Peralta, Mark Fisher, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ModuleRedeployer.ModuleDeployment Holds information about a module that needs to be re-deployed.

Field Summary

Fields

Modifier and Type	Field and Description
protected JobFactory	jobFactory Job factory.
protected org.apache.curator.framework.recipes.cache.PathChildrenCache	moduleDeploymentRequests Cache of children under the module deployment requests path.
protected StreamFactory	streamFactory Stream factory.

Constructor Summary

Constructors

Constructor and Description
ModuleRedeployer(ZooKeeperConnection zkConnection, ContainerRepository containerRepository, StreamFactory streamFactory, JobFactory jobFactory, org.apache.curator.framework.recipes.cache.PathChildrenCache moduleDeploymentRequests, ContainerMatcher containerMatcher, DeploymentUnitStateCalculator stateCalculator) Constructs ModuleRedeployer

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	deployModules(Container container) Deploy unallocated/orphaned modules.
protected java.util.List<ModuleDeploymentRequestsPath>	getAllModuleDeploymentRequests() Get all the module deployment requests.
protected org.apache.curator.framework.CuratorFramework	getClient() Return the Curator framework client.
protected ContainerMatcher	instantiateContainerMatcher(ModuleDescriptor moduleDescriptor) Return a ContainerMatcher that will exclude containers that are already hosting the module.
protected void	logUnwantedRedeployment(java.lang.String criteria, java.lang.String moduleLabel) Log unwanted re-deployment of the module if the module count is less than or equal to zero.
protected void	redeployModule(ModuleRedeployer.ModuleDeployment moduleDeployment, boolean arriving) Redeploy a module to a container.
protected void	updateDeploymentUnitState(ModuleRedeployer.ModuleDeployment moduleDeployment, ModuleDeploymentStatus deploymentStatus) Update the ZooKeeper ephemeral node that indicates the status for the provided deployment unit.

Methods inherited from class java.lang.Object

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

Field Detail

moduleDeploymentRequests

protected final org.apache.curator.framework.recipes.cache.PathChildrenCache moduleDeploymentRequests

Cache of children under the module deployment requests path.

streamFactory

protected final StreamFactory streamFactory

Stream factory.

jobFactory

protected final JobFactory jobFactory

Job factory.

Constructor Detail

ModuleRedeployer

public ModuleRedeployer(ZooKeeperConnection zkConnection,
                ContainerRepository containerRepository,
                StreamFactory streamFactory,
                JobFactory jobFactory,
                org.apache.curator.framework.recipes.cache.PathChildrenCache moduleDeploymentRequests,
                ContainerMatcher containerMatcher,
                DeploymentUnitStateCalculator stateCalculator)

Constructs ModuleRedeployer

Parameters:

zkConnection - ZooKeeper connection

containerRepository - the repository to find the containers

streamFactory - factory to construct Stream

jobFactory - factory to construct Job

moduleDeploymentRequests - cache of children for requested module deployments path

containerMatcher - matches modules to containers

stateCalculator - calculator for stream/job state

Method Detail

deployModules

protected abstract void deployModules(Container container)
                               throws java.lang.Exception

Deploy unallocated/orphaned modules.

Parameters:

container - the container to deploy

Throws:

java.lang.Exception

getClient

protected org.apache.curator.framework.CuratorFramework getClient()

Return the Curator framework client.

Returns:

Curator client

instantiateContainerMatcher

protected ContainerMatcher instantiateContainerMatcher(ModuleDescriptor moduleDescriptor)
                                                throws java.lang.Exception

Return a ContainerMatcher that will exclude containers that are already hosting the module.

Parameters:

moduleDescriptor - containers that have deployed this module will be excluded from the results returned by the ContainerMatcher.

Returns:

container matcher that will return containers not hosting the module

Throws:

java.lang.Exception

logUnwantedRedeployment

protected void logUnwantedRedeployment(java.lang.String criteria,
                           java.lang.String moduleLabel)

Log unwanted re-deployment of the module if the module count is less than or equal to zero.

Parameters:

criteria - the criteria for the module deployment

moduleLabel - the module label

redeployModule

protected void redeployModule(ModuleRedeployer.ModuleDeployment moduleDeployment,
                  boolean arriving)
                       throws java.lang.Exception

Redeploy a module to a container. This redeployment will occur if:

• the module needs to be redeployed per the deployment properties
• the stream has not been destroyed
• the stream has not been undeployed
• there is a container that can deploy the stream module

Parameters:

moduleDeployment - contains module redeployment details such as stream, module descriptor, and deployment properties

arriving - if true, this module redeployment is being triggered by an arriving container; if false this is being triggered by a departing container

Throws:

java.lang.InterruptedException

java.lang.Exception

updateDeploymentUnitState

protected void updateDeploymentUnitState(ModuleRedeployer.ModuleDeployment moduleDeployment,
                             ModuleDeploymentStatus deploymentStatus)
                                  throws java.lang.Exception

Update the ZooKeeper ephemeral node that indicates the status for the provided deployment unit.

Parameters:

moduleDeployment - module that a redeploy was attempted for

deploymentStatus - deployment status for the module; may be null if a module deployment was not attempted (for example if there were no containers available for deployment)

Throws:

java.lang.Exception

getAllModuleDeploymentRequests

protected java.util.List<ModuleDeploymentRequestsPath> getAllModuleDeploymentRequests()

Get all the module deployment requests.

Returns:

the list of all the requested modules' paths.