ETSI ES 202 915-13-2006 Open Service Access (OSA) Application Programming Interface (API) Part 13 Policy management SCF (Parlay 4) (V1 3 1 Includes Diskette)《开放业务接入(OSA) 应用编程接口(API.pdf

1、 ETSI ES 202 915-13 V1.3.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 13: Policy Management SCF(Parlay 4)floppy3 ETSI ETSI ES 202 915-13 V1.3.1 (2006-12) 2 Reference RES/TISPAN-01028-13-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-0

2、6921 Sophia Antipolis Cedex - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 Siret N 348 623 562 00017 - NAF 742 C Association but non lucratif enregistre la Sous-Prfecture de Grasse (06) N 7803/88 Important notice Individual copies of the present document can be downloaded from: http:/www.et

3、si.org The present document may be made available in more than one electronic version or in print. In any case of existing or perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF). In case of dispute, the reference shall be the printing o

4、n ETSI printers of the PDF version kept on a specific network drive within ETSI Secretariat. Users of the present document should be aware that the document may be subject to revision or change of status. Information on the current status of this and other ETSI documents is available at http:/portal

5、.etsi.org/tb/status/status.asp If you find errors in the present document, please send your comment to one of the following services: http:/portal.etsi.org/chaircor/ETSI_support.asp Copyright Notification No part may be reproduced except as authorized by written permission. The copyright and the for

6、egoing restriction extend to reproduction in all media. European Telecommunications Standards Institute 2006. The Parlay Group 2006. All rights reserved. DECTTM, PLUGTESTSTM and UMTSTM are Trade Marks of ETSI registered for the benefit of its Members. TIPHONTMand the TIPHON logo are Trade Marks curr

7、ently being registered by ETSI for the benefit of its Members. 3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 202 915-13 V1.3.1 (2006-12) 3 Contents Intellectual Property Rights7 Foreword.7 1 Scope 8 2 References 8 3 Def

8、initions and abbreviations.8 3.1 Definitions8 3.2 Abbreviations .8 4 Policy Management SCF9 5 Sequence Diagrams 9 5.1 Use of Policy Repository9 5.2 Introduce condition and action into rule.11 5.3 Create and receive an event13 5.4 Create and modify domain .15 5.5 ASP offering services to prepaid subs

9、cribers .17 6 Class Diagrams.19 7 The Service Interface Specifications20 7.1 Interface Specification Format .20 7.1.1 Interface Class 21 7.1.2 Method descriptions21 7.1.3 Parameter descriptions21 7.1.4 State Model.21 7.2 Base Interface.21 7.2.1 Interface Class IpInterface 21 7.3 Service Interfaces .

10、21 7.3.1 Overview 21 7.4 Generic Service Interface .22 7.4.1 Interface Class IpService 22 7.4.1.1 Method setCallback()22 7.4.1.2 Method setCallbackWithSessionID()22 8 Policy Management Interface Classes22 8.1 Interface Class IpPolicyManager23 8.1.1 Method createDomain()24 8.1.2 Method getDomain().24

11、 8.1.3 Method removeDomain() .24 8.1.4 Method getDomainCount().24 8.1.5 Method getDomainIterator().25 8.1.6 Method findMatchingDomains() 25 8.1.7 Method createRepository() .25 8.1.8 Method getRepository()26 8.1.9 Method removeRepository().26 8.1.10 Method getRepositoryCount() 26 8.1.11 Method getRep

12、ositoryIterator() 26 8.1.12 Method startTransaction().27 8.1.13 Method commitTransaction() .27 8.1.14 Method abortTransaction() .28 8.2 Interface Class IpPolicy28 8.2.1 Attributes 28 8.2.2 Method getAttribute().29 8.2.3 Method setAttribute() .29 8.2.4 Method getAttributes() .29 8.2.5 Method setAttri

13、butes()30 8.3 Interface Class IpPolicyDomain.30 ETSI ETSI ES 202 915-13 V1.3.1 (2006-12) 4 8.3.1 Attributes 32 8.3.2 Method getParentDomain() 32 8.3.3 Method createDomain()33 8.3.4 Method getDomain().33 8.3.5 Method removeDomain() .33 8.3.6 Method getDomainCount().34 8.3.7 Method getDomainIterator()

14、.34 8.3.8 Method createGroup().34 8.3.9 Method getGroup() .34 8.3.10 Method removeGroup() 35 8.3.11 Method getGroupCount() .35 8.3.12 Method getGroupIterator() .35 8.3.13 Method createRule() .36 8.3.14 Method getRule()36 8.3.15 Method removeRule().36 8.3.16 Method getRuleCount() 37 8.3.17 Method get

15、RuleIterator() 37 8.3.18 Method createEventDefinition() .37 8.3.19 Method getEventDefinition()38 8.3.20 Method removeEventDefinition().38 8.3.21 Method getEventDefinitionCount() 38 8.3.22 Method getEventDefinitionIterator()38 8.3.23 Method generateEvent() .39 8.3.24 Method createNotification()39 8.3

16、.25 Method destroyNotification() .40 8.3.26 Method createVariableSet()40 8.3.27 Method getVariableSet().40 8.3.28 Method removeVariableSet()41 8.3.29 Method getVariableSetCount().41 8.3.30 Method getVariableSetIterator().41 8.3.31 Method setVariable() 41 8.3.32 Method getVariable()42 8.4 Interface C

17、lass IpPolicyGroup .42 8.4.1 Attributes 43 8.4.2 Method getParentDomain() 44 8.4.3 Method getParentGroup() .44 8.4.4 Method createGroup().44 8.4.5 Method getGroup() .45 8.4.6 Method removeGroup() 45 8.4.7 Method getGroupCount() .45 8.4.8 Method getGroupIterator() .45 8.4.9 Method createRule() .46 8.

18、4.10 Method getRule()46 8.4.11 Method removeRule().46 8.4.12 Method getRuleCount() 47 8.4.13 Method getRuleIterator() 47 8.5 Interface Class IpPolicyRepository 47 8.5.1 Attributes 48 8.5.2 Method getParentRepository()49 8.5.3 Method createRepository() .49 8.5.4 Method getRepository()49 8.5.5 Method

19、removeRepository().50 8.5.6 Method getRepositoryCount() 50 8.5.7 Method getRepositoryIterator() 50 8.5.8 Method createCondition().51 8.5.9 Method getCondition() .51 8.5.10 Method removeCondition() 51 8.5.11 Method getConditionCount()52 8.5.12 Method getConditionIterator()52 8.5.13 Method createActio

20、n()52 8.5.14 Method getAction().53 8.5.15 Method removeAction() .53 ETSI ETSI ES 202 915-13 V1.3.1 (2006-12) 5 8.5.16 Method getActionCount().53 8.5.17 Method getActionIterator().54 8.6 Interface Class IpPolicyRule 54 8.6.1 Attributes 56 8.6.2 Method getParentGroup() .58 8.6.3 Method getParentDomain

21、() 58 8.6.4 Method createCondition().59 8.6.5 Method getCondition() .59 8.6.6 Method removeCondition() 59 8.6.7 Method getConditionCount()60 8.6.8 Method getConditionIterator()60 8.6.9 Method createAction()60 8.6.10 Method getAction().61 8.6.11 Method removeAction() .61 8.6.12 Method getActionCount(

22、).61 8.6.13 Method getActionIterator().61 8.6.14 Method setValidityPeriodConditionByName() 62 8.6.15 Method setValidityPeriodCondition().62 8.6.16 Method getValidityPeriodCondition() 62 8.6.17 Method unsetValidityPeriodCondition().63 8.6.18 Method setConditionList()63 8.6.19 Method getConditionList(

23、) .63 8.6.20 Method setActionList().63 8.6.21 Method getActionList() 64 8.7 Interface Class IpPolicyCondition65 8.7.1 Attributes 66 8.7.2 Method getParentRepository()66 8.7.3 Method getParentRule()67 8.8 Interface Class IpPolicyTimePeriodCondition.67 8.8.1 Attributes 68 8.9 Interface Class IpPolicyA

24、ction.70 8.9.1 Attributes 71 8.9.2 Method getParentRepository()72 8.9.3 Method getParentRule()72 8.10 Interface Class IpPolicyEventDefinition72 8.10.1 Attributes 73 8.10.2 Method setRequiredAttributes() .73 8.10.3 Method setOptionalAttributes()74 8.10.4 Method getRequiredAttributes().74 8.10.5 Metho

25、d getOptionalAttributes()74 8.10.6 Method getParentDomain() 74 8.11 Interface Class IpPolicyEventCondition 75 8.11.1 Attributes 75 8.12 Interface Class IpPolicyExpressionCondition 76 8.12.1 Attributes 76 8.13 Interface Class IpPolicyEventAction77 8.13.1 Attributes 77 8.14 Interface Class IpPolicyExp

26、ressionAction .78 8.14.1 Attributes 79 8.15 Interface Class IpPolicyIterator80 8.15.1 Attributes 80 8.15.2 Method getList() .81 8.16 Interface Class IpAppPolicyDomain81 8.16.1 Method reportNotification()81 9 State Transition Diagrams82 10 PM Service Properties82 11 Data Definitions .82 11.1 Policy M

27、anagement Data Definitions.82 11.1.1 TpPolicyConditionListType .83 11.1.2 TpPolicyConditionListElement 83 ETSI ETSI ES 202 915-13 V1.3.1 (2006-12) 6 11.1.3 TpPolicyConditionList83 11.1.4 TpPolicyConditionType83 11.1.5 TpPolicyActionListElement .83 11.1.6 TpPolicyActionList.83 11.1.7 TpPolicyActionTy

28、pe.83 11.1.8 TpPolicyEvent 84 11.1.9 TpPolicyKeyword.84 11.1.10 TpPolicyKeywordSet85 11.1.11 IpPolicyDomain85 11.1.12 IpPolicyDomainRef 85 11.1.13 IpPolicyRepository .85 11.1.14 IpPolicyRepositoryRef85 11.1.15 IpPolicyGroup.85 11.1.16 IpPolicyGroupRef.85 11.1.17 IpPolicyRule .85 11.1.18 IpPolicyRule

29、Ref .85 11.1.19 IpPolicyEventDefinition .86 11.1.20 IpPolicyEventDefinitionRef .86 11.1.21 IpAppPolicyDomain .86 11.1.22 IpAppPolicyDomainRef .86 11.1.23 IpPolicyCondition.86 11.1.24 IpPolicyConditionRef .86 11.1.25 IpPolicyTimePeriodCondition 86 11.1.26 IpPolicyTimePeriodConditionRef 86 12 Policy M

30、anagement Exception Classes86 Annex A (normative): OMG IDL Description of Policy Management SCF.87 Annex B (informative): Java API Description of the Policy Management SCF.88 Annex C (informative): Contents of 3GPP OSA R5 Policy Management.89 Annex D (informative): Record of changes 90 D.1 Interface

31、s 90 D.1.1 New 90 D.1.2 Deprecated90 D.1.3 Removed.90 D.2 Methods91 D.2.1 New 91 D.2.2 Deprecated91 D.2.3 Modified.91 D.2.4 Removed.91 D.3 Data Definitions .92 D.3.1 New 92 D.3.2 Modified.92 D.3.3 Removed.92 D.4 Service Properties.93 D.4.1 New 93 D.4.2 Deprecated93 D.4.3 Modified.93 D.4.4 Removed.93

32、 D.5 Exceptions 94 D.5.1 New 94 D.5.2 Modified.94 D.5.3 Removed.94 D.6 Others .94 History 95 ETSI ETSI ES 202 915-13 V1.3.1 (2006-12) 7 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to ETSI. The information pertaining to these ess

33、ential IPRs, if any, is publicly available for ETSI members and non-members, and can be found in ETSI SR 000 314: “Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in respect of ETSI standards“, which is available from the ETSI Secretariat. Latest updat

34、es are available on the ETSI Web server (http:/webapp.etsi.org/IPR/home.asp). Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the

35、ETSI Web server) which are, or may be, or may become, essential to the present document. Foreword This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is part 13 o

36、f a multi-part deliverable covering Open Service Access (OSA); Application Programming Interface (API), as identified below. The API specification (ES 202 915) is structured in the following parts: Part 1: “Overview“; Part 2: “Common Data Definitions“; Part 3: “Framework“; Part 4: “Call Control“; Pa

37、rt 5: “User Interaction SCF“; Part 6: “Mobility SCF“; Part 7: “Terminal Capabilities SCF“; Part 8: “Data Session Control SCF“; Part 9: “Generic Messaging SCF“; Part 10: “Connectivity Manager SCF“; Part 11: “Account Management SCF“; Part 12: “Charging SCF“; Part 13: “Policy Management SCF“; Part 14:

38、“Presence and Availability Management SCF“. The present document has been defined jointly between ETSI, The Parlay Group (http:/www.parlay.org) and the 3GPP, in co-operation with a number of JAIN Community (http:/ member companies. The present document forms part of the Parlay 4.3 set of specificati

39、ons. The present document is equivalent to 3GPP TS 29.198-13 V5.7.0 (Release 5). ETSI ETSI ES 202 915-13 V1.3.1 (2006-12) 8 1 Scope The present document is part 13 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA). The OSA specifications define

40、 an architecture that enables application developers to make use of network functionality through an open standardised interface, i.e. the OSA APIs. The present document specifies the Policy Management Service Capability Feature (SCF) aspects of the interface. All aspects of the Policy Management SC

41、F are defined here, these being: Sequence Diagrams. Class Diagrams. Interface specification plus detailed method descriptions. State Transition diagrams. Data Definitions. IDL Description of the interfaces. The process by which this task is accomplished is through the use of object modelling techniq

42、ues described by the Unified Modelling Language (UML). 2 References The references listed in clause 2 of ES 202 915-1 contain provisions which, through reference in this text, constitute provisions of the present document. ETSI ES 202 915-1: “Open Service Access (OSA); Application Programming Interf

43、ace (API); Part 1: Overview (Parlay 4)“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 202 915-1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations defined in ES 202 915-1 apply. ETSI

44、ETSI ES 202 915-13 V1.3.1 (2006-12) 9 4 Policy Management SCF It is expected that more and more OSA services will use policies to express operational criteria. It is also expected that network providers will host policy-enabled services that have been written by 3rdparty application service provider

45、s. In order to manage policy information and control access to it a policy management service is needed. Consistent with this, a policy management service interface manager, IpPolicyManager, has been defined. All policy management interfaces are accessible from IpPolicyManager. A number of APIs have

46、 been defined to obtain services from a policy management service. These include APIs to create, update or view policy information. Additionally APIs have been defined to facilitate interactions between clients (e.g. a 3rdparty application) and any policy enabled service. These include APIs to view

47、policy events, to subscribe to policy events and for the generation of events by clients. All APIs conform to an underlying policy information model. Clients that perform administrative tasks, e.g. create, update or delete policy information must obtain access to IpPolicyManager using the family of

48、obtainInterface() methods supported by the IpAccess interface. Administrative tasks may be performed through methods supported by IpPolicyManager. Clients that need to interact with a specific policy enabled service (for non-administrative tasks) can obtain access to that services interface directly

49、 via the selectService() method supported by the IpAccess interface. It should be noted that specific policy enabled services may support additional interfaces and methods that are not defined below. Examples of policy enabled services include: A load balancing service that uses policies to manage application loads on the network, a charging service that determines charging criteria based on policies, a call management service that uses policies to direct end-user calls to appropriate call agents, etc. The order is as follows: