TS 29.198-13
Open Service Access (OSA) API –
Part 13: Policy Management Service Capability Feature (SCF)
V9.0.0 (PDF)
2009/12 126 p.
V8.0.0
2008/12 126 p.
V7.0.0
2007/03 126 p.
V6.4.1
2006/07 126 p.
V5.7.0
2005/06 102 p.
- Rapporteur:
- Mr. Unmehopa, Musa
full Table of Contents for TS 29.198-13 Word version: 9.0.0
0 Introduction p. 8
1 Scope p. 10
2 References p. 10
3 Definitions and abbreviations p. 11
3.1 Definitions p. 11
3.2 Abbreviations p. 11
4 Policy Management SCF p. 11
5 Sequence Diagrams p. 12
5.1 Use of Policy Repository p. 12
5.2 Introduce condition and action into rule p. 14
5.3 Create event p. 16
5.4 Create and modify domain p. 18
5.5 ASP offering services to prepaid subscribers p. 20
5.6 Create Signature for an evaluation context p. 22
5.7 Request Evaluation of Policies p. 24
5.8 Register for and Receive Notification of a Policy Event p. 25
6 Class Diagrams p. 25
7 The Service Interface Specifications p. 28
7.1 Interface Specification Format p. 28
7.1.1 Interface Class p. 28
7.1.2 Method descriptions p. 28
7.1.3 Parameter descriptions p. 28
7.1.4 State Model p. 29
7.2 Base Interface p. 29
7.3 Service Interfaces p. 29
7.3.1 Overview p. 29
7.4 Generic Service Interface p. 29
8 Policy Management (PM) Interface Classes p. 30
8.1 PM Provisioning SCF Interface Classes p. 30
8.1.1 Interface Class IpPolicyManager p. 30
8.1.1.1 Method createDomain() p. 31
8.1.1.2 Method getDomain() p. 32
8.1.1.3 Method removeDomain() p. 32
8.1.1.4 Method getDomainCount() p. 32
8.1.1.5 Method getDomainIterator() p. 33
8.1.1.6 Method findMatchingDomains() p. 33
8.1.1.7 Method createRepository() p. 33
8.1.1.8 Method getRepository() p. 34
8.1.1.9 Method removeRepository() p. 34
8.1.1.10 Method getRepositoryCount() p. 34
8.1.1.11 Method getRepositoryIterator() p. 35
8.1.1.12 Method startTransaction() p. 35
8.1.1.13 Method commitTransaction() p. 36
8.1.1.14 Method abortTransaction() p. 36
8.1.2 Interface Class IpPolicy p. 36
8.1.2.1 Attributes p. 37
8.1.2.2 Method getAttribute() p. 37
8.1.2.3 Method setAttribute() p. 38
8.1.2.4 Method getAttributes() p. 38
8.1.2.5 Method setAttributes() p. 38
8.1.3 Interface Class IpPolicyDomain p. 39
8.1.3.1 Attributes p. 41
8.1.3.2 Method getParentDomain() p. 42
8.1.3.3 Method createDomain() p. 42
8.1.3.4 Method getDomain() p. 42
8.1.3.5 Method removeDomain() p. 43
8.1.3.6 Method getDomainCount() p. 43
8.1.3.7 Method getDomainIterator() p. 43
8.1.3.8 Method createGroup() p. 44
8.1.3.9 Method getGroup() p. 44
8.1.3.10 Method removeGroup() p. 45
8.1.3.11 Method getGroupCount() p. 45
8.1.3.12 Method getGroupIterator() p. 45
8.1.3.13 Method createRule() p. 46
8.1.3.14 Method getRule() p. 46
8.1.3.15 Method removeRule() p. 46
8.1.3.16 Method getRuleCount() p. 47
8.1.3.17 Method getRuleIterator() p. 47
8.1.3.18 Method createEventDefinition() p. 47
8.1.3.19 Method getEventDefinition() p. 48
8.1.3.20 Method removeEventDefinition() p. 48
8.1.3.21 Method getEventDefinitionCount() p. 48
8.1.3.22 Method getEventDefinitionIterator() p. 49
8.1.3.23 Method createVariableSet() p. 49
8.1.3.24 Method getVariableSet() p. 49
8.1.3.25 Method removeVariableSet() p. 50
8.1.3.26 Method getVariableSetCount() p. 50
8.1.3.27 Method getVariableSetIterator() p. 50
8.1.3.28 Method createVariable() p. 51
8.1.3.29 Method setVariableValue() p. 51
8.1.3.30 Method getVariableType() p. 52
8.1.3.31 Method getVariableValue() p. 52
8.1.3.32 Method getVariable() p. 52
8.1.3.33 Method removeVariable() p. 53
8.1.3.34 Method createSignature() p. 53
8.1.3.35 Method getSignature() p. 53
8.1.3.36 Method removeSignature() p. 54
8.1.3.37 Method getSignatureCount() p. 54
8.1.3.38 Method getSignatureIterator() p. 54
8.1.4 Interface Class IpPolicyGroup p. 55
8.1.4.1 Attributes p. 56
8.1.4.2 Method getParentDomain() p. 57
8.1.4.3 Method getParentGroup() p. 57
8.1.4.4 Method createGroup() p. 57
8.1.4.5 Method getGroup() p. 58
8.1.4.6 Method removeGroup() p. 58
8.1.4.7 Method getGroupCount() p. 58
8.1.4.8 Method getGroupIterator() p. 59
8.1.4.9 Method createRule() p. 59
8.1.4.10 Method getRule() p. 59
8.1.4.11 Method removeRule() p. 60
8.1.4.12 Method getRuleCount() p. 60
8.1.4.13 Method getRuleIterator() p. 60
8.1.5 Interface Class IpPolicyRepository p. 61
8.1.5.1 Attributes p. 62
8.1.5.2 Method getParentRepository() p. 63
8.1.5.3 Method createRepository() p. 63
8.1.5.4 Method getRepository() p. 63
8.1.5.5 Method removeRepository() p. 64
8.1.5.6 Method getRepositoryCount() p. 64
8.1.5.7 Method getRepositoryIterator() p. 64
8.1.5.8 Method createCondition() p. 65
8.1.5.9 Method getCondition() p. 65
8.1.5.10 Method removeCondition() p. 66
8.1.5.11 Method getConditionCount() p. 66
8.1.5.12 Method getConditionIterator() p. 66
8.1.5.13 Method createAction() p. 67
8.1.5.14 Method getAction() p. 67
8.1.5.15 Method removeAction() p. 68
8.1.5.16 Method getActionCount() p. 68
8.1.5.17 Method getActionIterator() p. 68
8.1.6 Interface Class IpPolicyRule p. 69
8.1.6.1 Attributes p. 71
8.1.6.2 Method getParentGroup() p. 73
8.1.6.3 Method getParentDomain() p. 73
8.1.6.4 Method createCondition() p. 74
8.1.6.5 Method getCondition() p. 74
8.1.6.6 Method removeCondition() p. 74
8.1.6.7 Method getConditionCount() p. 75
8.1.6.8 Method getConditionIterator() p. 75
8.1.6.9 Method createAction() p. 75
8.1.6.10 Method getAction() p. 76
8.1.6.11 Method removeAction() p. 76
8.1.6.12 Method getActionCount() p. 77
8.1.6.13 Method getActionIterator() p. 77
8.1.6.14 Method setValidityPeriodConditionByName() p. 77
8.1.6.15 Method setValidityPeriodCondition() p. 78
8.1.6.16 Method getValidityPeriodCondition() p. 78
8.1.6.17 Method unsetValidityPeriodCondition() p. 78
8.1.6.18 Method setConditionList() p. 79
8.1.6.19 Method getConditionList() p. 79
8.1.6.20 Method setActionList() p. 79
8.1.6.21 Method getActionList() p. 80
8.1.7 Interface Class IpPolicyCondition p. 80
8.1.7.1 Attributes p. 81
8.1.7.2 Method getParentRepository() p. 82
8.1.7.3 Method getParentRule() p. 82
8.1.8 Interface Class IpPolicyTimePeriodCondition p. 82
8.1.8.1 Attributes p. 83
8.1.9 Interface Class IpPolicyAction p. 86
8.1.9.1 Attributes p. 86
8.1.9.2 Method getParentRepository() p. 87
8.1.9.3 Method getParentRule() p. 87
8.1.10 Interface Class IpPolicyEventDefinition p. 88
8.1.10.1 Attributes p. 88
8.1.10.2 Method setRequiredAttributes() p. 89
8.1.10.3 Method setOptionalAttributes() p. 89
8.1.10.4 Method getRequiredAttributes() p. 89
8.1.10.5 Method getOptionalAttributes() p. 90
8.1.10.6 Method getParentDomain() p. 90
8.1.11 Interface Class IpPolicyEventCondition p. 90
8.1.11.1 Attributes p. 90
8.1.12 Interface Class IpPolicyExpressionCondition p. 91
8.1.12.1 Attributes p. 92
8.1.13 Interface Class IpPolicyEventAction p. 92
8.1.13.1 Attributes p. 93
8.1.14 Interface Class IpPolicyExpressionAction p. 93
8.1.14.1 Attributes p. 94
8.1.15 Interface Class IpPolicyIterator p. 94
8.1.15.1 Attributes p. 95
8.1.15.2 Method getList() p. 95
8.1.16 Interface Class IpPolicySignature p. 96
8.1.16.1 Attributes p. 96
8.1.16.2 Method setInputVariables() p. 98
8.1.16.3 Method setOutputVariables() p. 98
8.1.16.4 Method getInputVariables() p. 98
8.1.16.5 Method getOutputVariables() p. 99
8.1.16.6 Method setGroupNames() p. 99
8.1.16.7 Method setPolicyRoles() p. 99
8.1.16.8 Method getGroupNames() p. 100
8.1.16.9 Method getPolicyRoles() p. 100
8.1.16.10 Method getParentDomain() p. 100
8.2 PM Policy Evaluation SCF Interface Classes p. 101
8.2.1 Interface Class IpPolicyEvalManager p. 101
8.2.1.1 Method evalPolicy() p. 101
8.2.1.2 Method evalPolicyReq() p. 102
8.2.1.3 Method abortEvalPolicyReq() p. 103
8.2.1.4 Method generateEvent() p. 103
8.2.1.5 Method createNotification() p. 104
8.2.1.6 Method destroyNotification() p. 104
8.2.2 Interface Class IpAppPolicyDomain p. 104
9 State Transition Diagrams p. 106
9.1 PM Provisioning SCF State Transition Diagrams p. 106
9.2 PM Policy Evaluation SCF State Transition Diagrams p. 106
10 PM Service Properties p. 106
11 Data Definitions p. 107
11.1 Policy Management Data Definitions p. 107
11.1.1 TpPolicyConditionListType p. 107
11.1.2 TpPolicyConditionListElement p. 107
11.1.3 TpPolicyConditionList p. 107
11.1.4 TpPolicyConditionType p. 107
11.1.5 TpPolicyActionListElement p. 108
11.1.6 TpPolicyActionList p. 108
11.1.7 TpPolicyActionType p. 108
11.1.8 TpPolicyEvent p. 108
11.1.9 TpPolicyKeyword p. 108
11.1.10 TpPolicyKeywordSet p. 109
11.1.11 TpPolicyError p. 110
11.1.12 IpPolicyDomain p. 110
11.1.13 IpPolicyDomainRef p. 110
11.1.14 IpPolicyRepository p. 110
11.1.15 IpPolicyRepositoryRef p. 110
11.1.16 IpPolicyGroup p. 110
11.1.17 IpPolicyGroupRef p. 110
11.1.18 IpPolicyRule p. 110
11.1.19 IpPolicyRuleRef p. 110
11.1.20 IpPolicyEventDefinition p. 110
11.1.21 IpPolicyEventDefinitionRef p. 110
11.1.22 IpAppPolicyDomain p. 111
11.1.23 IpAppPolicyDomainRef p. 111
11.1.24 IpPolicyCondition p. 111
11.1.25 IpPolicyConditionRef p. 111
11.1.26 IpPolicyTimePeriodCondition p. 111
11.1.27 IpPolicyTimePeriodConditionRef p. 111
11.2 Data Types for PM Variables p. 111
11.2.1 TpPolicyVar p. 111
11.2.2 TpPolicyVarSet p. 111
11.2.3 TpPolicyRecordType p. 111
11.2.4 TpPolicyListType p. 112
11.2.5 TpPolicyTypeInfo p. 112
11.2.6 TpPolicyType p. 112
11.2.7 TpPolicyNameValue p. 112
11.2.8 TpPolicyNameValueList p. 113
11.3 eBNF for Condition and Action expressions p. 113
11.3.1 Basic Definition p. 113
11.3.2 Definitions of Constant (Literals) p. 113
11.3.3 Definition of Operators p. 114
11.3.4 Allowable arithmetic expressions & predicates p. 114
11.3.5 Accessing Variables p. 114
11.3.6 Allowable Condition and Action Expressions p. 114
11.4 Example Scenarios p. 115
11.5 Example XML Scenarios p. 117
12 Policy Management Exception Classes p. 118
A (Normative) OMG IDL Description of Policy Management SCF p. 119
B W3C WSDL Description of the Policy Management SCF p. 120
C Java API Description of the Policy Management SCF p. 121
D Description of Policy Management for 3GPP2 cdma2000 networks p. 122
D.1 General Exceptions p. 122
D.2 Specific Exceptions p. 122
D.2.1 Clause 1: Scope p. 122
D.2.2 Clause 2: References p. 122
D.2.3 Clause 3: Definitions and abbreviations p. 122
D.2.4 Clause 4: Policy Management SCF p. 122
D.2.5 Clause 5: Sequence Diagrams p. 122
D.2.6 Clause 6 Class Diagrams p. 123
D.2.7 Clause 7: The Service Interface Specifications p. 123
D.2.8 Clause 8: Policy Management Interface Classes p. 123
D.2.9 Clause 9: State Transition Diagrams p. 123
D.2.10 Clause 10: Data Definitions p. 123
D.2.11 Clause 11: Policy Management Exception Classes p. 123
D.2.12 Annex A (normative): OMG IDL Description of Policy Management SCF p. 123
$ Change history p. 124
