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

Interface ValidatorsRestOpenApi

All Known Implementing Classes:

ValidatorsRestController

@RequestMapping("/v2.1.1/configuration-validators/")
public interface ValidatorsRestOpenApi

Swagger documentation for validator definition.

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	createValidatorDefinition(@NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String className, @NotNull @Valid String script, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
void	deleteValidatorDefinition(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
List<ValidatorDefinition>	getAllValidatorDefinitions(@NotNull @Valid String sessionId)
List<ValidatorDefinition>	getValidatorDefinitionsForClass(@NotNull @Valid String className, @NotNull @Valid String sessionId)
List<Validator>	runValidationsForObject(@NotNull @Valid String className, @javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
void	updateValidatorDefinition(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String className, @NotNull @Valid String script, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled, @NotNull @Valid String userName, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

createValidatorDefinition

@RequestMapping(method=POST,
                value="createValidatorDefinition/{name}/{description}/{className}/{script}/{enabled}/{userName}/{sessionId}",
                produces="application/json")
long createValidatorDefinition(@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="className",required=true)
                               @NotNull @Valid String className,
                               @NotNull @Valid @PathVariable(value="script",required=true)
                               @NotNull @Valid String script,
                               @NotNull @Valid @PathVariable(value="enabled",required=true)
                               @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled,
                               @NotNull @Valid @PathVariable(value="userName",required=true)
                               @NotNull @Valid String userName,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

updateValidatorDefinition

@RequestMapping(method=PUT,
                value="updateValidatorDefinition/{id}/{name}/{description}/{className}/{script}/{enabled}/{userName}/{sessionId}",
                produces="application/json")
void updateValidatorDefinition(@NotNull @Valid @PathVariable(value="id",required=true)
                               @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                               @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="className",required=true)
                               @NotNull @Valid String className,
                               @NotNull @Valid @PathVariable(value="script",required=true)
                               @NotNull @Valid String script,
                               @NotNull @Valid @PathVariable(value="enabled",required=true)
                               @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled,
                               @NotNull @Valid @PathVariable(value="userName",required=true)
                               @NotNull @Valid String userName,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

getValidatorDefinitionsForClass

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

getAllValidatorDefinitions

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

runValidationsForObject

@RequestMapping(method=POST,
                value="runValidationsForObject/{className}/{id}/{sessionId}",
                produces="application/json")
List<Validator> runValidationsForObject(@NotNull @Valid @PathVariable(value="className",required=true)
                                        @NotNull @Valid String className,
                                        @NotNull @Valid @PathVariable(value="id",required=true)
                                        @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                        @NotNull @Valid String sessionId)

deleteValidatorDefinition

@RequestMapping(method=DELETE,
                value="deleteValidatorDefinition/{id}/{userName}/{sessionId}",
                produces="application/json")
void deleteValidatorDefinition(@NotNull @Valid @PathVariable(value="id",required=true)
                               @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                               @NotNull @Valid @PathVariable(value="userName",required=true)
                               @NotNull @Valid String userName,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)