ETSI ES 202 915-3-2006 Open Service Access (OSA) Application Programming Interface (API) Part 3 Framework (Parlay 4) (V1 4 1 Includes Diskette)《开放业务接入(OSA) 应用编程接口(API) 第3部分 框架(Parl_1.pdf

1、 ETSI ES 202 915-3 V1.4.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 3: Framework(Parlay 4)floppy3 ETSI ETSI ES 202 915-3 V1.4.1 (2006-12) 2 Reference RES/TISPAN-01028-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 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 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 202 915-3 V1.4.1 (2006-12) 3 Contents Intellectual Property Rights13 Foreword.13 1 Scope 14 2 References 14 3 Definitions and

8、 abbreviations.14 3.1 Definitions14 3.2 Abbreviations .14 4 Overview of the Framework.15 5 The Base Interface Specification16 5.1 Interface Specification Format .16 5.1.1 Interface Class 16 5.1.2 Method descriptions17 5.1.3 Parameter descriptions17 5.1.4 State Model.17 5.2 Base Interface.17 5.2.1 In

9、terface Class IpInterface 17 5.3 Service Interfaces .17 5.3.1 Overview 17 5.4 Generic Service Interface .17 5.4.1 Interface Class IpService 17 5.4.1.1 Method setCallback()18 5.4.1.2 Method setCallbackWithSessionID()18 6 Framework Access Session API.19 6.1 Sequence Diagrams 19 6.1.1 Trust and Securit

10、y Management Sequence Diagrams 19 6.1.1.1 Initial Access.19 6.1.1.2 Framework Terminates Access .20 6.1.1.3 Application Terminates Access.21 6.1.1.4 Non-API level Authentication.22 6.1.1.5 API Level Authentication .23 6.2 Class Diagrams.24 6.3 Interface Classes.25 6.3.1 Trust and Security Management

11、 Interface Classes .25 6.3.1.1 Interface Class IpClientAPILevelAuthentication25 6.3.1.1.1 Method authenticate().25 6.3.1.1.2 Method abortAuthentication() .26 6.3.1.1.3 Method authenticationSucceeded() .26 6.3.1.1.4 Method challenge() .26 6.3.1.2 Interface Class IpClientAccess27 6.3.1.2.1 Method term

12、inateAccess().28 6.3.1.3 Interface Class IpInitial .28 6.3.1.3.1 Method initiateAuthentication() .29 6.3.1.3.2 Method initiateAuthenticationWithVersion() .30 6.3.1.4 Interface Class IpAuthentication.31 6.3.1.4.1 Method requestAccess() 31 6.3.1.5 Interface Class IpAPILevelAuthentication .32 6.3.1.5.1

13、 Method selectEncryptionMethod().32 6.3.1.5.2 Method authenticate().33 6.3.1.5.3 Method abortAuthentication() .34 6.3.1.5.4 Method authenticationSucceeded() .34 6.3.1.5.5 Method selectAuthenticationMechanism() .34 6.3.1.5.6 Method challenge() .35 6.3.1.6 Interface Class IpAccess .36 ETSI ETSI ES 202

14、 915-3 V1.4.1 (2006-12) 4 6.3.1.6.1 Method obtainInterface().36 6.3.1.6.2 Method obtainInterfaceWithCallback().37 6.3.1.6.3 Method endAccess().37 6.3.1.6.4 Method listInterfaces() 38 6.3.1.6.5 Method releaseInterface().38 6.3.1.6.6 Method selectSigningAlgorithm() 38 6.3.1.6.7 Method terminateAccess(

15、) 39 6.3.1.6.8 Method relinquishInterface() 39 6.4 State Transition Diagrams 40 6.4.1 Trust and Security Management State Transition Diagrams 40 6.4.1.1 State Transition Diagrams for IpInitial .40 6.4.1.2 State Transition Diagrams for IpAPILevelAuthentication41 6.4.1.2.1 Idle State41 6.4.1.2.2 Authe

16、nticating Framework State .42 6.4.1.2.3 Framework Authenticated State 42 6.4.1.2.4 Authenticating Client State42 6.4.1.2.5 Client Authenticated State .42 6.4.1.2.6 Idle State43 6.4.1.2.7 Authenticating Framework State .44 6.4.1.2.8 Framework Authenticated State 44 6.4.1.2.9 Authenticating Client Sta

17、te44 6.4.1.2.10 Client Authenticated State .44 6.4.1.2.11 Idle State45 6.4.1.2.12 Authenticating Framework State .45 6.4.1.2.13 Framework Authenticated State 46 6.4.1.2.14 Authenticating Client State46 6.4.1.2.15 Client Authenticated State .46 6.4.1.2.16 Idle State47 6.4.1.2.17 Authenticating Framew

18、ork State .47 6.4.1.2.18 Framework Authenticated State 48 6.4.1.2.19 Authenticating Client State48 6.4.1.2.20 Client Authenticated State .48 6.4.1.3 State Transition Diagrams for IpAccess49 6.4.1.3.1 Active State .49 7 Framework-to-Application API .50 7.1 Sequence Diagrams 50 7.1.1 Event Notificatio

19、n Sequence Diagrams 50 7.1.1.1 Enable Event Notification .50 7.1.2 Integrity Management Sequence Diagrams 51 7.1.2.1 Load Management: Suspend/resume notification from application51 7.1.2.2 Load Management: Framework queries load statistics .52 7.1.2.3 Load Management: Framework callback registration

20、 and Application load control 53 7.1.2.4 Load Management: Application reports current load condition54 7.1.2.5 Load Management: Application queries load statistics.54 7.1.2.6 Load Management: Application callback registration and load control55 7.1.2.7 Heartbeat Management: Start/perform/end heartbe

21、at supervision of the application .55 7.1.2.8 Fault Management: Framework detects a Service failure .56 7.1.2.9 Fault Management: Application requests a Framework activity test 57 7.1.3 Service Agreement Management Sequence Diagrams .57 7.1.3.1 Service Selection.57 7.1.4 Service Discovery Sequence D

22、iagrams 59 7.1.4.1 Service Discovery .59 7.2 Class Diagrams.61 7.3 Interface Classes.63 7.3.1 Service Discovery Interface Classes.63 7.3.1.1 Interface Class IpServiceDiscovery 63 7.3.1.1.1 Method listServiceTypes() 64 7.3.1.1.2 Method describeServiceType()64 7.3.1.1.3 Method discoverService()65 7.3.

23、1.1.4 Method listSubscribedServices().66 7.3.2 Service Agreement Management Interface Classes66 ETSI ETSI ES 202 915-3 V1.4.1 (2006-12) 5 7.3.2.1 Interface Class IpAppServiceAgreementManagement .66 7.3.2.1.1 Method signServiceAgreement().66 7.3.2.1.2 Method terminateServiceAgreement() 67 7.3.2.2 Int

24、erface Class IpServiceAgreementManagement 68 7.3.2.2.1 Method signServiceAgreement().68 7.3.2.2.2 Method terminateServiceAgreement() 69 7.3.2.2.3 Method selectService()70 7.3.2.2.4 Method initiateSignServiceAgreement() .70 7.3.3 Integrity Management Interface Classes.71 7.3.3.1 Interface Class IpApp

25、FaultManager .71 7.3.3.1.1 Method activityTestRes() 72 7.3.3.1.2 Method appActivityTestReq().72 7.3.3.1.3 Method fwFaultReportInd() 72 7.3.3.1.4 Method fwFaultRecoveryInd()72 7.3.3.1.5 Method svcUnavailableInd()72 7.3.3.1.6 Method genFaultStatsRecordRes().73 7.3.3.1.7 Method fwUnavailableInd() 73 7.

26、3.3.1.8 Method activityTestErr() .73 7.3.3.1.9 Method genFaultStatsRecordErr()73 7.3.3.1.10 Method appUnavailableInd().74 7.3.3.1.11 Method genFaultStatsRecordReq() 74 7.3.3.1.12 Method svcAvailStatusInd() .74 7.3.3.1.13 Method generateFaultStatisticsRecordRes().74 7.3.3.1.14 Method generateFaultSta

27、tisticsRecordErr()75 7.3.3.1.15 Method generateFaultStatisticsRecordReq().75 7.3.3.2 Interface Class IpFaultManager 75 7.3.3.2.1 Method activityTestReq()76 7.3.3.2.2 Method appActivityTestRes() .77 7.3.3.2.3 Method svcUnavailableInd() .77 7.3.3.2.4 Method genFaultStatsRecordReq() 77 7.3.3.2.5 Method

28、 appActivityTestErr() 78 7.3.3.2.6 Method appUnavailableInd()78 7.3.3.2.7 Method genFaultStatsRecordRes().78 7.3.3.2.8 Method genFaultStatsRecordErr()78 7.3.3.2.9 Method appAvailStatusInd().79 7.3.3.2.10 Method generateFaultStatisticsRecordReq().79 7.3.3.2.11 Method generateFaultStatisticsRecordRes(

29、).80 7.3.3.2.12 Method generateFaultStatisticsRecordErr()80 7.3.3.3 Interface Class IpAppHeartBeatMgmt80 7.3.3.3.1 Method enableAppHeartBeat()81 7.3.3.3.2 Method disableAppHeartBeat().81 7.3.3.3.3 Method changeInterval() .81 7.3.3.4 Interface Class IpAppHeartBeat81 7.3.3.4.1 Method pulse() 81 7.3.3.

30、5 Interface Class IpHeartBeatMgmt.82 7.3.3.5.1 Method enableHeartBeat() 82 7.3.3.5.2 Method disableHeartBeat()82 7.3.3.5.3 Method changeInterval() .82 7.3.3.6 Interface Class IpHeartBeat 83 7.3.3.6.1 Method pulse() 83 7.3.3.7 Interface Class IpAppLoadManager .83 7.3.3.7.1 Method queryAppLoadReq() .8

31、4 7.3.3.7.2 Method queryLoadRes().84 7.3.3.7.3 Method queryLoadErr() .85 7.3.3.7.4 Method loadLevelNotification()85 7.3.3.7.5 Method resumeNotification() 85 7.3.3.7.6 Method suspendNotification().85 7.3.3.7.7 Method createLoadLevelNotification() 85 7.3.3.7.8 Method destroyLoadLevelNotification() 86

32、7.3.3.7.9 Method queryAppLoadStatsReq() 86 7.3.3.7.10 Method queryLoadStatsRes() .86 7.3.3.7.11 Method queryLoadStatsErr() 86 ETSI ETSI ES 202 915-3 V1.4.1 (2006-12) 6 7.3.3.8 Interface Class IpLoadManager 87 7.3.3.8.1 Method reportLoad() .88 7.3.3.8.2 Method queryLoadReq() 88 7.3.3.8.3 Method query

33、AppLoadRes()88 7.3.3.8.4 Method queryAppLoadErr().89 7.3.3.8.5 Method createLoadLevelNotification() .89 7.3.3.8.6 Method destroyLoadLevelNotification().89 7.3.3.8.7 Method resumeNotification() 90 7.3.3.8.8 Method suspendNotification().90 7.3.3.8.9 Method queryLoadStatsReq().90 7.3.3.8.10 Method quer

34、yAppLoadStatsRes().91 7.3.3.8.11 Method queryAppLoadStatsErr()91 7.3.3.9 Interface Class IpOAM .91 7.3.3.9.1 Method systemDateTimeQuery() 92 7.3.3.10 Interface Class IpAppOAM 92 7.3.3.10.1 Method systemDateTimeQuery() 92 7.3.4 Event Notification Interface Classes.93 7.3.4.1 Interface Class IpAppEven

35、tNotification .93 7.3.4.1.1 Method reportNotification() 93 7.3.4.1.2 Method notificationTerminated() 93 7.3.4.2 Interface Class IpEventNotification 93 7.3.4.2.1 Method createNotification() 94 7.3.4.2.2 Method destroyNotification() 94 7.4 State Transition Diagrams 94 7.4.1 Service Discovery State Tra

36、nsition Diagrams 95 7.4.1.1 State Transition Diagrams for IpServiceDiscovery.95 7.4.1.1.1 Active State .95 7.4.2 Service Agreement Management State Transition Diagrams .95 7.4.3 Integrity Management State Transition Diagrams 96 7.4.3.1 State Transition Diagrams for IpLoadManager.96 7.4.3.1.1 Idle St

37、ate96 7.4.3.1.2 Notification Suspended State.96 7.4.3.1.3 Active State .96 7.4.3.2 State Transition Diagrams for LoadManagerInternal97 7.4.3.2.1 Normal load State97 7.4.3.2.2 Application Overload State .97 7.4.3.2.3 Internal overload State.97 7.4.3.2.4 Internal and Application Overload State .97 7.4

38、.3.3 State Transition Diagrams for IpOAM98 7.4.3.3.1 Active State .98 7.4.3.4 State Transition Diagrams for IpFaultManager.98 7.4.3.4.1 Framework Active State 98 7.4.3.4.2 Framework Faulty State.99 7.4.3.4.3 Framework Activity Test State99 7.4.3.4.4 Service Activity Test State 99 7.4.4 Event Notific

39、ation State Transition Diagrams 99 7.4.4.1 State Transition Diagrams for IpEventNotification 99 8 Framework-to-Enterprise Operator API.99 8.1 Sequence Diagrams 103 8.1.1 Service Subscription Sequence Diagrams.103 8.1.1.1 Service Discovery and Subscription Scenario.103 8.1.1.2 Enterprise Operator and

40、 Client Application Subscription Management Sequence Diagram 105 8.2 Class Diagrams.107 8.3 Interface Classes.108 8.3.1 Service Subscription Interface Classes .108 8.3.1.1 Interface Class IpClientAppManagement .108 8.3.1.1.1 Method createClientApp().109 8.3.1.1.2 Method modifyClientApp().109 8.3.1.1

41、.3 Method deleteClientApp().110 8.3.1.1.4 Method createSAG() .110 8.3.1.1.5 Method modifySAG() .110 ETSI ETSI ES 202 915-3 V1.4.1 (2006-12) 7 8.3.1.1.6 Method deleteSAG() .110 8.3.1.1.7 Method addSAGMembers() 111 8.3.1.1.8 Method removeSAGMembers() 111 8.3.1.1.9 Method requestConflictInfo() .112 8.3

42、.1.2 Interface Class IpClientAppInfoQuery .112 8.3.1.2.1 Method describeClientApp() .113 8.3.1.2.2 Method listClientApps()113 8.3.1.2.3 Method describeSAG()113 8.3.1.2.4 Method listSAGs().113 8.3.1.2.5 Method listSAGMembers() .114 8.3.1.2.6 Method listClientAppMembership() .114 8.3.1.3 Interface Cla

43、ss IpServiceProfileManagement .114 8.3.1.3.1 Method createServiceProfile().115 8.3.1.3.2 Method modifyServiceProfile().115 8.3.1.3.3 Method deleteServiceProfile().116 8.3.1.3.4 Method assign().116 8.3.1.3.5 Method deassign() .116 8.3.1.3.6 Method requestConflictInfo() .117 8.3.1.4 Interface Class Ip

44、ServiceProfileInfoQuery .117 8.3.1.4.1 Method listServiceProfiles()118 8.3.1.4.2 Method describeServiceProfile().118 8.3.1.4.3 Method listAssignedMembers() 118 8.3.1.5 Interface Class IpServiceContractManagement 119 8.3.1.5.1 Method createServiceContract()119 8.3.1.5.2 Method modifyServiceContract()

45、119 8.3.1.5.3 Method deleteServiceContract()120 8.3.1.6 Interface Class IpServiceContractInfoQuery 120 8.3.1.6.1 Method describeServiceContract() 120 8.3.1.6.2 Method listServiceContracts().121 8.3.1.6.3 Method listServiceProfiles()121 8.3.1.7 Interface Class IpEntOpAccountManagement121 8.3.1.7.1 Me

46、thod modifyEntOpAccount()122 8.3.1.7.2 Method deleteEntOpAccount()122 8.3.1.8 Interface Class IpEntOpAccountInfoQuery 122 8.3.1.8.1 Method describeEntOpAccount()123 8.4 State Transition Diagrams 123 8.4.1 Service Subscription State Transition Diagrams.123 9 Framework-to-Service API 123 9.1 Sequence

47、Diagrams 123 9.1.1 Service Discovery Sequence Diagrams 123 9.1.2 Service Registration Sequence Diagrams .124 9.1.2.1 New SCF Registration.124 9.1.3 Service Instance Lifecycle Manager Sequence Diagrams 125 9.1.3.1 Sign Service Agreement125 9.1.4 Integrity Management Sequence Diagrams 126 9.1.4.1 Load

48、 Management: Service callback registration and load control.126 9.1.4.2 Load Management: Framework callback registration and service load control127 9.1.4.3 Load Management: Client and Service Load Balancing.128 9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service128

49、9.1.4.5 Fault Management: Service requests Framework activity test129 9.1.4.6 Fault Management: Service requests Application activity test .130 9.1.4.7 Fault Management: Application requests Service activity test .131 9.1.4.8 Fault Management: Application detects service is unavailable.132 9.1.5 Event Notification Sequence Diagrams 132 9.2 Class Diagrams.133 9.3 Interface Classes.135 9.3.1 Service Registration Interface Classes135 9.3.1.1 Interface Class IpFwServiceRegistration 135 9.3.1.1.1 Method registerService() .136 9.3.1.1.2 Method announceServiceAvailability().137 9.3.1.