org.springframework.xd.dirt.stream

Interface DeploymentValidator

All Known Implementing Classes:

AbstractDeployer, AbstractInstancePersistingDeployer, JobDeployer, StreamDeployer

public interface DeploymentValidator

This interface defines validation methods that verify a stream or job can be saved, deployed, undeployed, or deleted. Successful invocation of these methods indicates that the operation may proceed, whereas an exception indicates that the operation will not succeed.

This mechanism is useful when issuing operations asynchronously, as is the case when deploying via DeploymentMessage and DeploymentMessagePublisher.

Author:

Ilayaperumal Gopinathan

Method Summary

Methods

Modifier and Type	Method and Description
void	validateBeforeDelete(java.lang.String name) Validate before deletion of the definition.
void	validateBeforeDeploy(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Validate before deploying.
void	validateBeforeSave(java.lang.String name, java.lang.String definition) Validate before saving the definitions.
void	validateBeforeUndeploy(java.lang.String name) Validate before un-deployment.

Method Detail

validateBeforeSave

void validateBeforeSave(java.lang.String name,
                      java.lang.String definition)
                        throws DefinitionAlreadyExistsException

Validate before saving the definitions.

Parameters:

name - the deployment unit name

definition - the definition

Throws:

DefinitionAlreadyExistsException

validateBeforeDeploy

void validateBeforeDeploy(java.lang.String name,
                        java.util.Map<java.lang.String,java.lang.String> properties)
                          throws AlreadyDeployedException,
                                 DefinitionAlreadyExistsException

Validate before deploying.

Parameters:

name - the deployment unit name

properties -

Throws:

AlreadyDeployedException

DefinitionAlreadyExistsException

validateBeforeUndeploy

void validateBeforeUndeploy(java.lang.String name)
                            throws NoSuchDefinitionException,
                                   NotDeployedException

Validate before un-deployment.

Parameters:

name - the deployment unit name

Throws:

NoSuchDefinitionException

NotDeployedException

validateBeforeDelete

void validateBeforeDelete(java.lang.String name)
                          throws NoSuchDefinitionException

Validate before deletion of the definition.

Parameters:

name - the deployment unit name

Throws:

NoSuchDefinitionException