org.springframework.xd.dirt.rest

Class XDController<D extends BaseDefinition,A extends org.springframework.hateoas.mvc.ResourceAssemblerSupport<D,R>,R extends NamedResource>

java.lang.Object

org.springframework.xd.dirt.rest.XDController<D,A,R>

Type Parameters:

D - the kind of definition entity this controller deals with

A - a resource assembler that knows how to build Ts out of Ds

R - the resource class for D

Direct Known Subclasses:

JobsController, StreamsController

public abstract class XDController<D extends BaseDefinition,A extends org.springframework.hateoas.mvc.ResourceAssemblerSupport<D,R>,R extends NamedResource>
extends java.lang.Object

Base Class for XD Controllers.

Author:

Glenn Renfro, Ilayaperumal Gopinathan, David Turanski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XDController.QueryOptions Data holder class for controlling how the list methods should behave.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XDController(AbstractDeployer<D> deployer, A resourceAssemblerSupport)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract D	createDefinition(java.lang.String name, java.lang.String definition)
void	delete(java.lang.String name) Request removal of an existing resource definition (stream or job).
void	deleteAll() Request removal of all definitions.
void	deploy(java.lang.String name, java.lang.String properties) Request deployment of an existing definition resource.
org.springframework.hateoas.ResourceSupport	display(java.lang.String name) Retrieve information about a single ResourceSupport.
protected ResourceDeployer<D>	getDeployer()
protected org.springframework.hateoas.PagedResources<R>	listValues(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<D> assembler) List module definitions.
R	save(java.lang.String name, java.lang.String definition, boolean deploy) Create a new resource definition.
void	undeploy(java.lang.String name) Request un-deployment of an existing resource.
void	undeployAll() Request un-deployment of all resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

XDController

protected XDController(AbstractDeployer<D> deployer,
            A resourceAssemblerSupport)

Method Detail

getDeployer

protected ResourceDeployer<D> getDeployer()

delete

@RequestMapping(value="/definitions/{name}",
                method=DELETE)
@ResponseStatus(value=OK)
public void delete(@PathVariable(value="name")
                                        java.lang.String name)

Request removal of an existing resource definition (stream or job).

Parameters:

name - the name of an existing definition (required)

deleteAll

@RequestMapping(value="/definitions",
                method=DELETE)
@ResponseStatus(value=OK)
public void deleteAll()

Request removal of all definitions.

undeploy

@RequestMapping(value="/deployments/{name}",
                method=DELETE)
@ResponseStatus(value=OK)
public void undeploy(@PathVariable(value="name")
                                          java.lang.String name)

Request un-deployment of an existing resource.

Parameters:

name - the name of an existing resource (required)

undeployAll

@RequestMapping(value="/deployments",
                method=DELETE)
@ResponseStatus(value=OK)
public void undeployAll()

Request un-deployment of all resources.

deploy

@RequestMapping(value="/deployments/{name}",
                method=POST)
@ResponseStatus(value=CREATED)
@ResponseBody
public void deploy(@PathVariable(value="name")
                                                     java.lang.String name,
                                                     @RequestParam(required=false)
                                                     java.lang.String properties)

Request deployment of an existing definition resource. The definition must exist before deploying and is included in the path. A new deployment instance is created.

Parameters:

name - the name of an existing definition resource (job or stream) (required)

properties - the deployment properties for the resource as a comma-delimited list of key=value pairs

display

@RequestMapping(value="/definitions/{name}",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public org.springframework.hateoas.ResourceSupport display(@PathVariable(value="name")
                                                                                             java.lang.String name)

Retrieve information about a single ResourceSupport.

Parameters:

name - the name of an existing resource (required)

listValues

protected org.springframework.hateoas.PagedResources<R> listValues(org.springframework.data.domain.Pageable pageable,
                                                       org.springframework.data.web.PagedResourcesAssembler<D> assembler)

List module definitions.

save

@RequestMapping(value="/definitions",
                method=POST)
@ResponseStatus(value=CREATED)
@ResponseBody
public R save(@RequestParam(value="name")
                                                java.lang.String name,
                                                @RequestParam(value="definition")
                                                java.lang.String definition,
                                                @RequestParam(value="deploy",defaultValue="true")
                                                boolean deploy)

Create a new resource definition.

Parameters:

name - The name of the entity to create (required)

definition - The entity definition, expressed in the XD DSL (required)

createDefinition

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