Package com.evolveum.midpoint.model.api.simulation

Interface ProcessedObject<O extends ObjectType>

All Superinterfaces:

DebugDumpable, Serializable

All Known Implementing Classes:

ProcessedObjectImpl

public interface ProcessedObject<O extends ObjectType>
extends DebugDumpable, Serializable

Parsed analogy of SimulationResultProcessedObjectType. Used during creation of SimulationResultType objects, reporting on them, and during testing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ProcessedObject.Metric	Metric information, currently for reporting purposes.
static interface	ProcessedObject.ProcessedObjectItemDelta<V extends PrismValue,D extends ItemDefinition<?>>	ItemDelta augmented with functionality needed to display it in a complex way, for example, with the information on real change(s) to the object.
static class	ProcessedObject.ValueWithState	Value touched by a delta, along with their processing ProcessedObject.ValueWithState.State.

Field Summary

Fields

Modifier and Type	Field	Description
static Map<ChangeType,ObjectProcessingStateType>	DELTA_TO_PROCESSING_STATE

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	applyDefinitions(@NotNull Task task, @NotNull OperationResult result)	Applies the definitions (currently, resource schema related to specific shadow) to the object(s) before/after, and the delta.
void	fixEstimatedOldValuesInDelta()	Resolves "estimated old values" for item deltas where they are not known.
O	getAfter()	Returns the (expected) state of the object after the operation.
default O	getAfterOrBefore()
O	getBefore()	Returns the state of the object before the operation.
default O	getBeforeOrAfterRequired()
@Nullable ObjectDelta<O>	getDelta()	Returns the operation that is to be executed.
@NotNull Collection<ObjectReferenceType>	getEffectiveObjectMarksRefs()	Returns references of object marks.
@NotNull Collection<ProcessedObject.ProcessedObjectItemDelta<?,?>>	getItemDeltas(@Nullable Object pathsToInclude, @Nullable Object pathsToExclude, @Nullable Boolean includeOperationalItems)	Returns the collection of (augmented) item deltas related to this "processed object".
@NotNull Collection<String>	getMatchingEventMarksOids()	Returns OIDs of matching event marks for this object.
@NotNull Collection<ProcessedObject.Metric>	getMetrics(@Nullable Boolean showEventMarks, @Nullable Boolean showExplicitMetrics)	Returns the collection of ProcessedObject.Metric values for this object.
@Nullable PolyStringType	getName()	Name of the object being processed.
String	getOid()	OID of the object whole processing is described by this record.
@Nullable String	getResourceOid()	For processed objects that are shadows: returns the related resource OID.
@Nullable OperationResult	getResult()	The result of the operation connected to this object.
@Nullable OperationResultStatus	getResultStatus()	The status of the operation connected to this object.
@NotNull ObjectProcessingStateType	getState()	State of the object.
@NotNull Class<O>	getType()	Type of the object being processed.
boolean	hasEventMark(@NotNull String eventMarkOid)
boolean	hasNoEventMarks()
default boolean	isAddition()
default boolean	isDeletion()
boolean	isFocus()
default boolean	isModification()
default boolean	isNoChange()
default boolean	isOfFocusType()
default boolean	isShadow()
void	resolveEventMarks(OperationResult result)	For diagnostic purposes.
@NotNull SimulationResultProcessedObjectType	toBean()	Creates a SimulationResultProcessedObjectType bean corresponding to this object.

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

Field Detail

DELTA_TO_PROCESSING_STATE

static final Map<ChangeType,ObjectProcessingStateType> DELTA_TO_PROCESSING_STATE

Method Detail

getOid

String getOid()

OID of the object whole processing is described by this record. Usually not null but we shouldn't rely on it.

See Also:

SimulationResultProcessedObjectType.getOid()

getType

@NotNull
@NotNull Class<O> getType()

Type of the object being processed.

See Also:

SimulationResultProcessedObjectType.getType()

getName

@Nullable
@Nullable PolyStringType getName()

Name of the object being processed. May not be known; typically for shadows to-be-created.

See Also:

SimulationResultProcessedObjectType.getName()

getState

@NotNull
@NotNull ObjectProcessingStateType getState()

State of the object.

See Also:

DELTA_TO_PROCESSING_STATE, SimulationResultProcessedObjectType.getState()

getResultStatus

@Nullable
@Nullable OperationResultStatus getResultStatus()

The status of the operation connected to this object. Only "primary" objects have this information.

See Also:

SimulationResultProcessedObjectType.getResultStatus()

getResult

@Nullable
@Nullable OperationResult getResult()

The result of the operation connected to this object. Only "primary" objects have this information.

See Also:

SimulationResultProcessedObjectType.getResult()

getMatchingEventMarksOids

@NotNull
@NotNull Collection<String> getMatchingEventMarksOids()

Returns OIDs of matching event marks for this object.

getEffectiveObjectMarksRefs

@NotNull
@NotNull Collection<ObjectReferenceType> getEffectiveObjectMarksRefs()

Returns references of object marks. Primarily on "object before" state (if exists). To be reconsidered.

getBefore

O getBefore()

Returns the state of the object before the operation.

See Also:

SimulationResultProcessedObjectType.getBefore()

getAfter

O getAfter()

Returns the (expected) state of the object after the operation.

See Also:

SimulationResultProcessedObjectType.getAfter()

getDelta

@Nullable
@Nullable ObjectDelta<O> getDelta()

Returns the operation that is to be executed.

See Also:

SimulationResultProcessedObjectType.getDelta()

fixEstimatedOldValuesInDelta

void fixEstimatedOldValuesInDelta()

Resolves "estimated old values" for item deltas where they are not known. TEMPORARY; see MID-8536. This will be part of standard processing but because of code freeze doing it as separate code.

getAfterOrBefore

default O getAfterOrBefore()

getBeforeOrAfterRequired

@NotNull
default O getBeforeOrAfterRequired()

toBean

@NotNull
@NotNull SimulationResultProcessedObjectType toBean()

Creates a SimulationResultProcessedObjectType bean corresponding to this object.

resolveEventMarks

@VisibleForTesting
void resolveEventMarks(OperationResult result)

For diagnostic purposes.

hasEventMark

@VisibleForTesting
boolean hasEventMark(@NotNull
                     @NotNull String eventMarkOid)

hasNoEventMarks

@VisibleForTesting
boolean hasNoEventMarks()

getResourceOid

@VisibleForTesting
@Nullable
@Nullable String getResourceOid()

For processed objects that are shadows: returns the related resource OID.

getItemDeltas

@NotNull
@NotNull Collection<ProcessedObject.ProcessedObjectItemDelta<?,?>> getItemDeltas(@Nullable
                                                                                       @Nullable Object pathsToInclude,
                                                                                       @Nullable
                                                                                       @Nullable Object pathsToExclude,
                                                                                       @Nullable
                                                                                       @Nullable Boolean includeOperationalItems)

Returns the collection of (augmented) item deltas related to this "processed object". Limited! We are not able to see inside deltas. So, for example, when looking for `activation/administrativeStatus` property, and the whole `activation` container is added, the delta is not shown. See the implementation and ItemDeltaFilter for details. Experimental.

Parameters:

pathsToInclude - paths of items that we want to see in the list of deltas

pathsToExclude - paths of items that we do not want to see in the list of deltas

includeOperationalItems - should the operational items be included in the list of deltas?

getMetrics

@NotNull
@NotNull Collection<ProcessedObject.Metric> getMetrics(@Nullable
                                                       @Nullable Boolean showEventMarks,
                                                       @Nullable
                                                       @Nullable Boolean showExplicitMetrics)

Returns the collection of ProcessedObject.Metric values for this object.

Parameters:

showEventMarks - Should we include mark-based metrics?

showExplicitMetrics - Should we include explicitly defined metrics?

applyDefinitions

void applyDefinitions(@NotNull
                      @NotNull Task task,
                      @NotNull
                      @NotNull OperationResult result)
               throws SchemaException,
                      ExpressionEvaluationException,
                      CommunicationException,
                      ConfigurationException,
                      ObjectNotFoundException

Applies the definitions (currently, resource schema related to specific shadow) to the object(s) before/after, and the delta.

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

ConfigurationException

ObjectNotFoundException

isAddition

default boolean isAddition()

isModification

default boolean isModification()

isDeletion

default boolean isDeletion()

isNoChange

default boolean isNoChange()

isFocus

boolean isFocus()

isOfFocusType

default boolean isOfFocusType()

isShadow

default boolean isShadow()