org.springframework.cloud.dataflow.server.controller

Class AppRegistryController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.AppRegistryController

@RestController
@RequestMapping(value="/apps")
@ExposesResourceFor(value=AppRegistrationResource.class)
public class AppRegistryController
extends Object

Handles all AppRegistry related interactions.

Author:

Glenn Renfro, Mark Fisher, Gunnar Hillert, Eric Bottard, Gary Russell, Patrick Peralta

Constructor Summary

Constructors

Constructor and Description
AppRegistryController(AppRegistry appRegistry, ApplicationConfigurationMetadataResolver metadataResolver)

Method Summary

Methods

Modifier and Type	Method and Description
DetailedAppRegistrationResource	info(ApplicationType type, String name) Retrieve detailed information about a particular application.
org.springframework.hateoas.PagedResources<? extends AppRegistrationResource>	list(org.springframework.data.web.PagedResourcesAssembler<AppRegistration> pagedResourcesAssembler, ApplicationType type, boolean detailed) List app registrations.
void	register(ApplicationType type, String name, String uri, boolean force) Register a module name and type with its URI.
org.springframework.hateoas.PagedResources<? extends AppRegistrationResource>	registerAll(org.springframework.data.web.PagedResourcesAssembler<AppRegistration> pagedResourcesAssembler, String uri, Properties apps, boolean force) Register all applications listed in a properties file or provided as key/value pairs.
void	unregister(ApplicationType type, String name) Unregister an application by name and type.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppRegistryController

public AppRegistryController(AppRegistry appRegistry,
                     ApplicationConfigurationMetadataResolver metadataResolver)

Method Detail

list

@RequestMapping(method=GET)
@ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<? extends AppRegistrationResource> list(org.springframework.data.web.PagedResourcesAssembler<AppRegistration> pagedResourcesAssembler,
                                                                                                                               @RequestParam(value="type",required=false)
                                                                                                                               ApplicationType type,
                                                                                                                               @RequestParam(value="detailed",defaultValue="false")
                                                                                                                               boolean detailed)

List app registrations.

info

@RequestMapping(value="/{type}/{name}",
                method=GET)
@ResponseStatus(value=OK)
public DetailedAppRegistrationResource info(@PathVariable(value="type")
                                                                                      ApplicationType type,
                                                                                      @PathVariable(value="name")
                                                                                      String name)

Retrieve detailed information about a particular application.

Parameters:

type - application type

name - application name

Returns:

detailed application information

register

@RequestMapping(value="/{type}/{name}",
                method=POST)
@ResponseStatus(value=CREATED)
public void register(@PathVariable(value="type")
                                                                     ApplicationType type,
                                                                     @PathVariable(value="name")
                                                                     String name,
                                                                     @RequestParam(value="uri")
                                                                     String uri,
                                                                     @RequestParam(value="force",defaultValue="false")
                                                                     boolean force)

Register a module name and type with its URI.

Parameters:

type - module type

name - module name

uri - URI for the module artifact (e.g. maven://group:artifact:version)

force - if true, overwrites a pre-existing registration

unregister

@RequestMapping(value="/{type}/{name}",
                method=DELETE)
@ResponseStatus(value=OK)
public void unregister(@PathVariable(value="type")
                                                                    ApplicationType type,
                                                                    @PathVariable(value="name")
                                                                    String name)

Unregister an application by name and type. If the application does not exist, a NoSuchAppRegistrationException will be thrown.

Parameters:

type - the application type

name - the application name

registerAll

@RequestMapping(method=POST)
@ResponseStatus(value=CREATED)
public org.springframework.hateoas.PagedResources<? extends AppRegistrationResource> registerAll(org.springframework.data.web.PagedResourcesAssembler<AppRegistration> pagedResourcesAssembler,
                                                                                                                                            @RequestParam(value="uri",required=false)
                                                                                                                                            String uri,
                                                                                                                                            @RequestParam(value="apps",required=false)
                                                                                                                                            Properties apps,
                                                                                                                                            @RequestParam(value="force",defaultValue="false")
                                                                                                                                            boolean force)

Register all applications listed in a properties file or provided as key/value pairs.

Parameters:

uri - URI for the properties file

apps - key/value pairs representing applications, separated by newlines

force - if true, overwrites any pre-existing registrations