SIST ES 201 915-3 V1.4.1:2005

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

Maintenance update of ES 201 915-3 v.1.3.1.  Updated document will also be known as Parlay 3.3.  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: Okvir

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 201 915-3 V1.4.1 (2003-07) - Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 3)

Standards Content (Sample)

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

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

SIST ES 201 915-3 V1.4.1:2005

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

SIST ES 201 915-3 V1.4.1:2005

ETSI ES 201 915-3 V1.4.1 (2003-07)
ETSI Standard


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



�

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

SIST ES 201 915-3 V1.4.1:2005
 2 ETSI ES 201 915-3 V1.4.1 (2003-07)



Reference
RES/SPAN-120095-3
Keywords
API, OSA, IDL, 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 201 915-3 V1.4.1:2005
 3 ETSI ES 201 915-3 V1.4.1 (2003-07)
Contents
Intellectual Property Rights.9
Foreword.9
1 Scope.10
2 References.10
3 Definitions and abbreviations.10
3.1 Definitions.10
3.2 Abbreviations.10
4 Overview of the Framework.10
4.1 General requirements on support of methods.12
5 The Base Interface Specification.12
5.1 Interface Specification Format .12
5.1.1 Interface Class.12
5.1.2 Method descriptions.13
5.1.3 Parameter descriptions.13
5.1.4 State Model.13
5.2 Base Interface.13
5.2.1 Interface Class IpInterface .13
5.3 Service Interfaces.13
5.3.1 Overview.13
5.4 Generic Service Interface .13
5.4.1 Interface Class IpService .13
6 Framework Access Session API.15
6.1 Sequence Diagrams.15
6.1.1 Trust and Security Management Sequence Diagrams .15
6.1.1.1 Initial Access for trusted parties.15
6.1.1.2 Initial Access.15
6.1.1.3 Authentication.17
6.1.1.4 API Level Authentication.17
6.2 Class Diagrams.19
6.3 Interface Classes.19
6.3.1 Trust and Security Management Interface Classes .19
6.3.1.1 Interface Class IpClientAPILevelAuthentication.20
6.3.1.2 Interface Class IpClientAccess.21
6.3.1.3 Interface Class IpInitial .22
6.3.1.4 Interface Class IpAuthentication.23
6.3.1.5 Interface Class IpAPILevelAuthentication .24
6.3.1.6 Interface Class IpAccess .26
6.4 State Transition Diagrams .28
6.4.1 Trust and Security Management State Transition Diagrams .29
6.4.1.1 State Transition Diagrams for IpInitial .29
6.4.1.1.1 Active State.29
6.4.1.2 State Transition Diagrams for IpAPILevelAuthentication.29
6.4.1.2.1 Idle State.30
6.4.1.2.2 Selecting Method State.30
6.4.1.2.3 Authenticating Client State.30
6.4.1.2.4 Client Authenticated State.30
6.4.1.3 State Transition Diagrams for IpAccess.31
6.4.1.3.1 Active State.31
7 Framework-to-Application API.32
7.1 Sequence Diagrams.32
7.1.1 Event Notification Sequence Diagrams .32
7.1.1.1 Enable Event Notification .32
ETSI

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

SIST ES 201 915-3 V1.4.1:2005
 4 ETSI ES 201 915-3 V1.4.1 (2003-07)
7.1.2 Integrity Management Sequence Diagrams .33
7.1.2.1 Load Management: Suspend/resume notification from application.33
7.1.2.2 Load Management: Framework queries load statistics .34
7.1.2.3 Load Management: Framework callback registration and Application load control .35
7.1.2.4 Load Management: Application reports current load condition.36
7.1.2.5 Load Management: Application queries load statistics.36
7.1.2.6 Load Management: Application callback registration and load control.37
7.1.2.7 Heartbeat Management: Start/perform/end heartbeat supervision of the application .38
7.1.2.8 Fault Management: Framework detects a Service failure .39
7.1.2.9 Fault Management: Application requests a Framework activity test .40
7.1.3 Service Discovery Sequence Diagrams .40
7.1.3.1 Service Discovery.40
7.1.4 Service Agreement Management Sequence Diagrams .42
7.1.4.1 Service Selection.42
7.2 Class Diagrams.44
7.3 Interface Classes.47
7.3.1 Service Discovery Interface Classes.47
7.3.1.1 Interface Class IpServiceDiscovery .47
7.3.2 Service Agreement Management Interface Classes.50
7.3.2.1 Interface Class IpAppServiceAgreementManagement .50
7.3.2.2 Interface Class IpServiceAgreementManagement .52
7.3.3 Integrity Management Interface Classes.55
7.3.3.1 Interface Class IpAppFaultManager .55
7.3.3.2 Interface Class IpFaultManager .58
7.3.3.3 Interface Class IpAppHeartBeatMgmt.61
7.3.3.4 Interface Class IpAppHeartBeat.62
7.3.3.5 Interface Class IpHeartBeatMgmt.63
7.3.3.6 Interface Class IpHeartBeat .64
7.3.3.7 Interface Class IpAppLoadManager .65
7.3.3.8 Interface Class IpLoadManager .67
7.3.3.9 Interface Class IpOAM .71
7.3.3.10 Interface Class IpAppOAM .72
7.3.4 Event Notification Interface Classes.72
7.3.4.1 Interface Class IpAppEventNotification .72
7.3.4.2 Interface Class IpEventNotification .73
7.4 State Transition Diagrams .74
7.4.1 Service Discovery State Transition Diagrams .75
7.4.1.1 State Transition Diagrams for IpServiceDiscovery.75
7.4.1.1.1 Active State.75
7.4.2 Service Agreement Management State Transition Diagrams .75
7.4.3 Integrity Management State Transition Diagrams .76
7.4.3.1 State Transition Diagrams for IpLoadManager.76
7.4.3.1.1 Idle State.76
7.4.3.1.2 Notification Suspended State.76
7.4.3.1.3 Active State.76
7.4.3.2 State Transition Diagrams for LoadManagerInternal.77
7.4.3.2.1 Normal load State.77
7.4.3.2.2 Application Overload State .77
7.4.3.2.3 Internal overload State.77
7.4.3.2.4 Internal and Application Overload State .77
7.4.3.3 State Transition Diagrams for IpOAM.78
7.4.3.3.1 Active State.78
7.4.3.4 State Transition Diagrams for IpFaultManager.78
7.4.3.4.1 Framework Active State.79
7.4.3.4.2 Framework Faulty State.79
7.4.3.4.3 Framework Activity Test State.79
7.4.3.4.4 Service Activity Test State .79
7.4.4 Event Notification State Transition Diagrams .79
7.4.4.1 State Transition Diagrams for IpEventNotification .79
7.4.4.1.1 Idle State.80
7.4.4.1.2 Notification Active State.80
ETSI

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

SIST ES 201 915-3 V1.4.1:2005
 5 ETSI ES 201 915-3 V1.4.1 (2003-07)
8 Framework-to-Enterprise Operator API.80
8.1 Sequence Diagrams.84
8.1.1 Service Subscription Sequence Diagrams.84
8.1.1.1 Service Discovery and Subscription Scenario.84
8.1.1.2 Enterprise Operator and Client Application Subscription Management Sequence Diagram .85
8.2 Class Diagrams.88
8.3 Interface Classes.89
8.3.1 Service Subscription Interface Classes .89
8.3.1.1 Interface Class IpClientAppManagement .89
8.3.1.2 Interface Class IpClientAppInfoQuery .93
8.3.1.3 Interface Class IpServiceProfileManagement .95
8.3.1.4 Interface Class IpServiceProfileInfoQuery .98
8.3.1.5 Interface Class IpServiceContractManagement .99
8.3.1.6 Interface Class IpServiceContractInfoQuery .101
8.3.1.7 Interface Class IpEntOpAccountManagement.103
8.3.1.8 Interface Class IpEntOpAccountInfoQuery .104
8.4 State Transition Diagrams .104
8.4.1 Service Subscription State Transition Diagrams.104
9 Framework-to-Service API.105
9.1 Sequence Diagrams.105
9.1.1 Service Discovery Sequence Diagrams .105
9.1.2 Service Registration Sequence Diagrams .105
9.1.2.1 New SCF Registration.105
9.1.3 Service Instance Lifecycle Manager Sequence Diagrams .107
9.1.3.1 Sign Service Agreement.107
9.1.4 Integrity Management Sequence Diagrams .108
9.1.4.1 Load Management: Service callback registration and load control.108
9.1.4.2 Load Management: Framework callback registration and service load control.109
9.1.4.3 Load Management: Client and Service Load Balancing.110
9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service.111
9.1.4.5 Fault Management: Service requests Framework activity test.111
9.1.4.6 Fault Management: Service requests Application activity test .112
9.1.4.7 Fault Management: Application requests Service activity test .113
9.1.4.8 Fault Management: Application detects service is unavailable.114
9.1.5 Event Notification Sequence Diagrams .114
9.2 Class Diagrams.115
9.3 Interface Classes.117
9.3.1 Service Registration Interface Classes.117
9.3.1.1 Interface Class IpFwServiceRegistration .118
9.3.2 Service Instance Lifecycle Manager Interface Classes.121
9.3.2.1 Interface Class IpServiceInstanceLifecycleManager .121
9.3.3 Service Discovery Interface Classes.122
9.3.3.1 Interface Class IpFwServiceDiscovery .123
9.3.4 Integrity Management Interface Classes.125
9.3.4.1 Interface Class IpFwFaultManager .125
9.3.4.2 Interface Class IpSvcFaultManager .128
9.3.4.3 Interface Class IpFwHeartBeatMgmt.133
9.3.4.4 Interface Class IpFwHeartBeat .134
9.3.4.5 Interface Class IpSvcHeartBeatMgmt.134
9.3.4.6 Interface Class IpSvcHeartBeat .136
9.3.4.7 Interface Class IpFwLoadManager .136
9.3.4.8 Interface Class IpSvcLoadManager .140
9.3.4.9 Interface Class IpFwOAM .142
9.3.4.10 Interface Class IpSvcOAM .143
9.3.5 Event Notification Interface Classes.144
9.3.5.1 Interface Class IpFwEventNotification.144
9.3.5.2 Interface Class IpSvcEventNotification .145
9.4 State Transition Diagrams .146
9.4.1 Service Registration State Transition Diagrams .147
9.4.1.1 State Transition Diagrams for IpFwServiceRegistration.147
9.4.1.1.1 SCF Registered State.147
ETSI

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

SIST ES 201 915-3 V1.4.1:2005
 6 ETSI ES 201 915-3 V1.4.1 (2003-07)
9.4.1.1.2 SCF Announced State.147
9.4.2 Service Instance Lifecycle Manager State Transition Diagrams .147
9.4.3 Service Discovery State Transition Diagrams .148
9.4.4 Integrity Management State Transition Diagrams .148
9.4.4.1 State Transition Diagrams for IpFwLoadManager.148
9.4.4.1.1 Idle State.
...