Package org.neotropic.kuwaiba.northbound.rest.aem

Interface VariablesRestOpenApi

All Known Implementing Classes:

VariablesRestController

@RequestMapping("/v2.1.1/configuration-variables/")
public interface VariablesRestOpenApi

Swagger documentation for variables.

Author:

Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH

Method Summary

Modifier and Type	Method	Description
long	createConfigurationVariable(@NotNull @Valid String poolId, @NotNull @Valid String name, @NotNull @Valid String description, @javax.validation.constraints.NotNull,@javax.validation.Valid int type, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean masked, @NotNull @Valid String value, @NotNull @Valid String sessionId)
String	createConfigurationVariablesPool(@NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String sessionId)
void	deleteConfigurationVariable(@NotNull @Valid String name, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
void	deleteConfigurationVariablesPool(@NotNull @Valid String poolId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
List<ConfigurationVariable>	getAllConfigurationVariables(@NotNull @Valid String sessionId)
Properties	getConfiguration(@NotNull @Valid String sessionId)
ConfigurationVariable	getConfigurationVariable(@NotNull @Valid String name, @NotNull @Valid String sessionId)
List<ConfigurationVariable>	getConfigurationVariablesInPool(@NotNull @Valid String poolId, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getConfigurationVariablesPools(@NotNull @Valid String sessionId)
List<ConfigurationVariable>	getConfigurationVariablesWithPrefix(@NotNull @Valid String prefix, @NotNull @Valid String sessionId)
Object	getConfigurationVariableValue(@NotNull @Valid String name, @NotNull @Valid String sessionId)
void	updateConfigurationVariable(@NotNull @Valid String name, @NotNull @Valid String property, @NotNull @Valid String value, @NotNull @Valid String sessionId)
void	updateConfigurationVariablesPool(@NotNull @Valid String poolId, @NotNull @Valid String property, @NotNull @Valid String value, @NotNull @Valid String userName, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

createConfigurationVariable

@RequestMapping(method=POST,
                value="createConfigurationVariable/{poolId}/{name}/{description}/{type}/{masked}/{value}/{sessionId}",
                produces="application/json")
long createConfigurationVariable(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                 @NotNull @Valid String poolId,
                                 @NotNull @Valid @PathVariable(value="name",required=true)
                                 @NotNull @Valid String name,
                                 @NotNull @Valid @PathVariable(value="description",required=true)
                                 @NotNull @Valid String description,
                                 @NotNull @Valid @PathVariable(value="type",required=true)
                                 @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                                 @NotNull @Valid @PathVariable(value="masked",required=true)
                                 @javax.validation.constraints.NotNull,@javax.validation.Valid boolean masked,
                                 @NotNull @Valid @PathVariable(value="value",required=true)
                                 @NotNull @Valid String value,
                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                 @NotNull @Valid String sessionId)

createConfigurationVariablesPool

@RequestMapping(method=POST,
                value="createConfigurationVariablesPool/{name}/{description}/{sessionId}",
                produces="application/json")
String createConfigurationVariablesPool(@NotNull @Valid @PathVariable(value="name",required=true)
                                        @NotNull @Valid String name,
                                        @NotNull @Valid @PathVariable(value="description",required=true)
                                        @NotNull @Valid String description,
                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                        @NotNull @Valid String sessionId)

updateConfigurationVariable

@RequestMapping(method=PUT,
                value="updateConfigurationVariable/{name}/{property}/{value}/{sessionId}",
                produces="application/json")
void updateConfigurationVariable(@NotNull @Valid @PathVariable(value="name",required=true)
                                 @NotNull @Valid String name,
                                 @NotNull @Valid @PathVariable(value="property",required=true)
                                 @NotNull @Valid String property,
                                 @NotNull @Valid @PathVariable(value="value",required=true)
                                 @NotNull @Valid String value,
                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                 @NotNull @Valid String sessionId)

updateConfigurationVariablesPool

@RequestMapping(method=PUT,
                value="updateConfigurationVariablesPool/{poolId}/{property}/{value}/{userName}/{sessionId}",
                produces="application/json")
void updateConfigurationVariablesPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                      @NotNull @Valid String poolId,
                                      @NotNull @Valid @PathVariable(value="property",required=true)
                                      @NotNull @Valid String property,
                                      @NotNull @Valid @PathVariable(value="value",required=true)
                                      @NotNull @Valid String value,
                                      @NotNull @Valid @PathVariable(value="userName",required=true)
                                      @NotNull @Valid String userName,
                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                      @NotNull @Valid String sessionId)

getConfigurationVariable

@RequestMapping(method=GET,
                value="getConfigurationVariable/{name}/{sessionId}",
                produces="application/json")
ConfigurationVariable getConfigurationVariable(@NotNull @Valid @PathVariable(value="name",required=true)
                                               @NotNull @Valid String name,
                                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                               @NotNull @Valid String sessionId)

getConfigurationVariableValue

@RequestMapping(method=GET,
                value="getConfigurationVariableValue/{name}/{sessionId}",
                produces="application/json")
Object getConfigurationVariableValue(@NotNull @Valid @PathVariable(value="name",required=true)
                                     @NotNull @Valid String name,
                                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                     @NotNull @Valid String sessionId)

getConfigurationVariablesInPool

@RequestMapping(method=GET,
                value="getConfigurationVariablesInPool/{poolId}/{sessionId}",
                produces="application/json")
List<ConfigurationVariable> getConfigurationVariablesInPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                                            @NotNull @Valid String poolId,
                                                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                            @NotNull @Valid String sessionId)

getConfigurationVariablesWithPrefix

@RequestMapping(method=GET,
                value="getConfigurationVariablesWithPrefix/{prefix}/{sessionId}",
                produces="application/json")
List<ConfigurationVariable> getConfigurationVariablesWithPrefix(@NotNull @Valid @PathVariable(value="prefix",required=true)
                                                                @NotNull @Valid String prefix,
                                                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                                @NotNull @Valid String sessionId)

getAllConfigurationVariables

@RequestMapping(method=GET,
                value="getAllConfigurationVariables/{sessionId}",
                produces="application/json")
List<ConfigurationVariable> getAllConfigurationVariables(@NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                         @NotNull @Valid String sessionId)

getConfigurationVariablesPools

@RequestMapping(method=GET,
                value="getConfigurationVariablesPools/{sessionId}",
                produces="application/json")
List<InventoryObjectPool> getConfigurationVariablesPools(@NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                         @NotNull @Valid String sessionId)

getConfiguration

@RequestMapping(method=GET,
                value="getConfiguration/{sessionId}",
                produces="application/json")
Properties getConfiguration(@NotNull @Valid @PathVariable(value="sessionId",required=true)
                            @NotNull @Valid String sessionId)

deleteConfigurationVariable

@RequestMapping(method=DELETE,
                value="deleteConfigurationVariable/{name}/{userName}/{sessionId}",
                produces="application/json")
void deleteConfigurationVariable(@NotNull @Valid @PathVariable(value="name",required=true)
                                 @NotNull @Valid String name,
                                 @NotNull @Valid @PathVariable(value="userName",required=true)
                                 @NotNull @Valid String userName,
                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                 @NotNull @Valid String sessionId)

deleteConfigurationVariablesPool

@RequestMapping(method=DELETE,
                value="deleteConfigurationVariablesPool/{poolId}/{userName}/{sessionId}",
                produces="application/json")
void deleteConfigurationVariablesPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                      @NotNull @Valid String poolId,
                                      @NotNull @Valid @PathVariable(value="userName",required=true)
                                      @NotNull @Valid String userName,
                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                      @NotNull @Valid String sessionId)