SIST ES 203 915-3 V1.3.1:2008
Open Service Access (OSA) - Application Programming Interface (API) - Part 3: Framework (Parlay 5)
Open Service Access (OSA) - Application Programming Interface (API) - Part 3: Framework (Parlay 5)
Update of ES 203 915 to become Parlay 5.2. Only those parts requiring modification will be updated (most parts require maintenance fixes).The present document is part 3 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (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 Framework aspects of the interface. All aspects of the Framework are defined in the present document, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL Description of the interfaces.
• WSDL Description of the interfaces.
• Reference to the Java™ API description of the interfaces.
The process by which this task is accomplished is through the use of object modelling techniques described by the Unified Modelling Language (UML).
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 3. del: Okvirje (Parlay 5)
General Information
Buy Standard
Standards Content (Sample)
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)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 203 915-3 V1.3.1 (2008-04)
Reference
RES/TISPAN-01055-03-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 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 enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.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 ETSI 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.etsi.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 foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI ES 203 915-3 V1.3.1 (2008-04)
Contents
Intellectual Property Rights.14
Foreword.14
1 Scope.15
2 References.15
3 Definitions and abbreviations.15
3.1 Definitions.15
3.2 Abbreviations.15
4 Overview of the Framework.16
5 The Base Interface Specification.17
5.1 Interface Specification Format .17
5.1.1 Interface Class.17
5.1.2 Method descriptions.18
5.1.3 Parameter descriptions.18
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 Overview.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 Framework 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 IpClientAPILevelAuthentication.27
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 IpClientAccess.29
6.3.1.2.1 Method terminateAccess().30
6.3.1.3 Interface Class IpInitial .30
6.3.1.3.1 Method <> 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.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
---------------------- Page: 3 ----------------------
4 ETSI ES 203 915-3 V1.3.1 (2008-04)
6.3.1.6.1 Method obtainInterface().38
6.3.1.6.2 Method 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 .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 IpAPILevelAuthentication.43
6.4.1.2.1 Idle State.43
6.4.1.2.2 Authenticating Framework State .44
6.4.1.2.3 Framework Authenticated State.44
6.4.1.2.4 Authenticating Client State.44
6.4.1.2.5 Client Authenticated State .44
6.4.1.2.6 Idle State.45
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 State.46
6.4.1.2.10 Client Authenticated State .46
6.4.1.2.11 Idle State.47
6.4.1.2.12 Authenticating Framework State .47
6.4.1.2.13 Framework Authenticated State.48
6.4.1.2.14 Authenticating Client State.48
6.4.1.2.15 Client Authenticated State .48
6.4.1.2.16 Idle State.49
6.4.1.2.17 Authenticating Framework State .49
6.4.1.2.18 Framework Authenticated State.50
6.4.1.2.19 Authenticating Client State.50
6.4.1.2.20 Client Authenticated State .50
6.4.1.3 State Transition Diagrams for IpAccess.51
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 Management Sequence Diagrams .53
7.1.2.1 Load Management: Suspend/resume notification from application.53
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 current load condition.56
7.1.2.5 Load Management: Application queries load statistics.56
7.1.2.6 Load Management: Application callback registration and load control.57
7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .58
7.1.2.8 Fault Management: Framework detects 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 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 Classes.70
7.3.2.1 Interface Class IpAppServiceAgreementManagement .70
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 203 915-3 V1.3.1 (2008-04)
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 terminateServiceAgreement().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 <> fwFaultReportInd() .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 appUnavailableInd().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
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 Method <> 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 Interface Class IpAppHeartBeatMgmt.85
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 IpAppHeartBeat.86
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.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.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 <> queryLoadStatsRes() .91
7.3.3.7.11 Method <> queryLoadStatsErr() .91
ETSI
---------------------- Page: 5 ----------------------
6 ETSI ES 203 915-3 V1.3.1 (2008-04)
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 createLoadLevelNotification().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().
...
Final draft ETSI ES 203 915-3 V1.3.1 (2008-01)
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 3: Framework
(Parlay 5)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 203 915-3 V1.3.1 (2008-01)
Reference
RES/TISPAN-01055-03-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 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 enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.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 ETSI 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.etsi.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 foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 Final draft ETSI ES 203 915-3 V1.3.1 (2008-01)
Contents
Intellectual Property Rights.14
Foreword.14
1 Scope.15
2 References.15
3 Definitions and abbreviations.15
3.1 Definitions.15
3.2 Abbreviations.15
4 Overview of the Framework.16
5 The Base Interface Specification.17
5.1 Interface Specification Format .17
5.1.1 Interface Class.17
5.1.2 Method descriptions.18
5.1.3 Parameter descriptions.18
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 Overview.18
5.4 Generic Service Interface .18
5.4.1 Interface Class IpService .18
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 Framework Terminates Access.21
6.1.1.3 Application Terminates Access.22
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 IpClientAPILevelAuthentication.27
6.3.1.1.1 Method <> authenticate().28
6.3.1.1.2 Method abortAuthentication().28
6.3.1.1.3 Method authenticationSucceeded().29
6.3.1.1.4 Method challenge().29
6.3.1.2 Interface Class IpClientAccess.30
6.3.1.2.1 Method terminateAccess().30
6.3.1.3 Interface Class IpInitial .31
6.3.1.3.1 Method <> 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().34
6.3.1.5 Interface Class IpAPILevelAuthentication .34
6.3.1.5.1 Method <> selectEncryptionMethod().35
6.3.1.5.2 Method <> authenticate().36
6.3.1.5.3 Method abortAuthentication().36
6.3.1.5.4 Method authenticationSucceeded().36
6.3.1.5.5 Method selectAuthenticationMechanism().37
6.3.1.5.6 Method challenge().37
6.3.1.6 Interface Class IpAccess .38
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 203 915-3 V1.3.1 (2008-01)
6.3.1.6.1 Method obtainInterface().39
6.3.1.6.2 Method obtainInterfaceWithCallback().39
6.3.1.6.3 Method <> endAccess().40
6.3.1.6.4 Method listInterfaces().40
6.3.1.6.5 Method <> releaseInterface().40
6.3.1.6.6 Method selectSigningAlgorithm().41
6.3.1.6.7 Method terminateAccess().41
6.3.1.6.8 Method relinquishInterface().42
6.4 State Transition Diagrams .42
6.4.1 Trust and Security Management State Transition Diagrams .43
6.4.1.1 State Transition Diagrams for IpInitial .43
6.4.1.2 State Transition Diagrams for IpAPILevelAuthentication.44
6.4.1.2.1 Idle State.44
6.4.1.2.2 Authenticating Framework State .45
6.4.1.2.3 Framework Authenticated State.45
6.4.1.2.4 Authenticating Client State.45
6.4.1.2.5 Client Authenticated State .45
6.4.1.2.6 Idle State.46
6.4.1.2.7 Authenticating Framework State .47
6.4.1.2.8 Framework Authenticated State.47
6.4.1.2.9 Authenticating Client State.47
6.4.1.2.10 Client Authenticated State .47
6.4.1.2.11 Idle State.48
6.4.1.2.12 Authenticating Framework State .48
6.4.1.2.13 Framework Authenticated State.49
6.4.1.2.14 Authenticating Client State.49
6.4.1.2.15 Client Authenticated State .49
6.4.1.2.16 Idle State.50
6.4.1.2.17 Authenticating Framework State .50
6.4.1.2.18 Framework Authenticated State.51
6.4.1.2.19 Authenticating Client State.51
6.4.1.2.20 Client Authenticated State .51
6.4.1.3 State Transition Diagrams for IpAccess.52
6.4.1.3.1 Active State.52
7 Framework-to-Application API.53
7.1 Sequence Diagrams.53
7.1.1 Event Notification Sequence Diagrams .53
7.1.1.1 Enable Event Notification .53
7.1.2 Integrity Management Sequence Diagrams .54
7.1.2.1 Load Management: Suspend/resume notification from application.54
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 current load condition.56
7.1.2.5 Load Management: Application queries load statistics.57
7.1.2.6 Load Management: Application callback registration and load control.58
7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .59
7.1.2.8 Fault Management: Framework detects a Service failure .60
7.1.2.9 Fault Management: Application requests a Framework activity test .62
7.1.3 Service Agreement Management Sequence Diagrams .62
7.1.3.1 Service Selection.62
7.1.4 Service Discovery Sequence Diagrams .64
7.1.4.1 Service Discovery.64
7.2 Class Diagrams.67
7.3 Interface Classes.69
7.3.1 Service Discovery Interface Classes.69
7.3.1.1 Interface Class IpServiceDiscovery .69
7.3.1.1.1 Method listServiceTypes().70
7.3.1.1.3 Method discoverService().71
7.3.1.1.4 Method listSubscribedServices().72
7.3.2 Service Agreement Management Interface Classes.72
7.3.2.1 Interface Class IpAppServiceAgreementManagement .72
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 203 915-3 V1.3.1 (2008-01)
7.3.2.1.1 Method signServiceAgreement().72
7.3.2.1.2 Method terminateServiceAgreement().73
7.3.2.2 Interface Class IpServiceAgreementManagement .74
7.3.2.2.1 Method signServiceAgreement().74
7.3.2.2.2 Method terminateServiceAgreement().75
7.3.2.2.3 Method selectService().76
7.3.2.2.4 Method initiateSignServiceAgreement().76
7.3.3 Integrity Management Interface Classes.77
7.3.3.1 Interface Class IpAppFaultManager .77
7.3.3.1.1 Method activityTestRes().78
7.3.3.1.2 Method appActivityTestReq().78
7.3.3.1.3 Method <> fwFaultReportInd() .78
7.3.3.1.4 Method <> fwFaultRecoveryInd().78
7.3.3.1.5 Method <> svcUnavailableInd().78
7.3.3.1.6 Method <> genFaultStatsRecordRes().79
7.3.3.1.7 Method <> fwUnavailableInd() .79
7.3.3.1.8 Method activityTestErr().79
7.3.3.1.9 Method <> genFaultStatsRecordErr().79
7.3.3.1.10 Method appUnavailableInd().80
7.3.3.1.11 Method <> genFaultStatsRecordReq() .80
7.3.3.1.12 Method svcAvailStatusInd().80
7.3.3.1.13 Method <> generateFaultStatisticsRecordRes().80
7.3.3.1.14 Method <> generateFaultStatisticsRecordErr().81
7.3.3.1.15 Method <> generateFaultStatisticsRecordReq().81
7.3.3.1.16 Method <> fwAvailStatusInd().81
7.3.3.2 Interface Class IpFaultManager .82
7.3.3.2.1 Method activityTestReq().82
7.3.3.2.2 Method appActivityTestRes().83
7.3.3.2.3 Method svcUnavailableInd().83
7.3.3.2.4 Method <> genFaultStatsRecordReq() .84
7.3.3.2.5 Method appActivityTestErr().84
7.3.3.2.6 Method <> appUnavailableInd().84
7.3.3.2.7 Method <> genFaultStatsRecordRes().85
7.3.3.2.8 Method <> genFaultStatsRecordErr().85
7.3.3.2.9 Method appAvailStatusInd().85
7.3.3.2.10 Method <> generateFaultStatisticsRecordReq().86
7.3.3.2.11 Method <> generateFaultStatisticsRecordRes().86
7.3.3.2.12 Method <> generateFaultStatisticsRecordErr().86
7.3.3.3 Interface Class IpAppHeartBeatMgmt.87
7.3.3.3.1 Method enableAppHeartBeat().87
7.3.3.3.2 Method disableAppHeartBeat().87
7.3.3.3.3 Method changeInterval().87
7.3.3.4 Interface Class IpAppHeartBeat.88
7.3.3.4.1 Method pulse().88
7.3.3.5 Interface Class IpHeartBeatMgmt.88
7.3.3.5.1 Method enableHeartBeat().88
7.3.3.5.2 Method disableHeartBeat().89
7.3.3.5.3 Method changeInterval().89
7.3.3.6 Interface Class IpHeartBeat .89
7.3.3.6.1 Method pulse().90
7.3.3.7 Interface Class IpAppLoadManager .90
7.3.3.7.1 Method <> queryAppLoadReq() .90
7.3.3.7.2 Method <> queryLoadRes().91
7.3.3.7.3 Method <> queryLoadErr().91
7.3.3.7.4 Method loadLevelNotification().91
7.3.3.7.5 Method resumeNotification().91
7.3.3.7.6 Method suspendNotification().92
7.3.3.7.7 Method createLoadLevelNotification().92
7.3.3.7.8 Method destroyLoadLevelNotification().92
7.3.3.7.9 Method <> queryAppLoadStatsReq() .92
7.3.3.7.10 Method <> queryLoadStatsRes() .92
7.3.3.7.11 Method <> queryLoadStatsErr() .92
ETSI
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 203 915-3 V1.3.1 (2008-01)
7.3.3.8 Interface Class IpLoadManager .93
7.3.3.8.1 Method reportLoad().94
7.3.3.8.2 Method <> queryLoadReq().94
7.3.3.8.3 Method <> queryAppLoadRes().95
7.3.3.8.4 Method <> queryAppLoadErr().95
7.3.3.8.5 Method createLoadLevelNotification().96
7.3.3.8.6 Method destroyLoadLevelNotification().96
7.3.3.8.7 Method resumeNotification().96
7.3.3.8.8 Method suspendNotification().97
7.3.3.8.9 Method <> queryLoadStatsReq().97
7.3.3.8.10 Method <> queryAppLoadStatsRes().97
7.3.3.8.11 Method <> queryAppLoadStatsErr().
...
SLOVENSKI STANDARD
SIST ES 203 915-3 V1.3.1:2008
01-september-2008
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 3. del:
Okvirje (Parlay 5)
Open Service Access (OSA) - Application Programming Interface (API) - Part 3:
Framework (Parlay 5)
Ta slovenski standard je istoveten z: ES 203 915-3 Version 1.3.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 203 915-3 V1.3.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
---------------------- Page: 1 ----------------------
SIST ES 203 915-3 V1.3.1:2008
---------------------- Page: 2 ----------------------
SIST ES 203 915-3 V1.3.1:2008
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)
�
---------------------- Page: 3 ----------------------
SIST ES 203 915-3 V1.3.1:2008
2 ETSI ES 203 915-3 V1.3.1 (2008-04)
Reference
RES/TISPAN-01055-03-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 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 enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.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 ETSI 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.etsi.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 foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 4 ----------------------
SIST ES 203 915-3 V1.3.1:2008
3 ETSI ES 203 915-3 V1.3.1 (2008-04)
Contents
Intellectual Property Rights.14
Foreword.14
1 Scope.15
2 References.15
3 Definitions and abbreviations.15
3.1 Definitions.15
3.2 Abbreviations.15
4 Overview of the Framework.16
5 The Base Interface Specification.17
5.1 Interface Specification Format .17
5.1.1 Interface Class.17
5.1.2 Method descriptions.18
5.1.3 Parameter descriptions.18
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 Overview.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 Framework 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 IpClientAPILevelAuthentication.27
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 IpClientAccess.29
6.3.1.2.1 Method terminateAccess().30
6.3.1.3 Interface Class IpInitial .30
6.3.1.3.1 Method <> 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.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
---------------------- Page: 5 ----------------------
SIST ES 203 915-3 V1.3.1:2008
4 ETSI ES 203 915-3 V1.3.1 (2008-04)
6.3.1.6.1 Method obtainInterface().38
6.3.1.6.2 Method 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 .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 IpAPILevelAuthentication.43
6.4.1.2.1 Idle State.43
6.4.1.2.2 Authenticating Framework State .44
6.4.1.2.3 Framework Authenticated State.44
6.4.1.2.4 Authenticating Client State.44
6.4.1.2.5 Client Authenticated State .44
6.4.1.2.6 Idle State.45
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 State.46
6.4.1.2.10 Client Authenticated State .46
6.4.1.2.11 Idle State.47
6.4.1.2.12 Authenticating Framework State .47
6.4.1.2.13 Framework Authenticated State.48
6.4.1.2.14 Authenticating Client State.48
6.4.1.2.15 Client Authenticated State .48
6.4.1.2.16 Idle State.49
6.4.1.2.17 Authenticating Framework State .49
6.4.1.2.18 Framework Authenticated State.50
6.4.1.2.19 Authenticating Client State.50
6.4.1.2.20 Client Authenticated State .50
6.4.1.3 State Transition Diagrams for IpAccess.51
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 Management Sequence Diagrams .53
7.1.2.1 Load Management: Suspend/resume notification from application.53
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 current load condition.56
7.1.2.5 Load Management: Application queries load statistics.56
7.1.2.6 Load Management: Application callback registration and load control.57
7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .58
7.1.2.8 Fault Management: Framework detects 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 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 Classes.70
7.3.2.1 Interface Class IpAppServiceAgreementManagement .70
ETSI
---------------------- Page: 6 ----------------------
SIST ES 203 915-3 V1.3.1:2008
5 ETSI ES 203 915-3 V1.3.1 (2008-04)
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 terminateServiceAgreement().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 <> fwFaultReportInd() .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 appUnavailableInd().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
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 Method <> 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 Interface Class IpAppHeartBeatMgmt.85
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 IpAppHeartBeat.86
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.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.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 <> queryLoadStatsRes() .91
7.3.3.7.11 Method <> queryLoadStatsErr() .91
ETSI
---------------------- Page: 7 ----------------------
SIST ES 203 915-3 V1.3.1:2008
6 ETSI ES 203 915-3 V1.3.1 (2008-04)
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 createLoadLevelNoti
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.