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 ModuleDeploymentWriter.Result 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

Convenience methods validateResult(org.springframework.xd.dirt.server.ModuleDeploymentWriter.Result) and validateResults(java.util.Collection<org.springframework.xd.dirt.server.ModuleDeploymentWriter.Result>) can be used to examine the returned result and throw an IllegalStateException if a module deployment timed out. Otherwise the results may be examined to obtain detailed information about each deployment attempt and its result.

Author:

Patrick Peralta

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModuleDeploymentWriter.ContainerAwareModuleDeploymentPropertiesProvider Callback interface to obtain ModuleDeploymentProperties for a ModuleDescriptor within the context of deployment to the provided Container.
static interface	ModuleDeploymentWriter.ModuleDeploymentPropertiesProvider Callback interface to obtain ModuleDeploymentProperties for a ModuleDescriptor.
static class	ModuleDeploymentWriter.Result Result of a module deployment request.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERROR_DESCRIPTION_KEY Key used in status map to provide an error description.
static java.lang.String	STATUS_KEY Key used in status map to indicate the module deployment status.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	validateResult(ModuleDeploymentWriter.Result result) Validate the result.
void	validateResults(java.util.Collection<ModuleDeploymentWriter.Result> results) Validate the results.
java.util.Collection<ModuleDeploymentWriter.Result>	writeDeployment(java.util.Iterator<ModuleDescriptor> descriptors, ModuleDeploymentWriter.ModuleDeploymentPropertiesProvider provider) Write module deployment requests for the modules returned by the descriptors iterator.
java.util.Collection<ModuleDeploymentWriter.Result>	writeDeployment(java.util.Iterator<ModuleDescriptor> descriptors, ModuleDeploymentWriter.ModuleDeploymentPropertiesProvider provider, ContainerMatcher containerMatcher) Write module deployment requests for the modules returned by the descriptors iterator.
ModuleDeploymentWriter.Result	writeDeployment(ModuleDescriptor descriptor, Container container) Write a deployment request for the module to the container.
ModuleDeploymentWriter.Result	writeDeployment(ModuleDescriptor moduleDescriptor, ModuleDeploymentProperties deploymentProperties, ContainerMatcher containerMatcher) Write a module deployment request for the provided module descriptor using the provided properties.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_KEY

public static final java.lang.String STATUS_KEY

Key used in status map to indicate the module deployment status. The status map is written by the container deploying the module.

See Also:

ContainerRegistrar, Constant Field Values

ERROR_DESCRIPTION_KEY

public static final java.lang.String ERROR_DESCRIPTION_KEY

Key used in status map to provide an error description. The status map is written by the container deploying the module. This value will be written if there is an error deploying the module.

See Also:

ContainerRegistrar, Constant Field Values

Constructor Detail

ModuleDeploymentWriter

public ModuleDeploymentWriter(ZooKeeperConnection zkConnection,
                      ContainerRepository containerRepository,
                      ContainerMatcher containerMatcher)

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

Parameters:

zkConnection - ZooKeeper connection

containerRepository - repository for containers in the cluster

containerMatcher - matcher for modules to containers

ModuleDeploymentWriter

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

Construct a ModuleDeploymentWriter.

Parameters:

zkConnection - ZooKeeper connection

containerRepository - repository for containers in the cluster

containerMatcher - matcher for modules to containers

timeout - amount of time to wait for module deployments

Method Detail

writeDeployment

public ModuleDeploymentWriter.Result writeDeployment(ModuleDescriptor descriptor,
                                            Container container)
                                              throws java.lang.InterruptedException,
                                                     NoContainerException

Write a deployment request for the module to the container.

Parameters:

descriptor - module descriptor for module to be deployed

container - target container for deployment

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

public java.util.Collection<ModuleDeploymentWriter.Result> writeDeployment(java.util.Iterator<ModuleDescriptor> descriptors,
                                                                  ModuleDeploymentWriter.ModuleDeploymentPropertiesProvider provider)
                                                                    throws java.lang.InterruptedException,
                                                                           NoContainerException

Write module deployment requests for the modules returned by the descriptors iterator. The target containers are indicated by containerMatcher and the ModuleDeploymentProperties provided by the ModuleDeploymentWriter.ModuleDeploymentPropertiesProvider.

Parameters:

descriptors - descriptors for modules to deploy

provider - callback to obtain the deployment properties for a module

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

public ModuleDeploymentWriter.Result writeDeployment(ModuleDescriptor moduleDescriptor,
                                            ModuleDeploymentProperties deploymentProperties,
                                            ContainerMatcher containerMatcher)
                                              throws java.lang.InterruptedException,
                                                     NoContainerException

Write a module deployment request for the provided module descriptor using the provided properties. Since one module descriptor and one instance of ModuleDeploymentProperties are provided, it is assumed that the provided ContainerMatcher will only return one container. This method should be used for module redeployment when a container exits the cluster.

Parameters:

moduleDescriptor - descriptor for module to deploy

deploymentProperties - deployment properties for module

containerMatcher - matcher for modules to containers

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

public java.util.Collection<ModuleDeploymentWriter.Result> writeDeployment(java.util.Iterator<ModuleDescriptor> descriptors,
                                                                  ModuleDeploymentWriter.ModuleDeploymentPropertiesProvider provider,
                                                                  ContainerMatcher containerMatcher)
                                                                    throws java.lang.InterruptedException,
                                                                           NoContainerException

Write module deployment requests for the modules returned by the descriptors iterator. The target containers are indicated by the provided containerMatcher and the ModuleDeploymentProperties provided by the ModuleDeploymentWriter.ModuleDeploymentPropertiesProvider.

Parameters:

descriptors - descriptors for modules to deploy

provider - callback to obtain the deployment properties for a module

containerMatcher - matcher for modules to containers

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

validateResult

public void validateResult(ModuleDeploymentWriter.Result result)

Validate the result. An exception is thrown if the request did not succeed.

Parameters:

result - result to validate

Throws:

java.lang.IllegalStateException - if the result does not indicate a successful deployment

validateResults

public void validateResults(java.util.Collection<ModuleDeploymentWriter.Result> results)
                     throws java.lang.IllegalStateException

Validate the results. An exception is thrown if a request in the collection did not succeed. The error message will contain a summary of all failed deployments.

Parameters:

results - results to validate

Throws:

java.lang.IllegalStateException - if the result does not indicate a successful deployment