org.kie.server.client

Interface KieServicesClient

All Known Implementing Classes:

KieServicesClientImpl

public interface KieServicesClient

Method Summary

Methods

Modifier and Type	Method and Description
void	abortProcessInstance(String containerId, Long processInstanceId)
void	abortProcessInstances(String containerId, List<Long> processInstanceIds)
void	abortWorkItem(String containerId, Long processInstanceId, Long id)
void	activateTask(String containerId, Long taskId, String userId)
Long	addTaskAttachment(String containerId, Long taskId, String userId, Object attachment)
Long	addTaskComment(String containerId, Long taskId, String text, String addedBy, Date addedOn)
void	claimTask(String containerId, Long taskId, String userId)
void	completeTask(String containerId, Long taskId, String userId, Map<String,Object> params)
void	completeWorkItem(String containerId, Long processInstanceId, Long id, Map<String,Object> results)
ServiceResponse<KieContainerResource>	createContainer(String id, KieContainerResource resource)
void	delegateTask(String containerId, Long taskId, String userId, String targetUserId)
void	deleteTaskAttachment(String containerId, Long taskId, Long attachmentId)
void	deleteTaskComment(String containerId, Long taskId, Long commentId)
void	deleteTaskContent(String containerId, Long taskId, Long contentId)
ServiceResponse<Void>	disposeContainer(String id)
ServiceResponse<String>	executeCommands(String id, org.kie.api.command.Command<?> cmd)
ServiceResponse<String>	executeCommands(String id, String payload)
ServiceResponsesList	executeScript(CommandScript script)
void	exitTask(String containerId, Long taskId, String userId)
void	failTask(String containerId, Long taskId, String userId, Map<String,Object> params)
List<NodeInstance>	findActiveNodeInstances(Long processInstanceId, Integer page, Integer pageSize)
List<NodeInstance>	findCompletedNodeInstances(Long processInstanceId, Integer page, Integer pageSize)
NodeInstance	findNodeInstanceByWorkItemId(Long processInstanceId, Long workItemId)
List<NodeInstance>	findNodeInstances(Long processInstanceId, Integer page, Integer pageSize)
ProcessDefinition	findProcessByContainerIdProcessId(String containerId, String processId)
List<ProcessDefinition>	findProcesses(Integer page, Integer pageSize)
List<ProcessDefinition>	findProcesses(String filter, Integer page, Integer pageSize)
List<ProcessDefinition>	findProcessesByContainerId(String containerId, Integer page, Integer pageSize)
List<ProcessDefinition>	findProcessesById(String processId)
ProcessInstance	findProcessInstanceByCorrelationKey(org.kie.internal.process.CorrelationKey correlationKey)
ProcessInstance	findProcessInstanceById(Long processInstanceId)
List<ProcessInstance>	findProcessInstances(Integer page, Integer pageSize)
List<ProcessInstance>	findProcessInstancesByContainerId(String containerId, List<Integer> status, Integer page, Integer pageSize)
List<ProcessInstance>	findProcessInstancesByInitiator(String initiator, List<Integer> status, Integer page, Integer pageSize)
List<ProcessInstance>	findProcessInstancesByProcessId(String processId, List<Integer> status, Integer page, Integer pageSize)
List<ProcessInstance>	findProcessInstancesByProcessName(String processName, List<Integer> status, Integer page, Integer pageSize)
List<ProcessInstance>	findProcessInstancesByStatus(List<Integer> status, Integer page, Integer pageSize)
TaskInstance	findTaskById(Long taskId)
TaskInstance	findTaskByWorkItemId(Long workItemId)
List<TaskEventInstance>	findTaskEvents(Long taskId, Integer page, Integer pageSize)
List<TaskSummary>	findTasks(String userId, Integer page, Integer pageSize)
List<TaskSummary>	findTasksAssignedAsBusinessAdministrator(String userId, Integer page, Integer pageSize)
List<TaskSummary>	findTasksAssignedAsBusinessAdministrator(String userId, List<String> status, Integer page, Integer pageSize)
List<TaskSummary>	findTasksAssignedAsPotentialOwner(String userId, Integer page, Integer pageSize)
List<TaskSummary>	findTasksAssignedAsPotentialOwner(String userId, List<String> status, Integer page, Integer pageSize)
List<TaskSummary>	findTasksAssignedAsPotentialOwner(String userId, List<String> groups, List<String> status, Integer page, Integer pageSize)
List<TaskSummary>	findTasksByStatusByProcessInstanceId(Long processInstanceId, List<String> status, Integer page, Integer pageSize)
List<TaskSummary>	findTasksOwned(String userId, Integer page, Integer pageSize)
List<TaskSummary>	findTasksOwned(String userId, List<String> status, Integer page, Integer pageSize)
List<VariableInstance>	findVariableHistory(Long processInstanceId, String variableName, Integer page, Integer pageSize)
List<VariableInstance>	findVariablesCurrentState(Long processInstanceId)
void	forwardTask(String containerId, Long taskId, String userId, String targetEntityId)
AssociatedEntitiesDefinition	getAssociatedEntityDefinitions(String containerId, String processId)
List<String>	getAvailableSignals(String containerId, Long processInstanceId)
ServiceResponse<KieContainerResource>	getContainerInfo(String id)
ProcessDefinition	getProcessDefinition(String containerId, String processId)
ProcessInstance	getProcessInstance(String containerId, Long processInstanceId)
ProcessInstance	getProcessInstance(String containerId, Long processInstanceId, boolean withVars)
Object	getProcessInstanceVariable(String containerId, Long processInstanceId, String variableName)
<T> T	getProcessInstanceVariable(String containerId, Long processInstanceId, String variableName, Class<T> type)
Map<String,Object>	getProcessInstanceVariables(String containerId, Long processInstanceId)
VariablesDefinition	getProcessVariableDefinitions(String containerId, String processId)
SubProcessesDefinition	getReusableSubProcessDefinitions(String containerId, String processId)
ServiceResponse<KieScannerResource>	getScannerInfo(String id)
ServiceResponse<KieServerInfo>	getServerInfo()
ServiceTasksDefinition	getServiceTaskDefinitions(String containerId, String processId)
TaskAttachment	getTaskAttachmentById(String containerId, Long taskId, Long attachmentId)
Object	getTaskAttachmentContentById(String containerId, Long taskId, Long attachmentId)
List<TaskAttachment>	getTaskAttachmentsByTaskId(String containerId, Long taskId)
TaskComment	getTaskCommentById(String containerId, Long taskId, Long commentId)
List<TaskComment>	getTaskCommentsByTaskId(String containerId, Long taskId)
Map<String,Object>	getTaskInputContentByTaskId(String containerId, Long taskId)
TaskInstance	getTaskInstance(String containerId, Long taskId)
TaskInstance	getTaskInstance(String containerId, Long taskId, boolean withInputs, boolean withOutputs, boolean withAssignments)
Map<String,Object>	getTaskOutputContentByTaskId(String containerId, Long taskId)
UserTaskDefinitionList	getUserTaskDefinitions(String containerId, String processId)
TaskInputsDefinition	getUserTaskInputDefinitions(String containerId, String processId, String taskName)
TaskOutputsDefinition	getUserTaskOutputDefinitions(String containerId, String processId, String taskName)
WorkItemInstance	getWorkItem(String containerId, Long processInstanceId, Long id)
List<WorkItemInstance>	getWorkItemByProcessInstance(String containerId, Long processInstanceId)
ServiceResponse<KieContainerResourceList>	listContainers()
void	nominateTask(String containerId, Long taskId, String userId, List<String> potentialOwners)
ServiceResponse<KieServerInfo>	register(String controllerEndpoint, KieServerConfig kieServerConfig)
void	releaseTask(String containerId, Long taskId, String userId)
void	resumeTask(String containerId, Long taskId, String userId)
Long	saveTaskContent(String containerId, Long taskId, Map<String,Object> values)
void	setProcessVariable(String containerId, Long processInstanceId, String variableId, Object value)
void	setProcessVariables(String containerId, Long processInstanceId, Map<String,Object> variables)
void	setTaskDescription(String containerId, Long taskId, String description)
void	setTaskExpirationDate(String containerId, Long taskId, Date date)
void	setTaskName(String containerId, Long taskId, String name)
void	setTaskPriority(String containerId, Long taskId, int priority)
void	setTaskSkipable(String containerId, Long taskId, boolean skipable)
void	signalProcessInstance(String containerId, Long processInstanceId, String signalName, Object event)
void	signalProcessInstances(String containerId, List<Long> processInstanceId, String signalName, Object event)
void	skipTask(String containerId, Long taskId, String userId)
Long	startProcess(String containerId, String processId)
Long	startProcess(String containerId, String processId, org.kie.internal.process.CorrelationKey correlationKey)
Long	startProcess(String containerId, String processId, org.kie.internal.process.CorrelationKey correlationKey, Map<String,Object> variables)
Long	startProcess(String containerId, String processId, Map<String,Object> variables)
void	startTask(String containerId, Long taskId, String userId)
void	stopTask(String containerId, Long taskId, String userId)
void	suspendTask(String containerId, Long taskId, String userId)
ServiceResponse<ReleaseId>	updateReleaseId(String id, ReleaseId releaseId)
ServiceResponse<KieScannerResource>	updateScanner(String id, KieScannerResource resource)

Method Detail

register

ServiceResponse<KieServerInfo> register(String controllerEndpoint,
                                      KieServerConfig kieServerConfig)

getServerInfo

ServiceResponse<KieServerInfo> getServerInfo()

listContainers

ServiceResponse<KieContainerResourceList> listContainers()

createContainer

ServiceResponse<KieContainerResource> createContainer(String id,
                                                    KieContainerResource resource)

getContainerInfo

ServiceResponse<KieContainerResource> getContainerInfo(String id)

disposeContainer

ServiceResponse<Void> disposeContainer(String id)

executeCommands

ServiceResponse<String> executeCommands(String id,
                                      String payload)

executeCommands

ServiceResponse<String> executeCommands(String id,
                                      org.kie.api.command.Command<?> cmd)

executeScript

ServiceResponsesList executeScript(CommandScript script)

getScannerInfo

ServiceResponse<KieScannerResource> getScannerInfo(String id)

updateScanner

ServiceResponse<KieScannerResource> updateScanner(String id,
                                                KieScannerResource resource)

updateReleaseId

ServiceResponse<ReleaseId> updateReleaseId(String id,
                                         ReleaseId releaseId)

getProcessDefinition

ProcessDefinition getProcessDefinition(String containerId,
                                     String processId)

getReusableSubProcessDefinitions

SubProcessesDefinition getReusableSubProcessDefinitions(String containerId,
                                                      String processId)

getProcessVariableDefinitions

VariablesDefinition getProcessVariableDefinitions(String containerId,
                                                String processId)

getServiceTaskDefinitions

ServiceTasksDefinition getServiceTaskDefinitions(String containerId,
                                               String processId)

getAssociatedEntityDefinitions

AssociatedEntitiesDefinition getAssociatedEntityDefinitions(String containerId,
                                                          String processId)

getUserTaskDefinitions

UserTaskDefinitionList getUserTaskDefinitions(String containerId,
                                            String processId)

getUserTaskInputDefinitions

TaskInputsDefinition getUserTaskInputDefinitions(String containerId,
                                               String processId,
                                               String taskName)

getUserTaskOutputDefinitions

TaskOutputsDefinition getUserTaskOutputDefinitions(String containerId,
                                                 String processId,
                                                 String taskName)

startProcess

Long startProcess(String containerId,
                String processId)

startProcess

Long startProcess(String containerId,
                String processId,
                Map<String,Object> variables)

startProcess

Long startProcess(String containerId,
                String processId,
                org.kie.internal.process.CorrelationKey correlationKey)

startProcess

Long startProcess(String containerId,
                String processId,
                org.kie.internal.process.CorrelationKey correlationKey,
                Map<String,Object> variables)

abortProcessInstance

void abortProcessInstance(String containerId,
                        Long processInstanceId)

abortProcessInstances

void abortProcessInstances(String containerId,
                         List<Long> processInstanceIds)

getProcessInstanceVariable

Object getProcessInstanceVariable(String containerId,
                                Long processInstanceId,
                                String variableName)

getProcessInstanceVariable

<T> T getProcessInstanceVariable(String containerId,
                               Long processInstanceId,
                               String variableName,
                               Class<T> type)

getProcessInstanceVariables

Map<String,Object> getProcessInstanceVariables(String containerId,
                                             Long processInstanceId)

signalProcessInstance

void signalProcessInstance(String containerId,
                         Long processInstanceId,
                         String signalName,
                         Object event)

signalProcessInstances

void signalProcessInstances(String containerId,
                          List<Long> processInstanceId,
                          String signalName,
                          Object event)

getAvailableSignals

List<String> getAvailableSignals(String containerId,
                               Long processInstanceId)

setProcessVariable

void setProcessVariable(String containerId,
                      Long processInstanceId,
                      String variableId,
                      Object value)

setProcessVariables

void setProcessVariables(String containerId,
                       Long processInstanceId,
                       Map<String,Object> variables)

getProcessInstance

ProcessInstance getProcessInstance(String containerId,
                                 Long processInstanceId)

getProcessInstance

ProcessInstance getProcessInstance(String containerId,
                                 Long processInstanceId,
                                 boolean withVars)

completeWorkItem

void completeWorkItem(String containerId,
                    Long processInstanceId,
                    Long id,
                    Map<String,Object> results)

abortWorkItem

void abortWorkItem(String containerId,
                 Long processInstanceId,
                 Long id)

getWorkItem

WorkItemInstance getWorkItem(String containerId,
                           Long processInstanceId,
                           Long id)

getWorkItemByProcessInstance

List<WorkItemInstance> getWorkItemByProcessInstance(String containerId,
                                                  Long processInstanceId)

activateTask

void activateTask(String containerId,
                Long taskId,
                String userId)

claimTask

void claimTask(String containerId,
             Long taskId,
             String userId)

completeTask

void completeTask(String containerId,
                Long taskId,
                String userId,
                Map<String,Object> params)

delegateTask

void delegateTask(String containerId,
                Long taskId,
                String userId,
                String targetUserId)

exitTask

void exitTask(String containerId,
            Long taskId,
            String userId)

failTask

void failTask(String containerId,
            Long taskId,
            String userId,
            Map<String,Object> params)

forwardTask

void forwardTask(String containerId,
               Long taskId,
               String userId,
               String targetEntityId)

releaseTask

void releaseTask(String containerId,
               Long taskId,
               String userId)

resumeTask

void resumeTask(String containerId,
              Long taskId,
              String userId)

skipTask

void skipTask(String containerId,
            Long taskId,
            String userId)

startTask

void startTask(String containerId,
             Long taskId,
             String userId)

stopTask

void stopTask(String containerId,
            Long taskId,
            String userId)

suspendTask

void suspendTask(String containerId,
               Long taskId,
               String userId)

nominateTask

void nominateTask(String containerId,
                Long taskId,
                String userId,
                List<String> potentialOwners)

setTaskPriority

void setTaskPriority(String containerId,
                   Long taskId,
                   int priority)

setTaskExpirationDate

void setTaskExpirationDate(String containerId,
                         Long taskId,
                         Date date)

setTaskSkipable

void setTaskSkipable(String containerId,
                   Long taskId,
                   boolean skipable)

setTaskName

void setTaskName(String containerId,
               Long taskId,
               String name)

setTaskDescription

void setTaskDescription(String containerId,
                      Long taskId,
                      String description)

saveTaskContent

Long saveTaskContent(String containerId,
                   Long taskId,
                   Map<String,Object> values)

getTaskOutputContentByTaskId

Map<String,Object> getTaskOutputContentByTaskId(String containerId,
                                              Long taskId)

getTaskInputContentByTaskId

Map<String,Object> getTaskInputContentByTaskId(String containerId,
                                             Long taskId)

deleteTaskContent

void deleteTaskContent(String containerId,
                     Long taskId,
                     Long contentId)

addTaskComment

Long addTaskComment(String containerId,
                  Long taskId,
                  String text,
                  String addedBy,
                  Date addedOn)

deleteTaskComment

void deleteTaskComment(String containerId,
                     Long taskId,
                     Long commentId)

getTaskCommentsByTaskId

List<TaskComment> getTaskCommentsByTaskId(String containerId,
                                        Long taskId)

getTaskCommentById

TaskComment getTaskCommentById(String containerId,
                             Long taskId,
                             Long commentId)

addTaskAttachment

Long addTaskAttachment(String containerId,
                     Long taskId,
                     String userId,
                     Object attachment)

deleteTaskAttachment

void deleteTaskAttachment(String containerId,
                        Long taskId,
                        Long attachmentId)

getTaskAttachmentById

TaskAttachment getTaskAttachmentById(String containerId,
                                   Long taskId,
                                   Long attachmentId)

getTaskAttachmentContentById

Object getTaskAttachmentContentById(String containerId,
                                  Long taskId,
                                  Long attachmentId)

getTaskAttachmentsByTaskId

List<TaskAttachment> getTaskAttachmentsByTaskId(String containerId,
                                              Long taskId)

getTaskInstance

TaskInstance getTaskInstance(String containerId,
                           Long taskId)

getTaskInstance

TaskInstance getTaskInstance(String containerId,
                           Long taskId,
                           boolean withInputs,
                           boolean withOutputs,
                           boolean withAssignments)

findProcessByContainerIdProcessId

ProcessDefinition findProcessByContainerIdProcessId(String containerId,
                                                  String processId)

findProcessesById

List<ProcessDefinition> findProcessesById(String processId)

findProcesses

List<ProcessDefinition> findProcesses(Integer page,
                                    Integer pageSize)

findProcesses

List<ProcessDefinition> findProcesses(String filter,
                                    Integer page,
                                    Integer pageSize)

findProcessesByContainerId

List<ProcessDefinition> findProcessesByContainerId(String containerId,
                                                 Integer page,
                                                 Integer pageSize)

findProcessInstances

List<ProcessInstance> findProcessInstances(Integer page,
                                         Integer pageSize)

findProcessInstancesByProcessId

List<ProcessInstance> findProcessInstancesByProcessId(String processId,
                                                    List<Integer> status,
                                                    Integer page,
                                                    Integer pageSize)

findProcessInstancesByProcessName

List<ProcessInstance> findProcessInstancesByProcessName(String processName,
                                                      List<Integer> status,
                                                      Integer page,
                                                      Integer pageSize)

findProcessInstancesByContainerId

List<ProcessInstance> findProcessInstancesByContainerId(String containerId,
                                                      List<Integer> status,
                                                      Integer page,
                                                      Integer pageSize)

findProcessInstancesByStatus

List<ProcessInstance> findProcessInstancesByStatus(List<Integer> status,
                                                 Integer page,
                                                 Integer pageSize)

findProcessInstancesByInitiator

List<ProcessInstance> findProcessInstancesByInitiator(String initiator,
                                                    List<Integer> status,
                                                    Integer page,
                                                    Integer pageSize)

findProcessInstanceById

ProcessInstance findProcessInstanceById(Long processInstanceId)

findProcessInstanceByCorrelationKey

ProcessInstance findProcessInstanceByCorrelationKey(org.kie.internal.process.CorrelationKey correlationKey)

findNodeInstanceByWorkItemId

NodeInstance findNodeInstanceByWorkItemId(Long processInstanceId,
                                        Long workItemId)

findActiveNodeInstances

List<NodeInstance> findActiveNodeInstances(Long processInstanceId,
                                         Integer page,
                                         Integer pageSize)

findCompletedNodeInstances

List<NodeInstance> findCompletedNodeInstances(Long processInstanceId,
                                            Integer page,
                                            Integer pageSize)

findNodeInstances

List<NodeInstance> findNodeInstances(Long processInstanceId,
                                   Integer page,
                                   Integer pageSize)

findVariablesCurrentState

List<VariableInstance> findVariablesCurrentState(Long processInstanceId)

findVariableHistory

List<VariableInstance> findVariableHistory(Long processInstanceId,
                                         String variableName,
                                         Integer page,
                                         Integer pageSize)

findTaskByWorkItemId

TaskInstance findTaskByWorkItemId(Long workItemId)

findTaskById

TaskInstance findTaskById(Long taskId)

findTasksAssignedAsBusinessAdministrator

List<TaskSummary> findTasksAssignedAsBusinessAdministrator(String userId,
                                                         Integer page,
                                                         Integer pageSize)

findTasksAssignedAsBusinessAdministrator

List<TaskSummary> findTasksAssignedAsBusinessAdministrator(String userId,
                                                         List<String> status,
                                                         Integer page,
                                                         Integer pageSize)

findTasksAssignedAsPotentialOwner

List<TaskSummary> findTasksAssignedAsPotentialOwner(String userId,
                                                  Integer page,
                                                  Integer pageSize)

findTasksAssignedAsPotentialOwner

List<TaskSummary> findTasksAssignedAsPotentialOwner(String userId,
                                                  List<String> status,
                                                  Integer page,
                                                  Integer pageSize)

findTasksAssignedAsPotentialOwner

List<TaskSummary> findTasksAssignedAsPotentialOwner(String userId,
                                                  List<String> groups,
                                                  List<String> status,
                                                  Integer page,
                                                  Integer pageSize)

findTasksOwned

List<TaskSummary> findTasksOwned(String userId,
                               Integer page,
                               Integer pageSize)

findTasksOwned

List<TaskSummary> findTasksOwned(String userId,
                               List<String> status,
                               Integer page,
                               Integer pageSize)

findTasksByStatusByProcessInstanceId

List<TaskSummary> findTasksByStatusByProcessInstanceId(Long processInstanceId,
                                                     List<String> status,
                                                     Integer page,
                                                     Integer pageSize)

findTasks

List<TaskSummary> findTasks(String userId,
                          Integer page,
                          Integer pageSize)

findTaskEvents

List<TaskEventInstance> findTaskEvents(Long taskId,
                                     Integer page,
                                     Integer pageSize)