de.otto.jsonhome.registry.controller

Class RegistriesController

java.lang.Object

de.otto.jsonhome.registry.controller.RegistriesController

@Controller
@Docs(value={,})
public class RegistriesController
extends java.lang.Object

Controller responsible for requests to the /registry resource.

Since:

15.09.12

Constructor Summary

Constructors

Constructor and Description
RegistriesController()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteRegistry(java.lang.String registryName, javax.servlet.http.HttpServletResponse response) Deletes the specified registry.
java.util.Map<java.lang.String,?>	getRegistries(javax.servlet.http.HttpServletResponse response) Returns the registries as a list of URLs.
java.util.Map<java.lang.String,?>	getRegistry(java.lang.String registryName, javax.servlet.http.HttpServletResponse response) Returns the contents of the registry in application/json format.
void	handleBadRequest()
void	putRegistry(java.lang.String registryName, java.util.Map<java.lang.String,java.lang.Object> registry, javax.servlet.http.HttpServletResponse response) Creates or updates a registry.
void	setApplicationBaseUri(java.lang.String baseUri)
void	setRegistryRepository(RegistryRepository registryRepository) Injects the registry implementation used to store registry entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistriesController

public RegistriesController()

Method Detail

setApplicationBaseUri

@Value(value="${jsonhome.applicationBaseUri}")
public void setApplicationBaseUri(java.lang.String baseUri)

setRegistryRepository

@Autowired
public void setRegistryRepository(RegistryRepository registryRepository)

Injects the registry implementation used to store registry entries.

Parameters:

registryRepository - the Registry used by the controller.

getRegistries

@Rel(value="/rel/jsonhome/registries")
@RequestMapping(value="/registries",
                method=GET,
                produces="application/json")
@ResponseBody
public java.util.Map<java.lang.String,?> getRegistries(javax.servlet.http.HttpServletResponse response)

Returns the registries as a list of URLs.

     GET /registries

     {
          "self" : "http://example.org/registries",
          "registries" : [
              { "href" : "http://example.org/registries/live", "title" : "Live environment" },
              { "href" : "http://example.org/registries/test", "title" : "Testing environment" }
          ]
     }
 

HTTP status codes returned by this method:

• 200 OK: if the resource was successfully returned.

Parameters:

response - the HttpServletResponse

getRegistry

@Rel(value="/rel/jsonhome/registry")
@RequestMapping(value="/registries/{registryName}",
                method=GET,
                produces="application/json")
@ResponseBody
public java.util.Map<java.lang.String,?> getRegistry(@PathVariable
                                                                            java.lang.String registryName,
                                                                            javax.servlet.http.HttpServletResponse response)

Returns the contents of the registry in application/json format.

     GET /registries/live

     {
         "name" : "live",
         "title" : "Live environment",
         "self" : "http://example.org/registries/live",
         "container" : "http://example.org/registries",
         "service" : [
              {
                  "title" : "Home document of application foo",
                  "href" : "http://example.org/foo/json-home"
              },
              {
                  "title" : "Home document of application bar",
                  "href" : "http://example.org/bar/json-home
              }
         ]
     }
 

The attributes 'name', 'self' and 'container' are added by the server and will be ignored during PUT operations.

HTTP status codes returned by this method:

• 200 OK: if the resource was found.
• 404 NOT FOUND: if the document was not found.

Parameters:

response - HttpServletResponse with cache-control header and application/json in body.

Returns:

application/json

putRegistry

@Rel(value="/rel/jsonhome/registry")
@RequestMapping(value="/registries/{registryName}",
                method=PUT)
public void putRegistry(@PathVariable
                                  java.lang.String registryName,
                                  @RequestBody
                                  java.util.Map<java.lang.String,java.lang.Object> registry,
                                  javax.servlet.http.HttpServletResponse response)

Creates or updates a registry.

     PUT /registries/live

     {
         "title" : "Live environment",
         "service" : [
              {
                  "title" : "Home document of application foo",
                  "href" : "http://example.org/foo/json-home"
              },
              {
                  "title" : "Home document of application bar",
                  "href" : "http://example.org/bar/json-home
              }
         ]
     }
 

The server will add the following attributes to the document: 'name', 'self', 'container'. These attributes are overwritten, if provided by the caller.

HTTP status codes returned by this method:

• 201 CREATED: if the resource was successfully created.
• 204 NO CONTENT: if the resource was successfully updated.
• 400 BAD REQUEST: if the document was syntactically incorrect.

deleteRegistry

@Rel(value="/rel/jsonhome/registry")
@RequestMapping(value="/registries/{registryName}",
                method=DELETE)
public void deleteRegistry(@PathVariable
                                     java.lang.String registryName,
                                     javax.servlet.http.HttpServletResponse response)

Deletes the specified registry.

HTTP status codes returned by this method:

• 204 NO CONTENT: if the resource was successfully deleted or did not exist.

Parameters:

registryName - the name of the deleted registry

response - the response object

handleBadRequest

@ResponseStatus(value=BAD_REQUEST,
                reason="Illegal resource format")
@ExceptionHandler(value={java.lang.IllegalArgumentException.class,java.lang.NullPointerException.class})
public void handleBadRequest()