com.appiancorp.suiteapi.process.history

Class AuditHistory

java.lang.Object

com.appiancorp.suiteapi.process.history.AuditHistory

public final class AuditHistory
extends java.lang.Object

AuditHistory Audit Process History allows reading the process history of live processes and processes deleted, but still archived in Kafka. Example: AuditHistory.read(AuditHistory.process(123L), row -> System.out.println(row)); AuditHistory.read(AuditHistory.processModel(234L), row -> System.out.println(row));

Since:

21.3.775.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Method Summary

Modifier and Type	Method and Description
static AuditHistoryProcessOptionsBuilder	process(ServiceContext serviceContext, java.lang.Long processId) Option builder to read audit history for the given process id
static AuditHistoryProcessModelOptionsBuilder	processModel(ServiceContext serviceContext, java.lang.Long processModelId) Option builder to read audit history for the given process model
static AuditHistoryProcessModelOptionsBuilder	processModel(ServiceContext serviceContext, java.lang.Long processModelId, java.util.Set<java.lang.Long> processIds) Option builder to read audit history for the given process model and process ids
static AuditHistoryProcessModelOptionsBuilder	processModel(ServiceContext serviceContext, java.lang.String processModelUuid) Option builder to read audit history for the given process model
static AuditInfo	read(AuditHistoryProcessModelOptionsBuilder processModelOptionsBuilder, java.util.function.Consumer<? extends AuditHistoryRow> consumer) read audit history using the given options into the given Consumer.
static AuditInfo	read(AuditHistoryProcessOptionsBuilder processOptionsBuilder, java.util.function.Consumer<? extends AuditHistoryRow> consumer) read audit history using the given options into the given Consumer.
static AuditInfo	readWithSubprocesses(AuditHistoryProcessModelOptionsBuilder processModelOptionsBuilder, java.util.function.Consumer<? extends AuditHistoryRow> consumer) read audit history including all subprocesses using the given options into the given Consumer.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Method Detail

process

public static AuditHistoryProcessOptionsBuilder process(ServiceContext serviceContext,
                                                        java.lang.Long processId)

Option builder to read audit history for the given process id

Parameters:

serviceContext -

processId -

Returns:

AuditHistoryProcessOptionsBuilder

Since:

21.3.780.0

read

public static AuditInfo read(AuditHistoryProcessOptionsBuilder processOptionsBuilder,
                             java.util.function.Consumer<? extends AuditHistoryRow> consumer)
                      throws InvalidProcessException,
                             PrivilegeException,
                             AuditHistoryException

read audit history using the given options into the given Consumer.

Parameters:

processOptionsBuilder -

consumer - (may be a lambda), invoked for each relevant read given processOptions

Throws:

InvalidProcessException

PrivilegeException

AuditHistoryException

Since:

21.3.780.0

processModel

public static AuditHistoryProcessModelOptionsBuilder processModel(ServiceContext serviceContext,
                                                                  java.lang.Long processModelId)

Option builder to read audit history for the given process model

Parameters:

serviceContext -

processModelId -

Returns:

AuditHistoryProcessModelOptionsBuilder

Since:

21.3.780.0

processModel

public static AuditHistoryProcessModelOptionsBuilder processModel(ServiceContext serviceContext,
                                                                  java.lang.String processModelUuid)
                                                           throws InvalidProcessModelException,
                                                                  PrivilegeException

Option builder to read audit history for the given process model

Parameters:

serviceContext -

processModelUuid -

Returns:

AuditHistoryProcessModelOptionsBuilder

Throws:

InvalidProcessModelException

PrivilegeException

Since:

21.3.825.0

processModel

public static AuditHistoryProcessModelOptionsBuilder processModel(ServiceContext serviceContext,
                                                                  java.lang.Long processModelId,
                                                                  java.util.Set<java.lang.Long> processIds)

Option builder to read audit history for the given process model and process ids

Parameters:

serviceContext -

processModelId -

processIds -

Returns:

AuditHistoryProcessModelOptionsBuilder

Since:

21.3.780.0

read

public static AuditInfo read(AuditHistoryProcessModelOptionsBuilder processModelOptionsBuilder,
                             java.util.function.Consumer<? extends AuditHistoryRow> consumer)
                      throws PrivilegeException,
                             AuditHistoryException

read audit history using the given options into the given Consumer.

Parameters:

processModelOptionsBuilder -

consumer - (may be a lambda), invoked for each relevant read given processModelOptions

Throws:

PrivilegeException

AuditHistoryException

Since:

21.3.780.0

readWithSubprocesses

public static AuditInfo readWithSubprocesses(AuditHistoryProcessModelOptionsBuilder processModelOptionsBuilder,
                                             java.util.function.Consumer<? extends AuditHistoryRow> consumer)
                                      throws PrivilegeException,
                                             AuditHistoryException

read audit history including all subprocesses using the given options into the given Consumer.

Parameters:

processModelOptionsBuilder -

consumer - (may be a lambda), invoked for each relevant read given processModelOptions

Throws:

PrivilegeException

AuditHistoryException

Since:

21.3.780.0