org.finra.herd.rest

Class ConfigurationEntryRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.ConfigurationEntryRestController

@RestController
 @RequestMapping(value="/rest",
                produces={"application/xml","application/json"})
public class ConfigurationEntryRestController
extends HerdBaseController

The REST controller that handles configuration entries requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_ENTRIES_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
ConfigurationEntryRestController()

Method Summary

Modifier and Type	Method and Description
ConfigurationEntryKeys	getConfigurationEntries() Gets a list of configuration entry keys for all configuration entries defined in the system.
ConfigurationEntry	getConfigurationEntry(String configurationEntryKey) Gets an existing configuration entry by its configuration entry key.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_ENTRIES_URI_PREFIX

public static final String CONFIGURATION_ENTRIES_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

ConfigurationEntryRestController

public ConfigurationEntryRestController()

Method Detail

getConfigurationEntry

@RequestMapping(value="/configurationEntries/{configurationEntryKey}",
                method=GET)
 @Secured(value="FN_CONFIGURATION_ENTRIES_GET")
public ConfigurationEntry getConfigurationEntry(@PathVariable(value="configurationEntryKey")
                                                                                                                                                                                                   String configurationEntryKey)

Gets an existing configuration entry by its configuration entry key.

Parameters:

configurationEntryKey - the key of the configuration entry

Returns:

the retrieved configuration entry

getConfigurationEntries

@RequestMapping(value="/configurationEntries",
                method=GET)
 @Secured(value="FN_CONFIGURATION_ENTRIES_ALL_GET")
public ConfigurationEntryKeys getConfigurationEntries()

Gets a list of configuration entry keys for all configuration entries defined in the system.

Returns:

the list of configuration entry keys