1、 ETSI ES 201 915-11 V1.6.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 11: Account Management SCF(Parlay 3)floppy3 ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 2 Reference RES/TISPAN-01027-11-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-
2、06921 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.e
3、tsi.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
4、on 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:/porta
5、l.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 fo
6、regoing 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 cur
7、rently 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 201 915-11 V1.6.1 (2006-12) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 3 De
8、finitions and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4 Account Management SCF 7 4.1 General requirements on support of methods.7 5 Sequence Diagrams 7 5.1 Standard Transaction History Retrieval .7 5.2 Standard Query Handling.8 5.3 Standard Notification handling.9 6 Class Diagrams.10 7
9、 The Service Interface Specifications11 7.1 Interface Specification Format .11 7.1.1 Interface Class 11 7.1.2 Method descriptions11 7.1.3 Parameter descriptions11 7.1.4 State Model.12 7.2 Base Interface.12 7.2.1 Interface Class IpInterface 12 7.3 Service Interfaces .12 7.3.1 Overview 12 7.4 Generic
10、Service Interface .12 7.4.1 Interface Class IpService 12 8 Account Management Interface Classes 13 8.1 Interface Class IpAccountManager 13 8.2 Interface Class IpAppAccountManager .16 9 State Transition Diagrams18 9.1 State Transition Diagrams for IpAccountManager.18 9.1.1 Active State.18 9.1.2 Notif
11、ications created State 18 10 Account Management Service Properties 18 11 Data Definitions .19 11.1 Account Management Data Definitions .19 11.1.1 IpAppAccountManager 19 11.1.2 IpAppAccountManagerRef.19 11.1.3 IpAccountManager .20 11.1.4 IpAccountManagerRef20 11.1.5 TpBalanceQueryError.20 11.1.6 TpCh
12、argingEventName 20 11.1.7 TpBalanceInfo 20 11.1.8 TpChargingEventInfo .21 11.1.9 TpChargingEventCriteria21 11.1.10 TpChargingEventNameSet .21 11.1.11 TpChargingEventCriteriaResult .22 11.1.12 TpChargingEventCriteriaResultSet 22 11.1.13 TpBalance.22 11.1.14 TpBalanceSet22 ETSI ETSI ES 201 915-11 V1.6
13、.1 (2006-12) 4 11.1.15 TpTransactionHistory .22 11.1.16 TpTransactionHistorySet 22 11.1.17 TpTransactionHistoryStatus .23 12 Exception Classes.23 Annex A (normative): OMG IDL Description of Account Management SCF .24 Annex B (informative): Contents of 3GPP OSA R4 Account Management .25 Annex C (info
14、rmative): Record of changes 26 C.1 Interfaces 26 C.1.1 New 26 C.1.2 Deprecated26 C.1.3 Removed.26 C.2 Methods27 C.2.1 New 27 C.2.2 Deprecated27 C.2.3 Modified.27 C.2.4 Removed.27 C.3 Data Definitions .28 C.3.1 New 28 C.3.2 Modified.28 C.3.3 Removed.28 C.4 Service Properties.28 C.4.1 New 28 C.4.2 Dep
15、recated29 C.4.3 Modified.29 C.4.4 Removed.29 C.5 Exceptions 29 C.5.1 New 29 C.5.2 Modified.30 C.5.3 Removed.30 C.6 Others .30 History 31 ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 5 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to E
16、TSI. The information pertaining to these essential 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 avail
17、able from the ETSI Secretariat. Latest updates 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 reference
18、d in ETSI SR 000 314 (or the updates on the 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
19、 (TISPAN). The present document is part 11 of a multi-part deliverable covering Open Service Access (OSA); Application Programming Interface (API), as identified below. The API specification (ES 201 915) is structured in the following parts: Part 1: “Overview“; Part 2: “Common Data Definitions“; Par
20、t 3: “Framework“; Part 4: “Call Control SCF“; Part 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 S
21、CF“. 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 3.5 set of specifications. The present document is equivalent
22、to 3GPP TS 29.198-11 V4.6.0 (Release 4). ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 6 1 Scope The present document is part 11 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA). The OSA specifications define an architecture that enables applicatio
23、n developers to make use of network functionality through an open standardized interface, i.e. the OSA APIs. The present document specifies the Account Management Service Capability Feature (SCF) aspects of the interface. All aspects of the Account Management SCF are defined here, these being: Seque
24、nce 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 techniques described by the Unified Modelling
25、 Language (UML). 2 References The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute provisions of the present document. ETSI ES 201 915-1: “Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview (Parlay 3)
26、“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply. ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 7
27、4 Account Management SCF The following clauses describe each aspect of the Account Management Service Capability Feature (SCF). The order is as follows: The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented. The Class relationships clause show how each of the i
28、nterfaces applicable to the SCF, relate to one another. The Interface specification clause describes in detail each of the interfaces shown within the Class diagram part. The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions are well-defined; e
29、ither methods specified in the Interface specification or events occurring in the underlying networks cause state transitions. The Data Definitions clause shows a detailed expansion of each of the data types associated with the methods within the classes. Note that some data types are used in other
30、methods and classes and are therefore defined within the Common Data types part of the present document. 4.1 General requirements on support of methods An implementation of this API which supports or implements a method described in the present document, shall support or implement the functionality
31、described for that method, for at least one valid set of values for the parameters of that method. Where a method is not supported by an implementation of a Service interface, the exception P_METHOD_NOT_SUPPORTED shall be returned to any call of that method. Where a method is not supported by an imp
32、lementation of an Application interface, a call to that method shall be possible, and no exception shall be returned. 5 Sequence Diagrams 5.1 Standard Transaction History Retrieval : IpAppAccountManager: IpAccountManager1: retrieveTransactionHistoryReq( )2: retrieveTransactionHistoryRes( )1: This me
33、ssage is used by the application to retrieve a transaction history for a certain subscribers account. 2: This method passes the result of the transaction history retrieval request for a specific user to its callback object. ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 8 5.2 Standard Query Handling : IpA
34、ppAccountManager : IpAccountManagerApplication is requesting to query the balance1: queryBalanceReq( )2: queryBalanceRes( )3: queryBalanceReq( )Application is requesting to query the balance, but there is at least one error in the parameters that is detected by the IpAccountManager service.4: queryB
35、alanceReq( )Application is requesting to query the balance, but a network error occurs5: queryBalanceErr( )1: This message is used to query the balance of the account of one or several users. 2: This message passes the result of the balance query for one or several users to its callback object. 3: T
36、his scenario shows the case where at least one error in the parameters of the message is detected by the IpAccountManager object. An exception will be thrown. 4: This scenario shows the case where a network error occurs. 5: This message passes the error of the balance query. No exception is thrown.
37、ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 9 5.3 Standard Notification handling : IpAppAccountManager : IpAccountManager1: createNotification( )2: re portNoti fication ( )3: getNotification( )4: changeNotification( )5: re portNoti fication ( )6: destroyNotification( )1: This message is used by the app
38、lication to request notifications from the IpAccountManager service on certain criteria for one or several users. 2: This message is used by the IpAccountManager service to report a charging event that meets the criteria set in the createNotification message. 3: The application can request the curre
39、nt criteria set in the IpAccountManager service by invoking the getNotification method. 4: This message is used by the application to change the criteria initially created by createNotification, and previously obtained by getNotification. 5: This message is used by the IpAccountManager service to re
40、port a charging event that meets the new criteria. 6: This method is used by the application to disable the charging notifications. ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 106 Class Diagrams IpInterfaceIpAppAccountManagerreportNotification()queryBalanceRes()queryBalanceErr()retrieveTransact ionHist
41、 oryRes()ret ri eveTr ansact ion Hi st ory Er r( )IpAccountManagercreateNotification()destroyNotification()queryBalanceReq()changeNotification()getNot ific ati on()retrieveTransactionHistoryReq()Figure 1: Application Interfaces ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 11IpServicesetCallback()setCall
42、backWithSessionID()IpAccountManagercreateNotification()destroyNotification()queryBalanceReq()changeNotification()getNotification()retrieveTransactionHistoryReq()(from am)Figure 2: Service Interfaces 7 The Service Interface Specifications 7.1 Interface Specification Format This clause defines the int
43、erfaces, methods and parameters that form a part of the API specification. The Unified Modelling Language (UML) is used to specify the interface classes. The general format of an interface specification is described below. 7.1.1 Interface Class This shows a UML interface class description of the met
44、hods supported by that interface, and the relevant parameters and types. The Service and Framework interfaces for enterprise-based client applications are denoted by classes with name Ip. The callback interfaces to the applications are denoted by classes with name IpApp. For the interfaces between a
45、 Service and the Framework, the Service interfaces are typically denoted by classes with name IpSvc, while the Framework interfaces are denoted by classes with name IpFw. 7.1.2 Method descriptions Each method (API method “call“) is described. Both synchronous and asynchronous methods are used in the
46、 API. Asynchronous methods are identified by a “Req“ suffix for a method request, and, if applicable, are served by asynchronous methods identified by either a “Res“ or “Err“ suffix for method results and errors, respectively. To handle responses and reports, the application or service developer mus
47、t implement the relevant IpApp or IpSvc interfaces to provide the callback mechanism. 7.1.3 Parameter descriptions Each method parameter and its possible values are described. Parameters described as “in“ represent those that must have a value when the method is called. Those described as “out“ are
48、those that contain the return result of the method when the method returns. ETSI ETSI ES 201 915-11 V1.6.1 (2006-12) 127.1.4 State Model If relevant, a state model is shown to illustrate the states of the objects that implement the described interface. 7.2 Base Interface 7.2.1 Interface Class IpInte
49、rface All application, framework and service interfaces inherit from the following interface. This API Base Interface does not provide any additional methods. IpInterface 7.3 Service Interfaces 7.3.1 Overview The Service Interfaces provide the interfaces into the capabilities of the underlying network - such as call control, user interaction, messaging, mobility and connectivity management. The interfaces that are implemented by the services are denoted as “Service Interface“. The corresponding interfaces that must be im
