1、 ETSI ES 204 915-16 V1.1.1 (2008-05)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 16: Service Broker SCF(Parlay 6)floppy3 ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 2 Reference DES/TISPAN-01032-16-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-0692
2、1 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.etsi.
3、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 on E
4、TSI 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:/portal.et
5、si.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 forego
6、ing restriction extend to reproduction in all media. European Telecommunications Standards Institute 2008. The Parlay Group 2008. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTM, TIPHONTM, the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members. 3GPPTM is
7、 a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 3 Definitions and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4 Ser
8、vice Broker SCF7 4.1 General requirements on support of methods.7 5 Sequence Diagrams 7 6 Class Diagrams.8 7 The Service Interface Specifications8 7.1 Interface Specification Format .8 7.1.1 Interface Class 8 7.1.2 Method descriptions8 7.1.3 Parameter descriptions8 7.1.4 State Model.9 7.2 Base Inter
9、face.9 7.2.1 Interface Class IpInterface 9 7.3 Service Interfaces .9 7.3.1 Overview 9 7.4 Generic Service Interface .9 7.4.1 Interface Class IpService 9 7.4.1.1 Method setCallback()10 7.4.1.2 Method setCallbackWithSessionID()10 8 Service Broker Interface Classes10 8.1 Interface Class IpServiceBroker
10、.10 8.1.1 Method register() 11 8.1.2 Method unregister() 12 9 State Transition Diagrams12 10 Service Broker Service Properties12 11 Data Definitions .12 11.1 Service Broker Data Definitions 12 11.1.1 clientBrokerID 12 11.1.2 TpEndpointAddress 13 11.1.3 TpEndpointAddressCategory13 11.1.4 TpServiceKey
11、 .13 11.1.5 TpServiceKeyType .13 12 Exception Classes.13 Annex A (normative): OMG IDL Description of Service Broker SCF .14 Annex B (informative): W3C WSDL Description of Service Broker SCF15 Annex C (informative): Java API Description of the Service Broker SCF .16 Annex D (informative): Contents of
12、 3GPP OSA R7 Service Broker .17 Annex E (informative): Description of Service Broker for 3GPP2 cdma2000 networks.18 ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 4 E.1 General Exceptions.18 E.2 Specific Exceptions18 E.2.1 Clause 1: Scope 18 E.2.2 Clause 2: References 18 E.2.3 Clause 3: Definitions and ab
13、breviations.18 E.2.4 Clause 4: Service Broker SCF18 E.2.5 Clause 5: Sequence Diagrams 18 E.2.6 Clause 6: Class Diagrams.18 E.2.7 Clause 7: The Service Interface Specifications 18 E.2.8 Clause 8: Service Broker Interface Classes19 E.2.9 Clause 9: State Transition Diagrams 19 E.2.10 Clause 10: Service
14、 Broker Service Properties19 E.2.11 Clause 11: Data Definitions19 E.2.12 Annex A (normative): OMG IDL Description of Service Broker SCF19 E.2.13 Annex B (informative): W3C WSDL Description of Service Broker SCF19 Annex F (informative): Record of changes 20 F.1 Interfaces 20 F.1.1 New 20 F.1.2 Deprec
15、ated20 F.1.3 Removed.20 F.2 Methods20 F.2.1 New 20 F.2.2 Deprecated20 F.2.3 Modified.21 F.2.4 Removed.21 F.3 Data Definitions .21 F.3.1 New 21 F.3.2 Modified.21 F.3.3 Removed.21 F.4 Service Properties.21 F.4.1 New 21 F.4.2 Deprecated22 F.4.3 Modified.22 F.4.4 Removed.22 F.5 Exceptions 22 F.5.1 New 2
16、2 F.5.2 Modified.22 F.5.3 Removed.22 F.6 Others .22 History 23 ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 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 public
17、ly 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 available from the ETSI Secretariat. Latest updates are available on the ETSI W
18、eb 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 referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or
19、 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 (TISPAN). The present document is part 16 of a multi-part deliverable cov
20、ering Open Service Access (OSA); Application Programming Interface (API), as identified below. The API specification (ES 204 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“;
21、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 SCF“; Part 13: “Policy Management SCF“; Part 14: “Presence and Availability Man
22、agement SCF“; Part 15: “Multi-Media Messaging SCF“; Part 16: “Service Broker 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 pa
23、rt of the Parlay 6.0 set of specifications. The present document is equivalent to 3GPP TS 29.198-16 V1.0.0 (Release 7). ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 6 1 Scope The present document is part 16 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Acce
24、ss (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 Service Broker Service Capability Feature (SCF) aspects of the interface. All
25、 aspects of the Service Broker 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. The process by which this task is accomplished is through th
26、e use of object modelling techniques described by the Unified Modelling Language (UML). 2 References The references listed in clause 2 of ES 204 915-1 contain provisions which, through reference in this text, constitute provisions of the present document. ETSI ES 204 915-1: “Open Service Access (OSA
27、); Application Programming Interface (API); Part 1: Overview (Parlay 6)“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 204 915-1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations giv
28、en in ES 204 915-1 apply. ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 7 4 Service Broker SCF The following clauses describe each aspect of the Service Broker 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 imple
29、mented. The Class relationships clause shows how each of the interfaces 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 sta
30、tes in the SCF. The states and transitions are well-defined; either 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 wi
31、thin 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 204 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 docu
32、ment, 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 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 tha
33、t 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 be returned. 5 Sequence Diagrams There are no Sequence Diagrams for the Service Broker SCF. ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 8 6 Class D
34、iagrams IpServiceBrokerregister()unregister()(from svcbroker)IpServicesetCallback()setCallbackWithSessionI.(f ro m c sa p i)Figure 1: Service Broker Interfaces Overview 7 The Service Interface Specifications 7.1 Interface Specification Format This clause defines the interfaces, methods and parameter
35、s 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 methods supported by that interfa
36、ce, 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 Service and the Framework, th
37、e 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 API. Asynchronous methods are
38、 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 must implement the relevant IpApp or Ip
39、Svc 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 those that contain the return result of
40、the method when the method returns. ETSI ETSI ES 204 915-16 V1.1.1 (2008-05) 9 7.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 IpInterface All application, framework and ser
41、vice 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 interact
42、ion, messaging, mobility and connectivity management. The interfaces that are implemented by the services are denoted as Service Interface. The corresponding interfaces that must be implemented by the application (e.g. for API callbacks) are denoted as Application Interface. 7.4 Generic Service Inte
43、rface 7.4.1 Interface Class IpService Inherits from: IpInterface .All service interfaces inherit from the following interface. IpService setCallback (appInterface : in IpInterfaceRef) : void setCallbackWithSessionID (appInterface : in IpInterfaceRef, sessionID : in TpSessionID) : void ETSI ETSI ES 2
44、04 915-16 V1.1.1 (2008-05) 107.4.1.1 Method setCallback() This method specifies the reference address of the callback interface that a service uses to invoke methods on the application. It is not allowed to invoke this method on an interface that uses SessionIDs. Multiple invocations of this method
45、on an interface shall result in multiple callback references being specified. The SCS shall use the most recent callback interface provided by the application using this method. In the event that a callback reference fails or is no longer available, the next most recent callback reference available
46、shall be used. Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks. Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE 7.4.1.2 Method setCallbackWithSessionID() This method specifies the reference address of the applications ca
47、llback interface that a service uses for interactions associated with a specific session ID: e.g. a specific call, or call leg. It is not allowed to invoke this method on an interface that does not use SessionIDs. Multiple invocations of this method on an interface shall result in multiple callback
48、references being specified. The SCS shall use the most recent callback interface provided by the application using this method. In the event that a callback reference fails or is no longer available, the next most recent callback reference available shall be used. Parameters appInterface : in IpInte
49、rfaceRef Specifies a reference to the application interface, which is used for callbacks. sessionID : in TpSessionID Specifies the session for which the service can invoke the applications callback interface. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE 8 Service Broker Interface Classes The Service Broker SCF enables the application to register its interest in particular traffic as part of service interactions. The Service Broker service provides a SCF interface that is calle
