SIST ES 202 915-3 V1.2.1:2005

Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 4)

Maintenance update of ES 202 915-3 V1.1.1 to produce ES 202 915-3 V1.2.1 Updated document will also be known as PARLAY 4.1. Only those parts requiring modification will be updated ( most parts require maintenance fixes )

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 3. del: Okvirni del

General Information

• Status: Published
• Publication Date: 31-Dec-2004
• ICS: 33.040.01 - Telecommunication systems in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Jan-2005
• Due Date: 01-Jan-2005
• Completion Date: 01-Jan-2005
• Ref Project: ETSI ES 202 915-3 V1.2.1 (2003-08) - Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 4)

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 202 915-3 V1.2.1:2005
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 3.
del: Okvirni del
Open Service Access (OSA); Application Programming Interface (API); Part 3:
Framework (Parlay 4)
Ta slovenski standard je istoveten z: ES 202 915-3 Version 1.2.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 202 915-3 V1.2.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

SIST ES 202 915-3 V1.2.1:2005

---------------------- Page: 2 ----------------------

SIST ES 202 915-3 V1.2.1:2005

ETSI ES 202 915-3 V1.2.1 (2003-08)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 3: Framework
(Parlay 4)



�

---------------------- Page: 3 ----------------------

SIST ES 202 915-3 V1.2.1:2005
 2 ETSI ES 202 915-3 V1.2.1 (2003-08)



Reference
RES/SPAN-120096-3
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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, send your comment to:
[e-mail]
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 2003.
© The Parlay Group 2003.
All rights reserved.

TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI 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 202 915-3 V1.2.1:2005
 3 ETSI ES 202 915-3 V1.2.1 (2003-08)
Contents
Intellectual Property Rights.12
Foreword.12
1 Scope.13
2 References.13
3 Definitions and abbreviations.13
3.1 Definitions.13
3.2 Abbreviations.13
4 Overview of the Framework.14
5 The Base Interface Specification.15
5.1 Interface Specification Format .15
5.1.1 Interface Class.15
5.1.2 Method descriptions.16
5.1.3 Parameter descriptions.16
5.1.4 State Model.16
5.2 Base Interface.16
5.2.1 Interface Class IpInterface .16
5.3 Service Interfaces.16
5.3.1 Overview.16
5.4 Generic Service Interface .16
5.4.1 Interface Class IpService .16
5.4.1.1 Method setCallback().17
5.4.1.2 Method setCallbackWithSessionID().17
6 Framework Access Session API.18
6.1 Sequence Diagrams.18
6.1.1 Trust and Security Management Sequence Diagrams .18
6.1.1.1 Initial Access.18
6.1.1.2 Framework Terminates Access.19
6.1.1.3 Application Terminates Access.20
6.1.1.4 Non-API level Authentication.20
6.1.1.5 API Level Authentication.21
6.2 Class Diagrams.23
6.3 Interface Classes.23
6.3.1 Trust and Security Management Interface Classes .23
6.3.1.1 Interface Class IpClientAPILevelAuthentication.23
6.3.1.1.1 Method <> authenticate().24
6.3.1.1.2 Method abortAuthentication().24
6.3.1.1.3 Method authenticationSucceeded().25
6.3.1.1.4 Method <> challenge() .25
6.3.1.2 Interface Class IpClientAccess.25
6.3.1.2.1 Method terminateAccess().26
6.3.1.3 Interface Class IpInitial .26
6.3.1.3.1 Method <> initiateAuthentication() .27
6.3.1.3.2 Method <> initiateAuthenticationWithVersion() .28
6.3.1.4 Interface Class IpAuthentication.29
6.3.1.4.1 Method requestAccess().29
6.3.1.5 Interface Class IpAPILevelAuthentication .30
6.3.1.5.1 Method <> selectEncryptionMethod().30
6.3.1.5.2 Method <> authenticate().31
6.3.1.5.3 Method abortAuthentication().32
6.3.1.5.4 Method authenticationSucceeded().32
6.3.1.5.5 Method <> selectAuthenticationMechanism() .32
6.3.1.5.6 Method <> challenge() .33
6.3.1.6 Interface Class IpAccess .33
ETSI

---------------------- Page: 5 ----------------------

SIST ES 202 915-3 V1.2.1:2005
 4 ETSI ES 202 915-3 V1.2.1 (2003-08)
6.3.1.6.1 Method obtainInterface().34
6.3.1.6.2 Method obtainInterfaceWithCallback().34
6.3.1.6.3 Method <> endAccess().35
6.3.1.6.4 Method listInterfaces().35
6.3.1.6.5 Method <> releaseInterface().35
6.3.1.6.6 Method <> selectSigningAlgorithm() .36
6.3.1.6.7 Method <> terminateAccess() .36
6.3.1.6.8 Method <> relinquishInterface() .37
6.4 State Transition Diagrams .37
6.4.1 Trust and Security Management State Transition Diagrams .38
6.4.1.1 State Transition Diagrams for IpInitial .38
6.4.1.2 State Transition Diagrams for IpAPILevelAuthentication.38
6.4.1.2.1 Idle State.39
6.4.1.2.2 Authenticating Framework State .39
6.4.1.2.3 Framework Authenticated State.39
6.4.1.2.4 Authenticating Client State.39
6.4.1.2.5 Client Authenticated State.39
6.4.1.2.6 Idle State.40
6.4.1.2.7 Authenticating Framework State .40
6.4.1.2.8 Framework Authenticated State.41
6.4.1.2.9 Authenticating Client State.41
6.4.1.2.10 Client Authenticated State.41
6.4.1.2.11 Idle State.42
6.4.1.2.12 Authenticating Framework State .42
6.4.1.2.13 Framework Authenticated State.43
6.4.1.2.14 Authenticating Client State.43
6.4.1.2.15 Client Authenticated State.43
6.4.1.2.16 Idle State.44
6.4.1.2.17 Authenticating Framework State .44
6.4.1.2.18 Framework Authenticated State.45
6.4.1.2.19 Authenticating Client State.45
6.4.1.2.20 Client Authenticated State.45
6.4.1.3 State Transition Diagrams for IpAccess.46
6.4.1.3.1 Active State.46
7 Framework-to-Application API.47
7.1 Sequence Diagrams.47
7.1.1 Event Notification Sequence Diagrams .47
7.1.1.1 Enable Event Notification .47
7.1.2 Integrity Management Sequence Diagrams .48
7.1.2.1 Load Management: Suspend/resume notification from application.48
7.1.2.2 Load Management: Framework queries load statistics .49
7.1.2.3 Load Management: Framework callback registration and Application load control .49
7.1.2.4 Load Management: Application reports current load condition.50
7.1.2.5 Load Management: Application queries load statistics.50
7.1.2.6 Load Management: Application callback registration and load control.51
7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .52
7.1.2.8 Fault Management: Framework detects a Service failure .53
7.1.2.9 Fault Management: Application requests a Framework activity test .54
7.1.3 Service Agreement Management Sequence Diagrams .54
7.1.3.1 Service Selection.54
7.1.4 Service Discovery Sequence Diagrams .56
7.1.4.1 Service Discovery.56
7.2 Class Diagrams.58
7.3 Interface Classes.60
7.3.1 Event Notification Interface Classes.60
7.3.1.1 Interface Class IpAppEventNotification .60
7.3.1.1.1 Method reportNotification().61
7.3.1.1.2 Method notificationTerminated().61
7.3.1.2 Interface Class IpEventNotification .61
7.3.1.2.1 Method createNotification().61
7.3.1.2.2 Method destroyNotification().62
ETSI

---------------------- Page: 6 ----------------------

SIST ES 202 915-3 V1.2.1:2005
 5 ETSI ES 202 915-3 V1.2.1 (2003-08)
7.3.2 Integrity Management Interface Classes.62
7.3.2.1 Interface Class IpAppFaultManager .62
7.3.2.1.1 Method activityTestRes().63
7.3.2.1.2 Method appActivityTestReq().63
7.3.2.1.3 fwFaultReportInd().64
7.3.2.1.4 Method fwFaultRecoveryInd().64
7.3.2.1.5 Method <> svcUnavailableInd().64
7.3.2.1.6 Method genFaultStatsRecordRes().64
7.3.2.1.7 Method fwUnavailableInd().65
7.3.2.1.8 Method activityTestErr().65
7.3.2.1.9 Method genFaultStatsRecordErr().65
7.3.2.1.10 Method appUnavailableInd().65
7.3.2.1.11 Method genFaultStatsRecordReq().65
7.3.2.1.12 Method <> svcAvailStatusInd() .66
7.3.2.2 Interface Class IpFaultManager .66
7.3.2.2.1 Method activityTestReq().67
7.3.2.2.2 Method appActivityTestRes().67
7.3.2.2.3 Method svcUnavailableInd().68
7.3.2.2.4 Method genFaultStatsRecordReq().68
7.3.2.2.5 Method appActivityTestErr().68
7.3.2.2.6 Method <> appUnavailableInd().69
7.3.2.2.7 Method genFaultStatsRecordRes().69
7.3.2.2.8 Method genFaultStatsRecordErr().69
7.3.2.2.9 Method <> appAvailStatusInd().70
7.3.2.3 Interface Class IpAppHeartBeatMgmt.70
7.3.2.3.1 Method enableAppHeartBeat().70
7.3.2.3.2 Method disableAppHeartBeat().70
7.3.2.3.3 Method changeInterval().71
7.3.2.4 Interface Class IpAppHeartBeat.71
7.3.2.4.1 Method pulse().71
7.3.2.5 Interface Class IpHeartBeatMgmt.71
7.3.2.5.1 Method enableHeartBeat().72
7.3.2.5.2 Method disableHeartBeat().72
7.3.2.5.3 Method changeInterval().72
7.3.2.6 Interface Class IpHeartBeat .73
7.3.2.6.1 Method pulse().73
7.3.2.7 Interface Class IpAppLoadManager .73
7.3.2.7.1 Method queryAppLoadReq().74
7.3.2.7.2 Method queryLoadRes().74
7.3.2.7.3 Method queryLoadErr().74
7.3.2.7.4 Method loadLevelNotification().75
7.3.2.7.5 Method resumeNotification().75
7.3.2.7.6 Method suspendNotification().75
7.3.2.7.7 Method <> createLoadLevelNotification() .75
7.3.2.7.8 Method <> destroyLoadLevelNotification() .75
7.3.2.8 Interface Class IpLoadManager .76
7.3.2.8.1 Method reportLoad().76
7.3.2.8.2 Method queryLoadReq().77
7.3.2.8.3 Method queryAppLoadRes().77
7.3.2.8.4 Method queryAppLoadErr().77
7.3.2.8.5 Method createLoadLevelNotification().78
7.3.2.8.6 Method destroyLoadLevelNotification().78
7.3.2.8.7 Method resumeNotification().78
7.3.2.8.8 Method suspendNotification().79
7.3.2.9 Interface Class IpOAM .79
7.3.2.9.1 Method systemDateTimeQuery().79
7.3.2.10 Interface Class IpAppOAM .80
7.3.2.10.1 Method systemDateTimeQuery().80
7.3.3 Service Agreement Management Interface Classes.80
7.3.3.1 Interface Class IpAppServiceAgreementManagement .80
7.3.3.1.1 Method signServiceAgreement().81
7.3.3.1.2 Method terminateServiceAgreement().81
ETSI

---------------------- Page: 7 ----------------------

SIST ES 202 915-3 V1.2.1:2005
 6 ETSI ES 202 915-3 V1.2.1 (2003-08)
7.3.3.2 Interface Class IpServiceAgreementManagement .82
7.3.3.2.1 Method signServiceAgreement().82
7.3.3.2.2 Method terminateServiceAgreement().83
7.3.3.2.3 Method selectService().
...