org.nhindirect.config.resources

Class SettingResource

java.lang.Object

org.nhindirect.config.resources.ProtectedResource

org.nhindirect.config.resources.SettingResource

@RestController
 @RequestMapping(value="setting")
public class SettingResource
extends ProtectedResource

Resource for managing settings resources in the configuration service.

Although not required, this class is instantiated using the Jersey SpringServlet and dependencies are defined in the Sprint context XML file.

Since:

2.0

Author:

Greg Meyer

Constructor Summary

Constructors

Constructor and Description
SettingResource() Constructor

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	addSetting(org.nhindirect.config.model.Setting setting) Adds a setting to the system.
reactor.core.publisher.Mono<Void>	addSetting(String name, String value) Adds a setting to the system.
reactor.core.publisher.Flux<org.nhindirect.config.model.Setting>	getAllSettings() Gets all settings in the system.
reactor.core.publisher.Mono<org.nhindirect.config.model.Setting>	getSettingByName(String name) Gets a setting by name.
reactor.core.publisher.Mono<Void>	removeSettingByName(String name) Deletes a setting in the system by name.
void	setSettingRepository(org.nhindirect.config.repository.SettingRepository settingRepo) Sets the settings repository.
reactor.core.publisher.Mono<Void>	updateSetting(org.nhindirect.config.model.Setting setting) Updates the value of a setting.
reactor.core.publisher.Mono<Void>	updateSetting(String name, String value) Updates the value of a setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingResource

public SettingResource()

Constructor

Method Detail

setSettingRepository

@Autowired
public void setSettingRepository(org.nhindirect.config.repository.SettingRepository settingRepo)

Sets the settings repository. Auto populated by Spring

Parameters:

settingRepo - Settings repository

getAllSettings

@GetMapping(produces="application/json")
public reactor.core.publisher.Flux<org.nhindirect.config.model.Setting> getAllSettings()

Gets all settings in the system.

Returns:

A JSON representation of a collection of all settings in the system. Returns a status of 204 if no settings exist.

getSettingByName

@GetMapping(value="{name}",
            produces="application/json")
public reactor.core.publisher.Mono<org.nhindirect.config.model.Setting> getSettingByName(@PathVariable(value="name")
                                                                                                                                                              String name)

Gets a setting by name.

Parameters:

name - The name of the setting to retrieve.

Returns:

A JSON representation of the setting. Returns a status of 404 if a setting with the given name does not exist.

addSetting

@PutMapping(value="{name}/{value}")
 @ResponseStatus(value=CREATED)
public reactor.core.publisher.Mono<Void> addSetting(@PathVariable(value="name")
                                                                                                                        String name,
                                                                                                                        @PathVariable(value="value")
                                                                                                                        String value)

Adds a setting to the system.

Parameters:

uriInfo - Injected URI context used for building the location URI.

name - The name of the setting to add.

value - The value of the setting.

Returns:

Status of 201 if the setting was created or a status of 409 if a setting with the same name already exists.

addSetting

@PutMapping
 @ResponseStatus(value=CREATED)
public reactor.core.publisher.Mono<Void> addSetting(@RequestBody
                                                                                                org.nhindirect.config.model.Setting setting)

Adds a setting to the system. This is an alternative method for adding settings generally needed for values that contain characters that would otherwise be determined unsafe as a part of a URL template.

Parameters:

Setting - The setting argument that holds the name and value

Returns:

Status of 201 if the setting was created or a status of 409 if a setting with the same name already exists.

updateSetting

@PostMapping(value="{name}/{value}")
 @ResponseStatus(value=NO_CONTENT)
public reactor.core.publisher.Mono<Void> updateSetting(@PathVariable(value="name")
                                                                                                                               String name,
                                                                                                                               @PathVariable(value="value")
                                                                                                                               String value)

Updates the value of a setting.

Parameters:

name - The name of the setting to update.

value - The new value of the setting.

Returns:

Status of 204 if the value of the setting was updated or a status of 404 if a setting with the given name does not exist.

updateSetting

@PostMapping
 @ResponseStatus(value=NO_CONTENT)
public reactor.core.publisher.Mono<Void> updateSetting(@RequestBody
                                                                                                       org.nhindirect.config.model.Setting setting)

Updates the value of a setting. This is an alternative method for adding settings generally needed for values that contain characters that would otherwise be determined unsafe as a part of a URL template.

Parameters:

Setting - The setting argument that holds the name and value that is to be updated

Returns:

Status of 204 if the value of the setting was updated or a status of 404 if a setting with the given name does not exist.

removeSettingByName

@DeleteMapping(value="{name}")
public reactor.core.publisher.Mono<Void> removeSettingByName(@PathVariable(value="name")
                                                                                            String name)

Deletes a setting in the system by name.

Parameters:

name - The name of the setting to delete.

Returns:

Status of 200 if the setting was deleted or a status of 204 if a setting with the given name does not exist.