1、 ETSI ES 204 915-3 V1.1.1 (2008-05)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 3: Framework(Parlay 6)floppy3 ETSI ETSI ES 204 915-3 V1.1.1 (2008-05) 2 Reference DES/TISPAN-01032-3-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-06921 Sophia Anti
2、polis 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 prese
3、nt 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/sta
5、tus/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 restricti
6、on 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 Mark
7、 of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 204 915-3 V1.1.1 (2008-05) 3 Contents Intellectual Property Rights13 Foreword.13 1 Scope 14 2 References 14 3 Definitions and abbreviations.14 3.1 Definitions14 3.2 Abbreviations .14 4 Overview o
8、f 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 Interface Class IpInterface 17 5.3 Service Interfaces .17 5.3.1 Overview
9、 17 5.4 Generic Service Interface .18 5.4.1 Interface Class IpService 18 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 Security Management Sequence Diagrams 19 6.1.1.1 Initial Access.19 6.1.1.2 Fr
10、amework 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 Interface Classes .25 6.3.1.1 Interface Class IpClientAPILevelAuthent
11、ication25 6.3.1.1.1 Method abortAuthentication() .25 6.3.1.1.2 Method authenticationSucceeded() .26 6.3.1.1.3 Method challenge()26 6.3.1.2 Interface Class IpClientAccess27 6.3.1.2.1 Method terminateAccess().27 6.3.1.3 Interface Class IpInitial .28 6.3.1.3.1 Method initiateAuthenticationWithVersion()
12、28 6.3.1.4 Interface Class IpAuthentication.29 6.3.1.4.1 Method requestAccess() 30 6.3.1.5 Interface Class IpAPILevelAuthentication .30 6.3.1.5.1 Method abortAuthentication() .31 6.3.1.5.2 Method authenticationSucceeded() .31 6.3.1.5.3 Method selectAuthenticationMechanism()31 6.3.1.5.4 Method challe
13、nge()32 6.3.1.6 Interface Class IpAccess .33 6.3.1.6.1 Method obtainInterface().33 6.3.1.6.2 Method obtainInterfaceWithCallback().34 6.3.1.6.3 Method listInterfaces() 34 6.3.1.6.4 Method selectSigningAlgorithm().34 ETSI ETSI ES 204 915-3 V1.1.1 (2008-05) 4 6.3.1.6.5 Method terminateAccess().35 6.3.1
14、.6.6 Method relinquishInterface().35 6.4 State Transition Diagrams 36 6.4.1 Trust and Security Management State Transition Diagrams 36 6.4.1.1 State Transition Diagrams for IpInitial .36 6.4.1.2 State Transition Diagrams for IpAPILevelAuthentication37 6.4.1.2.1 Idle State37 6.4.1.2.2 Authenticating
15、Framework State .38 6.4.1.2.3 Framework Authenticated State 38 6.4.1.2.4 Authenticating Client State38 6.4.1.2.5 Client Authenticated State .38 6.4.1.2.6 Idle State39 6.4.1.2.7 Authenticating Framework State .39 6.4.1.2.8 Framework Authenticated State 39 6.4.1.2.9 Authenticating Client State40 6.4.1
16、.2.10 Client Authenticated State .40 6.4.1.3 State Transition Diagrams for IpAccess40 6.4.1.3.1 Active State .41 7 Framework-to-Application API .41 7.1 Sequence Diagrams 41 7.1.1 Event Notification Sequence Diagrams 41 7.1.1.1 Enable Event Notification .41 7.1.2 Integrity Management Sequence Diagram
17、s 42 7.1.2.1 Load Management: Suspend/resume notification from application42 7.1.2.2 Load Management: Framework queries load statistics .43 7.1.2.3 Load Management: Framework callback registration and Application load control 44 7.1.2.4 Load Management: Application reports current load condition45 7
18、.1.2.5 Load Management: Application queries load statistics.45 7.1.2.6 Load Management: Application callback registration and load control46 7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .47 7.1.2.8 Fault Management: Framework detects a Service failure .48
19、7.1.2.9 Fault Management: Application requests a Framework activity test 49 7.1.3 Service Agreement Management Sequence Diagrams .49 7.1.3.1 Service Selection.49 7.1.4 Service Discovery Sequence Diagrams 51 7.1.4.1 Service Discovery .51 7.2 Class Diagrams.53 7.3 Interface Classes.55 7.3.1 Service Di
20、scovery Interface Classes.55 7.3.1.1 Interface Class IpServiceDiscovery 55 7.3.1.1.1 Method listServiceTypes() 56 7.3.1.1.2 Method describeServiceType()56 7.3.1.1.3 Method discoverService()57 7.3.1.1.4 Method listSubscribedServices().58 7.3.2 Service Agreement Management Interface Classes58 7.3.2.1
21、Interface Class IpAppServiceAgreementManagement .58 7.3.2.1.1 Method signServiceAgreement().58 7.3.2.1.2 Method terminateServiceAgreement() 59 7.3.2.2 Interface Class IpServiceAgreementManagement 60 7.3.2.2.1 Method signServiceAgreement().60 7.3.2.2.2 Method terminateServiceAgreement() 61 7.3.2.2.3
22、Method selectService()62 7.3.2.2.4 Method initiateSignServiceAgreement() .62 7.3.3 Integrity Management Interface Classes.62 7.3.3.1 Interface Class IpAppFaultManager .62 7.3.3.1.1 Method activityTestRes() 63 7.3.3.1.2 Method appActivityTestReq().63 7.3.3.1.3 Method fwFaultReportInd() .63 7.3.3.1.4
23、Method fwFaultRecoveryInd().64 7.3.3.1.5 Method fwUnavailableInd() .64 7.3.3.1.6 Method activityTestErr() .64 ETSI ETSI ES 204 915-3 V1.1.1 (2008-05) 5 7.3.3.1.7 Method appUnavailableInd().64 7.3.3.1.8 Method svcAvailStatusInd()65 7.3.3.1.9 Method generateFaultStatisticsRecordRes()65 7.3.3.1.10 Meth
24、od generateFaultStatisticsRecordErr() 65 7.3.3.1.11 Method generateFaultStatisticsRecordReq() .66 7.3.3.1.12 Method fwAvailStatusInd().66 7.3.3.2 Interface Class IpFaultManager 66 7.3.3.2.1 Method activityTestReq()67 7.3.3.2.2 Method appActivityTestRes() .67 7.3.3.2.3 Method svcUnavailableInd() .68
25、7.3.3.2.4 Method appActivityTestErr() 68 7.3.3.2.5 Method appAvailStatusInd() .68 7.3.3.2.6 Method generateFaultStatisticsRecordReq() .68 7.3.3.2.7 Method generateFaultStatisticsRecordRes()69 7.3.3.2.8 Method generateFaultStatisticsRecordErr() 69 7.3.3.3 Interface Class IpAppHeartBeatMgmt70 7.3.3.3.
26、1 Method enableAppHeartBeat()70 7.3.3.3.2 Method disableAppHeartBeat().70 7.3.3.3.3 Method changeInterval() .70 7.3.3.4 Interface Class IpAppHeartBeat70 7.3.3.4.1 Method pulse() 71 7.3.3.5 Interface Class IpHeartBeatMgmt.71 7.3.3.5.1 Method enableHeartBeat() 71 7.3.3.5.2 Method disableHeartBeat()72
27、7.3.3.5.3 Method changeInterval() .72 7.3.3.6 Interface Class IpHeartBeat 72 7.3.3.6.1 Method pulse() 72 7.3.3.7 Interface Class IpAppLoadManager .73 7.3.3.7.1 Method loadLevelNotification()73 7.3.3.7.2 Method resumeNotification() 73 7.3.3.7.3 Method suspendNotification().74 7.3.3.7.4 Method createL
28、oadLevelNotification() .74 7.3.3.7.5 Method destroyLoadLevelNotification().74 7.3.3.7.6 Method queryAppLoadStatsReq().74 7.3.3.7.7 Method queryLoadStatsRes() 74 7.3.3.7.8 Method queryLoadStatsErr().75 7.3.3.8 Interface Class IpLoadManager 75 7.3.3.8.1 Method reportLoad() .76 7.3.3.8.2 Method createL
29、oadLevelNotification() .76 7.3.3.8.3 Method destroyLoadLevelNotification().76 7.3.3.8.4 Method resumeNotification() 77 7.3.3.8.5 Method suspendNotification().77 7.3.3.8.6 Method queryLoadStatsReq()77 7.3.3.8.7 Method queryAppLoadStatsRes() .78 7.3.3.8.8 Method queryAppLoadStatsErr()78 7.3.3.9 Interf
30、ace Class IpOAM .78 7.3.3.9.1 Method systemDateTimeQuery() 79 7.3.3.10 Interface Class IpAppOAM 79 7.3.3.10.1 Method systemDateTimeQuery() 79 7.3.4 Event Notification Interface Classes.80 7.3.4.1 Interface Class IpAppEventNotification .80 7.3.4.1.1 Method reportNotification() 80 7.3.4.1.2 Method not
31、ificationTerminated() 80 7.3.4.2 Interface Class IpEventNotification 81 7.3.4.2.1 Method createNotification() 81 7.3.4.2.2 Method destroyNotification() 81 7.4 State Transition Diagrams 82 7.4.1 Service Discovery State Transition Diagrams 82 7.4.1.1 State Transition Diagrams for IpServiceDiscovery.82
32、 7.4.1.1.1 Active State .82 7.4.2 Service Agreement Management State Transition Diagrams .82 7.4.3 Integrity Management State Transition Diagrams 83 ETSI ETSI ES 204 915-3 V1.1.1 (2008-05) 6 7.4.3.1 State Transition Diagrams for IpLoadManager.83 7.4.3.1.1 Idle State83 7.4.3.1.2 Notification Suspende
33、d State.83 7.4.3.1.3 Active State .83 7.4.3.2 State Transition Diagrams for LoadManagerInternal84 7.4.3.2.1 Normal load State84 7.4.3.2.2 Application Overload State .84 7.4.3.2.3 Internal overload State.84 7.4.3.2.4 Internal and Application Overload State .84 7.4.3.3 State Transition Diagrams for Ip
34、OAM85 7.4.3.3.1 Active State .85 7.4.3.4 State Transition Diagrams for IpFaultManager.85 7.4.3.4.1 Framework Active State 85 7.4.3.4.2 Framework Faulty State.86 7.4.3.4.3 Framework Activity Test State86 7.4.3.4.4 Service Activity Test State 86 7.4.4 Event Notification State Transition Diagrams 86 7.
35、4.4.1 State Transition Diagrams for IpEventNotification 86 8 Framework-to-Enterprise Operator API.86 8.1 Sequence Diagrams 91 8.1.1 Event Notification Sequence Diagrams 91 8.1.2 Service Subscription Sequence Diagrams.91 8.1.2.1 Service Discovery and Subscription Scenario.91 8.1.2.2 Enterprise Operat
36、or and Client Application Subscription Management Sequence Diagram 93 8.2 Class Diagrams.95 8.3 Interface Classes.96 8.3.1 Event Notification Interface Classes.96 8.3.1.1 Interface Class IpClientEventNotification 96 8.3.1.1.1 Method reportNotification() 97 8.3.1.1.2 Method notificationTerminated() 9
37、7 8.3.1.2 Interface Class IpEventNotification 97 8.3.1.2.1 Method createNotification() 98 8.3.1.2.2 Method destroyNotification() 98 8.3.2 Service Subscription Interface Classes .98 8.3.2.1 Interface Class IpClientAppManagement .98 8.3.2.1.1 Method createClientApp().99 8.3.2.1.2 Method modifyClientAp
38、p().99 8.3.2.1.3 Method deleteClientApp().100 8.3.2.1.4 Method createSAG() .100 8.3.2.1.5 Method modifySAG() .100 8.3.2.1.6 Method deleteSAG() .100 8.3.2.1.7 Method addSAGMembers() 101 8.3.2.1.8 Method removeSAGMembers() 101 8.3.2.1.9 Method requestConflictInfo()101 8.3.2.2 Interface Class IpClientA
39、ppInfoQuery .102 8.3.2.2.1 Method describeClientApp() .103 8.3.2.2.2 Method listClientApps()103 8.3.2.2.3 Method describeSAG()103 8.3.2.2.4 Method listSAGs().104 8.3.2.2.5 Method listSAGMembers() .104 8.3.2.2.6 Method listClientAppMembership() .104 8.3.2.3 Interface Class IpServiceProfileManagement
40、.104 8.3.2.3.1 Method createServiceProfile().105 8.3.2.3.2 Method modifyServiceProfile().105 8.3.2.3.3 Method deleteServiceProfile().106 8.3.2.3.4 Method assign().106 8.3.2.3.5 Method deassign() .106 8.3.2.3.6 Method requestConflictInfo()107 8.3.2.4 Interface Class IpServiceProfileInfoQuery .107 8.3
41、.2.4.1 Method listServiceProfiles()108 8.3.2.4.2 Method describeServiceProfile().108 ETSI ETSI ES 204 915-3 V1.1.1 (2008-05) 7 8.3.2.4.3 Method listAssignedMembers() 108 8.3.2.5 Interface Class IpServiceContractManagement 109 8.3.2.5.1 Method createServiceContract()109 8.3.2.5.2 Method modifyService
42、Contract()110 8.3.2.5.3 Method deleteServiceContract()110 8.3.2.6 Interface Class IpServiceContractInfoQuery 110 8.3.2.6.1 Method describeServiceContract() 110 8.3.2.6.2 Method listServiceContracts().111 8.3.2.6.3 Method listServiceProfiles()111 8.3.2.7 Interface Class IpEntOpAccountManagement111 8.
43、3.2.7.1 Method modifyEntOpAccount()112 8.3.2.7.2 Method deleteEntOpAccount()112 8.3.2.8 Interface Class IpEntOpAccountInfoQuery 112 8.3.2.8.1 Method describeEntOpAccount()113 8.4 State Transition Diagrams 113 8.4.1 Event Notification State Transition Diagrams 113 8.4.2 Service Subscription State Tra
44、nsition Diagrams.113 9 Framework-to-Service API 114 9.1 Sequence Diagrams 114 9.1.1 Service Discovery Sequence Diagrams 114 9.1.2 Service Registration Sequence Diagrams .114 9.1.2.1 New SCF Sub Type Registration 114 9.1.2.2 New SCF Registration.114 9.1.3 Service Instance Lifecycle Manager Sequence D
45、iagrams 116 9.1.3.1 Sign Service Agreement116 9.1.4 Integrity Management Sequence Diagrams 117 9.1.4.1 Load Management: Service callback registration and load control.117 9.1.4.2 Load Management: Framework callback registration and service load control118 9.1.4.3 Load Management: Client and Service
46、Load Balancing.120 9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service121 9.1.4.5 Fault Management: Service requests Framework activity test121 9.1.4.6 Fault Management: Service requests Application activity test .122 9.1.4.7 Fault Management: Application requests Se
47、rvice activity test .123 9.1.4.8 Fault Management: Application detects service is unavailable.124 9.1.5 Event Notification Sequence Diagrams 124 9.2 Class Diagrams.125 9.3 Interface Classes.127 9.3.1 Service Registration Interface Classes127 9.3.1.1 Interface Class IpFwServiceRegistration 127 9.3.1.
48、1.1 Method registerService() .127 9.3.1.1.2 Method announceServiceAvailability().128 9.3.1.1.3 Method unregisterService() .129 9.3.1.1.4 Method describeService()129 9.3.1.1.5 Method unannounceService()130 9.3.1.1.6 Method registerServiceSubType().130 9.3.2 Service Instance Lifecycle Manager Interfac
49、e Classes.131 9.3.2.1 Interface Class IpServiceInstanceLifecycleManager 131 9.3.2.1.1 Method createServiceManager() .131 9.3.2.1.2 Method destroyServiceManager() .132 9.3.3 Service Discovery Interface Classes.132 9.3.3.1 Interface Class IpFwServiceDiscovery .132 9.3.3.1.1 Method listServiceTypes() 133 9.3.3.1.2 Method describeServiceType()133 9.3.3.1.3 Method discoverService()134 9.3.3.1.4 Method listRegisteredServices()134 9.3.4 Integrity Management Interface Classes.135 9.3.4.1 Interface Class IpFwFaultManager .135 9.3.4.1.1 Method activityTestReq()135 9.3.4.1.2 Method svcAct
