org.springframework.xd.dirt.stream

Class AbstractDeployer<D extends BaseDefinition>

java.lang.Object

org.springframework.xd.dirt.stream.AbstractDeployer<D>

All Implemented Interfaces:

ResourceDeployer<D>, DeploymentValidator

Direct Known Subclasses:

AbstractInstancePersistingDeployer

public abstract class AbstractDeployer<D extends BaseDefinition>
extends java.lang.Object
implements ResourceDeployer<D>, DeploymentValidator

Abstract implementation of the @link ResourceDeployer interface. It provides the basic support for calling CrudRepository methods and sending deployment messages.

Author:

Luke Taylor, Mark Pollack, Eric Bottard, Andy Clement, David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
protected ParsingContext	definitionKind Used in exception messages as well as indication to the parser.
protected XDParser	parser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDeployer(ZooKeeperConnection zkConnection, org.springframework.data.repository.PagingAndSortingRepository<D,java.lang.String> repository, XDParser parser, ParsingContext parsingContext)

Method Summary

Methods

Modifier and Type	Method and Description
protected D	afterSave(D savedDefinition) Callback method that subclasses may override to get a chance to act on newly saved definitions.
protected D	basicDeploy(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Provides basic deployment behavior, whereby running state of deployed definitions is not persisted.
protected void	beforeDelete(D definition) Callback method that subclasses may override to get a chance to act on definitions that are about to be deleted.
protected abstract D	createDefinition(java.lang.String name, java.lang.String definition)
protected java.util.List<ModuleDefinition>	createModuleDefinitions(java.util.List<ModuleDescriptor> moduleDescriptors) Create a list of ModuleDefinitions given the results of parsing the definition.
void	delete(java.lang.String name) Delete the Definition using the provided name.
void	deleteAll() Delete all the definitions
java.lang.Iterable<D>	findAll()
org.springframework.data.domain.Page<D>	findAll(org.springframework.data.domain.Pageable pageable) Return a slice of all definitions.
D	findOne(java.lang.String name) Retrieves a single Definition or null if none is found.
protected org.springframework.data.repository.CrudRepository<D,java.lang.String>	getDefinitionRepository()
protected abstract java.lang.String	getDeploymentPath(D definition) Return the ZooKeeper path used for deployment requests for the given definition.
protected ZooKeeperConnection	getZooKeeperConnection() Return the ZooKeeper connection.
D	save(D definition)
protected void	throwAlreadyDeployedException(java.lang.String name)
protected void	throwDefinitionAlreadyExistsException(D definition)
protected void	throwDefinitionNotDeployable(java.lang.String name)
protected void	throwNoSuchDefinitionException(java.lang.String name)
protected void	throwNoSuchDefinitionException(java.lang.String name, java.lang.String definitionKind)
protected void	throwNotDeployedException(java.lang.String name)
void	validateBeforeDelete(java.lang.String name) Validate before deletion of the definition.
void	validateBeforeSave(java.lang.String name, java.lang.String definition) Validate before saving the definitions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.xd.dirt.core.ResourceDeployer

deploy, undeploy, undeployAll

Methods inherited from interface org.springframework.xd.dirt.stream.DeploymentValidator

validateBeforeDeploy, validateBeforeUndeploy

Field Detail

parser

protected final XDParser parser

definitionKind

protected final ParsingContext definitionKind

Used in exception messages as well as indication to the parser.

Constructor Detail

AbstractDeployer

protected AbstractDeployer(ZooKeeperConnection zkConnection,
                org.springframework.data.repository.PagingAndSortingRepository<D,java.lang.String> repository,
                XDParser parser,
                ParsingContext parsingContext)

Method Detail

save

public D save(D definition)

Specified by:

save in interface ResourceDeployer<D extends BaseDefinition>

validateBeforeSave

public void validateBeforeSave(java.lang.String name,
                      java.lang.String definition)

Description copied from interface: DeploymentValidator

Validate before saving the definitions.

Specified by:

validateBeforeSave in interface DeploymentValidator

Parameters:

name - the deployment unit name

definition - the definition

createModuleDefinitions

protected java.util.List<ModuleDefinition> createModuleDefinitions(java.util.List<ModuleDescriptor> moduleDescriptors)

Create a list of ModuleDefinitions given the results of parsing the definition.

Parameters:

moduleDescriptors - The list of ModuleDescriptors resulting from parsing the definition.

Returns:

a list of ModuleDefinitions

getZooKeeperConnection

protected ZooKeeperConnection getZooKeeperConnection()

Return the ZooKeeper connection.

Returns:

the ZooKeeper connection

afterSave

protected D afterSave(D savedDefinition)

Callback method that subclasses may override to get a chance to act on newly saved definitions.

throwDefinitionAlreadyExistsException

protected void throwDefinitionAlreadyExistsException(D definition)

throwNoSuchDefinitionException

protected void throwNoSuchDefinitionException(java.lang.String name)

throwDefinitionNotDeployable

protected void throwDefinitionNotDeployable(java.lang.String name)

throwNoSuchDefinitionException

protected void throwNoSuchDefinitionException(java.lang.String name,
                                  java.lang.String definitionKind)

throwNotDeployedException

protected void throwNotDeployedException(java.lang.String name)

throwAlreadyDeployedException

protected void throwAlreadyDeployedException(java.lang.String name)

findOne

public D findOne(java.lang.String name)

Description copied from interface: ResourceDeployer

Retrieves a single Definition or null if none is found.

Specified by:

findOne in interface ResourceDeployer<D extends BaseDefinition>

Parameters:

name - of the definition to find. Must not be null.

findAll

public java.lang.Iterable<D> findAll()

Specified by:

findAll in interface ResourceDeployer<D extends BaseDefinition>

Returns:

Iterable all definitions

findAll

public org.springframework.data.domain.Page<D> findAll(org.springframework.data.domain.Pageable pageable)

Description copied from interface: ResourceDeployer

Return a slice of all definitions.

Specified by:

findAll in interface ResourceDeployer<D extends BaseDefinition>

deleteAll

public void deleteAll()

Description copied from interface: ResourceDeployer

Delete all the definitions

Specified by:

deleteAll in interface ResourceDeployer<D extends BaseDefinition>

getDefinitionRepository

protected org.springframework.data.repository.CrudRepository<D,java.lang.String> getDefinitionRepository()

basicDeploy

protected D basicDeploy(java.lang.String name,
            java.util.Map<java.lang.String,java.lang.String> properties)

Provides basic deployment behavior, whereby running state of deployed definitions is not persisted.

Returns:

the definition object for the given name

Throws:

NoSuchDefinitionException - if there is no definition by the given name

createDefinition

protected abstract D createDefinition(java.lang.String name,
                 java.lang.String definition)

getDeploymentPath

protected abstract java.lang.String getDeploymentPath(D definition)

Return the ZooKeeper path used for deployment requests for the given definition.

Parameters:

definition - definition for which to obtain path

Returns:

ZooKeeper path for deployment requests

validateBeforeDelete

public void validateBeforeDelete(java.lang.String name)

Description copied from interface: DeploymentValidator

Validate before deletion of the definition.

Specified by:

validateBeforeDelete in interface DeploymentValidator

Parameters:

name - the deployment unit name

delete

public void delete(java.lang.String name)

Description copied from interface: ResourceDeployer

Delete the Definition using the provided name. The definition may also be undeployed as part of that process.

Specified by:

delete in interface ResourceDeployer<D extends BaseDefinition>

Parameters:

name - the name of the definition to delete

beforeDelete

protected void beforeDelete(D definition)

Callback method that subclasses may override to get a chance to act on definitions that are about to be deleted.