1 Introduction
This document contains the Word presentation of the model generated from the ONAP Eclipse Papyrus UML Information model using gendoc. This format is provided to assist the reader that does not use UML or has no access to UML tools.
2 Policy
2.1 Overview
Qualified Name: Common::Policy
2.2 Associations
2.2.1 Overview
Qualified Name: Common::Policy::Associations
2.2.1.1 Associations
2.3 Diagrams
2.3.1 Overview
Qualified Name: Common::Policy::Diagrams
Description:
2.3.1.1 Diagrams
Figure 2?1: Diagram Basic Policy
Figure 2?2: Diagram PolicyEvent
Figure 2?3: Diagram Policy Action
Figure 2?4: Diagram PolicyTypes
2.4 PolicyObjectClasses
2.4.1 Overview
Qualified Name: Common::Policy::PolicyObjectClasses
2.4.1.1 Classes
2.4.1.1.1 PolicyAction class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyAction
Description:
This is an abstract base class that represents how to form the action clause of a PolicyRule. This consists of a single occurrence of a PolicyStatement, which is of the form:
{variable, operator, value}
Policy actions have the semantics of "SET variable to value". There are two types of actions:
This class is abstract.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?1 Attributes for Class PolicyAction
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 1 |
| OpenModelAttribute
|
id | String | 1 |
| OpenModelAttribute
|
description | String | 1 |
| OpenModelAttribute
|
keyValuePair | String | 0..* |
| OpenModelAttribute
|
actionExecutionStrategy | PolicyExecutionStrategy | 1 |
| OpenModelAttribute
|
2.4.1.1.2 PolicyActionAtomic class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyActionAtomic
Description:
This is the base class for all simple PolicyActions. A simple PolicyAction consists of a single Boolean clause, which is used to perform a single action. This consists of a single occurrence of a PolicyStatement, which is of the form:
{SET | CLEAR} PolicyVariable to PolicyValue
This is distinctly different from the PolicyActionVendor, which does not use a PolicyStatement.
PolicyActionAtomic objects can also be used to form more complex action structures. A PolicyActionComposite object can be used to contain a group of PolicyActionAtomic objects - this grouping enables multiple PolicyActionAtomic objects to be executed as a group. Alternatively, a PolicyActionAtomic object can contain one or more PolicyActionAtomic objects (and also PolicyActionComposite groups if desired) to provide the semantics of a compound PolicyAction. In either case, the aggregation is done using the containedPolicyActions aggregation.
Parent class: PolicyAction
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?2 Attributes for Class PolicyActionAtomic
| Attribute Name | Type | Mult. | Description | Stereotypes |
actionSequenceNumber | Integer | 1 | This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. This will allow a policy engine to reference externally supplied arguments to this object as it is executed.
| OpenModelAttribute
|
hasExecuted | HasExecuted | 1 | This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction.
| OpenModelAttribute
|
hasSubActions | Boolean | 1 | This is a Boolean attribute that, if TRUE, signifies that this PolicyAction has one or more sub-actions. Sub-actions are used to enforce a hierarchical nesting of actions, so that parent actions may control the evaluation and other semantics of the sub-actions that they contain.
| OpenModelAttribute
|
Actor | 1 |
| OpenModelAttribute
| |
Target | 1 |
| OpenModelAttribute
| |
name | String | 1 |
| OpenModelAttribute
|
id | String | 1 |
| OpenModelAttribute
|
description | String | 1 |
| OpenModelAttribute
|
keyValuePair | String | 0..* |
| OpenModelAttribute
|
actionExecutionStrategy | PolicyExecutionStrategy | 1 |
| OpenModelAttribute
|
2.4.1.1.3 PolicyActionComposite class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyActionComposite
Description:
This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure.
For example if a composite is part of another composite policy structure.
Notes: default is "1"
Parent class: PolicyAction
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?3 Attributes for Class PolicyActionComposite
| Attribute Name | Type | Mult. | Description | Stereotypes |
actionSequence | Integer | 1 |
| OpenModelAttribute
|
hasSubPolicyActions | Boolean | 1 | This is a Boolean attribute that, if TRUE, signifies that this PolicyAction has one or more sub-actions. Sub-actions are used to enforce a hierarchical nesting of actions, so that parent actions may control the evaluation and other semantics of sub-actions that they contain.
| OpenModelAttribute
|
actionsCNF | Boolean | 1 |
| OpenModelAttribute
|
WorkflowExecutionStrategy | 1 |
| OpenModelAttribute
| |
name | String | 1 |
| OpenModelAttribute
|
id | String | 1 |
| OpenModelAttribute
|
description | String | 1 |
| OpenModelAttribute
|
keyValuePair | String | 0..* |
| OpenModelAttribute
|
actionExecutionStrategy | PolicyExecutionStrategy | 1 |
| OpenModelAttribute
|
2.4.1.1.4 PolicyEvent class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEvent
Description:
A PolicyEvent is an occurrence of an important event, and can be used to trigger the evaluation of a PolicyCondition or PolicyCondition clause in a PolicyRule.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?4 Attributes for Class PolicyEvent
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 1 |
| OpenModelAttribute
|
id | Identifier | 1 |
| OpenModelAttribute
|
description | String | 1 |
| OpenModelAttribute
|
eventOrigin | 1 |
| OpenModelAttribute
| |
eventDomain | 1 |
| OpenModelAttribute
|
2.4.1.1.5 PolicyEventAtomic class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventAtomic
Parent class: PolicyEvent
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 2?5 Attributes for Class PolicyEventAtomic
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 1 |
| OpenModelAttribute
|
id | Identifier | 1 |
| OpenModelAttribute
|
description | String | 1 |
| OpenModelAttribute
|
eventOrigin | 1 |
| OpenModelAttribute
| |
eventDomain | 1 |
| OpenModelAttribute
|
2.4.1.1.6 PolicyEventComposite class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventComposite
Parent class: PolicyEvent
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 2?6 Attributes for Class PolicyEventComposite
| Attribute Name | Type | Mult. | Description | Stereotypes |
policyevent | PolicyEvent | 0..1 |
| OpenModelAttribute
|
name | String | 1 |
| OpenModelAttribute
|
id | Identifier | 1 |
| OpenModelAttribute
|
description | String | 1 |
| OpenModelAttribute
|
eventOrigin | 1 |
| OpenModelAttribute
| |
eventDomain | 1 |
| OpenModelAttribute
|
2.4.1.1.7 PolicyGroup class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyGroup
Description:
This class is a generalized aggregation container. It enables PolicyRules and/or PolicyGroups to be aggregated in a single container. Note that loops, including the degenerate case of a PolicyGroup that contains itself, are not allowed when PolicyGroups contain other PolicyGroups.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?7 Attributes for Class PolicyGroup
| Attribute Name | Type | Mult. | Description | Stereotypes |
isMandatoryEvaluation | Boolean | 1 | This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored.
| OpenModelAttribute
|
usage | String | 1 | This is a free-form string attribute that recommends how this policy object should be used.
| OpenModelAttribute
|
keywords | String | 1 | This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined:
| OpenModelAttribute
|
policyName | String | 1 | This is a generic naming attribute that can be used to identify different policy entities. This enables commonName to be used to enforce enterprise or service provider generic naming and this attribute to be used to fine tune the naming of policy entities. Thus, commonName is public in scope and policyName is private to policy.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | This is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
2.4.1.1.8 PolicyRule class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRule
Description:
This is a concrete base class for realizing the "event-condition-passaction-failaction" semantics that form a policy rule. The semantics of this rule are that the rule is evaluated when an event occurs. If the condition clause is satisfied, then the pass-action clause will be executed (otherwise, the fail-action clause will be executed).
PolicyRules may be nested within PolicyRules. This is often needed in networking (e.g., bandwidth allocation).
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?8 Attributes for Class PolicyRule
| Attribute Name | Type | Mult. | Description | Stereotypes |
isCNF | Boolean | 1 | This is a Boolean attribute that, if TRUE, defines the condition clause of this rule to be represented in Conjunctive Normal Form (e.g., an AND of ORs). If the value of this attribute is FALSE, then the condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs).
| OpenModelAttribute
|
hasSubRules | Boolean | 1 | This is a Boolean attribute that, if TRUE, signifies that this PolicyRule has one or more sub-rules. Sub-rules are used to enforce a hierarchical nesting of rules, so that parent rules may control the execution and other semantics of sub-rules that they contain.
| OpenModelAttribute
|
isMandatoryEvaluation | Boolean | 1 | This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored.
| OpenModelAttribute
|
usage | String | 1 | This is a free-form string attribute that recommends how this policy object should be used.
| OpenModelAttribute
|
keywords | String | 1 | This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined:
| OpenModelAttribute
|
policyName | String | 1 | This is a generic naming attribute that can be used to identify different policy entities. This enables commonName to be used to enforce enterprise or service provider generic naming and this attribute to be used to fine tune the naming of policy entities. Thus, commonName is public in scope and policyName is private to policy.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | This is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 |
| OpenModelAttribute
|
2.4.1.1.9 PolicyRule Template A (Drools) class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRule Template A (Drools)
Parent class: PolicyRuleTemplate (PolicyRuleSpec)
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 2?9 Attributes for Class PolicyRule Template A (Drools)
| Attribute Name | Type | Mult. | Description | Stereotypes |
executionStrategy | PolicyExecutionStrategy | 1 | This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include:
| OpenModelAttribute
|
sequencedActions | Integer | 1 | This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted.
| OpenModelAttribute
|
policyActionSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
policyConditionSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
policyEventSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
decisionStrategy | DecisionStrategy | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | his is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
2.4.1.1.10 PolicyRuleTemplate (PolicyRuleSpec) class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplate (PolicyRuleSpec)
Description:
This is a concrete base class that is used to define the invariant characteristics (attributes, methods, constraints and relationships) of a PolicyRule entity.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?10 Attributes for Class PolicyRuleTemplate (PolicyRuleSpec)
| Attribute Name | Type | Mult. | Description | Stereotypes |
executionStrategy | PolicyExecutionStrategy | 1 | This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include:
| OpenModelAttribute
|
sequencedActions | Integer | 1 | This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted.
| OpenModelAttribute
|
policyActionSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
policyConditionSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
policyEventSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
decisionStrategy | DecisionStrategy | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | his is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
2.4.1.1.11 PolicyRuleTemplate B (XACML) class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplate B (XACML)
Parent class: PolicyRuleTemplate (PolicyRuleSpec)
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 2?11 Attributes for Class PolicyRuleTemplate B (XACML)
| Attribute Name | Type | Mult. | Description | Stereotypes |
executionStrategy | PolicyExecutionStrategy | 1 | This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include:
| OpenModelAttribute
|
sequencedActions | Integer | 1 | This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted.
| OpenModelAttribute
|
policyActionSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
policyConditionSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
policyEventSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
|
decisionStrategy | DecisionStrategy | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | his is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
2.5 PolicyTypeDefinitions
2.5.1 Overview
Qualified Name: Common::Policy::PolicyTypeDefinitions
2.5.1.1 Datatypes
2.5.1.2 Enumerations
2.5.1.2.1 DecisionStrategy enumeration
Qualified Name: Common::Policy::PolicyTypeDefinitions::DecisionStrategy
Description:
This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.
Permitted Values:
0: Unknown
1: MatchFirst
2: MatchAll
MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated.
MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute.
Contains Enumeration Literals:
- 0
- 1
- 2
2.5.1.2.2 HasExecuted enumeration
Qualified Name: Common::Policy::PolicyTypeDefinitions::HasExecuted
Description:
This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction.
Permited Values:
0: not yet executed
1: executed with no errors
2: executed with errors but successfully rolled back
3: executed with errors and did not roll back
4: did not complete execution but successfully rolled back
5: did not complete execution and did not roll back
Notes:
Not present in the ITU or CIM specs.
Contains Enumeration Literals:
- 0
- 1
- 2
- 3
2.5.1.2.3 PolicyExecutionStrategy enumeration
Qualified Name: Common::Policy::PolicyTypeDefinitions::PolicyExecutionStrategy
Description:
This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include:
0: Unknown
1: Do Until Success
2: Do All
3: Do Until Failure
4: Do All Without Failure or Do Nothing
"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed).
"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails.
"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped.
Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered.
Contains Enumeration Literals:
- 0
- 1
- 2
- 3
- 4