1、 ETSI ES 203 915-3 V1.3.1 (2008-04)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 3: Framework(Parlay 5)floppy3 ETSI ETSI ES 203 915-3 V1.3.1 (2008-04) 2 Reference RES/TISPAN-01055-03-OSA Keywords API, IDL, OSA, 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 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 a Trade Mar
7、k of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 203 915-3 V1.3.1 (2008-04) 3 Contents Intellectual Property Rights14 Foreword.14 1 Scope 15 2 References 15 3 Definitions and abbreviations.15 3.1 Definitions15 3.2 Abbreviations .15 4 Overview
8、of the Framework.16 5 The Base Interface Specification17 5.1 Interface Specification Format .17 5.1.1 Interface Class 17 5.1.2 Method descriptions18 5.1.3 Parameter descriptions18 5.1.4 State Model.18 5.2 Base Interface.18 5.2.1 Interface Class IpInterface 18 5.3 Service Interfaces .18 5.3.1 Overvie
9、w 18 5.4 Generic Service Interface .19 5.4.1 Interface Class IpService 19 5.4.1.1 Method setCallback()19 5.4.1.2 Method setCallbackWithSessionID()19 6 Framework Access Session API.20 6.1 Sequence Diagrams 20 6.1.1 Trust and Security Management Sequence Diagrams 20 6.1.1.1 Initial Access.20 6.1.1.2 F
10、ramework Terminates Access .22 6.1.1.3 Application Terminates Access.23 6.1.1.4 Non-API level Authentication.23 6.1.1.5 API Level Authentication .24 6.2 Class Diagrams.26 6.3 Interface Classes.27 6.3.1 Trust and Security Management Interface Classes .27 6.3.1.1 Interface Class IpClientAPILevelAuthen
11、tication27 6.3.1.1.1 Method authenticate().27 6.3.1.1.2 Method abortAuthentication() .28 6.3.1.1.3 Method authenticationSucceeded() .28 6.3.1.1.4 Method challenge()28 6.3.1.2 Interface Class IpClientAccess29 6.3.1.2.1 Method terminateAccess().30 6.3.1.3 Interface Class IpInitial .30 6.3.1.3.1 Method
12、 initiateAuthentication() .31 6.3.1.3.2 Method initiateAuthenticationWithVersion()32 6.3.1.4 Interface Class IpAuthentication.33 6.3.1.4.1 Method requestAccess() 33 6.3.1.5 Interface Class IpAPILevelAuthentication .34 6.3.1.5.1 Method selectEncryptionMethod().34 6.3.1.5.2 Method authenticate().35 6.
13、3.1.5.3 Method abortAuthentication() .36 6.3.1.5.4 Method authenticationSucceeded() .36 6.3.1.5.5 Method selectAuthenticationMechanism()36 6.3.1.5.6 Method challenge()37 6.3.1.6 Interface Class IpAccess .38 ETSI ETSI ES 203 915-3 V1.3.1 (2008-04) 4 6.3.1.6.1 Method obtainInterface().38 6.3.1.6.2 Met
14、hod obtainInterfaceWithCallback().39 6.3.1.6.3 Method endAccess().39 6.3.1.6.4 Method listInterfaces() 40 6.3.1.6.5 Method releaseInterface().40 6.3.1.6.6 Method selectSigningAlgorithm().40 6.3.1.6.7 Method terminateAccess().41 6.3.1.6.8 Method relinquishInterface().41 6.4 State Transition Diagrams
15、42 6.4.1 Trust and Security Management State Transition Diagrams 42 6.4.1.1 State Transition Diagrams for IpInitial .42 6.4.1.2 State Transition Diagrams for IpAPILevelAuthentication43 6.4.1.2.1 Idle State43 6.4.1.2.2 Authenticating Framework State .44 6.4.1.2.3 Framework Authenticated State 44 6.4.
16、1.2.4 Authenticating Client State44 6.4.1.2.5 Client Authenticated State .44 6.4.1.2.6 Idle State45 6.4.1.2.7 Authenticating Framework State .46 6.4.1.2.8 Framework Authenticated State 46 6.4.1.2.9 Authenticating Client State46 6.4.1.2.10 Client Authenticated State .46 6.4.1.2.11 Idle State47 6.4.1.
17、2.12 Authenticating Framework State .47 6.4.1.2.13 Framework Authenticated State 48 6.4.1.2.14 Authenticating Client State48 6.4.1.2.15 Client Authenticated State .48 6.4.1.2.16 Idle State49 6.4.1.2.17 Authenticating Framework State .49 6.4.1.2.18 Framework Authenticated State 50 6.4.1.2.19 Authenti
18、cating Client State50 6.4.1.2.20 Client Authenticated State .50 6.4.1.3 State Transition Diagrams for IpAccess51 6.4.1.3.1 Active State .51 7 Framework-to-Application API .52 7.1 Sequence Diagrams 52 7.1.1 Event Notification Sequence Diagrams 52 7.1.1.1 Enable Event Notification .52 7.1.2 Integrity
19、Management Sequence Diagrams 53 7.1.2.1 Load Management: Suspend/resume notification from application53 7.1.2.2 Load Management: Framework queries load statistics .54 7.1.2.3 Load Management: Framework callback registration and Application load control 55 7.1.2.4 Load Management: Application reports
20、 current load condition56 7.1.2.5 Load Management: Application queries load statistics.56 7.1.2.6 Load Management: Application callback registration and load control57 7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .58 7.1.2.8 Fault Management: Framework det
21、ects a Service failure .59 7.1.2.9 Fault Management: Application requests a Framework activity test 60 7.1.3 Service Agreement Management Sequence Diagrams .60 7.1.3.1 Service Selection.60 7.1.4 Service Discovery Sequence Diagrams 62 7.1.4.1 Service Discovery .62 7.2 Class Diagrams.65 7.3 Interface
22、Classes.67 7.3.1 Service Discovery Interface Classes.67 7.3.1.1 Interface Class IpServiceDiscovery 67 7.3.1.1.1 Method listServiceTypes() 68 7.3.1.1.3 Method discoverService()69 7.3.1.1.4 Method listSubscribedServices().70 7.3.2 Service Agreement Management Interface Classes70 7.3.2.1 Interface Clas
23、s IpAppServiceAgreementManagement .70 ETSI ETSI ES 203 915-3 V1.3.1 (2008-04) 5 7.3.2.1.1 Method signServiceAgreement().71 7.3.2.1.2 Method terminateServiceAgreement() 71 7.3.2.2 Interface Class IpServiceAgreementManagement 72 7.3.2.2.1 Method signServiceAgreement().72 7.3.2.2.2 Method terminateServ
24、iceAgreement() 73 7.3.2.2.3 Method selectService()74 7.3.2.2.4 Method initiateSignServiceAgreement() .74 7.3.3 Integrity Management Interface Classes.75 7.3.3.1 Interface Class IpAppFaultManager .75 7.3.3.1.1 Method activityTestRes() 76 7.3.3.1.2 Method appActivityTestReq().76 7.3.3.1.3 Method fwFau
25、ltReportInd() .76 7.3.3.1.4 Method fwFaultRecoveryInd().76 7.3.3.1.5 Method svcUnavailableInd()76 7.3.3.1.6 Method genFaultStatsRecordRes().77 7.3.3.1.7 Method fwUnavailableInd() .77 7.3.3.1.8 Method activityTestErr() .77 7.3.3.1.9 Method genFaultStatsRecordErr()77 7.3.3.1.10 Method appUnavailableIn
26、d().78 7.3.3.1.11 Method genFaultStatsRecordReq() 78 7.3.3.1.12 Method svcAvailStatusInd()78 7.3.3.1.13 Method generateFaultStatisticsRecordRes().78 7.3.3.1.14 Method generateFaultStatisticsRecordErr()79 7.3.3.1.15 Method generateFaultStatisticsRecordReq().79 7.3.3.1.16 Method fwAvailStatusInd() 79
27、7.3.3.2 Interface Class IpFaultManager 80 7.3.3.2.1 Method activityTestReq()81 7.3.3.2.2 Method appActivityTestRes() .81 7.3.3.2.3 Method svcUnavailableInd() .81 7.3.3.2.4 Method genFaultStatsRecordReq() 82 7.3.3.2.5 Method appActivityTestErr() 82 7.3.3.2.6 Method appUnavailableInd()82 7.3.3.2.7 Met
28、hod genFaultStatsRecordRes().83 7.3.3.2.8 Method genFaultStatsRecordErr()83 7.3.3.2.9 Method appAvailStatusInd() .83 7.3.3.2.10 Method generateFaultStatisticsRecordReq().84 7.3.3.2.11 Method generateFaultStatisticsRecordRes().84 7.3.3.2.12 Method generateFaultStatisticsRecordErr()85 7.3.3.3 Interfac
29、e Class IpAppHeartBeatMgmt85 7.3.3.3.1 Method enableAppHeartBeat()85 7.3.3.3.2 Method disableAppHeartBeat().86 7.3.3.3.3 Method changeInterval() .86 7.3.3.4 Interface Class IpAppHeartBeat86 7.3.3.4.1 Method pulse() 86 7.3.3.5 Interface Class IpHeartBeatMgmt.86 7.3.3.5.1 Method enableHeartBeat() 87 7
30、.3.3.5.2 Method disableHeartBeat()87 7.3.3.5.3 Method changeInterval() .87 7.3.3.6 Interface Class IpHeartBeat 88 7.3.3.6.1 Method pulse() 88 7.3.3.7 Interface Class IpAppLoadManager .88 7.3.3.7.1 Method queryAppLoadReq() .89 7.3.3.7.2 Method queryLoadRes().89 7.3.3.7.3 Method queryLoadErr() .90 7.3
31、.3.7.4 Method loadLevelNotification()90 7.3.3.7.5 Method resumeNotification() 90 7.3.3.7.6 Method suspendNotification().90 7.3.3.7.7 Method createLoadLevelNotification() .90 7.3.3.7.8 Method destroyLoadLevelNotification().91 7.3.3.7.9 Method queryAppLoadStatsReq() 91 7.3.3.7.10 Method queryLoadStats
32、Res() .91 7.3.3.7.11 Method queryLoadStatsErr() 91 ETSI ETSI ES 203 915-3 V1.3.1 (2008-04) 6 7.3.3.8 Interface Class IpLoadManager 92 7.3.3.8.1 Method reportLoad() .93 7.3.3.8.2 Method queryLoadReq() 93 7.3.3.8.3 Method queryAppLoadRes()93 7.3.3.8.4 Method queryAppLoadErr().94 7.3.3.8.5 Method creat
33、eLoadLevelNotification() .94 7.3.3.8.6 Method destroyLoadLevelNotification().94 7.3.3.8.7 Method resumeNotification() 95 7.3.3.8.8 Method suspendNotification().95 7.3.3.8.9 Method queryLoadStatsReq().95 7.3.3.8.10 Method queryAppLoadStatsRes().96 7.3.3.8.11 Method queryAppLoadStatsErr()96 7.3.3.9 In
34、terface Class IpOAM .97 7.3.3.9.1 Method systemDateTimeQuery() 97 7.3.3.10 Interface Class IpAppOAM 97 7.3.3.10.1 Method systemDateTimeQuery() 98 7.3.4 Event Notification Interface Classes.98 7.3.4.1 Interface Class IpAppEventNotification .98 7.3.4.1.1 Method reportNotification() 98 7.3.4.1.2 Method
35、 notificationTerminated() 98 7.3.4.2 Interface Class IpEventNotification 99 7.3.4.2.1 Method createNotification() 99 7.3.4.2.2 Method destroyNotification() 99 7.4 State Transition Diagrams 100 7.4.1 Service Discovery State Transition Diagrams 100 7.4.1.1 State Transition Diagrams for IpServiceDiscov
36、ery.100 7.4.1.1.1 Active State .100 7.4.2 Service Agreement Management State Transition Diagrams .100 7.4.3 Integrity Management State Transition Diagrams 101 7.4.3.1 State Transition Diagrams for IpLoadManager.101 7.4.3.1.1 Idle State101 7.4.3.1.2 Notification Suspended State.101 7.4.3.1.3 Active S
37、tate .102 7.4.3.2 State Transition Diagrams for LoadManagerInternal102 7.4.3.2.1 Normal load State102 7.4.3.2.2 Application Overload State .102 7.4.3.2.3 Internal overload State.102 7.4.3.2.4 Internal and Application Overload State .103 7.4.3.3 State Transition Diagrams for IpOAM103 7.4.3.3.1 Active
38、 State .103 7.4.3.4 State Transition Diagrams for IpFaultManager.103 7.4.3.4.1 Framework Active State 104 7.4.3.4.2 Framework Faulty State.104 7.4.3.4.3 Framework Activity Test State104 7.4.3.4.4 Service Activity Test State 104 7.4.4 Event Notification State Transition Diagrams 104 7.4.4.1 State Tra
39、nsition Diagrams for IpEventNotification 104 8 Framework-to-Enterprise Operator API.104 8.1 Sequence Diagrams 108 8.1.1 Event Notification Sequence Diagrams 108 8.1.2 Service Subscription Sequence Diagrams.108 8.1.2.1 Service Discovery and Subscription Scenario.108 8.1.2.2 Enterprise Operator and Cl
40、ient Application Subscription Management Sequence Diagram 110 8.2 Class Diagrams.112 8.3 Interface Classes.113 8.3.1 Event Notification Interface Classes.113 8.3.1.1 Interface Class IpClientEventNotification 113 8.3.1.1.1 Method reportNotification() 114 8.3.1.1.2 Method notificationTerminated() 114
41、8.3.1.2 Interface Class IpEventNotification 114 8.3.1.2.1 Method createNotification() 115 ETSI ETSI ES 203 915-3 V1.3.1 (2008-04) 7 8.3.1.2.2 Method destroyNotification() 115 8.3.2 Service Subscription Interface Classes .115 8.3.2.1 Interface Class IpClientAppManagement .115 8.3.2.1.1 Method createC
42、lientApp().116 8.3.2.1.2 Method modifyClientApp().116 8.3.2.1.3 Method deleteClientApp().117 8.3.2.1.4 Method createSAG() .117 8.3.2.1.5 Method modifySAG() .117 8.3.2.1.6 Method deleteSAG() .118 8.3.2.1.7 Method addSAGMembers() 118 8.3.2.1.8 Method removeSAGMembers() 118 8.3.2.1.9 Method requestConf
43、lictInfo()119 8.3.2.2 Interface Class IpClientAppInfoQuery .119 8.3.2.2.1 Method describeClientApp() .120 8.3.2.2.2 Method listClientApps()120 8.3.2.2.3 Method describeSAG()121 8.3.2.2.4 Method listSAGs().121 8.3.2.2.5 Method listSAGMembers() .121 8.3.2.2.6 Method listClientAppMembership() .122 8.3.
44、2.3 Interface Class IpServiceProfileManagement .122 8.3.2.3.1 Method createServiceProfile().123 8.3.2.3.2 Method modifyServiceProfile().123 8.3.2.3.3 Method deleteServiceProfile().123 8.3.2.3.4 Method assign().124 8.3.2.3.5 Method deassign() .124 8.3.2.3.6 Method requestConflictInfo()124 8.3.2.4 Int
45、erface Class IpServiceProfileInfoQuery .125 8.3.2.4.1 Method listServiceProfiles()125 8.3.2.4.2 Method describeServiceProfile().126 8.3.2.4.3 Method listAssignedMembers() 126 8.3.2.5 Interface Class IpServiceContractManagement 126 8.3.2.5.1 Method createServiceContract()127 8.3.2.5.2 Method modifySe
46、rviceContract()127 8.3.2.5.3 Method deleteServiceContract()128 8.3.2.6 Interface Class IpServiceContractInfoQuery 128 8.3.2.6.1 Method describeServiceContract() 128 8.3.2.6.2 Method listServiceContracts().129 8.3.2.6.3 Method listServiceProfiles()129 8.3.2.7 Interface Class IpEntOpAccountManagement1
47、30 8.3.2.7.1 Method modifyEntOpAccount()130 8.3.2.7.2 Method deleteEntOpAccount()130 8.3.2.8 Interface Class IpEntOpAccountInfoQuery 131 8.3.2.8.1 Method describeEntOpAccount()131 8.4 State Transition Diagrams 131 8.4.1 Event Notification State Transition Diagrams 131 8.4.2 Service Subscription Stat
48、e Transition Diagrams.131 9 Framework-to-Service API 132 9.1 Sequence Diagrams 132 9.1.1 Service Discovery Sequence Diagrams 132 9.1.2 Service Registration Sequence Diagrams .132 9.1.2.1 New SCF Sub Type Registration 132 9.1.2.2 New SCF Registration.133 9.1.3 Service Instance Lifecycle Manager Seque
49、nce Diagrams 134 9.1.3.1 Sign Service Agreement134 9.1.4 Integrity Management Sequence Diagrams 135 9.1.4.1 Load Management: Service callback registration and load control.135 9.1.4.2 Load Management: Framework callback registration and service load control136 9.1.4.3 Load Management: Client and Service Load Balancing.137 9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service138 9.1.4.5 Fault Management: Service requests Framework activity test138 9.1.4.6 Fault Management: Service requests Application activity test .139 ETSI ETSI ES 203 915-3 V1.3.
