de.cinovo.cloudconductor.api.interfaces

Interface IConfigValue

@Path(value="/config")
 @Produces(value="application/json;charset=UTF-8")
 @Consumes(value="application/json;charset=UTF-8")
public interface IConfigValue

Copyright 2017 Cinovo AG

Author:

psigloch

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String template, java.lang.String service, java.lang.String key) Delete a ConfigValue
void	deleteForService(java.lang.String template, java.lang.String service) Deletes all configuration values for given template and service.
void	deleteForTemplate(java.lang.String templateName) Deletes all configuration values for the given template.
ConfigDiff[]	diffTemplates(java.lang.String templateA, java.lang.String templateB) Returns the value for a key of the given service within the template as Key-Value Pair, but does no parent matching
ConfigValue[]	get(java.lang.String template) Returns configuration of the given template as Key-Value Pairs
ConfigValue[]	get(java.lang.String template, java.lang.String service) Returns configuration of the given service within the template as Key-Value Pairs
java.lang.String	get(java.lang.String template, java.lang.String service, java.lang.String key) Returns the value for a key of the given service within the template as Key-Value Pairs
java.lang.String[]	getAvailableTemplates()
ConfigValue[]	getClean(java.lang.String template) Returns all configuration key of a template, without variable swaps
ConfigValue[]	getClean(java.lang.String template, java.lang.String service) Returns configuration of the given service within the template as Key-Value Pairs, without variable swaps
java.lang.String	getClean(java.lang.String template, java.lang.String service, java.lang.String key) Returns the value for a key of the given service within the template as Key-Value Pairs, without variable swaps
ConfigValue[]	getCleanUnstacked(java.lang.String template) Returns all configuration key of a template in a non stacked variant, without variable swaps
ConfigValue[]	getCleanVars(java.lang.String template) Returns the value for variables of the given template as Key-Value Pair, but does no parent matching
java.lang.String	getExact(java.lang.String template, java.lang.String service, java.lang.String key) Returns the value for a key of the given service within the template as Key-Value Pair, but does no parent matching
ConfigValue[]	getUnstacked(java.lang.String template) Deprecated. use getCleanUnstacked instead.
void	migrateGlobalConfig() Migrate global configuration values.
void	save(ConfigValue config) Adds a new key-value pair to the configuration of a service within a template

Method Detail

getAvailableTemplates

@GET
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES"})
java.lang.String[] getAvailableTemplates()

Returns:

a collection of known templates

get

@GET
 @Path(value="/{template}")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
ConfigValue[] get(@PathParam(value="template")
                                                                                                                                                                                                                                           java.lang.String template)

Returns configuration of the given template as Key-Value Pairs

Parameters:

template - the template name

Returns:

set of stacked config values

deleteForTemplate

@DELETE
 @Path(value="/{template}")
 @RolesAllowed(value="EDIT_CONFIGVALUES")
void deleteForTemplate(@PathParam(value="template")
                                                                                                     java.lang.String templateName)

Deletes all configuration values for the given template.

Parameters:

templateName - the name of the template

getUnstacked

@GET
 @Path(value="/{template}/unstacked")
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
 @Deprecated
ConfigValue[] getUnstacked(@PathParam(value="template")
                                                                                                                                                                   java.lang.String template)

Deprecated. use getCleanUnstacked instead.

Returns all configuration key of a template in a non stacked variant

Parameters:

template - the template name

Returns:

array of configuration values

get

@GET
 @Path(value="/{template}/{service}")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
ConfigValue[] get(@PathParam(value="template")
                                                                                                                                                                                                                                                     java.lang.String template,
                                                                                                                                                                                                                                                     @PathParam(value="service")
                                                                                                                                                                                                                                                     java.lang.String service)

Returns configuration of the given service within the template as Key-Value Pairs

Parameters:

template - the template name

service - the name of the service

Returns:

array of key value pairs representing the configuration of the service within the template

deleteForService

@DELETE
 @Path(value="/{template}/{service}")
 @RolesAllowed(value="EDIT_CONFIGVALUES")
void deleteForService(@PathParam(value="template")
                                                                                                              java.lang.String template,
                                                                                                              @PathParam(value="service")
                                                                                                              java.lang.String service)

Deletes all configuration values for given template and service.

Parameters:

template - the name of the template

service - the name of the service

get

@GET
 @Path(value="/{template}/{service:.*}/{key}")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
java.lang.String get(@PathParam(value="template")
                                                                                                                                                                                                                                                                 java.lang.String template,
                                                                                                                                                                                                                                                                 @PathParam(value="service")
                                                                                                                                                                                                                                                                 java.lang.String service,
                                                                                                                                                                                                                                                                 @PathParam(value="key")
                                                                                                                                                                                                                                                                 java.lang.String key)

Returns the value for a key of the given service within the template as Key-Value Pairs

Parameters:

template - the template name

service - the name of the service

key - the name of the key

Returns:

the value of the key of the service within the template

getExact

@GET
 @Path(value="/{template}/{service:.*}/{key}/exact")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
java.lang.String getExact(@PathParam(value="template")
                                                                                                                                                                                                                                                                            java.lang.String template,
                                                                                                                                                                                                                                                                            @PathParam(value="service")
                                                                                                                                                                                                                                                                            java.lang.String service,
                                                                                                                                                                                                                                                                            @PathParam(value="key")
                                                                                                                                                                                                                                                                            java.lang.String key)

Returns the value for a key of the given service within the template as Key-Value Pair, but does no parent matching

Parameters:

template - the template name

service - the name of the service

key - the name of the key

Returns:

the value of the key of the service within the template

save

@PUT
 @RolesAllowed(value="EDIT_CONFIGVALUES")
void save(ConfigValue config)

Adds a new key-value pair to the configuration of a service within a template

Parameters:

config - the config value

delete

@DELETE
 @Path(value="/{template}/{service:.*}/{key}")
 @RolesAllowed(value="EDIT_CONFIGVALUES")
void delete(@PathParam(value="template")
                                                                                                             java.lang.String template,
                                                                                                             @PathParam(value="service")
                                                                                                             java.lang.String service,
                                                                                                             @PathParam(value="key")
                                                                                                             java.lang.String key)

Delete a ConfigValue

Parameters:

template - the template name

service - the name of the service

key - the name of the key

getClean

@GET
 @Path(value="/clean/{template}")
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
ConfigValue[] getClean(@PathParam(value="template")
                                                                                                                                              java.lang.String template)

Returns all configuration key of a template, without variable swaps

Parameters:

template - the template name

Returns:

array of configuration values

getCleanUnstacked

@GET
 @Path(value="/clean/unstacked/{template}")
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
ConfigValue[] getCleanUnstacked(@PathParam(value="template")
                                                                                                                                                                 java.lang.String template)

Returns all configuration key of a template in a non stacked variant, without variable swaps

Parameters:

template - the template name

Returns:

array of configuration values

getClean

@GET
 @Path(value="/clean/{template}/{service}")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
ConfigValue[] getClean(@PathParam(value="template")
                                                                                                                                                                                                                                                                java.lang.String template,
                                                                                                                                                                                                                                                                @PathParam(value="service")
                                                                                                                                                                                                                                                                java.lang.String service)

Returns configuration of the given service within the template as Key-Value Pairs, without variable swaps

Parameters:

template - the template name

service - the name of the service

Returns:

array of key value pairs representing the configuration of the service within the template

getClean

@GET
 @Path(value="/clean/{template}/{service:.*}/{key}")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
java.lang.String getClean(@PathParam(value="template")
                                                                                                                                                                                                                                                                            java.lang.String template,
                                                                                                                                                                                                                                                                            @PathParam(value="service")
                                                                                                                                                                                                                                                                            java.lang.String service,
                                                                                                                                                                                                                                                                            @PathParam(value="key")
                                                                                                                                                                                                                                                                            java.lang.String key)

Returns the value for a key of the given service within the template as Key-Value Pairs, without variable swaps

Parameters:

template - the template name

service - the name of the service

key - the name of the key

Returns:

the value of the key of the service within the template

getCleanVars

@GET
 @Path(value="clean/vars/{template}")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES","USE_AGENT_API"})
ConfigValue[] getCleanVars(@PathParam(value="template")
                                                                                                                                                                                                                                                              java.lang.String template)

Returns the value for variables of the given template as Key-Value Pair, but does no parent matching

Parameters:

template - the template name

Returns:

the value of the key of the service within the template

diffTemplates

@GET
 @Path(value="diff/{templateA}/{templateB}")
 @Produces(value={"application/json;charset=UTF-8","application/x-javaargs","application/x-javaprops"})
 @RolesAllowed(value={"VIEW_CONFIGVALUES","EDIT_CONFIGVALUES"})
ConfigDiff[] diffTemplates(@PathParam(value="templateA")
                                                                                                                                                                                                                                                     java.lang.String templateA,
                                                                                                                                                                                                                                                     @PathParam(value="templateB")
                                                                                                                                                                                                                                                     java.lang.String templateB)

Returns the value for a key of the given service within the template as Key-Value Pair, but does no parent matching

Parameters:

templateA - the template name

templateB - the other themplate name

Returns:

the value of the key of the service within the template

migrateGlobalConfig

@PUT
 @Path(value="migrate")
 @RolesAllowed(value="EDIT_CONFIGVALUES")
void migrateGlobalConfig()

Migrate global configuration values.