Package com.evolveum.midpoint.repo.common.activity.run

Class ActivityRunResult

java.lang.Object

com.evolveum.midpoint.repo.common.activity.run.ActivityRunResult

All Implemented Interfaces:

ShortDumpable

public class ActivityRunResult
extends Object
implements ShortDumpable

Result of an run of an activity. Fields are currently not final, in order to allow setting them stepwise.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ActivityRunResult.RestartRequestingInformation	Details for runResultStatus being ActivityRunResultStatus.RESTART_REQUESTED.

Constructor Summary

Constructors

Constructor	Description
ActivityRunResult()
ActivityRunResult(@NotNull OperationResultStatus operationResultStatus, @NotNull ActivityRunResultStatus runResultStatus)

Method Summary

Modifier and Type	Method	Description
static ActivityRunResult	aborted(OperationResultStatus opResultStatus, ActivityAbortingInformationType abortingInformation)
void	close(boolean canRun, OperationResultStatus status)	"Closes" the result by converting null or "in progress" values into finished/interrupted/success/default ones.
static ActivityRunResult	finished(OperationResultStatus opResultStatus)
static ActivityRunResult	fromException(OperationResultStatus opStatus, ActivityRunResultStatus runStatus, Throwable throwable)	Converts exception into ActivityRunResult.
@Nullable String	getMessage()
OperationResultStatus	getOperationResultStatus()
OperationResultStatusType	getOperationResultStatusBean()
@NotNull ActivityRunResult.RestartRequestingInformation	getRestartRequestingInformationRequired()
ActivityRunResultStatus	getRunResultStatus()
ActivitySimplifiedRealizationStateType	getSimplifiedRealizationState()
Throwable	getThrowable()
static @NotNull ActivityRunResult	handleException(@NotNull Exception e, @NotNull OperationResult opResult, @NotNull AbstractActivityRun<?,?,?> activityRun)	Handles exceptions that occurred during run of an activity: . converts them into ActivityRunResult . logs them appropriately . records them into the provided OperationResult (Logging and recording are things we usually do when catching exceptions.)
static ActivityRunResult	interrupted()
boolean	isAborted()
boolean	isError()
boolean	isFinished()
boolean	isInterrupted()
boolean	isRestartRequested()
boolean	isWaiting()
ActivityRunResult	message(String message)
void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.
static ActivityRunResult	success()
String	toString()
static ActivityRunResult	waiting()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.util.ShortDumpable

shortDump, shortDumpLazily

Constructor Details

ActivityRunResult

public ActivityRunResult()

ActivityRunResult

public ActivityRunResult(@NotNull
 @NotNull OperationResultStatus operationResultStatus,
 @NotNull
 @NotNull ActivityRunResultStatus runResultStatus)

Method Details

fromException

public static ActivityRunResult fromException(OperationResultStatus opStatus,
 ActivityRunResultStatus runStatus,
 Throwable throwable)

Converts exception into ActivityRunResult. Used when the exception is not ActivityRunException (that provides its own statuses). Otherwise, consider #fromException(Exception).

success

public static ActivityRunResult success()

interrupted

public static ActivityRunResult interrupted()

finished

public static ActivityRunResult finished(OperationResultStatus opResultStatus)

aborted

public static ActivityRunResult aborted(OperationResultStatus opResultStatus,
 ActivityAbortingInformationType abortingInformation)

waiting

public static ActivityRunResult waiting()

handleException

@NotNull
public static @NotNull ActivityRunResult handleException(@NotNull
 @NotNull Exception e,
 @NotNull
 @NotNull OperationResult opResult,
 @NotNull
 @NotNull AbstractActivityRun<?,?,?> activityRun)

Handles exceptions that occurred during run of an activity: . converts them into ActivityRunResult . logs them appropriately . records them into the provided OperationResult (Logging and recording are things we usually do when catching exceptions.) This method is to be called at places that expect ActivityRunResult to be returned, instead of throwing exceptions.

Parameters:

e - Exception to be handled

opResult - Operation result into which the exception should be recorded

activityRun - Instance of activity run in which the exception is converted. It is used just for logging purposes.

See Also:

• fromException(OperationResultStatus, ActivityRunResultStatus, Throwable)

getRunResultStatus

public ActivityRunResultStatus getRunResultStatus()

isError

public boolean isError()

isFinished

public boolean isFinished()

isWaiting

public boolean isWaiting()

isInterrupted

public boolean isInterrupted()

isAborted

public boolean isAborted()

getSimplifiedRealizationState

public ActivitySimplifiedRealizationStateType getSimplifiedRealizationState()

isRestartRequested

public boolean isRestartRequested()

getOperationResultStatus

public OperationResultStatus getOperationResultStatus()

getOperationResultStatusBean

public OperationResultStatusType getOperationResultStatusBean()

getThrowable

public Throwable getThrowable()

message

public ActivityRunResult message(String message)

getMessage

@Nullable
public @Nullable String getMessage()

getRestartRequestingInformationRequired

@NotNull
public @NotNull ActivityRunResult.RestartRequestingInformation getRestartRequestingInformationRequired()

toString

public String toString()

Overrides:

toString in class Object

shortDump

public void shortDump(StringBuilder sb)

Description copied from interface: ShortDumpable

Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.

Specified by:

shortDump in interface ShortDumpable

Parameters:

sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.

close

public void close(boolean canRun,
 OperationResultStatus status)

"Closes" the result by converting null or "in progress" values into finished/interrupted/success/default ones.