org.springframework.xd.dirt.server

Class ModuleDeploymentWriter

java.lang.Object

org.springframework.xd.dirt.server.ModuleDeploymentWriter

public class ModuleDeploymentWriter
extends java.lang.Object

Utility class to write module deployment requests under /xd/deployments/modules. There are several writeDeployment methods that allow for targeting a deployment to a specific container or to a collection of containers indicated by the ContainerMatcher passed into the constructor.

General usage is to invoke writeDeployment and examine the ModuleDeploymentStatus object that is returned. This invocation will block until:

• all containers have "responded" by updating the ZooKeeper nodes
• the timeout period elapses without all containers responding (default value is DEFAULT_TIMEOUT.
• the waiting thread is interrupted

The results may be examined to obtain detailed information about each deployment attempt and its result.

Author:

Patrick Peralta, Ilayaperumal Gopinathan

See Also:

DeploymentUnitStateCalculator

Constructor Summary

Constructors

Constructor and Description
ModuleDeploymentWriter(ZooKeeperConnection zkConnection, ContainerMatcher containerMatcher) Construct a ModuleDeploymentWriter with the default timeout value indicated by DEFAULT_TIMEOUT.
ModuleDeploymentWriter(ZooKeeperConnection zkConnection, ContainerMatcher containerMatcher, long timeout) Construct a ModuleDeploymentWriter.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Collection<ModuleDeploymentStatus>	processResults(org.springframework.xd.dirt.server.ModuleDeploymentWriter.ResultCollector collector) Block the calling thread until all expected results are returned or until a timeout occurs.
protected java.util.Collection<ModuleDeploymentStatus>	writeDeployment(ModuleDescriptor moduleDescriptor, ModuleDeploymentPropertiesProvider<RuntimeModuleDeploymentProperties> provider, java.util.Collection<Container> containers) Write module deployment requests for the provided module descriptor using the runtime deployment properties provided by the provider to the given matched containers.
protected ModuleDeploymentStatus	writeDeployment(ModuleDescriptor moduleDescriptor, RuntimeModuleDeploymentProperties deploymentProperties, Container container) Write a module deployment request for the provided module descriptor using the provided properties to the given matched container.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDeploymentWriter

public ModuleDeploymentWriter(ZooKeeperConnection zkConnection,
                      ContainerMatcher containerMatcher)

Construct a ModuleDeploymentWriter with the default timeout value indicated by DEFAULT_TIMEOUT.

Parameters:

zkConnection - ZooKeeper connection

containerMatcher - matcher for modules to containers

ModuleDeploymentWriter

public ModuleDeploymentWriter(ZooKeeperConnection zkConnection,
                      ContainerMatcher containerMatcher,
                      long timeout)

Construct a ModuleDeploymentWriter.

Parameters:

zkConnection - ZooKeeper connection

containerMatcher - matcher for modules to containers

timeout - amount of time to wait for module deployments

Method Detail

writeDeployment

protected ModuleDeploymentStatus writeDeployment(ModuleDescriptor moduleDescriptor,
                                     RuntimeModuleDeploymentProperties deploymentProperties,
                                     Container container)
                                          throws java.lang.InterruptedException,
                                                 NoContainerException

Write a module deployment request for the provided module descriptor using the provided properties to the given matched container.

Parameters:

moduleDescriptor - descriptor for module to deploy

deploymentProperties - deployment properties for module

container - the container to deploy

Returns:

result of request

Throws:

java.lang.InterruptedException - if the executing thread is interrupted

NoContainerException - if there are no containers that match the criteria for module deployment

writeDeployment

protected java.util.Collection<ModuleDeploymentStatus> writeDeployment(ModuleDescriptor moduleDescriptor,
                                                           ModuleDeploymentPropertiesProvider<RuntimeModuleDeploymentProperties> provider,
                                                           java.util.Collection<Container> containers)
                                                                throws java.lang.InterruptedException,
                                                                       NoContainerException

Write module deployment requests for the provided module descriptor using the runtime deployment properties provided by the provider to the given matched containers.

Parameters:

moduleDescriptor - descriptor for module to deploy

provider - runtime deployment properties provider for the module

containers - the matched containers to deploy

Returns:

result of request

Throws:

java.lang.InterruptedException - if the executing thread is interrupted

NoContainerException - if there are no containers that match the criteria for module deployment

processResults

protected java.util.Collection<ModuleDeploymentStatus> processResults(org.springframework.xd.dirt.server.ModuleDeploymentWriter.ResultCollector collector)
                                                               throws java.lang.InterruptedException

Block the calling thread until all expected results are returned or until a timeout occurs. Additionally, remove any module deployment paths for deployments that failed or timed out.

Parameters:

collector - ZooKeeper watch used to collect results

Returns:

collection of results for module deployment requests

Throws:

java.lang.InterruptedException