1、 ETSI ES 201 915-3 V1.5.1 (2005-02)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 3: Framework(Parlay 3)floppy3 ETSI ETSI ES 201 915-3 V1.5.1 (2005-02) 2 Reference RES/TISPAN-01008-03-OSA Keywords API, OSA, IDL, UML ETSI 650 Route des Lucioles F-06921 Sophia Ant
2、ipolis 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 The pres
3、ent 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 printers
4、 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/tb/st
5、atus/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 restrict
6、ion extend to reproduction in all media. European Telecommunications Standards Institute 2005. The Parlay Group 2005. 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 being reg
7、istered 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-3 V1.5.1 (2005-02) 3 Contents Intellectual Property Rights9 Foreword.9 1 Scope 10 2 References 10 3 Definitions and a
8、bbreviations.10 3.1 Definitions10 3.2 Abbreviations .10 4 Overview of the Framework.10 4.1 General requirements on support of methods.12 5 The Base Interface Specification12 5.1 Interface Specification Format .12 5.1.1 Interface Class 12 5.1.2 Method descriptions13 5.1.3 Parameter descriptions13 5.1
9、.4 State Model.13 5.2 Base Interface.13 5.2.1 Interface Class IpInterface 13 5.3 Service Interfaces .13 5.3.1 Overview 13 5.4 Generic Service Interface .13 5.4.1 Interface Class IpService 13 6 Framework Access Session API.15 6.1 Sequence Diagrams 15 6.1.1 Trust and Security Management Sequence Diagr
10、ams 15 6.1.1.1 Initial Access for trusted parties15 6.1.1.2 Initial Access.15 6.1.1.3 Authentication.17 6.1.1.4 API Level Authentication .17 6.2 Class Diagrams.19 6.3 Interface Classes.19 6.3.1 Trust and Security Management Interface Classes .19 6.3.1.1 Interface Class IpClientAPILevelAuthentication
11、20 6.3.1.2 Interface Class IpClientAccess21 6.3.1.3 Interface Class IpInitial .22 6.3.1.4 Interface Class IpAuthentication.23 6.3.1.5 Interface Class IpAPILevelAuthentication .24 6.3.1.6 Interface Class IpAccess .26 6.4 State Transition Diagrams 28 6.4.1 Trust and Security Management State Transitio
12、n Diagrams 28 6.4.1.1 State Transition Diagrams for IpInitial .28 6.4.1.2 State Transition Diagrams for IpAPILevelAuthentication29 6.4.1.2.1 Idle State29 6.4.1.2.2 Selecting Method State29 6.4.1.2.3 Authenticating Client State30 6.4.1.2.4 Client Authenticated State .30 6.4.1.3 State Transition Diagr
13、ams for IpAccess30 6.4.1.3.1 Active State .31 7 Framework-to-Application API .31 7.1 Sequence Diagrams 31 7.1.1 Event Notification Sequence Diagrams 31 7.1.1.1 Enable Event Notification .31 7.1.2 Integrity Management Sequence Diagrams 33 ETSI ETSI ES 201 915-3 V1.5.1 (2005-02) 4 7.1.2.1 Load Managem
14、ent: Suspend/resume notification from application33 7.1.2.2 Load Management: Framework queries load statistics .34 7.1.2.3 Load Management: Framework callback registration and Application load control 35 7.1.2.4 Load Management: Application reports current load condition36 7.1.2.5 Load Management: A
15、pplication queries load statistics.36 7.1.2.6 Load Management: Application callback registration and load control37 7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .38 7.1.2.8 Fault Management: Framework detects a Service failure .39 7.1.2.9 Fault Management:
16、 Application requests a Framework activity test 40 7.1.3 Service Discovery Sequence Diagrams 40 7.1.3.1 Service Discovery .40 7.1.4 Service Agreement Management Sequence Diagrams .42 7.1.4.1 Service Selection.42 7.2 Class Diagrams.44 7.3 Interface Classes.47 7.3.1 Service Discovery Interface Classes
17、.47 7.3.1.1 Interface Class IpServiceDiscovery 47 7.3.2 Service Agreement Management Interface Classes50 7.3.2.1 Interface Class IpAppServiceAgreementManagement .50 7.3.2.2 Interface Class IpServiceAgreementManagement 52 7.3.3 Integrity Management Interface Classes.54 7.3.3.1 Interface Class IpAppFa
18、ultManager .54 7.3.3.2 Interface Class IpFaultManager 58 7.3.3.3 Interface Class IpAppHeartBeatMgmt61 7.3.3.4 Interface Class IpAppHeartBeat62 7.3.3.5 Interface Class IpHeartBeatMgmt.62 7.3.3.6 Interface Class IpHeartBeat 63 7.3.3.7 Interface Class IpAppLoadManager .64 7.3.3.8 Interface Class IpLoad
19、Manager 66 7.3.3.9 Interface Class IpOAM .69 7.3.3.10 Interface Class IpAppOAM 70 7.3.4 Event Notification Interface Classes.71 7.3.4.1 Interface Class IpAppEventNotification .71 7.3.4.2 Interface Class IpEventNotification 71 7.4 State Transition Diagrams 72 7.4.1 Service Discovery State Transition
20、Diagrams 73 7.4.1.1 State Transition Diagrams for IpServiceDiscovery.73 7.4.1.1.1 Active State .73 7.4.2 Service Agreement Management State Transition Diagrams .73 7.4.3 Integrity Management State Transition Diagrams 74 7.4.3.1 State Transition Diagrams for IpLoadManager.74 7.4.3.1.1 Idle State74 7.
21、4.3.1.2 Notification Suspended State.74 7.4.3.1.3 Active State .74 7.4.3.2 State Transition Diagrams for LoadManagerInternal75 7.4.3.2.1 Normal load State75 7.4.3.2.2 Application Overload State .75 7.4.3.2.3 Internal overload State.75 7.4.3.2.4 Internal and Application Overload State .75 7.4.3.3 Sta
22、te Transition Diagrams for IpOAM76 7.4.3.3.1 Active State .76 7.4.3.4 State Transition Diagrams for IpFaultManager.77 7.4.3.4.1 Framework Active State 77 7.4.3.4.2 Framework Faulty State.77 7.4.3.4.3 Framework Activity Test State77 7.4.3.4.4 Service Activity Test State 77 7.4.4 Event Notification St
23、ate Transition Diagrams 78 7.4.4.1 State Transition Diagrams for IpEventNotification 78 8 Framework-to-Enterprise Operator API.78 8.1 Sequence Diagrams 82 8.1.1 Service Subscription Sequence Diagrams.82 ETSI ETSI ES 201 915-3 V1.5.1 (2005-02) 5 8.1.1.1 Service Discovery and Subscription Scenario.82
24、8.1.1.2 Enterprise Operator and Client Application Subscription Management Sequence Diagram 84 8.2 Class Diagrams.87 8.3 Interface Classes.88 8.3.1 Service Subscription Interface Classes .88 8.3.1.1 Interface Class IpClientAppManagement .88 8.3.1.2 Interface Class IpClientAppInfoQuery .92 8.3.1.3 In
25、terface Class IpServiceProfileManagement .94 8.3.1.4 Interface Class IpServiceProfileInfoQuery .96 8.3.1.5 Interface Class IpServiceContractManagement 97 8.3.1.6 Interface Class IpServiceContractInfoQuery 99 8.3.1.7 Interface Class IpEntOpAccountManagement101 8.3.1.8 Interface Class IpEntOpAccountIn
26、foQuery 102 8.4 State Transition Diagrams 102 8.4.1 Service Subscription State Transition Diagrams.102 9 Framework-to-Service API 103 9.1 Sequence Diagrams 103 9.1.1 Service Discovery Sequence Diagrams 103 9.1.2 Service Registration Sequence Diagrams .103 9.1.2.1 New SCF Registration.103 9.1.3 Servi
27、ce Instance Lifecycle Manager Sequence Diagrams 104 9.1.3.1 Sign Service Agreement104 9.1.4 Integrity Management Sequence Diagrams 106 9.1.4.1 Load Management: Service callback registration and load control.106 9.1.4.2 Load Management: Framework callback registration and service load control107 9.1.
28、4.3 Load Management: Client and Service Load Balancing.108 9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service108 9.1.4.5 Fault Management: Service requests Framework activity test109 9.1.4.6 Fault Management: Service requests Application activity test .110 9.1.4.7 F
29、ault Management: Application requests Service activity test .111 9.1.4.8 Fault Management: Application detects service is unavailable.112 9.1.5 Event Notification Sequence Diagrams 112 9.2 Class Diagrams.113 9.3 Interface Classes.115 9.3.1 Service Registration Interface Classes115 9.3.1.1 Interface
30、Class IpFwServiceRegistration 116 9.3.2 Service Instance Lifecycle Manager Interface Classes.119 9.3.2.1 Interface Class IpServiceInstanceLifecycleManager 119 9.3.3 Service Discovery Interface Classes.120 9.3.3.1 Interface Class IpFwServiceDiscovery .120 9.3.4 Integrity Management Interface Classes.
31、123 9.3.4.1 Interface Class IpFwFaultManager .123 9.3.4.2 Interface Class IpSvcFaultManager 126 9.3.4.3 Interface Class IpFwHeartBeatMgmt129 9.3.4.4 Interface Class IpFwHeartBeat .131 9.3.4.5 Interface Class IpSvcHeartBeatMgmt.131 9.3.4.6 Interface Class IpSvcHeartBeat 132 9.3.4.7 Interface Class Ip
32、FwLoadManager .133 9.3.4.8 Interface Class IpSvcLoadManager 136 9.3.4.9 Interface Class IpFwOAM 139 9.3.4.10 Interface Class IpSvcOAM .139 9.3.5 Event Notification Interface Classes.140 9.3.5.1 Interface Class IpFwEventNotification.140 9.3.5.2 Interface Class IpSvcEventNotification 141 9.4 State Tra
33、nsition Diagrams 142 9.4.1 Service Registration State Transition Diagrams .143 9.4.1.1 State Transition Diagrams for IpFwServiceRegistration.143 9.4.1.1.1 SCF Registered State.143 9.4.1.1.2 SCF Announced State143 9.4.2 Service Instance Lifecycle Manager State Transition Diagrams 143 9.4.3 Service Di
34、scovery State Transition Diagrams 144 ETSI ETSI ES 201 915-3 V1.5.1 (2005-02) 6 9.4.4 Integrity Management State Transition Diagrams 144 9.4.4.1 State Transition Diagrams for IpFwLoadManager144 9.4.4.1.1 Idle State144 9.4.4.1.2 Notification Suspended State.144 9.4.4.1.3 Active State .145 9.4.5 Event
35、 Notification State Transition Diagrams 145 10 Service Properties.145 10.1 Service Property Types 145 10.2 General Service Properties .147 10.2.1 Service Name147 10.2.2 Service Version.147 10.2.3 Service Instance ID.147 10.2.4 Service Instance Description.147 10.2.5 Product Name .147 10.2.6 Product
36、Version 148 10.2.7 Supported Interfaces .148 10.2.8 Operation Set 148 11 Data Definitions .148 11.1 Common Framework Data Definitions 148 11.1.1 TpClientAppID .148 11.1.2 TpClientAppIDList.148 11.1.3 TpDomainID.148 11.1.4 TpDomainIDType.149 11.1.5 TpEntOpID .149 11.1.6 TpPropertyName.149 11.1.7 TpPr
37、opertyValue.149 11.1.8 TpProperty149 11.1.9 TpPropertyList149 11.1.10 TpEntOpIDList .149 11.1.11 TpFwID 150 11.1.12 TpService150 11.1.13 TpServiceList150 11.1.14 TpServiceDescription .150 11.1.15 TpServiceID150 11.1.16 TpServiceIDList .150 11.1.17 TpServiceInstanceID 150 11.1.18 TpServiceSpecString
38、150 11.1.19 TpServiceTypeProperty151 11.1.20 TpServiceTypePropertyList151 11.1.21 TpServiceTypePropertyMode.151 11.1.22 TpServicePropertyTypeName.151 11.1.23 TpServicePropertyName.151 11.1.24 TpServicePropertyNameList.151 11.1.25 TpServicePropertyValue.151 11.1.26 TpServicePropertyValueList.151 11.1
39、.27 TpServiceProperty 152 11.1.28 TpServicePropertyList 152 11.1.29 TpServiceSupplierID 152 11.1.30 TpServiceTypeDescription .152 11.1.31 TpServiceTypeName 152 11.1.32 TpServiceTypeNameList 153 11.1.33 TpSubjectType153 11.2 Event Notification Data Definitions.153 11.2.1 TpFwEventName153 11.2.2 TpFwE
40、ventCriteria .153 11.2.3 TpFwEventInfo.154 11.3 Trust and Security Management Data Definitions .154 11.3.1 TpAccessType 154 11.3.2 TpAuthType154 11.3.3 TpEncryptionCapability155 ETSI ETSI ES 201 915-3 V1.5.1 (2005-02) 7 11.3.4 TpEncryptionCapabilityList .155 11.3.5 TpEndAccessProperties155 11.3.6 Tp
41、AuthDomain.155 11.3.7 TpInterfaceName 156 11.3.8 TpInterfaceNameList 156 11.3.9 TpServiceToken156 11.3.10 TpSignatureAndServiceMgr.156 11.3.11 TpSigningAlgorithm.157 11.4 Integrity Management Data Definitions .157 11.4.1 TpActivityTestRes157 11.4.2 TpFaultStatsRecord 157 11.4.3 TpFaultStats157 11.4.
42、4 TpFaultStatisticsError.157 11.4.5 TpFaultStatsSet.158 11.4.6 TpActivityTestID158 11.4.7 TpInterfaceFault .158 11.4.8 TpSvcUnavailReason158 11.4.9 TpFwUnavailReason 158 11.4.10 TpLoadLevel.158 11.4.11 TpLoadThreshold .159 11.4.12 TpLoadInitVal 159 11.4.13 TpLoadPolicy .159 11.4.14 TpLoadStatistic.1
43、59 11.4.15 TpLoadStatisticList.159 11.4.16 TpLoadStatisticData .159 11.4.17 TpLoadStatisticEntityID.160 11.4.18 TpLoadStatisticEntityType.160 11.4.19 TpLoadStatisticInfo 160 11.4.20 TpLoadStatisticInfoType 160 11.4.21 TpLoadStatisticError 160 11.5 Service Subscription Data Definitions .161 11.5.1 Tp
44、PropertyName.161 11.5.2 TpPropertyValue.161 11.5.3 TpProperty161 11.5.4 TpPropertyList161 11.5.5 TpEntOpProperties .161 11.5.6 TpEntOp .161 11.5.7 TpServiceContractID161 11.5.8 TpServiceContractIDList161 11.5.9 TpPersonName .161 11.5.10 TpPostalAddress .162 11.5.11 TpTelephoneNumber162 11.5.12 TpEma
45、il 162 11.5.13 TpHomePage 162 11.5.14 TpPersonProperties.162 11.5.15 TpPerson.162 11.5.16 TpServiceStartDate.162 11.5.17 TpServiceEndDate162 11.5.18 TpServiceRequestor162 11.5.19 TpBillingContact 162 11.5.20 TpServiceSubscriptionProperties163 11.5.21 TpServiceContract 163 11.5.22 TpServiceContractDe
46、scription163 11.5.23 TpClientAppProperties .163 11.5.24 TpClientAppDescription.163 11.5.25 TpSagID163 11.5.26 TpSagIDList .164 11.5.27 TpSagDescription .164 11.5.28 TpSag164 11.5.29 TpServiceProfileID.164 11.5.30 TpServiceProfileIDList.164 11.5.31 TpServiceProfile .164 ETSI ETSI ES 201 915-3 V1.5.1
47、(2005-02) 8 11.5.32 TpServiceProfileDescription.164 12 Exception Classes.165 Annex A (normative): OMG IDL description of Framework167 Annex B (informative): Contents of 3GPP OSA R4 Framework.168 Annex C (informative): Record of changes 169 C.1 Interfaces 169 C.1.1 New 169 C.1.2 Deprecated169 C.1.3 R
48、emoved.169 C.2 Methods170 C.2.1 New 170 C.2.2 Deprecated170 C.2.3 Modified.170 C.2.4 Removed.170 C.3 Data Definitions .171 C.3.1 New 171 C.3.2 Modified.171 C.3.3 Removed.171 C.4 Service Properties.171 C.4.1 New 171 C.4.2 Deprecated172 C.4.3 Modified.172 C.4.4 Removed.172 C.5 Exceptions 172 C.5.1 New
49、 172 C.5.2 Modified.173 C.5.3 Removed.173 C.6 Others .173 History 174 ETSI ETSI ES 201 915-3 V1.5.1 (2005-02) 9 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 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 a
