Package clients

Class ProcessInstanceHttpClient

java.lang.Object

clients.BaseClient

clients.ProcessInstanceHttpClient

All Implemented Interfaces:

IBaseClient, IProcessInstanceExtensionAdapter, java.lang.AutoCloseable

public class ProcessInstanceHttpClient
extends BaseClient
implements IProcessInstanceExtensionAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface extensionAdapter.IProcessInstanceExtensionAdapter

IProcessInstanceExtensionAdapter.ProcessInstanceQueryOptions, IProcessInstanceExtensionAdapter.ProcessInstanceRetryOptions

Field Summary

Fields inherited from class clients.BaseClient

httpClient, identity, socketIoManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProcessInstanceHttpClient(@NonNull java.net.URI engineUrl, @NonNull Identity identity, SocketIoManager socketIoManager)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteProcessInstances(@NonNull java.lang.String[] processInstanceIds, boolean deleteAllRelatedData, Identity identity)
java.util.concurrent.CompletableFuture<ProcessDefinition>	getProcessDefinition(@NonNull java.lang.String processInstanceId, Identity identity)
java.util.concurrent.CompletableFuture<ProcessDefinition.ProcessModel>	getProcessModel(@NonNull java.lang.String processInstanceId, Identity identity)
java.util.concurrent.CompletableFuture<ProcessInstance.ProcessInstanceList>	query(@NonNull ProcessInstanceQuery query, IProcessInstanceExtensionAdapter.ProcessInstanceQueryOptions options)
java.util.concurrent.CompletableFuture<java.lang.Void>	retryProcessInstance(@NonNull java.lang.String processInstanceId, IProcessInstanceExtensionAdapter.ProcessInstanceRetryOptions options)
java.util.concurrent.CompletableFuture<java.lang.Void>	terminateProcessInstance(@NonNull java.lang.String processInstanceId, Identity identity)
java.util.concurrent.CompletableFuture<java.lang.Void>	transferOwnership(@NonNull java.lang.String processInstanceId, @NonNull Identity newOwner, Identity identity)

Methods inherited from class clients.BaseClient

addParameterToUrl, buildUrl, close, connected, createRequestAuthHeaders, createSocketIoSubscription, disconnectSocket, getEngineUrl, isSocketConnected, removeSocketIoSubscription

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstanceHttpClient

protected ProcessInstanceHttpClient(@NonNull
                                    @NonNull java.net.URI engineUrl,
                                    @NonNull
                                    @NonNull Identity identity,
                                    SocketIoManager socketIoManager)
                             throws java.net.UnknownHostException,
                                    java.net.URISyntaxException

Throws:

java.net.UnknownHostException

java.net.URISyntaxException

Method Detail

query

public java.util.concurrent.CompletableFuture<ProcessInstance.ProcessInstanceList> query(@NonNull
                                                                                         @NonNull ProcessInstanceQuery query,
                                                                                         IProcessInstanceExtensionAdapter.ProcessInstanceQueryOptions options)

Specified by:

query in interface IProcessInstanceExtensionAdapter

getProcessDefinition

public java.util.concurrent.CompletableFuture<ProcessDefinition> getProcessDefinition(@NonNull
                                                                                      @NonNull java.lang.String processInstanceId,
                                                                                      Identity identity)

Specified by:

getProcessDefinition in interface IProcessInstanceExtensionAdapter

getProcessModel

public java.util.concurrent.CompletableFuture<ProcessDefinition.ProcessModel> getProcessModel(@NonNull
                                                                                              @NonNull java.lang.String processInstanceId,
                                                                                              Identity identity)

Specified by:

getProcessModel in interface IProcessInstanceExtensionAdapter

transferOwnership

public java.util.concurrent.CompletableFuture<java.lang.Void> transferOwnership(@NonNull
                                                                                @NonNull java.lang.String processInstanceId,
                                                                                @NonNull
                                                                                @NonNull Identity newOwner,
                                                                                Identity identity)

Specified by:

transferOwnership in interface IProcessInstanceExtensionAdapter

terminateProcessInstance

public java.util.concurrent.CompletableFuture<java.lang.Void> terminateProcessInstance(@NonNull
                                                                                       @NonNull java.lang.String processInstanceId,
                                                                                       Identity identity)

Specified by:

terminateProcessInstance in interface IProcessInstanceExtensionAdapter

retryProcessInstance

public java.util.concurrent.CompletableFuture<java.lang.Void> retryProcessInstance(@NonNull
                                                                                   @NonNull java.lang.String processInstanceId,
                                                                                   IProcessInstanceExtensionAdapter.ProcessInstanceRetryOptions options)

Specified by:

retryProcessInstance in interface IProcessInstanceExtensionAdapter

deleteProcessInstances

public java.util.concurrent.CompletableFuture<java.lang.Void> deleteProcessInstances(@NonNull
                                                                                     @NonNull java.lang.String[] processInstanceIds,
                                                                                     boolean deleteAllRelatedData,
                                                                                     Identity identity)

Specified by:

deleteProcessInstances in interface IProcessInstanceExtensionAdapter