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

Class ActivityPolicyRule

java.lang.Object

com.evolveum.midpoint.repo.common.activity.policy.ActivityPolicyRule

All Implemented Interfaces:

DebugDumpable

public class ActivityPolicyRule
extends Object
implements DebugDumpable

A policy rule that is being evaluated in a context of given activity. - These objects are created when an activity run (AbstractActivityRun) starts - in ActivityPolicyRulesCollector.collectRulesAndPreexistingValues(OperationResult) method. - They are evaluated periodically during the activity run - currently in ActivityPolicyRulesProcessor.evaluateAndExecuteRules(ItemProcessingResult, OperationResult) method. How it is related to EvaluatedActivityPolicyRuleImpl: This class represents the rule as defined in the policy, enriched with data such as current state and counters, and persisted in ActivityPolicyRulesContext throughout an activity run. On the other hand, EvaluatedActivityPolicyRuleImpl is a lightweight wrapper used only during a single evaluation cycle. TODO think of a better name, since this class is responsible for storing activity policy state (counters, data needs, etc.)

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
ActivityPolicyRule(@NotNull PolicyRuleConfigItem policy, @NotNull ActivityPath path, PolicyRuleIdentifier customPolicyRuleIdentifier, @NotNull Set<DataNeed> dataNeeds)

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
boolean	doesUseCounters()	Does this policy rule need counters to be evaluated?
ActivityPolicyStateType	getCurrentState()
Integer	getLocalCount()	Local count of the rule, i.e., the count that was computed for the current activity only.
String	getName()
Integer	getOrder()
@NotNull ConfigurationItemOrigin	getOrigin()
@NotNull ActivityPath	getPath()
@NotNull PolicyRuleType	getPolicyBean()
@NotNull PolicyRuleConfigItem	getPolicyRuleConfigItem()
@NotNull PolicyRuleIdentifier	getRuleIdentifier()
Integer	getTotalCount()	Current count that should be used for policy threshold evaluation.
void	setCount(Integer localValue, Integer totalValue)
void	setCurrentState(ActivityPolicyStateType currentState)
String	toString()

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

Constructor Details

ActivityPolicyRule

public ActivityPolicyRule(@NotNull
 @NotNull PolicyRuleConfigItem policy,
 @NotNull
 @NotNull ActivityPath path,
 PolicyRuleIdentifier customPolicyRuleIdentifier,
 @NotNull
 @NotNull Set<DataNeed> dataNeeds)

Method Details

getPolicyRuleConfigItem

@NotNull
public @NotNull PolicyRuleConfigItem getPolicyRuleConfigItem()

getPath

@NotNull
public @NotNull ActivityPath getPath()

getRuleIdentifier

@NotNull
public @NotNull PolicyRuleIdentifier getRuleIdentifier()

getName

public String getName()

getOrder

public Integer getOrder()

getLocalCount

public Integer getLocalCount()

Local count of the rule, i.e., the count that was computed for the current activity only. It is a part of getTotalCount().

See Also:

• getTotalCount()

getTotalCount

public Integer getTotalCount()

Current count that should be used for policy threshold evaluation. This is the result of policy constraint evaluation. For activity trees, this value is the total count for the activity tree, i.e., it contains the relevant data from all activities that were already finished.

getCurrentState

public ActivityPolicyStateType getCurrentState()

setCount

public void setCount(Integer localValue,
 Integer totalValue)

setCurrentState

public void setCurrentState(ActivityPolicyStateType currentState)

getPolicyBean

@NotNull
public @NotNull PolicyRuleType getPolicyBean()

getOrigin

@NotNull
public @NotNull ConfigurationItemOrigin getOrigin()

doesUseCounters

public boolean doesUseCounters()

Does this policy rule need counters to be evaluated? Currently not used, we take all counters from the whole tree.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object