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>

Direct Known Subclasses:

AbstractInstancePersistingDeployer

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

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 java.lang.String	definitionKind Lower-case, singular name of the kind of definition we're deploying.
protected XDParser	streamParser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDeployer(org.springframework.data.repository.PagingAndSortingRepository<D,java.lang.String> repository, DeploymentMessageSender messageSender, XDParser parser, java.lang.String definitionKind)

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) Provides basic deployment behavior, whereby running state of deployed definitions is not persisted.
protected void	basicUndeploy(java.lang.String name) Provides basic un-deployment behavior, whereby state of deployed definitions is not dealt with.
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 java.util.List<ModuleDeploymentRequest>	buildUndeployRequests(D 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 java.util.List<ModuleDeploymentRequest>	parse(java.lang.String name, java.lang.String definition)
D	save(D definition)
protected void	sendDeploymentRequests(java.lang.String name, java.util.List<ModuleDeploymentRequest> requests)
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)

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, deployAll, undeploy, undeployAll

Field Detail

streamParser

protected final XDParser streamParser

definitionKind

protected final java.lang.String definitionKind

Lower-case, singular name of the kind of definition we're deploying. Used in exception messages.

Constructor Detail

AbstractDeployer

protected AbstractDeployer(org.springframework.data.repository.PagingAndSortingRepository<D,java.lang.String> repository,
                DeploymentMessageSender messageSender,
                XDParser parser,
                java.lang.String definitionKind)

Method Detail

save

public D save(D definition)

Specified by:

save in interface ResourceDeployer<D extends BaseDefinition>

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()

sendDeploymentRequests

protected void sendDeploymentRequests(java.lang.String name,
                          java.util.List<ModuleDeploymentRequest> requests)

parse

protected java.util.List<ModuleDeploymentRequest> parse(java.lang.String name,
                                            java.lang.String definition)

buildUndeployRequests

protected java.util.List<ModuleDeploymentRequest> buildUndeployRequests(D definition)

basicDeploy

protected D basicDeploy(java.lang.String name)

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

basicUndeploy

protected void basicUndeploy(java.lang.String name)

Provides basic un-deployment behavior, whereby state of deployed definitions is not dealt with.

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.