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

Interface TaskRestOpenApi

All Known Implementing Classes:

TaskRestController

@RequestMapping("/v2.1.1/task-manager/")
public interface TaskRestOpenApi

Swagger documentation for task manager.

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	createTask(@Valid Task task, @NotNull @Valid String sessionId)
void	deleteTask(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
TaskResult	executeTask(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
List<UserProfileLight>	getSubscribersForTask(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
Task	getTask(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
List<Task>	getTasks(@NotNull @Valid String sessionId)
List<Task>	getTasksForUser(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)
ChangeDescriptor	subscribeUserToTask(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
ChangeDescriptor	unsubscribeUserFromTask(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
ChangeDescriptor	updateTaskNotificationType(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid TaskNotificationDescriptor notificationType, @NotNull @Valid String sessionId)
ChangeDescriptor	updateTaskParameters(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid List<StringPair> parameters, @NotNull @Valid String sessionId)
ChangeDescriptor	updateTaskProperties(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String property, @NotNull @Valid String value, @NotNull @Valid String sessionId)
ChangeDescriptor	updateTaskSchedule(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid TaskScheduleDescriptor schedule, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

createTask

@RequestMapping(method=POST,
                value="createTask/{sessionId}",
                produces="application/json")
long createTask(@Valid @RequestBody
                @Valid Task task,
                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                @NotNull @Valid String sessionId)

updateTaskProperties

@RequestMapping(method=PUT,
                value="updateTaskProperties/{id}/{property}/{value}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateTaskProperties(@NotNull @Valid @PathVariable(value="id",required=true)
                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                      @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)

updateTaskParameters

@RequestMapping(method=PUT,
                value="updateTaskParameters/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateTaskParameters(@NotNull @Valid @PathVariable(value="id",required=true)
                                      @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                      @NotNull @Valid @RequestBody
                                      @NotNull @Valid List<StringPair> parameters,
                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                      @NotNull @Valid String sessionId)

updateTaskSchedule

@RequestMapping(method=PUT,
                value="updateTaskSchedule/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateTaskSchedule(@NotNull @Valid @PathVariable(value="id",required=true)
                                    @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                    @NotNull @Valid @RequestBody
                                    @NotNull @Valid TaskScheduleDescriptor schedule,
                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                    @NotNull @Valid String sessionId)

updateTaskNotificationType

@RequestMapping(method=PUT,
                value="updateTaskNotificationType/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateTaskNotificationType(@NotNull @Valid @PathVariable(value="id",required=true)
                                            @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                            @NotNull @Valid @RequestBody
                                            @NotNull @Valid TaskNotificationDescriptor notificationType,
                                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                            @NotNull @Valid String sessionId)

deleteTask

@RequestMapping(method=DELETE,
                value="deleteTask/{id}/{sessionId}",
                produces="application/json")
void deleteTask(@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)

subscribeUserToTask

@RequestMapping(method=PUT,
                value="subscribeUserToTask/{userId}/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor subscribeUserToTask(@NotNull @Valid @PathVariable(value="userId",required=true)
                                     @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                     @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)

unsubscribeUserFromTask

@RequestMapping(method=PUT,
                value="unsubscribeUserFromTask/{userId}/{id}/{sessionId}",
                produces="application/json")
ChangeDescriptor unsubscribeUserFromTask(@NotNull @Valid @PathVariable(value="userId",required=true)
                                         @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                         @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)

getTask

@RequestMapping(method=GET,
                value="getTask/{id}/{sessionId}",
                produces="application/json")
Task getTask(@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)

getSubscribersForTask

@RequestMapping(method=GET,
                value="getSubscribersForTask/{id}/{sessionId}",
                produces="application/json")
List<UserProfileLight> getSubscribersForTask(@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)

getTasks

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

getTasksForUser

@RequestMapping(method=GET,
                value="getTasksForUser/{userId}/{sessionId}",
                produces="application/json")
List<Task> getTasksForUser(@NotNull @Valid @PathVariable(value="userId",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

executeTask

@RequestMapping(method=PUT,
                value="executeTask/{id}/{sessionId}",
                produces="application/json")
TaskResult executeTask(@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)