1、 ETSI ES 202 915-12 V1.4.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 12: Charging SCF(Parlay 4)floppy3 ETSI ETSI ES 202 915-12 V1.4.1 (2006-12) 2 Reference RES/TISPAN-01028-12-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-06921 Soph
2、ia 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.etsi.org Th
3、e 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 on ETSI pr
4、inters 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.etsi.org
5、/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 foregoing re
6、striction 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 currently bei
7、ng 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-12 V1.4.1 (2006-12) 3 Contents Intellectual Property Rights6 Foreword.6 1 Scope 7 2 References 7 3 Definitions
8、and abbreviations.7 3.1 Definitions7 3.2 Abbreviations .7 4 Charging SCF.8 4.1 General requirements on support of methods.8 5 Sequence Diagrams 8 5.1 Reservation / payment in parts .8 5.2 Immediate Charge 10 6 Class Diagrams.12 7 The Service Interface Specifications13 7.1 Interface Specification For
9、mat .13 7.1.1 Interface Class 14 7.1.2 Method descriptions14 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 Interfaces .14 7.3.1 Overview 14 7.4 Generic Service Interface .15 7.4.1 Interface Class IpService 15 7.4.1.1 Method
10、 setCallback()15 7.4.1.2 Method setCallbackWithSessionID()15 8 Charging Interface Classes.16 8.1 Interface Class IpChargingManager.16 8.1.1 Method createChargingSession()17 8.1.2 Method createSplitChargingSession()18 8.2 Interface Class IpAppChargingManager 18 8.2.1 Method sessionAborted()19 8.3 Int
11、erface Class IpChargingSession.19 8.3.1 Method creditAmountReq()20 8.3.2 Method creditUnitReq()21 8.3.3 Method debitAmountReq().22 8.3.4 Method debitUnitReq().22 8.3.5 Method directCreditAmountReq()23 8.3.6 Method directCreditUnitReq()23 8.3.7 Method directDebitAmountReq().24 8.3.8 Method directDebi
12、tUnitReq().25 8.3.9 Method extendLifeTimeReq() 25 8.3.10 Method getAmountLeft()25 8.3.11 Method getLifeTimeLeft()26 8.3.12 Method getUnitLeft()26 8.3.13 Method rateReq()26 8.3.14 Method release() .27 8.3.15 Method reserveAmountReq() .27 8.3.16 Method reserveUnitReq() .28 8.4 Interface Class IpAppCha
13、rgingSession28 ETSI ETSI ES 202 915-12 V1.4.1 (2006-12) 4 8.4.1 Method creditAmountErr() .30 8.4.2 Method creditAmountRes() 30 8.4.3 Method creditUnitErr().30 8.4.4 Method creditUnitRes() 31 8.4.5 Method debitAmountErr() 31 8.4.6 Method debitAmountRes() .32 8.4.7 Method debitUnitErr() 32 8.4.8 Metho
14、d debitUnitRes() .32 8.4.9 Method directCreditAmountErr() .33 8.4.10 Method directCreditAmountRes() 33 8.4.11 Method directCreditUnitErr() .33 8.4.12 Method directCreditUnitRes() 34 8.4.13 Method directDebitAmountErr() 34 8.4.14 Method directDebitAmountRes() .34 8.4.15 Method directDebitUnitErr() 35
15、 8.4.16 Method directDebitUnitRes() .35 8.4.17 Method extendLifeTimeErr()35 8.4.18 Method extendLifeTimeRes().36 8.4.19 Method rateErr() .36 8.4.20 Method rateRes() 36 8.4.21 Method reserveAmountErr().36 8.4.22 Method reserveAmountRes()37 8.4.23 Method reserveUnitErr().37 8.4.24 Method reserveUnitRe
16、s()38 8.4.25 Method sessionEnded().38 9 State Transition Diagrams39 9.1 State Transition Diagrams for IpChargingSession .39 9.1.1 Session Created State40 9.1.2 Amount Reserved State 40 9.1.3 Volume Reserved State.40 9.1.4 Reservation Ended State .40 10 Content Based Charging Service Properties.40 11
17、 Data Definitions .41 11.1 Charging Data Definitions41 11.1.1 IpChargingManager42 11.1.2 IpChargingManagerRef 42 11.1.3 IpAppChargingManager .42 11.1.4 IpAppChargingManagerRef .42 11.1.5 IpChargingSession42 11.1.6 IpChargingSessionRef 42 11.1.7 IpAppChargingSession .42 11.1.8 IpAppChargingSessionRef
18、 .42 11.1.9 TpApplicationDescription 42 11.1.10 TpAppInformationSet.42 11.1.11 TpAppInformation43 11.1.12 TpAppInformationType43 11.1.13 TpSessionEndedCause43 11.1.14 TpMerchantAccountID.43 11.1.15 TpCorrelationID .43 11.1.16 TpCorrelationType43 11.1.17 TpChargingPrice.44 11.1.18 TpAmount.44 11.1.19
19、 TpChargingParameterSet44 11.1.20 TpChargingParameter.44 11.1.21 TpChargingParameterID.44 11.1.22 TpChargingParameterValue .44 11.1.23 TpChargingParameterValueType .45 11.1.24 TpVolumeSet45 11.1.25 TpVolume.45 11.1.26 TpUnitID 45 ETSI ETSI ES 202 915-12 V1.4.1 (2006-12) 5 11.1.27 TpChargingSessionID
20、.45 11.1.28 TpPriceVolumeSet46 11.1.29 TpPriceVolume.46 11.1.30 TpChargingError.46 12 Exception Classes.46 Annex A (normative): OMG IDL Description of Charging SCF.47 Annex B (informative): W3C WSDL Description of Charging SCF.48 Annex C (informative): Java API Description of the Charging SCF 49 Ann
21、ex D (informative): Contents of 3GPP OSA R5 Charging.50 Annex E (informative): Record of changes 51 E.1 Interfaces 51 E.1.1 New 51 E.1.2 Deprecated51 E.1.3 Removed.51 E.2 Methods52 E.2.1 New 52 E.2.2 Deprecated52 E.2.3 Modified.52 E.2.4 Removed.52 E.3 Data Definitions .53 E.3.1 New 53 E.3.2 Modified
22、.53 E.3.3 Removed.53 E.4 Service Properties.54 E.4.1 New 54 E.4.2 Deprecated54 E.4.3 Modified.54 E.4.4 Removed.55 E.5 Exceptions 55 E.5.1 New 55 E.5.2 Modified.55 E.5.3 Removed.55 E.6 Others .56 History 57 ETSI ETSI ES 202 915-12 V1.4.1 (2006-12) 6 Intellectual Property Rights IPRs essential or pote
23、ntially 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 Essential
24、, 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 ETSI. No g
25、uarantee 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 Telecommunications
26、and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is part 12 of 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 follow
27、ing 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: “Connectivity Mana
28、ger 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 jointly between ETSI, The Parlay Group (http:/www.parlay.org) and the 3GPP, in co-operation with a number
29、 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-12 V5.9.0 (Release 5). ETSI ETSI ES 202 915-12 V1.4.1 (2006-12) 7 1 Scope The present document is part 12 of the Stage 3 specific
30、ation 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 APIs. The present document specifies the Cha
31、rging Service Capability Feature (SCF) aspects of the interface. All aspects of the Charging SCF 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
32、. WSDL Description of the interfaces. Reference to the Java API 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 ES 202
33、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 Definitions and abbreviations 3.1 Definitions For the purposes of the
34、 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-12 V1.4.1 (2006-12) 8 4 Charging SCF The following clauses describe each aspect of the Charging
35、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 Interface specification clause de
36、scribes 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 occurring in the underlying
37、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 Data types part ES 202 915-2.
38、 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 parameters of that method. Where
39、 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 possible, and no exception shall
40、 be returned. 5 Sequence Diagrams 5.1 Reservation / payment in parts The sequence diagram illustrates how to request a reservation and how to charge a user from the reserved amount, for instance to charge a user for a streamed video which lasts 10 minutes and costs a total of $2,00. The operations a
41、nd interfaces that do not provide rating are employed throughout this sequence diagram. We assume the application has already discovered the Charging SCF. As a result, the application received an object reference pointing to an object that implements the IpChargingManager interface. The operations w
42、hich handle units are used exactly the same, except that the amount of application usage is indicated instead of a price. ETSI ETSI ES 202 915-12 V1.4.1 (2006-12) 9 Application : IpChargingSession : IpChargingManager : IpAppChargingSession1: new()2: createChargingSession( )3: new()4: reserveAmountRe
43、q( )5: reserveAmountRes( )6: forward event()7: debitAmountReq( )8: debitAmountRes( )9: forward event()10: getLifeTimeLeft( )11: extendLifeTimeReq( )12: ex tendLifeTimeRes( )13: forward event()14: debitAmountReq( )15: debitAmountRes( )16: forward event()17: release( )1: The application creates a loca
44、l object implementing the IpAppChargingSession interface. This object will receive response messages from the IpChargingSession object. 2: The application opens a charging session, a reference to a new or existing object implementing IpChargingSession is returned together with a unique session ID. E
45、TSI ETSI ES 202 915-12 V1.4.1 (2006-12) 103: In this case a new object is used. 4: The application requests the reservation of $2,00. 5: Assuming the criteria for requesting a reservation are met (the application provider has permission to charge the requested amount, the charged user has agreed to
46、pay the requested amount), the amount is reserved in the session. At this point, the application provider knows that the network operator will accept later debit requests up to the reserved amount. So, the application may start serving the user, for instance by sending the video stream. 6: The succe
47、ssful reservation is reported back to the application. After half of the video has been sent to the user, the application may choose to capture half of the price already: 7: The application requests to debit $1,00 from the reservation. 8: The successful debit is reported back to the application. 9:
48、The acknowledge is forwarded to the application. 10: The application checks if the remaining lifetime of the reservation will cover the remaining 5 minutes of video. Let us assume, it does not. 11: The application asks the IpChargingSession object to extend the lifetime of the reservation. 12: Assum
49、ing that the application provider is allowed to keep reservations open for longer than 10 minutes, the extendLifeTimeReq() will be honoured and confirmed properly. 13: The confirmation is forwarded to the application. 14: When the complete video has been transmitted to the user without errors, the application charges another $1,00. 15: The IpChargingSession object acknowledges the successful debit at the IpAppChargingSession callback object. 16: The IpAppChargingSession object forwards the acknowledge
