General Information

Abstract

ETSI OSA APIs Phase 4.   Based on ES 203 915 and the new requirements for OSA Phase 4, to produce ES 204 915 V1.1.1.  ETSI OSA Phase 4 incorporates 3GPP OSA Release 7 and is also known as Parlay 6.0.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).

Status
Published
Publication Date
02-Jul-2008
Current Stage
6060 - National Implementation/Publication (Adopted Project)
Start Date
11-Jun-2008
Due Date
16-Aug-2008
Completion Date
03-Jul-2008

Buy Documents

Standard

ETSI ES 204 915-3 V1.1.1 (2008-02) - Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 6)

English language (198 pages)
sale 15% off
Preview
sale 15% off
Preview
Standard

ETSI ES 204 915-3 V1.1.1 (2008-05) - Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 6)

English language (198 pages)
sale 15% off
Preview
sale 15% off
Preview
Standardization document

SIST ES 204 915-3 V1.1.1:2008

English language (198 pages)
Preview
Preview
e-Library read for
×1 day

Overview

SIST ES 204 915-3 V1.1.1:2008 addresses the Open Service Access (OSA) - Application Programming Interface (API) - Part 3: Framework (Parlay 6). Developed by the Slovenian Institute for Standardization (SIST) based on European Telecommunications Standards Institute (ETSI) documentation, this standard focuses on the framework aspects of the OSA API as defined in ETSI OSA Phase 4, also known as Parlay 6.0 and aligned with 3GPP OSA Release 7.

The OSA standard is designed to enable consistent, open access to telecommunications network capabilities via standardized APIs. By abstracting network interfaces, it empowers application developers to build value-added services while maintaining interoperability and adhering to industry best practices. This part (Part 3) specifically defines the architectural framework, laying the foundation for robust, secure, and scalable OSA implementations.

Key Topics

SIST ES 204 915-3 V1.1.1 provides comprehensive specifications for the OSA framework, including:

  • Sequence Diagrams: Visualizes the interactions between framework components and external entities to clarify message flows, authentication, and error management.
  • Class Diagrams: Outlines the structure of major classes forming the basis of the OSA API, supporting the object-oriented paradigm.
  • Interface Specification: Details methods, parameters, and expected behaviors for service access, authentication, event handling, and more.
  • State Transition Diagrams: Documents the various states of critical framework entities, aiding in service lifecycle and error handling.
  • Data Definitions: Standardizes the data structures used across the API to promote consistency.
  • IDL and WSDL Descriptions: Facilitates language-independent and web services integration by defining interfaces in Interface Definition Language (IDL) and Web Services Description Language (WSDL).
  • Java™ API Reference: Links to Java-based implementations for direct use by developers.
  • UML-based Object Modelling: Uses Unified Modelling Language (UML) to ensure clarity in architectural documentation and specification.

Applications

The framework laid out in SIST ES 204 915-3 V1.1.1 underpins a wide range of practical applications within telecommunications and IT environments:

  • Development of Value-Added Network Services: Service providers and third-party developers can use OSA APIs to access SMS, MMS, call control, location, charging, and presence services in a standardized and secure manner.
  • Enterprise Integration: Enables businesses to integrate telecommunications functions directly into business applications, enhancing customer engagement and automation.
  • Operator Platform Extensions: Supports operators aiming to expose specific network capabilities to trusted third-party developers while maintaining control and security.
  • Web Services and Multi-Platform Enablement: Offers WSDL-based definitions allowing seamless integration of telecom features into modern, service-oriented applications and cloud environments.
  • Network Abstraction: Simplifies complex telecom infrastructures for developers by delivering a consistent API, independent of underlying network implementations.

Benefits

  • Interoperability: Ensures applications remain portable across different network vendors and platforms.
  • Security: Offers standard mechanisms for authentication, trust management, and error handling.
  • Future Proofing: Based on robust object modelling, helping service providers and developers adapt to evolving network technologies.
  • Accelerated Development: Clear, standardized APIs reduce time-to-market for telecom-enabled products and services.

Related Standards

For a full understanding and implementation of OSA APIs, the following related standards and specifications should be considered:

  • ETSI ES 203 915 - Predecessor standard providing core OSA API requirements.
  • 3GPP OSA Release 7 - Defines the telecommunication reference architecture on which ETSI OSA Phase 4 is based.
  • Other parts of SIST/ETSI ES 204 915:
    • Part 1: Overall Architecture
    • Part 2: Common Data Definitions
    • Service-specific API specifications (e.g., call control, messaging, charging)
  • UML (Unified Modelling Language) - Used throughout the documentation for object and sequence diagramming.
  • Interface Definition Language (IDL) and WSDL - Industry standards enabling language-neutral and service-oriented integration.

SIST ES 204 915-3 V1.1.1:2008 is vital for organizations implementing OSA/Parlay 6 APIs, promoting interoperability, secure access, and streamlined development of telecommunications services and enterprise solutions.

Buy Documents

Standard

ETSI ES 204 915-3 V1.1.1 (2008-02) - Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 6)

English language (198 pages)
sale 15% off
Preview
sale 15% off
Preview
Standard

ETSI ES 204 915-3 V1.1.1 (2008-05) - Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 6)

English language (198 pages)
sale 15% off
Preview
sale 15% off
Preview
Standardization document

SIST ES 204 915-3 V1.1.1:2008

English language (198 pages)
Preview
Preview
e-Library read for
×1 day

Get Certified

Connect with accredited certification bodies for this standard

BSI Group

BSI (British Standards Institution) is the business standards company that helps organizations make excellence a habit.

UKAS United Kingdom Verified

NYCE

Mexican standards and certification body.

EMA Mexico Verified

Sponsored listings

Frequently Asked Questions

SIST ES 204 915-3 V1.1.1:2008 is a standard published by the Slovenian Institute for Standardization (SIST). Its full title is "Open Service Access (OSA) - Application Programming Interface (API) - Part 3: Framework (Parlay 6)". This standard covers: ETSI OSA APIs Phase 4. Based on ES 203 915 and the new requirements for OSA Phase 4, to produce ES 204 915 V1.1.1. ETSI OSA Phase 4 incorporates 3GPP OSA Release 7 and is also known as Parlay 6.0.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).

ETSI OSA APIs Phase 4. Based on ES 203 915 and the new requirements for OSA Phase 4, to produce ES 204 915 V1.1.1. ETSI OSA Phase 4 incorporates 3GPP OSA Release 7 and is also known as Parlay 6.0.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).

SIST ES 204 915-3 V1.1.1:2008 is classified under the following ICS (International Classification for Standards) categories: 35.100.01 - Open systems interconnection in general. The ICS classification helps identify the subject area and facilitates finding related standards.

SIST ES 204 915-3 V1.1.1:2008 is available in PDF format for immediate download after purchase. The document can be added to your cart and obtained through the secure checkout process. Digital delivery ensures instant access to the complete standard document.

Standards Content (Sample)


Final draft ETSI ES 204 915-3 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 3: Framework
(Parlay 6)
�
2 Final draft ETSI ES 204 915-3 V1.1.1 (2008-02)

Reference
DES/TISPAN-01032-3-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
3 Final draft ETSI ES 204 915-3 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.13
Foreword.13
1 Scope.14
2 References.14
3 Definitions and abbreviations.14
3.1 Definitions.14
3.2 Abbreviations.14
4 Overview of the Framework.15
5 The Base Interface Specification.16
5.1 Interface Specification Format .16
5.1.1 Interface Class.16
5.1.2 Method descriptions.17
5.1.3 Parameter descriptions.17
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.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 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 Interface Classes .25
6.3.1.1 Interface Class IpClientAPILevelAuthentication.25
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 IpClientAccess.27
6.3.1.2.1 Method terminateAccess().27
6.3.1.3 Interface Class IpInitial .28
6.3.1.3.1 Method initiateAuthenticationWithVersion().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 challenge().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
4 Final draft ETSI ES 204 915-3 V1.1.1 (2008-02)
6.3.1.6.5 Method terminateAccess().35
6.3.1.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 IpAPILevelAuthentication.37
6.4.1.2.1 Idle State.37
6.4.1.2.2 Authenticating Framework State .38
6.4.1.2.3 Framework Authenticated State.38
6.4.1.2.4 Authenticating Client State.38
6.4.1.2.5 Client Authenticated State .38
6.4.1.2.6 Idle State.39
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 State.40
6.4.1.2.10 Client Authenticated State .40
6.4.1.3 State Transition Diagrams for IpAccess.40
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 Diagrams .42
7.1.2.1 Load Management: Suspend/resume notification from application.42
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 condition.45
7.1.2.5 Load Management: Application queries load statistics.45
7.1.2.6 Load Management: Application callback registration and load control.46
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
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 Discovery 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 Classes.58
7.3.2.1 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 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 Method <> fwFaultRecoveryInd().64
7.3.3.1.5 Method <> fwUnavailableInd() .64
7.3.3.1.6 Method activityTestErr().64
ETSI
5 Final draft ETSI ES 204 915-3 V1.1.1 (2008-02)
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 Method 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
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 IpAppHeartBeatMgmt.70
7.3.3.3.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 IpAppHeartBeat.70
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
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 createLoadLevelNotification().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 createLoadLevelNotification().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 Interface 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 notificationTerminated().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
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
6 Final draft ETSI ES 204 915-3 V1.1.1 (2008-02)
7.4.3.1 State Transition Diagrams for IpLoadManager.83
7.4.3.1.1 Idle State.83
7.4.3.1.2 Notification Suspended State.83
7.4.3.1.3 Active State.83
7.4.3.2 State Transition Diagrams for LoadManagerInternal.84
7.4.3.2.1 Normal load State.84
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 IpOAM.85
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 State.86
7.4.3.4.4 Service Activity Test State .86
7.4.4 Event Notification State Transition Diagrams .86
7.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 Operator 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().97
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 modifyClientApp().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 IpClientAppInfoQuery .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 .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.2.4.1 Method listServiceProfiles().108
8.3.2.4.2 Method describeServiceProfile().108
ETSI
7 Final draft ETSI ES 204 915-3 V1.1.1 (2008-02)
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 modifyServiceContract().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 IpEntOpAccountManagement.111
8.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 Transition 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 Diagrams .116
9.1.3.1 Sign Service Agreement.116
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 control.118
9.1.4.3 Load Management: Client and Service Load Balancing.120
9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service.121
9.1.4.5 Fault Management: Service requests Framework activity test.121
9.1.4.6 Fault Management: Service requests Application activity test .122
9.1.4.7 Fault Management: Application requests Service 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 Classes.127
9.3.1.1 Interface Class IpFwServiceRegistration .127
9.3.1.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 Interface 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 .
...


ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 3: Framework
(Parlay 6)
�
2 ETSI ES 204 915-3 V1.1.1 (2008-05)

Reference
DES/TISPAN-01032-3-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
3 ETSI ES 204 915-3 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.13
Foreword.13
1 Scope.14
2 References.14
3 Definitions and abbreviations.14
3.1 Definitions.14
3.2 Abbreviations.14
4 Overview of the Framework.15
5 The Base Interface Specification.16
5.1 Interface Specification Format .16
5.1.1 Interface Class.16
5.1.2 Method descriptions.17
5.1.3 Parameter descriptions.17
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.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 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 Interface Classes .25
6.3.1.1 Interface Class IpClientAPILevelAuthentication.25
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 IpClientAccess.27
6.3.1.2.1 Method terminateAccess().27
6.3.1.3 Interface Class IpInitial .28
6.3.1.3.1 Method initiateAuthenticationWithVersion().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 challenge().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
4 ETSI ES 204 915-3 V1.1.1 (2008-05)
6.3.1.6.5 Method terminateAccess().35
6.3.1.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 IpAPILevelAuthentication.37
6.4.1.2.1 Idle State.37
6.4.1.2.2 Authenticating Framework State .38
6.4.1.2.3 Framework Authenticated State.38
6.4.1.2.4 Authenticating Client State.38
6.4.1.2.5 Client Authenticated State .38
6.4.1.2.6 Idle State.39
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 State.40
6.4.1.2.10 Client Authenticated State .40
6.4.1.3 State Transition Diagrams for IpAccess.40
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 Diagrams .42
7.1.2.1 Load Management: Suspend/resume notification from application.42
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 condition.45
7.1.2.5 Load Management: Application queries load statistics.45
7.1.2.6 Load Management: Application callback registration and load control.46
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
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 Discovery 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 Classes.58
7.3.2.1 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 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 Method <> fwFaultRecoveryInd().64
7.3.3.1.5 Method <> fwUnavailableInd() .64
7.3.3.1.6 Method activityTestErr().64
ETSI
5 ETSI ES 204 915-3 V1.1.1 (2008-05)
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 Method 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
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 IpAppHeartBeatMgmt.70
7.3.3.3.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 IpAppHeartBeat.70
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
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 createLoadLevelNotification().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 createLoadLevelNotification().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 Interface 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 notificationTerminated().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
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
6 ETSI ES 204 915-3 V1.1.1 (2008-05)
7.4.3.1 State Transition Diagrams for IpLoadManager.83
7.4.3.1.1 Idle State.83
7.4.3.1.2 Notification Suspended State.83
7.4.3.1.3 Active State.83
7.4.3.2 State Transition Diagrams for LoadManagerInternal.84
7.4.3.2.1 Normal load State.84
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 IpOAM.85
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 State.86
7.4.3.4.4 Service Activity Test State .86
7.4.4 Event Notification State Transition Diagrams .86
7.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 Operator 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().97
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 modifyClientApp().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 IpClientAppInfoQuery .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 .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.2.4.1 Method listServiceProfiles().108
8.3.2.4.2 Method describeServiceProfile().108
ETSI
7 ETSI ES 204 915-3 V1.1.1 (2008-05)
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 modifyServiceContract().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 IpEntOpAccountManagement.111
8.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 Transition 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 Diagrams .116
9.1.3.1 Sign Service Agreement.116
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 control.118
9.1.4.3 Load Management: Client and Service Load Balancing.120
9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service.121
9.1.4.5 Fault Management: Service requests Framework activity test.121
9.1.4.6 Fault Management: Service requests Application activity test .122
9.1.4.7 Fault Management: Application requests Service 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 Classes.127
9.3.1.1 Interface Class IpFwServiceRegistration .127
9.3.1.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 Interface 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 .
...


SLOVENSKI STANDARD
01-september-2008
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 3. del:
Okvirje (Parlay 6)
Open Service Access (OSA) - Application Programming Interface (API) - Part 3:
Framework (Parlay 6)
Ta slovenski standard je istoveten z: ES 204 915-3 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 3: Framework
(Parlay 6)
�
2 ETSI ES 204 915-3 V1.1.1 (2008-05)

Reference
DES/TISPAN-01032-3-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
3 ETSI ES 204 915-3 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.13
Foreword.13
1 Scope.14
2 References.14
3 Definitions and abbreviations.14
3.1 Definitions.14
3.2 Abbreviations.14
4 Overview of the Framework.15
5 The Base Interface Specification.16
5.1 Interface Specification Format .16
5.1.1 Interface Class.16
5.1.2 Method descriptions.17
5.1.3 Parameter descriptions.17
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.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 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 Interface Classes .25
6.3.1.1 Interface Class IpClientAPILevelAuthentication.25
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 IpClientAccess.27
6.3.1.2.1 Method terminateAccess().27
6.3.1.3 Interface Class IpInitial .28
6.3.1.3.1 Method initiateAuthenticationWithVersion().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 challenge().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
4 ETSI ES 204 915-3 V1.1.1 (2008-05)
6.3.1.6.5 Method terminateAccess().35
6.3.1.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 IpAPILevelAuthentication.37
6.4.1.2.1 Idle State.37
6.4.1.2.2 Authenticating Framework State .38
6.4.1.2.3 Framework Authenticated State.38
6.4.1.2.4 Authenticating Client State.38
6.4.1.2.5 Client Authenticated State .38
6.4.1.2.6 Idle State.39
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 State.40
6.4.1.2.10 Client Authenticated State .40
6.4.1.3 State Transition Diagrams for IpAccess.40
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 Diagrams .42
7.1.2.1 Load Management: Suspend/resume notification from application.42
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 condition.45
7.1.2.5 Load Management: Application queries load statistics.45
7.1.2.6 Load Management: Application callback registration and load control.46
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
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 Discovery 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 Classes.58
7.3.2.1 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 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 Method <> fwFaultRecoveryInd().64
7.3.3.1.5 Method <> fwUnavailableInd() .64
7.3.3.1.6 Method activityTestErr().64
ETSI
5 ETSI ES 204 915-3 V1.1.1 (2008-05)
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 Method 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
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 IpAppHeartBeatMgmt.70
7.3.3.3.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 IpAppHeartBeat.70
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
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 createLoadLevelNotification().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 createLoadLevelNotification().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 Interface 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 notificationTerminated().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
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
6 ETSI ES 204 915-3 V1.1.1 (2008-05)
7.4.3.1 State Transition Diagrams for IpLoadManager.83
7.4.3.1.1 Idle State.83
7.4.3.1.2 Notification Suspended State.83
7.4.3.1.3 Active State.83
7.4.3.2 State Transition Diagrams for LoadManagerInternal.84
7.4.3.2.1 Normal load State.84
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 IpOAM.85
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 State.86
7.4.3.4.4 Service Activity Test State .86
7.4.4 Event Notification State Transition Diagrams .86
7.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 Operator 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().97
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 modifyClientApp().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 IpClientAppInfoQuery .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 .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.2.4.1 Method listServiceProfiles().108
8.3.2.4.2 Method describeServiceProfile().108
ETSI
7 ETSI ES 204 915-3 V1.1.1 (2008-05)
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 modifyServiceContract().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 IpEntOpAccountManagement.111
8.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 Transition 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 Diagrams .116
9.1.3.1 Sign Service Agreement.116
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 control.118
9.1.4.3 Load Management: Client and Service Load Balancing.120
9.1.4.4 Heartbeat Management: Start/perform/end heartbeat supervision of the service.121
9.1.4.5 Fault Management: Service requests Framework activity test.121
9.1.4.6 Fault Management: Service requests Application activity test .122
9.1.4.7 Fault Management: Application requests Service 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 Classes.127
9.3.1.1 Interface Class IpFwServiceRegistration .127
9.3.1.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 registe
...