de.codecentric.boot.admin.registry.web

Class RegistryController

java.lang.Object

de.codecentric.boot.admin.registry.web.RegistryController

@AdminController
 @ResponseBody
 @RequestMapping(value="/api/applications")
public class RegistryController
extends Object

REST controller for controlling registration of managed applications.

Constructor Summary

Constructors

Constructor and Description
RegistryController(ApplicationRegistry registry)

Method Summary

Modifier and Type	Method and Description
Collection<Application>	applications(String name) List all registered applications with name
org.springframework.http.ResponseEntity<?>	get(String id) Get a single application out of the registry.
org.springframework.http.ResponseEntity<?>	register(Application application, org.springframework.web.util.UriComponentsBuilder builder) Register an application within this admin application.
org.springframework.http.ResponseEntity<?>	unregister(String id) Unregister an application within this admin application.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryController

public RegistryController(ApplicationRegistry registry)

Method Detail

register

@RequestMapping(method=POST)
public org.springframework.http.ResponseEntity<?> register(@RequestBody
                                                                                        Application application,
                                                                                        org.springframework.web.util.UriComponentsBuilder builder)

Register an application within this admin application.

Parameters:

application - The application infos.

Returns:

The registered application.

applications

@RequestMapping(method=GET)
public Collection<Application> applications(@RequestParam(value="name",required=false)
                                                                        String name)

List all registered applications with name

Parameters:

name - the name to search for

Returns:

List

get

@RequestMapping(value="/{id}",
                method=GET)
public org.springframework.http.ResponseEntity<?> get(@PathVariable
                                                                                                                 String id)

Get a single application out of the registry.

Parameters:

id - The application identifier.

Returns:

The registered application.

unregister

@RequestMapping(value="/{id}",
                method=DELETE)
public org.springframework.http.ResponseEntity<?> unregister(@PathVariable
                                                                                                                           String id)

Unregister an application within this admin application.

Parameters:

id - The application id.

Returns:

the unregistered application.