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

1、 ETSI ES 202 915-11 V1.4.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 11: Account Management SCF(Parlay 4)floppy3 ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 2 Reference RES/TISPAN-01028-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 202 915-11 V1.4.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 8 5.1 Standard Transaction History Retrieval .8 5.2 Standard Query Handling.9 5.3 Standard Notification handling.10 5.4 Network Controll

9、ed Notifications 11 6 Class Diagrams.12 7 The Service Interface Specifications13 7.1 Interface Specification Format .13 7.1.1 Interface Class 13 7.1.2 Method descriptions13 7.1.3 Parameter descriptions14 7.1.4 State Model.14 7.2 Base Interface.14 7.2.1 Interface Class IpInterface 14 7.3 Service Inte

10、rfaces .14 7.3.1 Overview 14 7.4 Generic Service Interface .14 7.4.1 Interface Class IpService 14 7.4.1.1 Method setCallback()15 7.4.1.2 Method setCallbackWithSessionID()15 8 Account Management Interface Classes 15 8.1 Interface Class IpAccountManager 15 8.1.1 Method createNotification()16 8.1.2 Met

11、hod destroyNotification() .17 8.1.3 Method queryBalanceReq()17 8.1.4 Method changeNotification()17 8.1.5 Method getNotification() 17 8.1.6 Method retrieveTransactionHistoryReq() .18 8.1.7 Method enableNotifications().18 8.1.8 Method disableNotifications()19 8.2 Interface Class IpAppAccountManager .1

12、9 8.2.1 Method reportNotification()20 8.2.2 Method queryBalanceRes() 20 8.2.3 Method queryBalanceErr() .20 8.2.4 Method retrieveTransactionHistoryRes() .20 8.2.5 Method retrieveTransactionHistoryErr() 21 9 State Transition Diagrams21 9.1 State Transition Diagrams for IpAccountManager.21 9.1.1 Active

13、 State.21 9.1.2 Notifications created State 21 10 Account Management Service Properties 22 ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 4 11 Data Definitions .22 11.1 Account Management Data Definitions .22 11.1.1 IpAppAccountManager 23 11.1.2 IpAppAccountManagerRef.23 11.1.3 IpAccountManager .23 11.1.4

14、 IpAccountManagerRef23 11.1.5 TpBalanceQueryError.23 11.1.6 TpChargingEventName 23 11.1.7 TpBalanceInfo 24 11.1.8 TpChargingEventInfo .24 11.1.9 TpChargingEventCriteria25 11.1.10 TpChargingEventNameSet .25 11.1.11 TpChargingEventCriteriaResult .25 11.1.12 TpChargingEventCriteriaResultSet 25 11.1.13

15、TpBalance.25 11.1.14 TpBalanceSet25 11.1.15 TpTransactionHistory .25 11.1.16 TpTransactionHistorySet 26 11.1.17 TpTransactionHistoryStatus .26 12 Exception Classes.26 Annex A (normative): OMG IDL Description of Account Management SCF .27 Annex B (informative): W3C WSDL Description of Account Managem

16、ent SCF28 Annex C (informative): Java API Description of the Account Management SCF .29 Annex D (informative): Contents of 3GPP OSA Rel-5 Account Management.30 Annex E (informative): Record of changes 31 E.1 Interfaces 31 E.1.1 New 31 E.1.2 Deprecated31 E.1.3 Removed.31 E.2 Methods32 E.2.1 New 32 E.

17、2.2 Deprecated32 E.2.3 Modified.32 E.2.4 Removed.32 E.3 Data Definitions .33 E.3.1 New 33 E.3.2 Modified.33 E.3.3 Removed.33 E.4 Service Properties.34 E.4.1 New 34 E.4.2 Deprecated34 E.4.3 Modified.34 E.4.4 Removed.34 E.5 Exceptions 35 E.5.1 New 35 E.5.2 Modified.35 E.5.3 Removed.35 E.6 Others .35 H

18、istory 36 ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 5 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to ETSI. The information pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and ca

19、n 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 updates are available on the ETSI Web server (http:/webapp.etsi.org/IPR/home.asp). Pursu

20、ant 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 ETSI Web server) which are, or may be, or may become, essential to the present docu

21、ment. 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 11 of a multi-part deliverable covering Open Service Access (OSA); Application Programm

22、ing 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“; Part 5: “User Interaction SCF“; Part 6: “Mobility SCF“; Part 7: “Terminal Capabilitie

23、s 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: “Presence and Availability Management SCF“. The present document has been defined j

24、ointly 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 specifications. The present document is equivalent to 3GPP TS 29.198-11 V5.8.0 (Release 5). ET

25、SI ETSI ES 202 915-11 V1.4.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 application developers to make use of network functio

26、nality through an open standardised 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: Sequence Diagrams. Class Diagrams. Interface spe

27、cification plus detailed method descriptions. State Transition diagrams. Data Definitions. IDL Description of the interfaces. WSDL 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 Langua

28、ge (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 Interface (API); Part 1: Overview (Parlay 4)“. 3 De

29、finitions 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 ETSI ES 202 915-11 V1.4.1 (2006-12) 7 4 Accou

30、nt 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 shows how each of the interfa

31、ces 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; either

32、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 method

33、s and classes and are therefore defined within the Common Data types part ES 202 915-2. 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 described for tha

34、t 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 implementation of an

35、 Application interface, a call to that method shall be possible, and no exception shall be returned. ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 8 5 Sequence Diagrams 5.1 Standard Transaction History Retrieval : IpAppAccountManager: IpAccountManager1: retrieveTransactionHistoryReq( )2: retrieveTransact

36、ionHistoryRes( )1: This message 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 202 915-11 V1.4.1 (2006-12) 9 5.2 Sta

37、ndard Query Handling : IpAppAccountManager : 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 p arameters that is de tected by the IpAcco

38、untManager service.4: queryBalanceReq( )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

39、to its callback object. 3: This 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 que

40、ry. No exception is thrown. ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 105.3 Standard Notification handling : IpAppAccountManager : IpAccountManager1: createNotification( )2: reportNotification( )3: getNotification( )4: changeNotification( )5: reportNotification( )6: destroyNotification( )1: This mess

41、age is used by the application 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

42、 can request the current 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 IpAccoun

43、tManager service to report a charging event that meets the new criteria. 6: This method is used by the application to disable the charging notifications. ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 115.4 Network Controlled Notifications The following sequence diagram shows how an application can receiv

44、e notifications that have not been created by the application, but are provisioned from within the network. AppLogic : IpAppAccountManager : IpAccountManager1: New()2: enableNotifications( )3: reportNotification( )4: forward event5: reportNotification( )6: forward event7: disableNotifications( )1: T

45、he application is started. The application creates a new IpAppAccountManager to handle callbacks. 2: The enableNotifications method is invoked on the IpAccountManager interface to indicate that the application is ready to receive notifications that are created in the network. For illustrative purpos

46、es we assume notifications of type “B“ are created in the network. 3: When a network created trigger occurs the application is notified on the callback interface. 4: The event is forwarded to the application. 5: When a network created trigger occurs the application is notified on the callback interf

47、ace. 6: The event is forwarded to the application. 7: When the application does not want to receive notifications created in the network anymore, it invokes disableNotifications on the IpMultiPartyCallConrolManager interface. From now on the gateway will not send any notifications to the application

48、 that are created in the network. The application will still receive notifications that it has created himself until the application removes them. ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 126 Class Diagrams IpInterfaceIpAppAccountManagerreportNotification()queryBalanceRes()queryBalanceErr()retrieveT

49、ransactionHistoryRes()retrieveTransactionHistoryErr()IpAccountManagercreateNotification()destroyNotification()queryBalanceReq()changeNotification()getNotific ation()retrieveTransactionHistoryReq() enableNotifications() disableNotifications()Figure 1: Application Interfaces ETSI ETSI ES 202 915-11 V1.4.1 (2006-12) 13IpServicesetCallback()setCallbackWithSessionID()IpAccountManagercreateNotification()destroyNotification()queryBalanceReq()changeNotification()getNotification()retrieveTransactionHistoryReq() enableNotif