1、 ETSI ES 201 915-12 V1.6.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 12: Charging SCF(Parlay 3)floppy3 ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 2 Reference RES/TISPAN-01027-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 201 915-12 V1.6.1 (2006-12) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 3 Definitions
8、and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4 Charging SCF.7 4.1 General requirements on support of methods.7 5 Sequence Diagrams 7 5.1 Reservation / payment in parts .7 5.2 Immediate Charge 9 6 Class Diagrams.11 7 The Service Interface Specifications12 7.1 Interface Specification Form
9、at .12 7.1.1 Interface Class 12 7.1.2 Method descriptions13 7.1.3 Parameter descriptions13 7.1.4 State Model.13 7.2 Base Interface.13 7.2.1 Interface Class IpInterface 13 7.3 Service Interfaces .13 7.3.1 Overview 13 7.4 Generic Service Interface .14 7.4.1 Interface Class IpService 14 8 Charging Inte
10、rface Classes.15 8.1 Interface Class IpChargingManager.15 8.2 Interface Class IpAppChargingManager 16 8.3 Interface Class IpChargingSession.17 8.4 Interface Class IpAppChargingSession26 9 State Transition Diagrams37 9.1 State Transition Diagrams for IpChargingSession .37 9.1.1 Session Created State3
11、8 9.1.2 Amount Reserved State 38 9.1.3 Volume Reserved State.38 9.1.4 Reservation Ended State .38 10 Data Definitions .38 10.1 Charging Data Definitions38 10.1.1 IpChargingManager38 10.1.2 IpChargingManagerRef 39 10.1.3 IpAppChargingManager .39 10.1.4 IpAppChargingManagerRef .39 10.1.5 IpChargingSes
12、sion39 10.1.6 IpChargingSessionRef 39 10.1.7 IpAppChargingSession .39 10.1.8 IpAppChargingSessionRef .39 10.1.9 TpApplicationDescription 39 10.1.10 TpAppInformationSet.39 10.1.11 TpAppInformation39 10.1.12 TpAppInformationType40 ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 4 10.1.13 TpSessionEndedCause4
13、0 10.1.14 TpMerchantAccountID.40 10.1.15 TpCorrelationID .40 10.1.16 TpCorrelationType40 10.1.17 TpChargingPrice.40 10.1.18 TpAmount.41 10.1.19 TpChargingParameterSet41 10.1.20 TpChargingParameter.41 10.1.21 TpChargingParameterID.41 10.1.22 TpChargingParameterValue .41 10.1.23 TpChargingParameterVal
14、ueType .42 10.1.24 TpVolumeSet42 10.1.25 TpVolume.42 10.1.26 TpUnitID 42 10.1.27 TpChargingSessionID.42 10.1.28 TpPriceVolumeSet43 10.1.29 TpPriceVolume.43 10.1.30 TpChargingError.43 11 Exception Classes.43 Annex A (normative): OMG IDL Description of Charging SCF.44 Annex B (informative): Contents o
15、f 3GPP OSA R4 Charging.45 Annex C (informative): Record of changes 46 C.1 Interfaces 46 C.1.1 New 46 C.1.2 Deprecated46 C.1.3 Removed.46 C.2 Methods47 C.2.1 New 47 C.2.2 Deprecated47 C.2.3 Modified.47 C.2.4 Removed.47 C.3 Data Definitions .48 C.3.1 New 48 C.3.2 Modified.48 C.3.3 Removed.48 C.4 Servi
16、ce Properties.48 C.4.1 New 48 C.4.2 Deprecated49 C.4.3 Modified.49 C.4.4 Removed.49 C.5 Exceptions 49 C.5.1 New 49 C.5.2 Modified.50 C.5.3 Removed.50 C.6 Others .50 History 51 ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 5 Intellectual Property Rights IPRs essential or potentially essential to the prese
17、nt 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, IPRs notified to ETSI in res
18、pect 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 guarantee can be given as to th
19、e 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 and Internet converged Service
20、s 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 201 915) is structured in the following parts: Part 1: “Overview“;
21、 Part 2: “Common Data Definitions“; Part 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: “Accoun
22、t Management SCF“; Part 12: “Charging 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 3.5 set of specificatio
23、ns. The present document is equivalent to 3GPP TS 29.198-12 V4.6.0 (Release 4). ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 6 1 Scope The present document is part 12 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA). The OSA specifications define
24、an architecture that enables application developers to make use of network functionality through an open standardized interface, i.e. the OSA APIs. The present document specifies the Charging Service Capability Feature (SCF) aspects of the interface. All aspects of the Charging SCF are defined here,
25、 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 techniques described by th
26、e Unified Modelling 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:
27、Overview (Parlay 3)“. 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-12
28、V1.6.1 (2006-12) 7 4 Charging SCF The following clauses describe each aspect of the Charging 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 in
29、terfaces 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; ei
30、ther methods specified in the Interface specification or events occurring in the underlying networks cause state transitions. The Data Definitions clause show 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 me
31、thods 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 de
32、scribed 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 imple
33、mentation of an Application interface, a call to that method shall be possible, and no exception shall 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
34、charge a user for a streamed video which lasts 10 minutes and costs a total of $2,00. The operations and 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 ob
35、ject reference pointing to an object that implements the IpChargingManager interface. The operations which handle units are used exactly the same, except that the amount of application usage is indicated instead of a price. ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 8 Application : IpChargingSession :
36、 IpChargingManager : IpAppChargingSession1: new()2: createChargingSes sion( )3: new()4: reserveAmountReq( )5: reserveAmountRes( )6: forward event()7: debitAmountReq( )8: debitAmountRes( )9: forward event()10: getLifeTimeLeft( )11: extendLifeTimeReq( )12: ex tendLifeTimeRes ( )13: forward event()14:
37、debitAmountReq( )15: debitAmountRes( )16: forward event()17: release( )1: The application creates a local 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
38、a new or existing object implementing IpChargingSession is returned together with a unique session ID. 3: In this case a new object is used. ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 9 4: The application requests the reservation of $2,00. 5: Assuming the criteria for requesting a reservation are met
39、(the application provider has permission to charge the requested amount, the charged user has agreed to 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
40、. So, the application may start serving the user, for instance by sending the video stream. 6: The successful 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 reques
41、ts to debit $1,00 from the reservation. 8: The successful debit is reported back to the application. 9: 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
42、: The application asks the IpChargingSession object to extend the lifetime of the reservation. 12: Assuming 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 forwarde
43、d 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 a
44、cknowledge to the application. 17: Since the service is complete, the application frees all resources associated with the reservation and session. 5.2 Immediate Charge This sequence diagram illustrates how immediate charging is used. Assume a WAP gateway that charges the user $0,01 per requested URL
45、. Since it is acceptable to loose one tick worth $0,01, no prior reservations are made. The WAP gateway sends an immediate debit for each requested URL, and should a payment have as result failure, the user is disconnected. The operations which handle units are used exactly the same, except that the
46、 amount of application usage is indicated instead of a price. ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 10Application : IpChargingSession : IpAppChargingSession : IpChargingManager1: new()2: createChargingSession( )3: directDebitAmountReq( )4: directDebitAmountRes( )5: forward notification6: directDe
47、bitAmountReq( )7: directDebitAmountErr( )8: forward notification9: release( )1: The application creates a local object implementing the IpAppChargingSession interface. This object will receive response messages from the IpChargingSession object. 2: The application orders the creation of a session. N
48、o new object is created for the charging session handling in this example implementation. 3: The application requests to charge the user $0,01. 4: The payment is acknowledged. 5: The acknowledgement is forwarded in the application. 6: The application requests to charge the user $0,01. 7: The payment
49、 is reported to fail. 8: The failure report is forwarded in the application. (repeat steps 3 to 5 and 6 to 8 as long as you want to in any order you want to). 9: The application releases the session. ETSI ETSI ES 201 915-12 V1.6.1 (2006-12) 116 Class Diagrams This class diagram shows the application interfaces for charging and their relations to the service interfaces. IpInterface(from csapi)IpAppChargingSessioncreditAmountErr()creditAmountRes()creditUnitErr()creditUnitRes()debitAmountErr()debitAmoun
