1、 ETSI ES 203 915-11 V1.2.1 (2007-01)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 11: Account Management SCF(Parlay 5)floppy3 ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 2 Reference RES/TISPAN-01029-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 2007. The Parlay Group 2007. 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 203 915-11 V1.2.1 (2007-01) 3 Contents Intellectual Property Rights6 Foreword.6 1 Scope 7 2 References 7 3 De
8、finitions and abbreviations.7 3.1 Definitions7 3.2 Abbreviations .7 4 Account Management SCF 8 4.1 General requirements on support of methods.8 5 Sequence Diagrams 9 5.1 Standard Voucher Handling .9 5.2 Standard Transaction History Retrieval .10 5.3 Standard Query Handling.11 5.4 Standard Notificati
9、on handling.12 5.5 Network Controlled Notifications 13 6 Class Diagrams.14 7 The Service Interface Specifications15 7.1 Interface Specification Format .15 7.1.1 Interface Class 15 7.1.2 Method descriptions15 7.1.3 Parameter descriptions16 7.1.4 State Model.16 7.2 Base Interface.16 7.2.1 Interface Cl
10、ass IpInterface 16 7.3 Service Interfaces .16 7.3.1 Overview 16 7.4 Generic Service Interface .16 7.4.1 Interface Class IpService 16 7.4.1.1 Method setCallback()17 7.4.1.2 Method setCallbackWithSessionID()17 8 Account Management Interface Classes 17 8.1 Interface Class IpAccountManager 17 8.1.1 Meth
11、od createNotification()18 8.1.2 Method destroyNotification() .19 8.1.3 Method queryBalanceReq()19 8.1.4 Method changeNotification()19 8.1.5 Method getNotification() 20 8.1.6 Method retrieveTransactionHistoryReq() .20 8.1.7 Method enableNotifications() .20 8.1.8 Method disableNotifications() 21 8.1.9
12、 Method queryBalanceExpiryDateReq() .21 8.1.10 Method updateBalanceReq()21 8.1.11 Method createVoucherReq() 22 8.1.12 Method destroyVoucherReq()22 8.1.13 Method queryVoucherReq().23 8.1.14 Method queryUserVouchersReq() .23 8.2 Interface Class IpAppAccountManager .23 8.2.1 Method reportNotification()
13、24 8.2.2 Method queryBalanceRes() 24 8.2.3 Method queryBalanceErr() .25 8.2.4 Method retrieveTransactionHistoryRes() .25 ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 4 8.2.5 Method retrieveTransactionHistoryErr() 25 8.2.6 Method queryBalanceExpiryDateRes()25 8.2.7 Method queryBalanceExpiryDateErr() 26 8
14、.2.8 Method updateBalanceRes() 26 8.2.9 Method updateBalanceErr() .26 8.2.10 Method createVoucherRes().26 8.2.11 Method createVoucherErr() .27 8.2.12 Method destroyVoucherRes() 27 8.2.13 Method destroyVoucherErr() .27 8.2.14 Method queryVoucherRes().27 8.2.15 Method queryVoucherErr()28 8.2.16 Method
15、 queryUserVouchersRes()28 8.2.17 Method queryUserVouchersErr().28 9 State Transition Diagrams29 9.1 State Transition Diagrams for IpAccountManager.29 9.1.1 Active State.29 9.1.2 Notifications created State 29 10 Account Management Service Properties 29 11 Data Definitions .30 11.1 Account Management
16、 Data Definitions .30 11.1.1 IpAppAccountManager 30 11.1.2 IpAppAccountManagerRef.30 11.1.3 IpAccountManager .30 11.1.4 IpAccountManagerRef31 11.1.5 TpBalanceQueryError.31 11.1.6 TpChargingEventName 31 11.1.7 TpBalanceInfo 31 11.1.8 TpChargingEventInfo .32 11.1.9 TpChargingEventCriteria32 11.1.10 Tp
17、ChargingEventNameSet .32 11.1.11 TpChargingEventCriteriaResult .32 11.1.12 TpChargingEventCriteriaResultSet 32 11.1.13 TpBalance.33 11.1.14 TpBalanceSet33 11.1.15 TpTransactionHistory .33 11.1.16 TpTransactionHistorySet 33 11.1.17 TpTransactionHistoryStatus .33 11.1.18 TpBalanceExpiryDate.33 11.1.19
18、 TpBalanceExpiryDateSet34 11.1.20 TpVoucherError34 11.1.21 TpVoucher 34 11.1.22 TpVoucherSet .34 12 Exception Classes.34 Annex A (normative): OMG IDL Description of Account Management SCF .35 Annex B (informative): W3C WSDL Description of Account Management SCF36 Annex C (informative): Java API Desc
19、ription of the Account Management SCF .37 Annex D (informative): Contents of 3GPP OSA Rel-6 Account Management.38 Annex E (informative): Description of Account Management for 3GPP2 cdma2000 networks.39 E.1 General Exceptions.39 E.2 Specific Exceptions39 E.2.1 Clause 1: Scope 39 E.2.2 Clause 2: Refer
20、ences 39 E.2.3 Clause 3: Definitions and abbreviations.39 ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 5 E.2.4 Clause 4: Account Management SCF.39 E.2.5 Clause 5: Sequence Diagrams 39 E.2.6 Clause 6: Class Diagrams.39 E.2.7 Clause 7: The Service Interface Specifications 39 E.2.8 Clause 8: Account Manage
21、ment Interface Classes.40 E.2.9 Clause 9: State Transition Diagrams 40 E.2.10 Clause 10: Account Management Service Properties.40 E.2.11 Clause 11: Data Definitions40 E.2.12 Clause 12: Exception Classes.40 E.2.13 Annex A (normative): OMG IDL Description of Account Management SCF.40 E.2.14 Annex B (i
22、nformative): W3C WSDL Description of Account Management SCF.40 Annex F (informative): Record of changes 41 F.1 Interfaces 41 F.1.1 New 41 F.1.2 Deprecated41 F.1.3 Removed.41 F.2 Methods42 F.2.1 New 42 F.2.2 Deprecated42 F.2.3 Modified.42 F.2.4 Removed.42 F.3 Data Definitions .43 F.3.1 New 43 F.3.2 M
23、odified.43 F.3.3 Removed.43 F.4 Service Properties.43 F.4.1 New 43 F.4.2 Deprecated43 F.4.3 Modified.44 F.4.4 Removed.44 F.5 Exceptions 44 F.5.1 New 44 F.5.2 Modified.44 F.5.3 Removed.44 F.6 Others .44 History 45 ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 6 Intellectual Property Rights IPRs essential
24、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 can be found in ETSI SR 000 314: “Intellectual Property Rights (IPRs); Essential, or potentially Es
25、sential, 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). Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETS
26、I. 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 document. Foreword This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunic
27、ations 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 Programming Interface (API), as identified below. The API specification (ES 203 915) is structured in the
28、 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 Capabilities SCF“; Part 8: “Data Session Control SCF“; Part 9: “Generic Messaging SCF“; Part 10: “Connectivi
29、ty Manager SCF“; Part 11: “Account Management SCF“; Part 12: “Charging SCF“; Part 13: “Policy Management SCF“; Part 14: “Presence and Availability Management SCF“; Part 15: “Multi-Media Messaging SCF“. The present document has been defined jointly between ETSI, The Parlay Group (http:/www.parlay.org
30、) and the 3GPP, in co-operation with a number of JAIN Community (http:/ member companies. The present document forms part of the Parlay 5.1 set of specifications. The present document is equivalent to 3GPP TS 29.198-11 V6.5.0 (Release 6). ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 7 1 Scope The presen
31、t 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 functionality through an open standardised interface, i.e. the OSA
32、 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 specification plus detailed method descriptions. State Transit
33、ion 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 Language (UML). 2 References The references listed in clause 2 of
34、 ES 203 915-1 contain provisions which, through reference in this text, constitute provisions of the present document. ETSI ES 203 915-1: “Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview (Parlay 5)“. 3 Definitions and abbreviations 3.1 Definitions For the purpose
35、s of the present document, the terms and definitions given in ES 203 915-1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in ES 203 915-1 apply. ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 8 4 Account Management SCF The following clauses describe each aspect
36、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 interfaces applicable to the SCF, relate to one another. The Interfa
37、ce 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 methods specified in the Interface specification or events oc
38、curring 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 methods and classes and are therefore defined within the Common Dat
39、a types part ES 203 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 that method, for at least one valid set of values for the parame
40、ters 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 Application interface, a call to that method shall be possib
41、le, and no exception shall be returned. ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 9 5 Sequence Diagrams 5.1 Standard Voucher Handling : IpAccountManager: IpAppAccountManager1: queryVoucherReq( )2: queryVoucherRes( )The application queries the voucher amountThe application updates the balance of the a
42、ccount3: updateBalanceReq( )4: updateBalanceRes( )5: destroyVoucherReq( )6: destroyVoucherRes( )1: This message is used to get a voucher for an amount. 2: This message used to return the amount requested. 3: This message is used to update the balance of the account. 4: This message is used to return
43、 the confirmation of the update. 5: This message is used to remove the voucher. 6: This message is used to confirm that the voucher is removed. ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 105.2 Standard Transaction History Retrieval : IpAppAccountManager: IpAccountManager1: retrieveTransactionHistoryRe
44、q( )2: retrieveTransactionHistoryRes( )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 203 915-11 V1.
45、2.1 (2007-01) 115.3 Standard 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 parameters that is d
46、etected by the IpAccountManager 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
47、one or several users 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 err
48、or of the balance query. No exception is thrown. ETSI ETSI ES 203 915-11 V1.2.1 (2007-01) 125.4 Standard Notification handling : IpAppAccountManager : IpAccountManager1: createNotification( )2: reportNotification( )3: getNotification( )4: changeNotification( )5: reportNotification( )6: destroyNotifi
49、cation( )1: This message 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 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 crea
