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
...
Following is an update to the Policy Contribution.
1 Policy
1.1 Overview
Qualified Name: Common::Policy::Diagrams
Description:
Presently the scope of policy is imperitive (event, condition, action) only - not declaritive or intent.
Approach will be pragmatic in nature, establishing a model that meets the Policy team's near term needs, and then evolve from that base.
1.2 Diagrams
1.2
...
.1 Overview
Qualified Name: Common::Policy::Diagrams
Description:
1.2.1.1 Diagrams
Figure 2?7‑1: Diagram Basic Policy
Figure 2?7‑2: Diagram PolicyEventPolicy Event
Figure 2?7‑3: Diagram Policy Action
Figure 2?47‑4: Diagram Policy
Figure 7‑5: Diagram PolicyTypes
2.4 PolicyObjectClasses
...
Figure 7‑6: Diagram Policy Datatypes & Enumerations
1.3 PolicyObjectClasses
1.3.1 Overview
Qualified Name: Common::Policy::PolicyObjectClasses
...
1.
...
3.1.1 Classes
...
1.
...
3.1.1.1
...
Policy class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyActionPolicy
Description:
This class 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
...
.
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑1 Attributes for Class Policy
| Attribute Name | Type | Mult. | Description | Stereotypes | |||||
name | String | 1 |
| OpenModelAttribute 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).
| id | String | 1 |
| OpenModelAttribute
|
description | String | 0..1 | Defines a textual free-form description of the object.
| OpenModelAttribute
| |||||
keyValuePairid | Identifier | String | 0..* |
| OpenModelAttribute isInvariant:1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
| ||
actionExecutionStrategyinvarientId | PolicyExecutionStrategyIdentifier | 1 | An ID for the entity that does not change regardless of version.
| OpenModelAttribute
|
...
1.
...
3.1.1.2
...
PolicyAction class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyActionAtomicPolicyAction
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
...
an abstract base class that represents how to form the action clause of a PolicyRule.
Certain actions will take place if the condition clause is TRUE, others if the condition clause is FALSE.
This class is abstract.
Parent class: Policy
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑2 Attributes for Class PolicyAction
| Attribute Name | Type | Mult. | Description | Stereotypes | |
keyValuePair | String | 1 | Additional metadata pertinant to the action.
| OpenModelAttribute
| |
actionExecutionStrategy | PolicyExecutionStrategy | 1 | Defines the strategy to be used when executing the aggregated actions
| 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
| |
hasExecuteddescription | HasExecutedString | 0..1 | This is an enumerated integer that is set by a policy application to define the state of execution of this policyActionDefines a textual free-form description of the object.
Permited Values: | OpenModelAttribute
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: | |
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
| |
hasSubActionsinvarientId | BooleanIdentifier | 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 isInvariant:An ID for the entity that does not change regardless of version.
| OpenModelAttribute
Actor |
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
Target
...
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
name
...
String
...
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
id
...
String
...
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
description
...
String
...
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
keyValuePair
...
String
...
0..*
...
OpenModelAttribute
...
.3.1.1.3 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 7‑3 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
|
actionExecutionStrategysubject | PolicyExecutionStrategyString | 1 | Tthe entity that is executing the policy.
| OpenModelAttribute
|
target |
...
String |
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 | 1 | he set of entities that are affect-ed by the policy.
| OpenModelAttribute
|
hasExecutedd | HasExecuted | 1 | This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction.
| OpenModelAttribute
| |
keyValuePair | String | 1 | Additional metadata pertinant to the action.
| OpenModelAttribute
| |
hasSubPolicyActionsactionExecutionStrategy | BooleanPolicyExecutionStrategy | 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 Defines the strategy to be used when executing the aggregated actions
| OpenModelAttribute
|
actionsCNF | Boolean | 1 |
| OpenModelAttribute
| WorkflowExecutionStrategy | 1 |
| OpenModelAttribute
| name | String | 1 |
|
1.3.1.1.4 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 7‑4 Attributes for Class PolicyActionComposite
...
id
...
String
...
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
description
...
String
...
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
keyValuePair
...
String
...
0..*
| Attribute Name | Type | Mult. | Description | Stereotypes |
actionSequence | 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.
| OpenModelAttribute
|
actionExecutionStrategyhasSubPolicyActions | PolicyExecutionStrategyBoolean | 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 |
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
...
1 | Specifies if the action is in confunctive normal form.
| OpenModelAttribute
|
...
Future
|
| Attribute Name | Type | Mult. | Description | Stereotypes | ||||
name | String | 1 |
| OpenModelAttribute isInvariant:
| ||||
workflowExecutionStrategy | PolicyExecutionStrategy | 1 | Execution Strategy that applies to the entire workflow.
| OpenModelAttribute
| ||||
idkeyValuePair | IdentifierString | 1 | Additional metadata pertinant to the action.
| OpenModelAttribute
| ||||
descriptionactionExecutionStrategy | StringPolicyExecutionStrategy | 1 |
| OpenModelAttribute Defines the strategy to be used when executing the aggregated actions
| eventOrigin | 1 |
| OpenModelAttribute
eventDomain |
1.3.1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
2.4.1.1.5 PolicyEventAtomic class
...
.1.5 PolicyCondition class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventAtomicPolicyCondition
Parent classDescription: PolicyEvent
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 2?5 Attributes for Class PolicyEventAtomic
...
Attribute Name
...
Type
...
Mult.
...
Description
...
Stereotypes
...
name
...
String
...
1
...
OpenModelAttribute
...
This is an abstract base class that represents how to form the condition clause of a PolicyRule. This class can be used to represent rule-specific or reusable policy conditions.
Policy conditions are of the form:
{variable, operator, value}
where the operator is usually the MATCH operator, but could be another type (e.g., compare) of operator. This gives the semantics of "IF the condition is TRUE (or FALSE)".
The subclasses of PolicyCondition, along with its recursive aggregation, enable simple and compound (e.g., nested) PolicyConditions to be supported by the same structure.
Parent class: Policy
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
...
id
...
Identifier
...
1
...
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
description
...
String
...
1
...
Table 7‑5 Attributes for Class PolicyCondition
| Attribute Name | Type | Mult. | Description | Stereotypes | ||
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
| ||
eventOrigindescription | 1 |
| String | 0..1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
eventDomainid | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
2.4.1.1.6 PolicyEventComposite class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventComposite
...
invarientId | Identifier | 1 | An ID for the entity that does not change regardless of version.
| OpenModelAttribute
|
1.3.1.1.6 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.
Parent class: Policy
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?7‑6 Attributes for Class PolicyEventCompositePolicyEvent
| Attribute Name | Type | Mult. | Description | Stereotypes | |||
policyeventeventOrigin | PolicyEventString | 0..1 | eventOrigin provides information on the entity that generates the event (DCAE, Vnf, monitors).
| OpenModelAttribute
| |||
nameeventDomain | String | 1 | The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center).
| OpenModelAttribute
| |||
idPayload | IdentifierString | 1 | The payload for the event.
| OpenModelAttribute
| |||
descriptioneventType | String | 1 |
| OpenModelAttribute
| eventOrigin | 1 Classification that captures the symantics of that particular event categorization (enodeb, vnf)
| OpenModelAttribute
Future eventDomain
|
1name |
| 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 |
...
0. |
...
.1 |
...
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
...
Defines a textual free-form description of the object.
| OpenModelAttribute
|
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 isInvariant:
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
invarientId | Identifier | 1 | An ID for the entity that does not change regardless of version.
| 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:
1.3.1.1.7 PolicyEventAtomic class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventAtomic
Parent class: PolicyEvent
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑7 Attributes for Class PolicyEventAtomic
| Attribute Name | Type | Mult. | Description | Stereotypes |
eventOrigin | String | 1 | eventOrigin provides information on the entity that generates the event (DCAE, Vnf, monitors).
| OpenModelAttribute
|
eventDomain | String | 1 | The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center).
| OpenModelAttribute
|
policyNamePayload | 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
|
eventType | String | 1 | Classification that captures the symantics of that particular event categorization (enodeb, vnf)
| OpenModelAttribute
Future
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
...
1.3.1.1.8 PolicyEventComposite class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventComposite
Parent class: PolicyEvent
Applied Stereotypes:
- Experimental
- Future
- OpenModelClass
- support: MANDATORY
Table 7‑8 Attributes for Class PolicyEventComposite
| Attribute Name | Type | Mult. | Description | Stereotypes |
_policyevent | PolicyEvent | 0..* | Composite event has events
| OpenModelAttribute
|
descriptioneventOrigin | String | 1 | This is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
|
ideventDomain | IdentifierString | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object.The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center).
| OpenModelAttribute
|
Payload |
...
String |
...
1 | The payload for the event.
| OpenModelAttribute
| ||
eventType | String | 1 | Classification that captures the symantics of that particular event categorization (enodeb, vnf)
| OpenModelAttribute
Future
|
1.3.1.1.9 PolicyGroup class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRulePolicyGroup
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 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.
Parent class: Policy
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?87‑9 Attributes for Class PolicyRulePolicyGroup
| Attribute Name | Type | Mult. | Description | Stereotypes | |||||
isCNFisMandatoryEvaluation | 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 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 condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs).
| OpenModelAttribute
| |||||
hasSubRulesusage | BooleanString | 1 | This is a Boolean free-form string 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 containrecommends how this policy object should be used.
| OpenModelAttribute
| |||||
isMandatoryEvaluationkeywords | BooleanString | 1 | This is a Boolean string 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
|
keywordspolicyName | String | 1 | This is a string generic naming 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
| |||||
policyNamename | 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
| |||||
namedescription | 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)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
| |||||
descriptionname | String | 1 | This is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
| |||||
iddescription | IdentifierString | 0..1 | Defines a textual free-form description of the object.
| 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
...
| Attribute Name | Type | Mult. | Description | Stereotypes |
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
Table 2?9 Attributes for Class PolicyRule Template A (Drools)
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 isInvariant:invarientId | Identifier | 1 | An ID for the entity that does not change regardless of version.
| OpenModelAttribute
|
1.3.1.1.10 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).
Parent class: Policy
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 7‑10 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
Future
| |||||
sequencedActionsisMandatoryEvaluation | IntegerBoolean | 1 | This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreteda 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
Future
| |||||
policyActionSelectCriteriausage | String | 1 | This is an a free-form string 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
Future
| |||||
policyConditionSelectCriteriakeywords | String | 1 | 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 | 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
Future decisionStrategy
|
Version | DecisionStrategyString | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySetVersion of the policy as defined by the developer.
Permitted Values: | OpenModelAttribute
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 | |||||
hasSubRuless | Boolean | 1 | his 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
Future
| |||||
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 | 0..1 | his is a string, and defines a Defines a textual free-form description of the object.
Notes | OpenModelAttribute
| |||||
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
| |||||
idinvarientId | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the objectAn ID for the entity that does not change regardless of version.
| OpenModelAttribute
|
...
1.
...
3.1.1.
...
11 PolicyRuleTemplate (PolicyRuleSpec) class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplate (PolicyRuleSpec)
...
This is a concrete base class that is used to define the invariant characteristics (attributes, methods, constraints and relationships) of a PolicyRule entity.
Parent class: Descriptor (EntitySpecification)
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Table 2?107‑11 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
Future
|
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
Future
|
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
Future
|
decisionStrategy | DecisionStrategy | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.
| OpenModelAttribute
Future name
|
EventTypes | 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)..* | List of Event Types to be considered by this event.
| OpenModelAttribute
Future
|
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
|
descriptionstatus | String | 1 | his is a string, and defines a textual free-form description of the object.
| OpenModelAttribute
|
iddescriptorVersion | IdentifierString | 1 | Unambiguously distinguishes different object instances. It is the naming attribute Identifies the version of the objectdescriptor.
| OpenModelAttribute
|
name |
...
String |
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. Notes: Not present in the ITU or CIM specs 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 | 0..1 | 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. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
| |
invarientId | Identifier | 1 | An ID for the entity that does not change regardless of version.
| OpenModelAttribute
|
1.3.1.1.12 PolicyRuleTemplateA (Drools) class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplateA (Drools)
Parent class: PolicyRuleTemplate (PolicyRuleSpec)
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 7‑12 Attributes for Class PolicyRuleTemplateA (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
| ||
policyConditionSelectCriteriapolicyActionSelectCriteria | String | 1 | This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents 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 PolicyEvents PolicyConditions can be used to trigger the evaluation of build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality.
| OpenModelAttribute
Future policyEventSelectCriteria
| ||
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
Future decisionStrategy
| ||
policyEventSelectCriteria | DecisionStrategyString | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySetattribute 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.
0: Unknown | OpenModelAttribute
Future
| ||
decisionStrategy | DecisionStrategy | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.
| OpenModelAttribute
| order in which the PolicyRules execute.
| OpenModelAttribute
Future
|
EventTypes | String | 1..* | List of Event Types to be considered by this event.
| OpenModelAttribute
Future
| ||
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
| ||
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
| ||
descriptorVersion | String | 1 | Identifies the version of the descriptor.
| OpenModelAttribute
|
1.3.1.1.13 PolicyRuleTemplateB (XACML) class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplateB (XACML)
Parent class: PolicyRuleTemplate (PolicyRuleSpec)
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 7‑13 Attributes for Class PolicyRuleTemplateB (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
Future
|
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
Future
|
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
Future
|
decisionStrategy | DecisionStrategy | 1 | This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.
| OpenModelAttribute
Future
|
EventTypes | String | 1..* | List of Event Types to be considered by this event.
| OpenModelAttribute
Future
|
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
|
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
|
descriptorVersion | String | 1 | Identifies the version of the descriptor.
| OpenModelAttribute
|
1.3.1.1.14 PolicyStatement class
Qualified Name: Common::Policy::PolicyObjectClasses::PolicyStatement
Parent class: Policy
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 7‑14 Attributes for Class PolicyStatement
| Attribute Name | Type | Mult. | Description | Stereotypes |
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 | 0..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. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
invarientId | Identifier | 1 | An ID for the entity that does not change regardless of version.
| OpenModelAttribute
|
...
1.
...
4 PolicyTypeDefinitions
...
1.
...
4.1 Overview
Qualified Name: Common::Policy::PolicyTypeDefinitions
...
1.
...
4.1.1 Datatypes
...
1.
...
4.1.2 Enumerations
...
1.
...
4.1.2.1 DecisionStrategy enumeration
Qualified Name: Common::Policy::PolicyTypeDefinitions::DecisionStrategy
...
Contains Enumeration Literals:
- 0
- 1
- 2
...
1.
...
4.1.2.2 HasExecuted enumeration
Qualified Name: Common::Policy::PolicyTypeDefinitions::HasExecuted
...
Contains Enumeration Literals:
- 0
- 1
- 2
- 3
...
1.
...
4.1.2.3 PolicyExecutionStrategy enumeration
Qualified Name: Common::Policy::PolicyTypeDefinitions::PolicyExecutionStrategy
...