Package com.evolveum.midpoint.model.impl.lens

Class DirectlyEvaluatedClockworkPolicyRuleImpl

java.lang.Object

com.evolveum.midpoint.repo.common.policy.BaseEvaluatedPolicyRuleImpl

com.evolveum.midpoint.model.impl.lens.DirectlyEvaluatedClockworkPolicyRuleImpl

All Implemented Interfaces:

DirectlyEvaluatedClockworkPolicyRule, EvaluatedClockworkPolicyRule, EvaluatedPolicyRule, DebugDumpable, Serializable, Cloneable

public class DirectlyEvaluatedClockworkPolicyRuleImpl
extends BaseEvaluatedPolicyRuleImpl
implements DirectlyEvaluatedClockworkPolicyRule

A (single) implementation of DirectlyEvaluatedClockworkPolicyRule.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.model.api.context.DirectlyEvaluatedClockworkPolicyRule

DirectlyEvaluatedClockworkPolicyRule.TargetType

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI, @NotNull String ruleId, @Nullable AssignmentPath ruleAssignmentPath, @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType)
DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI, @NotNull String ruleId, @Nullable AssignmentPath ruleAssignmentPath, @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType, ActivityPolicyRule activityPolicyRule)
DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI, @NotNull String ruleId, @Nullable AssignmentPath ruleAssignmentPath, @Nullable EvaluatedAssignmentImpl<?> originatingAssignment, @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType)
DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI, @NotNull String ruleId, @Nullable AssignmentPath ruleAssignmentPath, @Nullable EvaluatedAssignmentImpl<?> originatingAssignment, @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType, ActivityPolicyRule activityPolicyRule)

Method Summary

Modifier and Type	Method	Description
DirectlyEvaluatedClockworkPolicyRuleImpl	clone()
void	computeEnabledActions(@Nullable PolicyRuleEvaluationContext<?> rctx, PrismObject<?> object, Task task, OperationResult result)	Call only after "triggered" status was determined.
String	debugDump(int indent)
boolean	equals(Object o)
ActivityPath	getActivityPath()
Integer	getCount()
@NotNull List<? extends PolicyActionConfigItem<?>>	getEnabledActions()	Returns all enabled actions.
@Nullable EvaluatedAssignmentImpl<?>	getOriginatingAssignment()	The assignment that brought this policy rule to the focus or to the assignment target object.
@NotNull Collection<EvaluatedExclusionTrigger>	getRelevantExclusionTriggers()	Returns all exclusion triggers that are relevant for the assignment owning this direct/foreign rule.
@Nullable AssignmentPath	getRuleAssignmentPath()	Information about exact place where the rule was found.
@NotNull AssignmentPath	getRuleAssignmentPathRequired()
DirectlyEvaluatedClockworkPolicyRule.TargetType	getTargetType()	To which object is the policy rule targeted and how.
int	hashCode()
boolean	isEvaluated()	Was the rule already evaluated?
boolean	isGlobal()	Is this a global policy rule?
void	registerAsForeignRuleIfNeeded()
void	setCount(Integer localValue, Integer totalValue)
void	setEvaluated()
@NotNull Collection<EvaluatedPolicyRuleType>	toEvaluatedPolicyRuleBeans(@NotNull PolicyRuleExternalizationOptions options, @Nullable Predicate<EvaluatedPolicyRuleTrigger<?>> triggerSelector)	Serializes the policy rule into bean form (EvaluatedPolicyRuleType)
String	toShortString()	Returns short, (more or less) user-level characterization of this object.
String	toString()

Methods inherited from class com.evolveum.midpoint.repo.common.policy.BaseEvaluatedPolicyRuleImpl

extractMessages, extractShortMessages, getAllTriggers, getAllTriggers, getPolicyRuleConfigItem, getPolicySituation, getRuleIdentifier, getTriggers, isTriggered, setTriggers, trigger

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.model.api.context.DirectlyEvaluatedClockworkPolicyRule

getAssignmentPath, isApplicableToAssignment, isApplicableToFocusObject, isApplicableToProjection

Methods inherited from interface com.evolveum.midpoint.model.api.context.EvaluatedClockworkPolicyRule

getAssignmentOverride, getAssignmentOverrideShortDump, getEvaluatedAssignment, getRelevantTriggersFilter, isTriggered

Methods inherited from interface com.evolveum.midpoint.repo.common.policy.EvaluatedPolicyRule

containsEnabledAction, containsEnabledAction, extractMessages, extractShortMessages, getActions, getAllEventMarksOids, getAllTriggers, getAllTriggers, getEnabledAction, getEnabledActions, getName, getOrder, getPolicyConstraints, getPolicyMarkRef, getPolicyRuleBean, getPolicyRuleConfigItem, getPolicySituation, getPolicyThreshold, getRawActions, getRuleIdentifier, getRuleOrigin, getTriggers, hasSituationConstraint, hasThreshold, isContainedIn, isOverThreshold, trigger, trigger

Constructor Details

DirectlyEvaluatedClockworkPolicyRuleImpl

public DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull
 @NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI,
 @NotNull
 @NotNull String ruleId,
 @Nullable
 @Nullable AssignmentPath ruleAssignmentPath,
 @NotNull
 @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType)

DirectlyEvaluatedClockworkPolicyRuleImpl

public DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull
 @NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI,
 @NotNull
 @NotNull String ruleId,
 @Nullable
 @Nullable AssignmentPath ruleAssignmentPath,
 @NotNull
 @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType,
 ActivityPolicyRule activityPolicyRule)

DirectlyEvaluatedClockworkPolicyRuleImpl

public DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull
 @NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI,
 @NotNull
 @NotNull String ruleId,
 @Nullable
 @Nullable AssignmentPath ruleAssignmentPath,
 @Nullable
 @Nullable EvaluatedAssignmentImpl<?> originatingAssignment,
 @NotNull
 @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType)

DirectlyEvaluatedClockworkPolicyRuleImpl

public DirectlyEvaluatedClockworkPolicyRuleImpl(@NotNull
 @NotNull AbstractPolicyRuleConfigItem<?> policyRuleCI,
 @NotNull
 @NotNull String ruleId,
 @Nullable
 @Nullable AssignmentPath ruleAssignmentPath,
 @Nullable
 @Nullable EvaluatedAssignmentImpl<?> originatingAssignment,
 @NotNull
 @NotNull DirectlyEvaluatedClockworkPolicyRule.TargetType targetType,
 ActivityPolicyRule activityPolicyRule)

Method Details

clone

public DirectlyEvaluatedClockworkPolicyRuleImpl clone()

Overrides:

clone in class Object

getActivityPath

public ActivityPath getActivityPath()

Specified by:

getActivityPath in interface EvaluatedPolicyRule

setCount

public void setCount(Integer localValue,
 Integer totalValue)

Specified by:

setCount in interface EvaluatedPolicyRule

Overrides:

setCount in class BaseEvaluatedPolicyRuleImpl

isGlobal

public boolean isGlobal()

Description copied from interface: EvaluatedClockworkPolicyRule

Is this a global policy rule?

Specified by:

isGlobal in interface EvaluatedClockworkPolicyRule

getRuleAssignmentPath

@Nullable
public @Nullable AssignmentPath getRuleAssignmentPath()

Description copied from interface: DirectlyEvaluatedClockworkPolicyRule

Information about exact place where the rule was found. This can be important for rules that are indirectly attached to an assignment. An example: Let `Engineer` induce `Employee` which conflicts with `Contractor`. The SoD rule is attached to `Employee`. But let the user have assignments for `Engineer` and `Contractor` only. When evaluating `Engineer` assignment, we find a (indirectly attached) SoD rule. But we need to know it came from `Employee`. This is what `assignmentPath` (`Engineer`->`Employee`->(maybe some metarole)->rule) is for. For global policy rules, `assignmentPath` is the path to the target object that matched global policy rule. See also DirectlyEvaluatedClockworkPolicyRule.getTargetType(). It can null for artificially-created policy rules e.g. in task validity cases. TODO To be reviewed.

Specified by:

getRuleAssignmentPath in interface DirectlyEvaluatedClockworkPolicyRule

getRuleAssignmentPathRequired

@NotNull
public @NotNull AssignmentPath getRuleAssignmentPathRequired()

getOriginatingAssignment

@Nullable
public @Nullable EvaluatedAssignmentImpl<?> getOriginatingAssignment()

Description copied from interface: EvaluatedClockworkPolicyRule

The assignment that brought this policy rule to the focus or to the assignment target object. May be missing e.g. for object-related global policy rules or object collection related policy rules. (Note that assignment-related global policy rules have a value here.)

Specified by:

getOriginatingAssignment in interface EvaluatedClockworkPolicyRule

getRelevantExclusionTriggers

@NotNull
public @NotNull Collection<EvaluatedExclusionTrigger> getRelevantExclusionTriggers()

Description copied from interface: EvaluatedClockworkPolicyRule

Returns all exclusion triggers that are relevant for the assignment owning this direct/foreign rule.

Specified by:

getRelevantExclusionTriggers in interface EvaluatedClockworkPolicyRule

See Also:

• DirectlyEvaluatedClockworkPolicyRule
• ForeignEvaluatedClockworkPolicyRule

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class BaseEvaluatedPolicyRuleImpl

toString

public String toString()

Overrides:

toString in class Object

toShortString

public String toShortString()

Description copied from interface: EvaluatedClockworkPolicyRule

Returns short, (more or less) user-level characterization of this object.

Specified by:

toShortString in interface EvaluatedClockworkPolicyRule

toEvaluatedPolicyRuleBeans

@NotNull
public @NotNull Collection<EvaluatedPolicyRuleType> toEvaluatedPolicyRuleBeans(@NotNull
 @NotNull PolicyRuleExternalizationOptions options,
 @Nullable
 @Nullable Predicate<EvaluatedPolicyRuleTrigger<?>> triggerSelector)

Description copied from interface: EvaluatedPolicyRule

Serializes the policy rule into bean form (EvaluatedPolicyRuleType). - Serializes only triggered rules. - For sitation rules with are both hidden and final, serializes the inner rules. (TODO why should that be?) TODO consider if we cannot merge trigger selector with the options

Specified by:

toEvaluatedPolicyRuleBeans in interface EvaluatedPolicyRule

Parameters:

options - Options - how the serialization should take place.

triggerSelector - Which triggers should be processed?

getEnabledActions

@NotNull
public @NotNull List<? extends PolicyActionConfigItem<?>> getEnabledActions()

Description copied from interface: EvaluatedPolicyRule

Returns all enabled actions. Fails if they were not computed yet. TODO clockwork vs other policy rules

Specified by:

getEnabledActions in interface EvaluatedPolicyRule

Overrides:

getEnabledActions in class BaseEvaluatedPolicyRuleImpl

computeEnabledActions

public void computeEnabledActions(@Nullable
 @Nullable PolicyRuleEvaluationContext<?> rctx,
 PrismObject<?> object,
 Task task,
 OperationResult result)
                           throws ExpressionEvaluationException,
ObjectNotFoundException,
SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Call only after "triggered" status was determined.

Throws:

ExpressionEvaluationException

ObjectNotFoundException

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

getCount

public Integer getCount()

Specified by:

getCount in interface EvaluatedPolicyRule

Overrides:

getCount in class BaseEvaluatedPolicyRuleImpl

getTargetType

@NotNull
public DirectlyEvaluatedClockworkPolicyRule.TargetType getTargetType()

Description copied from interface: DirectlyEvaluatedClockworkPolicyRule

To which object is the policy rule targeted and how. See DirectlyEvaluatedClockworkPolicyRule.TargetType for detailed explanation.

Specified by:

getTargetType in interface DirectlyEvaluatedClockworkPolicyRule

registerAsForeignRuleIfNeeded

public void registerAsForeignRuleIfNeeded()

setEvaluated

public void setEvaluated()

isEvaluated

public boolean isEvaluated()

Description copied from interface: EvaluatedClockworkPolicyRule

Was the rule already evaluated?

Specified by:

isEvaluated in interface EvaluatedClockworkPolicyRule

equals

public boolean equals(Object o)

Overrides:

equals in class BaseEvaluatedPolicyRuleImpl

hashCode

public int hashCode()

Overrides:

hashCode in class BaseEvaluatedPolicyRuleImpl