org.springframework.xd.dirt.stream

Class AbstractInstancePersistingDeployer<D extends BaseDefinition,I extends BaseInstance<D>>

java.lang.Object

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

org.springframework.xd.dirt.stream.AbstractInstancePersistingDeployer<D,I>

All Implemented Interfaces:

ResourceDeployer<D>, DeploymentValidator

Direct Known Subclasses:

JobDeployer, StreamDeployer

public abstract class AbstractInstancePersistingDeployer<D extends BaseDefinition,I extends BaseInstance<D>>
extends AbstractDeployer<D>

Base support class for deployers that know how to deal with instances of a definition.

Author:

Eric Bottard, Ilayaperumal Gopinathan

Field Summary

Fields

Modifier and Type	Field and Description
protected DeploymentHandler	deploymentHandler
protected DomainRepository<I,java.lang.String>	instanceRepository

Fields inherited from class org.springframework.xd.dirt.stream.AbstractDeployer

composedJobParser, definitionKind, parser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInstancePersistingDeployer(ZooKeeperConnection zkConnection, org.springframework.data.repository.PagingAndSortingRepository<D,java.lang.String> definitionRespository, DomainRepository<I,java.lang.String> instanceRepository, XDParser parser, DeploymentHandler deploymentHandler, ParsingContext definitionKind)

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	deleteAll() Delete all the definitions
void	deploy(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Deploy a resource (job or stream).
BaseInstance<D>	deploymentInfo(java.lang.String id) Query deployment information about the definition whose ID is provided.
java.lang.Iterable<I>	deploymentInfo(java.lang.String first, java.lang.String last) Query deployment information about definitions whose ids range from first to last.
protected void	deployResource(java.lang.String deploymentUnitName) Deploy the deployment unit with the given name.
protected abstract I	makeInstance(D definition) Create an running instance out of the given definition;
void	undeploy(java.lang.String name)
void	undeployAll() Undeploy all the deployed resources.
protected void	undeployResource(java.lang.String deploymentUnitName) Un-deploy the deployment unit with the given name
void	validateBeforeDeploy(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Validate before deploying.
void	validateBeforeUndeploy(java.lang.String name) Validate before un-deployment.

Methods inherited from class org.springframework.xd.dirt.stream.AbstractDeployer

afterSave, basicDeploy, createDefinition, createModuleDefinitions, delete, findAll, findAll, findOne, getDefinitionRepository, getDeploymentPath, getZooKeeperConnection, save, throwAlreadyDeployedException, throwDefinitionAlreadyExistsException, throwDefinitionNotDeployable, throwNoSuchDefinitionException, throwNoSuchDefinitionException, throwNotDeployedException, validateBeforeDelete, validateBeforeSave

Methods inherited from class java.lang.Object

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

Field Detail

instanceRepository

protected final DomainRepository<I extends BaseInstance<D>,java.lang.String> instanceRepository

deploymentHandler

protected final DeploymentHandler deploymentHandler

Constructor Detail

AbstractInstancePersistingDeployer

protected AbstractInstancePersistingDeployer(ZooKeeperConnection zkConnection,
                                  org.springframework.data.repository.PagingAndSortingRepository<D,java.lang.String> definitionRespository,
                                  DomainRepository<I,java.lang.String> instanceRepository,
                                  XDParser parser,
                                  DeploymentHandler deploymentHandler,
                                  ParsingContext definitionKind)

Method Detail

beforeDelete

protected void beforeDelete(D definition)

Description copied from class: AbstractDeployer

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

Overrides:

beforeDelete in class AbstractDeployer<D extends BaseDefinition>

undeploy

public void undeploy(java.lang.String name)

deploy

public void deploy(java.lang.String name,
          java.util.Map<java.lang.String,java.lang.String> properties)

Description copied from interface: ResourceDeployer

Deploy a resource (job or stream).

Parameters:

name - name of the resource

properties - deployment properties to use (may not be null)

undeployAll

public void undeployAll()

Description copied from interface: ResourceDeployer

Undeploy all the deployed resources.

deleteAll

public void deleteAll()

Description copied from interface: ResourceDeployer

Delete all the definitions

Specified by:

deleteAll in interface ResourceDeployer<D extends BaseDefinition>

Overrides:

deleteAll in class AbstractDeployer<D extends BaseDefinition>

deploymentInfo

public java.lang.Iterable<I> deploymentInfo(java.lang.String first,
                                   java.lang.String last)

Query deployment information about definitions whose ids range from first to last.

deploymentInfo

public BaseInstance<D> deploymentInfo(java.lang.String id)

Query deployment information about the definition whose ID is provided.

makeInstance

protected abstract I makeInstance(D definition)

Create an running instance out of the given definition;

deployResource

protected final void deployResource(java.lang.String deploymentUnitName)

Deploy the deployment unit with the given name.

Parameters:

deploymentUnitName - the deployment unit name

undeployResource

protected final void undeployResource(java.lang.String deploymentUnitName)

Un-deploy the deployment unit with the given name

Parameters:

deploymentUnitName - the deployment unit name

validateBeforeUndeploy

public void validateBeforeUndeploy(java.lang.String name)

Description copied from interface: DeploymentValidator

Validate before un-deployment.

Parameters:

name - the deployment unit name

validateBeforeDeploy

public void validateBeforeDeploy(java.lang.String name,
                        java.util.Map<java.lang.String,java.lang.String> properties)

Description copied from interface: DeploymentValidator

Validate before deploying.

Parameters:

name - the deployment unit name