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

Class ActivityState

java.lang.Object

com.evolveum.midpoint.repo.common.activity.run.state.ActivityState

All Implemented Interfaces:

DebugDumpable

Direct Known Subclasses:

CurrentActivityState, OtherActivityState

public abstract class ActivityState
extends Object
implements DebugDumpable

Used to manipulate ActivityStateType objects in a task: - either the current one (CurrentActivityState) - or some other one (OtherActivityState) - e.g. parent activity (in the same task or its parent task), or any other activity in the task tree. The most recommended usage style is to update the current activity state. It is e.g. the most safe regarding the concurrency. NOTE: This class is NOT intended to hold everything related to "activity state". It is just

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull CommonTaskBeans	beans

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActivityState()

Method Summary

Modifier and Type	Method	Description
void	addDeleteItemRealValues(@NotNull ItemPath path, @NotNull Collection<?> valuesToAdd, @NotNull Collection<?> valuesToDelete)	DO NOT use for setting work state items because of dynamic typing of the work state container value.
String	debugDump(int indent)
protected abstract void	debugDumpExtra(StringBuilder sb, int indent)
void	flushPendingTaskModifications(OperationResult result)	Flushes pending task modifications.
void	flushPendingTaskModificationsChecked(OperationResult result)	Flushes pending task modifications.
ActivityAbortingInformationType	getAbortingInformation()
ActivityAbortingInformationType	getAbortingInformationRequired()
ObjectReferenceType	getAbortingWorkerRef()
abstract @NotNull ActivityPath	getActivityPath()
static @NotNull ActivityState	getActivityStateDownwards(@NotNull ActivityPath activityPath, @NotNull Task task, @NotNull QName workStateTypeName, OperationResult result)	Gets the state of the given activity, starting from the `task` and going downwards.
Iterable<ActivityState>	getActivityStatesUpwardsForParent(OperationResult result)	Returns an iterator over activity states, from the parent of the current activity to the root.
static @NotNull ActivityState	getActivityStateUpwards(@NotNull ActivityPath activityPath, @NotNull Task task, @Nullable QName workStateTypeName, OperationResult result)	Returns activity state for given path, crawling from the current task upwards.
BucketsProcessingRoleType	getBucketProcessingRole()
@NotNull Map<String,Integer>	getCounters(@NotNull ExecutionSupport.CountersGroup counterGroup)
@NotNull ActivityState	getCurrentActivityStateInParentTask(boolean fresh, @NotNull QName workStateTypeName, @Nullable OperationResult result)	Returns the state of the current activity in the parent task.
protected @NotNull String	getEnhancedClassName()
int	getExecutionAttempt()
@NotNull ActivityState	getParentActivityState(@Nullable QName workStateTypeName, OperationResult result)	Returns the state of the _parent activity_, e.g. operations completion sub-activity -> reconciliation activity.
<T> T	getPropertyRealValue(ItemPath path, Class<T> expectedType)
@NotNull Collection<ActivityRunRecordType>	getRawRunRecordsClone()
XMLGregorianCalendar	getRealizationStartTimestamp()
ActivityRealizationStateType	getRealizationState()
@NotNull RestartActivityPolicyActionType	getRestartPolicyActionRequired()
OperationResultStatus	getResultStatus()
@Nullable String	getSimulationResultOid()
@Nullable ObjectReferenceType	getSimulationResultRef()
protected abstract @NotNull Task	getTask()
abstract @Nullable ComplexTypeDefinition	getWorkStateComplexTypeDefinition()
<T> T	getWorkStateItemRealValueClone(ItemPath path, Class<T> expectedType)
<T> T	getWorkStatePropertyRealValue(ItemPath path, Class<T> expectedType)
ObjectReferenceType	getWorkStateReferenceRealValue(ItemPath path)
Collection<ObjectReferenceType>	getWorkStateReferenceRealValues(ItemPath path)
Map<String,Integer>	incrementCounters(@NotNull ExecutionSupport.CountersGroup counterGroup, @NotNull Collection<String> countersIdentifiers, @NotNull OperationResult result)
boolean	isAborted()
boolean	isBeingRestarted()	Returns true if there is a request to restart this particular activity.
boolean	isBeingRestartedOrSkipped()	Returns true if there is a request to restart or skip this particular activity.
boolean	isBeingSkipped()	Returns true if there is a request to skip this particular activity.
boolean	isBucketedWorkAborted()
boolean	isBucketedWorkComplete()
boolean	isComplete()
boolean	isDelegating()	Beware!
boolean	isScavenger()
boolean	isSimulationResultCreated()
boolean	isWorker()
void	setAbortingWorkerRef(ObjectReferenceType workerRef)
void	setBucketProcessingRole(BucketsProcessingRoleType role)
void	setItemRealValues(ItemPath path, Object... values)	DO NOT use for setting work state items because of dynamic typing of the work state container value.
void	setItemRealValuesCollection(ItemPath path, Collection<?> values)	DO NOT use for setting work state items because of dynamic typing of the work state container value.
void	setSimulationResultCreated()
void	setSimulationResultOid(String oid)
void	setWorkStateItemRealValues(ItemPath path, ItemDefinition<?> explicitDefinition, Object... values)
void	setWorkStateItemRealValues(ItemPath path, Object... values)
String	toString()
Map<String,ActivityPolicyStateType>	updatePolicies(@NotNull Collection<ActivityPolicyStateType> policies, @NotNull OperationResult result)

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.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Field Details

beans

@NotNull
protected final @NotNull CommonTaskBeans beans

Constructor Details

ActivityState

protected ActivityState()

Method Details

getRealizationState

public ActivityRealizationStateType getRealizationState()

isComplete

public boolean isComplete()

isAborted

public boolean isAborted()

isBeingRestartedOrSkipped

public boolean isBeingRestartedOrSkipped()

Returns true if there is a request to restart or skip this particular activity.

isBeingRestarted

public boolean isBeingRestarted()

Returns true if there is a request to restart this particular activity.

getRestartPolicyActionRequired

@NotNull
public @NotNull RestartActivityPolicyActionType getRestartPolicyActionRequired()

isBeingSkipped

public boolean isBeingSkipped()

Returns true if there is a request to skip this particular activity.

getRealizationStartTimestamp

public XMLGregorianCalendar getRealizationStartTimestamp()

getResultStatus

public OperationResultStatus getResultStatus()

setBucketProcessingRole

public void setBucketProcessingRole(BucketsProcessingRoleType role)
                             throws ActivityRunException

Throws:

ActivityRunException

getBucketProcessingRole

public BucketsProcessingRoleType getBucketProcessingRole()

isWorker

public boolean isWorker()

isScavenger

public boolean isScavenger()

isBucketedWorkComplete

public boolean isBucketedWorkComplete()

setAbortingWorkerRef

public void setAbortingWorkerRef(ObjectReferenceType workerRef)
                          throws ActivityRunException

Throws:

ActivityRunException

getAbortingWorkerRef

public ObjectReferenceType getAbortingWorkerRef()

isBucketedWorkAborted

public boolean isBucketedWorkAborted()

getPropertyRealValue

public <T> T getPropertyRealValue(ItemPath path,
 Class<T> expectedType)

setItemRealValues

public void setItemRealValues(ItemPath path,
 Object... values)
                       throws ActivityRunException

DO NOT use for setting work state items because of dynamic typing of the work state container value.

Throws:

ActivityRunException

setItemRealValuesCollection

public void setItemRealValuesCollection(ItemPath path,
 Collection<?> values)
                                 throws ActivityRunException

DO NOT use for setting work state items because of dynamic typing of the work state container value.

Throws:

ActivityRunException

addDeleteItemRealValues

public void addDeleteItemRealValues(@NotNull
 @NotNull ItemPath path,
 @NotNull
 @NotNull Collection<?> valuesToAdd,
 @NotNull
 @NotNull Collection<?> valuesToDelete)
                             throws ActivityRunException

DO NOT use for setting work state items because of dynamic typing of the work state container value.

Throws:

ActivityRunException

flushPendingTaskModifications

public void flushPendingTaskModifications(OperationResult result)
                                   throws SchemaException,
ObjectNotFoundException,
ObjectAlreadyExistsException

Flushes pending task modifications. Note for implementers: this method should be equivalent to a direct call to Task.flushPendingModifications(OperationResult).

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException

flushPendingTaskModificationsChecked

public void flushPendingTaskModificationsChecked(OperationResult result)
                                          throws ActivityRunException

Flushes pending task modifications. Note for implementers: this method should be equivalent to a direct call to Task.flushPendingModifications(OperationResult).

Throws:

ActivityRunException

getWorkStateComplexTypeDefinition

@Nullable
public abstract @Nullable ComplexTypeDefinition getWorkStateComplexTypeDefinition()

getWorkStatePropertyRealValue

public <T> T getWorkStatePropertyRealValue(ItemPath path,
 Class<T> expectedType)

getWorkStateItemRealValueClone

public <T> T getWorkStateItemRealValueClone(ItemPath path,
 Class<T> expectedType)

getWorkStateReferenceRealValue

public ObjectReferenceType getWorkStateReferenceRealValue(ItemPath path)

getWorkStateReferenceRealValues

public Collection<ObjectReferenceType> getWorkStateReferenceRealValues(ItemPath path)

setWorkStateItemRealValues

public void setWorkStateItemRealValues(ItemPath path,
 Object... values)
                                throws SchemaException

Throws:

SchemaException

setWorkStateItemRealValues

public void setWorkStateItemRealValues(ItemPath path,
 ItemDefinition<?> explicitDefinition,
 Object... values)
                                throws SchemaException

Parameters:

explicitDefinition - If present, we do not try to derive the definition from work state CTD.

Throws:

SchemaException

getTask

@NotNull
protected abstract @NotNull Task getTask()

setSimulationResultOid

public void setSimulationResultOid(String oid)
                            throws ActivityRunException

Throws:

ActivityRunException

setSimulationResultCreated

public void setSimulationResultCreated()
                                throws ActivityRunException

Throws:

ActivityRunException

getSimulationResultRef

@Nullable
public @Nullable ObjectReferenceType getSimulationResultRef()

getSimulationResultOid

@Nullable
public @Nullable String getSimulationResultOid()

isSimulationResultCreated

public boolean isSimulationResultCreated()

getRawRunRecordsClone

@NotNull
public @NotNull Collection<ActivityRunRecordType> getRawRunRecordsClone()

isDelegating

@Experimental
public boolean isDelegating()

Beware! May not be quite precise if the state was not set up yet.

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

debugDumpExtra

protected abstract void debugDumpExtra(StringBuilder sb,
 int indent)

getEnhancedClassName

@NotNull
protected @NotNull String getEnhancedClassName()

getParentActivityState

@NotNull
public @NotNull ActivityState getParentActivityState(@Nullable
 @Nullable QName workStateTypeName,
 OperationResult result)
                                              throws SchemaException,
ObjectNotFoundException

Returns the state of the _parent activity_, e.g. operations completion sub-activity -> reconciliation activity.

Throws:

SchemaException

ObjectNotFoundException

getActivityStatesUpwardsForParent

@Experimental
public Iterable<ActivityState> getActivityStatesUpwardsForParent(OperationResult result)

Returns an iterator over activity states, from the parent of the current activity to the root. Note that the _work_ states must either exist, or must not be modified by the caller after obtaining (as we don't know their type - at least for now). The idea is to encapsulate the crawling logic, while avoiding the (eventual) task fetch operations if they are not really needed. BEWARE: The OperationResult instance is buried into the iterator, and used within Iterator.next() calls. This is quite dangerous. Maybe we should not do this at all. The best use of this method is when the result is consumed (iterated through) just after it is obtained. That way you avoid the risk of using OperationResult instance at an unexpected place.

getActivityStateUpwards

@NotNull
public static @NotNull ActivityState getActivityStateUpwards(@NotNull
 @NotNull ActivityPath activityPath,
 @NotNull
 @NotNull Task task,
 @Nullable
 @Nullable QName workStateTypeName,
 OperationResult result)
                                                      throws SchemaException,
ObjectNotFoundException

Returns activity state for given path, crawling from the current task upwards.

Parameters:

activityPath - Path to activity for which to obtain activity state.

task - Task where to start searching.

workStateTypeName - Expected type of the work state.

Throws:

SchemaException

ObjectNotFoundException

getCurrentActivityStateInParentTask

@NotNull
public @NotNull ActivityState getCurrentActivityStateInParentTask(boolean fresh,
 @NotNull
 @NotNull QName workStateTypeName,
 @Nullable
 @Nullable OperationResult result)
                                                           throws SchemaException,
ObjectNotFoundException

Returns the state of the current activity in the parent task. Assumes that it exists.

Parameters:

fresh - true if we always need to load the parent task from repository; false if we can use cached version (created when the running task started)

result - Can be null if we are 100% sure it will not be used.

Throws:

SchemaException

ObjectNotFoundException

getActivityStateDownwards

@NotNull
public static @NotNull ActivityState getActivityStateDownwards(@NotNull
 @NotNull ActivityPath activityPath,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull QName workStateTypeName,
 OperationResult result)
                                                        throws SchemaException,
ObjectNotFoundException

Gets the state of the given activity, starting from the `task` and going downwards. UNTESTED. Use with care. TODO cleanup and test thoroughly

Throws:

SchemaException

ObjectNotFoundException

getActivityPath

@NotNull
public abstract @NotNull ActivityPath getActivityPath()

incrementCounters

public Map<String,Integer> incrementCounters(@NotNull
 @NotNull ExecutionSupport.CountersGroup counterGroup,
 @NotNull
 @NotNull Collection<String> countersIdentifiers,
 @NotNull
 @NotNull OperationResult result)
                                      throws SchemaException,
ObjectNotFoundException,
ObjectAlreadyExistsException

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException

getCounters

@NotNull
public @NotNull Map<String,Integer> getCounters(@NotNull
 @NotNull ExecutionSupport.CountersGroup counterGroup)

getAbortingInformation

public ActivityAbortingInformationType getAbortingInformation()

getAbortingInformationRequired

public ActivityAbortingInformationType getAbortingInformationRequired()

updatePolicies

public Map<String,ActivityPolicyStateType> updatePolicies(@NotNull
 @NotNull Collection<ActivityPolicyStateType> policies,
 @NotNull
 @NotNull OperationResult result)
                                                   throws SchemaException,
ObjectNotFoundException,
ObjectAlreadyExistsException

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException

getExecutionAttempt

public int getExecutionAttempt()