org.springframework.xd.dirt.rest

Class ContainersController

java.lang.Object

org.springframework.xd.dirt.rest.ContainersController

@Controller
@RequestMapping(value="/runtime/containers")
@ExposesResourceFor(value=DetailedContainerResource.class)
public class ContainersController
extends java.lang.Object

Handles interaction with the runtime containers/and its modules.

Author:

Ilayaperumal Gopinathan, Mark Fisher

Constructor Summary

Constructors

Constructor and Description
ContainersController(ContainerRepository containerRepository)

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.hateoas.PagedResources<DetailedContainerResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<DetailedContainer> assembler) List all the available containers along with the message rates for each deployed modules.
void	shutdownContainer(java.lang.String containerId) Shutdown container by the given containerId.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainersController

@Autowired
public ContainersController(ContainerRepository containerRepository)

Method Detail

list

@RequestMapping(value="",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public org.springframework.hateoas.PagedResources<DetailedContainerResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                                    org.springframework.data.web.PagedResourcesAssembler<DetailedContainer> assembler)
                                                                           throws ModuleMessageRateNotFoundException

List all the available containers along with the message rates for each deployed modules.

Throws:

ModuleMessageRateNotFoundException

org.codehaus.jettison.json.JSONException

shutdownContainer

@RequestMapping(value="",
                method=DELETE,
                params="containerId")
@ResponseStatus(value=OK)
public void shutdownContainer(java.lang.String containerId)
                       throws NoSuchContainerException,
                              ContainerShutdownException

Shutdown container by the given containerId.

Throws:

NoSuchContainerException

ContainerShutdownException