org.kie.server.remote.rest.jbpm.admin

Class UserTaskAdminResource

java.lang.Object

org.kie.server.remote.rest.jbpm.admin.UserTaskAdminResource

@Path(value="server/admin/containers/{containerId}/tasks")
public class UserTaskAdminResource
extends Object

Constructor Summary

Constructors

Constructor and Description
UserTaskAdminResource()
UserTaskAdminResource(UserTaskAdminServiceBase userTaskAdminServiceBase, KieServerRegistry context)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	acknowledgeError(javax.ws.rs.core.HttpHeaders headers, String containerId, String errorId)
javax.ws.rs.core.Response	acknowledgeErrors(javax.ws.rs.core.HttpHeaders headers, String containerId, List<String> errorIds)
javax.ws.rs.core.Response	addAdmins(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, boolean removeExisting, String payload)
javax.ws.rs.core.Response	addExcludedOwners(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, boolean removeExisting, String payload)
javax.ws.rs.core.Response	addPotentialOwners(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, boolean removeExisting, String payload)
javax.ws.rs.core.Response	addTaskInputs(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String payload)
protected javax.ws.rs.core.Response	addToTask(javax.ws.rs.core.HttpHeaders headers, String userId, String containerId, Long tInstanceId, boolean removeExisting, String payload, int operation)
javax.ws.rs.core.Response	cancelNotification(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, Long notificationId)
javax.ws.rs.core.Response	cancelReassignment(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, Long reassignmentId)
javax.ws.rs.core.Response	getExecutionErrorById(javax.ws.rs.core.HttpHeaders headers, String containerId, String errorId)
javax.ws.rs.core.Response	getExecutionErrors(javax.ws.rs.core.HttpHeaders headers, String containerId, boolean includeAcknowledged, String taskName, String processId, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getExecutionErrorsByTask(javax.ws.rs.core.HttpHeaders headers, String containerId, Long taskId, boolean includeAcknowledged, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getTaskNotifications(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, boolean activeOnly)
javax.ws.rs.core.Response	getTaskReassignments(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, boolean activeOnly)
javax.ws.rs.core.Response	notify(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String expiresAt, boolean whenNotStarted, boolean whenNotCompleted, String payload)
javax.ws.rs.core.Response	reassign(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String expiresAt, boolean whenNotStarted, boolean whenNotCompleted, String payload)
javax.ws.rs.core.Response	removeAdminsGroups(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, String groups)
javax.ws.rs.core.Response	removeAdminsUsers(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, String users)
javax.ws.rs.core.Response	removeExcludedOwnersGroups(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, String groups)
javax.ws.rs.core.Response	removeExcludedOwnersUsers(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, String users)
protected javax.ws.rs.core.Response	removeFromTask(javax.ws.rs.core.HttpHeaders headers, String userId, String containerId, Long tInstanceId, boolean isUser, String entities, int operation)
javax.ws.rs.core.Response	removePotentialOwnersGroups(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, String groups)
javax.ws.rs.core.Response	removePotentialOwnersUsers(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, String userId, String users)
javax.ws.rs.core.Response	removeTaskInputs(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, List<String> inputNames)
javax.ws.rs.core.Response	removeTaskOutputs(javax.ws.rs.core.HttpHeaders headers, String containerId, Long tInstanceId, List<String> outputNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserTaskAdminResource

public UserTaskAdminResource()

UserTaskAdminResource

public UserTaskAdminResource(UserTaskAdminServiceBase userTaskAdminServiceBase,
                             KieServerRegistry context)

Method Detail

addPotentialOwners

@PUT
 @Path(value="{taskInstanceId}/pot-owners")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response addPotentialOwners(@Context
                                                                                                                                                                                                                       javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                       @PathParam(value="containerId")
                                                                                                                                                                                                                       String containerId,
                                                                                                                                                                                                                       @PathParam(value="taskInstanceId")
                                                                                                                                                                                                                       Long tInstanceId,
                                                                                                                                                                                                                       @QueryParam(value="user")
                                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                                       @QueryParam(value="remove") @DefaultValue(value="false")
                                                                                                                                                                                                                       boolean removeExisting,
                                                                                                                                                                                                                       String payload)

addExcludedOwners

@PUT
 @Path(value="{taskInstanceId}/exl-owners")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response addExcludedOwners(@Context
                                                                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                      @PathParam(value="containerId")
                                                                                                                                                                                                                      String containerId,
                                                                                                                                                                                                                      @PathParam(value="taskInstanceId")
                                                                                                                                                                                                                      Long tInstanceId,
                                                                                                                                                                                                                      @QueryParam(value="user")
                                                                                                                                                                                                                      String userId,
                                                                                                                                                                                                                      @QueryParam(value="remove") @DefaultValue(value="false")
                                                                                                                                                                                                                      boolean removeExisting,
                                                                                                                                                                                                                      String payload)

addAdmins

@PUT
 @Path(value="{taskInstanceId}/admins")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response addAdmins(@Context
                                                                                                                                                                                                          javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                          @PathParam(value="containerId")
                                                                                                                                                                                                          String containerId,
                                                                                                                                                                                                          @PathParam(value="taskInstanceId")
                                                                                                                                                                                                          Long tInstanceId,
                                                                                                                                                                                                          @QueryParam(value="user")
                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                          @QueryParam(value="remove") @DefaultValue(value="false")
                                                                                                                                                                                                          boolean removeExisting,
                                                                                                                                                                                                          String payload)

removePotentialOwnersUsers

@DELETE
 @Path(value="{taskInstanceId}/pot-owners/users/{entityId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removePotentialOwnersUsers(@Context
                                                                                                                                                                                          javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                          @PathParam(value="containerId")
                                                                                                                                                                                          String containerId,
                                                                                                                                                                                          @PathParam(value="taskInstanceId")
                                                                                                                                                                                          Long tInstanceId,
                                                                                                                                                                                          @QueryParam(value="user")
                                                                                                                                                                                          String userId,
                                                                                                                                                                                          @PathParam(value="entityId")
                                                                                                                                                                                          String users)

removeExcludedOwnersUsers

@DELETE
 @Path(value="{taskInstanceId}/exl-owners/users/{entityId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removeExcludedOwnersUsers(@Context
                                                                                                                                                                                         javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                         @PathParam(value="containerId")
                                                                                                                                                                                         String containerId,
                                                                                                                                                                                         @PathParam(value="taskInstanceId")
                                                                                                                                                                                         Long tInstanceId,
                                                                                                                                                                                         @QueryParam(value="user")
                                                                                                                                                                                         String userId,
                                                                                                                                                                                         @PathParam(value="entityId")
                                                                                                                                                                                         String users)

removeAdminsUsers

@DELETE
 @Path(value="{taskInstanceId}/admins/users/{entityId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removeAdminsUsers(@Context
                                                                                                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                             @PathParam(value="containerId")
                                                                                                                                                                             String containerId,
                                                                                                                                                                             @PathParam(value="taskInstanceId")
                                                                                                                                                                             Long tInstanceId,
                                                                                                                                                                             @QueryParam(value="user")
                                                                                                                                                                             String userId,
                                                                                                                                                                             @PathParam(value="entityId")
                                                                                                                                                                             String users)

removePotentialOwnersGroups

@DELETE
 @Path(value="{taskInstanceId}/pot-owners/groups/{entityId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removePotentialOwnersGroups(@Context
                                                                                                                                                                                            javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                            @PathParam(value="containerId")
                                                                                                                                                                                            String containerId,
                                                                                                                                                                                            @PathParam(value="taskInstanceId")
                                                                                                                                                                                            Long tInstanceId,
                                                                                                                                                                                            @QueryParam(value="user")
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @PathParam(value="entityId")
                                                                                                                                                                                            String groups)

removeExcludedOwnersGroups

@DELETE
 @Path(value="{taskInstanceId}/exl-owners/groups/{entityId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removeExcludedOwnersGroups(@Context
                                                                                                                                                                                           javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                           @PathParam(value="containerId")
                                                                                                                                                                                           String containerId,
                                                                                                                                                                                           @PathParam(value="taskInstanceId")
                                                                                                                                                                                           Long tInstanceId,
                                                                                                                                                                                           @QueryParam(value="user")
                                                                                                                                                                                           String userId,
                                                                                                                                                                                           @PathParam(value="entityId")
                                                                                                                                                                                           String groups)

removeAdminsGroups

@DELETE
 @Path(value="{taskInstanceId}/admins/groups/{entityId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removeAdminsGroups(@Context
                                                                                                                                                                               javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                               @PathParam(value="containerId")
                                                                                                                                                                               String containerId,
                                                                                                                                                                               @PathParam(value="taskInstanceId")
                                                                                                                                                                               Long tInstanceId,
                                                                                                                                                                               @QueryParam(value="user")
                                                                                                                                                                               String userId,
                                                                                                                                                                               @PathParam(value="entityId")
                                                                                                                                                                               String groups)

addTaskInputs

@PUT
 @Path(value="{taskInstanceId}/contents/input")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response addTaskInputs(@Context
                                                                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                      @PathParam(value="containerId")
                                                                                                                                                                                                                      String containerId,
                                                                                                                                                                                                                      @PathParam(value="taskInstanceId")
                                                                                                                                                                                                                      Long tInstanceId,
                                                                                                                                                                                                                      String payload)

removeTaskInputs

@DELETE
 @Path(value="{taskInstanceId}/contents/input")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removeTaskInputs(@Context
                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                   @PathParam(value="containerId")
                                                                                                                                                                   String containerId,
                                                                                                                                                                   @PathParam(value="taskInstanceId")
                                                                                                                                                                   Long tInstanceId,
                                                                                                                                                                   @QueryParam(value="name")
                                                                                                                                                                   List<String> inputNames)

removeTaskOutputs

@DELETE
 @Path(value="{taskInstanceId}/contents/output")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removeTaskOutputs(@Context
                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                     @PathParam(value="containerId")
                                                                                                                                                                     String containerId,
                                                                                                                                                                     @PathParam(value="taskInstanceId")
                                                                                                                                                                     Long tInstanceId,
                                                                                                                                                                     @QueryParam(value="name")
                                                                                                                                                                     List<String> outputNames)

reassign

@POST
 @Path(value="{taskInstanceId}/reassignments")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response reassign(@Context
                                                                                                                                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                 @PathParam(value="containerId")
                                                                                                                                                                                                                 String containerId,
                                                                                                                                                                                                                 @PathParam(value="taskInstanceId")
                                                                                                                                                                                                                 Long tInstanceId,
                                                                                                                                                                                                                 @QueryParam(value="expiresAt")
                                                                                                                                                                                                                 String expiresAt,
                                                                                                                                                                                                                 @QueryParam(value="whenNotStarted") @DefaultValue(value="false")
                                                                                                                                                                                                                 boolean whenNotStarted,
                                                                                                                                                                                                                 @QueryParam(value="whenNotCompleted") @DefaultValue(value="false")
                                                                                                                                                                                                                 boolean whenNotCompleted,
                                                                                                                                                                                                                 String payload)

notify

@POST
 @Path(value="{taskInstanceId}/notifications")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response notify(@Context
                                                                                                                                                                                                               javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                               @PathParam(value="containerId")
                                                                                                                                                                                                               String containerId,
                                                                                                                                                                                                               @PathParam(value="taskInstanceId")
                                                                                                                                                                                                               Long tInstanceId,
                                                                                                                                                                                                               @QueryParam(value="expiresAt")
                                                                                                                                                                                                               String expiresAt,
                                                                                                                                                                                                               @QueryParam(value="whenNotStarted") @DefaultValue(value="false")
                                                                                                                                                                                                               boolean whenNotStarted,
                                                                                                                                                                                                               @QueryParam(value="whenNotCompleted") @DefaultValue(value="false")
                                                                                                                                                                                                               boolean whenNotCompleted,
                                                                                                                                                                                                               String payload)

cancelReassignment

@DELETE
 @Path(value="{taskInstanceId}/reassignments/{reassignmentId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response cancelReassignment(@Context
                                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                     @PathParam(value="containerId")
                                                                                                                                                                                     String containerId,
                                                                                                                                                                                     @PathParam(value="taskInstanceId")
                                                                                                                                                                                     Long tInstanceId,
                                                                                                                                                                                     @PathParam(value="reassignmentId")
                                                                                                                                                                                     Long reassignmentId)

cancelNotification

@DELETE
 @Path(value="{taskInstanceId}/notifications/{notificationId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response cancelNotification(@Context
                                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                     @PathParam(value="containerId")
                                                                                                                                                                                     String containerId,
                                                                                                                                                                                     @PathParam(value="taskInstanceId")
                                                                                                                                                                                     Long tInstanceId,
                                                                                                                                                                                     @PathParam(value="notificationId")
                                                                                                                                                                                     Long notificationId)

getTaskReassignments

@GET
 @Path(value="{taskInstanceId}/reassignments")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getTaskReassignments(@Context
                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                   @PathParam(value="containerId")
                                                                                                                                                                   String containerId,
                                                                                                                                                                   @PathParam(value="taskInstanceId")
                                                                                                                                                                   Long tInstanceId,
                                                                                                                                                                   @QueryParam(value="activeOnly") @DefaultValue(value="true")
                                                                                                                                                                   boolean activeOnly)

getTaskNotifications

@GET
 @Path(value="{taskInstanceId}/notifications")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getTaskNotifications(@Context
                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                   @PathParam(value="containerId")
                                                                                                                                                                   String containerId,
                                                                                                                                                                   @PathParam(value="taskInstanceId")
                                                                                                                                                                   Long tInstanceId,
                                                                                                                                                                   @QueryParam(value="activeOnly") @DefaultValue(value="true")
                                                                                                                                                                   boolean activeOnly)

acknowledgeError

@PUT
 @Path(value="errors/{errorId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response acknowledgeError(@Context
                                                                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                 @PathParam(value="containerId")
                                                                                                                                                 String containerId,
                                                                                                                                                 @PathParam(value="errorId")
                                                                                                                                                 String errorId)

acknowledgeErrors

@PUT
 @Path(value="errors")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response acknowledgeErrors(@Context
                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                        @PathParam(value="containerId")
                                                                                                                                        String containerId,
                                                                                                                                        @QueryParam(value="errorId")
                                                                                                                                        List<String> errorIds)

getExecutionErrorById

@GET
 @Path(value="errors/{errorId}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getExecutionErrorById(@Context
                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                      @PathParam(value="containerId")
                                                                                                                                                      String containerId,
                                                                                                                                                      @PathParam(value="errorId")
                                                                                                                                                      String errorId)

getExecutionErrorsByTask

@GET
 @Path(value="{taskInstanceId}/errors")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getExecutionErrorsByTask(@Context
                                                                                                                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                @PathParam(value="containerId")
                                                                                                                                                                String containerId,
                                                                                                                                                                @PathParam(value="taskInstanceId")
                                                                                                                                                                Long taskId,
                                                                                                                                                                @QueryParam(value="includeAck") @DefaultValue(value="false")
                                                                                                                                                                boolean includeAcknowledged,
                                                                                                                                                                @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                                                Integer page,
                                                                                                                                                                @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                                                Integer pageSize,
                                                                                                                                                                @QueryParam(value="sort")
                                                                                                                                                                String sort,
                                                                                                                                                                @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                                                                boolean sortOrder)

getExecutionErrors

@GET
 @Path(value="errors")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getExecutionErrors(@Context
                                                                                                                                         javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                         @PathParam(value="containerId")
                                                                                                                                         String containerId,
                                                                                                                                         @QueryParam(value="includeAck") @DefaultValue(value="false")
                                                                                                                                         boolean includeAcknowledged,
                                                                                                                                         @QueryParam(value="name")
                                                                                                                                         String taskName,
                                                                                                                                         @QueryParam(value="process")
                                                                                                                                         String processId,
                                                                                                                                         @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                         Integer page,
                                                                                                                                         @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                         Integer pageSize,
                                                                                                                                         @QueryParam(value="sort")
                                                                                                                                         String sort,
                                                                                                                                         @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                                         boolean sortOrder)

addToTask

protected javax.ws.rs.core.Response addToTask(javax.ws.rs.core.HttpHeaders headers,
                                              String userId,
                                              String containerId,
                                              Long tInstanceId,
                                              boolean removeExisting,
                                              String payload,
                                              int operation)

removeFromTask

protected javax.ws.rs.core.Response removeFromTask(javax.ws.rs.core.HttpHeaders headers,
                                                   String userId,
                                                   String containerId,
                                                   Long tInstanceId,
                                                   boolean isUser,
                                                   String entities,
                                                   int operation)