SIST ES 204 915-3 V1.1.1:2008

• 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
• ICS: 35.100.01 - Open systems interconnection in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 11-Jun-2008
• Due Date: 16-Aug-2008
• Completion Date: 03-Jul-2008
• Ref Project: ETSI ES 204 915-3 V1.1.1 (2008-05) - Open Service Access (OSA); Application Programming Interface (API); Part 3: Framework (Parlay 6)

SIST ES 204 915-3 V1.1.1:2008 is an ETSI standard for Open Service Access (OSA) Application Programming Interface (API), Part 3: Framework (Parlay 6). It specifies the Framework-side interfaces and behavior that let application developers, service providers, and enterprise operators use network functionality through the OSA APIs.

This part covers the Framework mechanisms for authentication, access control, service discovery, service agreement handling, integrity management, event notifications, and service subscription support. It is written as a Stage 3 API specification and uses UML to define the interface model.

What does SIST ES 204 915-3 V1.1.1:2008 specify?

SIST ES 204 915-3 V1.1.1:2008 specifies the Framework aspects of the OSA interface. It organizes those aspects into interface specifications, sequence diagrams, class diagrams, state transition diagrams, data definitions, and language bindings for IDL, WSDL, and Java.

The scope also makes clear that the API is about the Framework relationship to applications, service capability servers, and enterprise operators. Interfaces between an enterprise operator and the client applications in its own domain are outside the scope of this API and are handled through the subscription model instead.

Annex	What it covers
Annex A	OMG IDL description of the Framework
Annex B	W3C WSDL description of the Framework
Annex C	Java™ API description of the Framework
Annex D	Contents of 3GPP OSA R7 Framework
Annex E	Description of the Framework for 3GPP2 cdma2000 networks
Annex F	Change summary for interfaces, methods, data definitions, service properties, and exceptions

What are the key requirements of SIST ES 204 915-3 V1.1.1:2008?

Access to the Framework is controlled by authentication and interface management

Clause 6 defines the Trust and Security Management flow. The Framework authenticates a client, then returns an access interface that the client uses to reach other Framework functions. In practice, this means a client cannot simply call service functions first - it must establish identity and access rights before discovery or subscription work begins.

The authentication model supports both framework-authenticates-client and client-authenticates-framework exchanges. Clause 6 shows API-level authentication with IpInitial, IpAPILevelAuthentication, IpAuthentication, and IpAccess, and it describes requestAccess() as the step that returns access only after authentication succeeds.

The standard defines how applications discover and select services

Clause 7 and Clause 9 cover discovery on the application side and the service side. The application can list service types, describe a service type, discover services by property list, and list already subscribed services. This matters because service integration usually starts with matching what the network offers to what the application needs.

The service agreement flow is separate from discovery. selectService() returns a service token, and signServiceAgreement() uses that token together with the agreement text and a signing algorithm. The document also states that the signing process uses CMS (Cryptographic Message Syntax) Signed-data and a signing-time attribute for replay prevention, so implementations need to handle signed agreement exchange carefully.

Integrity management covers load, heartbeat, fault, and OAM behavior

Clause 7 and Clause 9 define integrity management for applications and services. The Framework can ask for load reports, register or remove load notifications, suspend and resume notifications, supervise heartbeat, request activity tests, and exchange availability status messages. In practice, this is the operational layer that helps an implementation react to overload, service failure, or recovery.

The load management model distinguishes load levels and supports statistics exchange. Heartbeat management uses periodic pulse() messages, so missed pulses signal that a side may have failed. Fault management includes activity tests and fault statistics records, which are used when an operator needs evidence of service health or failure history.

Service subscription is modeled as an enterprise operator function

Clause 8 explains the subscription business model. Enterprise operators can manage client applications, service access groups (SAGs), service profiles, service contracts, and enterprise operator accounts through the Framework. The result is a controlled subscription structure that maps which client applications may use which services.

This part matters for organizations that sell or govern service access centrally. The enterprise operator creates and maintains the subscription data, while the Framework enforces the resulting access rights for the client applications in that enterprise domain.

Service properties are used to register capabilities and match discovery requests

Clause 10 defines service properties and service property types. A service provider registers properties to describe what a service capability feature can support, and a client uses property values during discovery to find a match. That means service properties are not just descriptive - they are the filter the Framework uses to match available services to requested capabilities.

The clause also lists general service properties such as Service Name, Service Version, Service ID, Service Description, Product Name, Product Version, Operation Set, Compatible Service, Backward Compatibility Level, Migration Required, Data Migrated, Migration Date and Time, and Support for Regular Expressions in Address Range. Those properties help operators describe service identity, compatibility, and migration behavior in a consistent way.

The document is built around structured data definitions and explicit exceptions

Clause 11 provides the Framework-specific data definitions needed by the API. These include identifiers for client applications, enterprise operators, services, service profiles, service contracts, properties, and event or fault records. In practice, implementers use these types to build request and response payloads that match the Framework model.

Clause 12 lists the exception classes used by the API, including access, service ID, service type, authentication, and signing related errors. That is important for implementation and testing because each operation has defined failure cases that must be handled consistently.

What terms does SIST ES 204 915-3 V1.1.1:2008 define?

• Open Service Access (OSA) - The architecture and API family that lets applications use network functionality through standardized interfaces.
• Application Programming Interface (API) - The callable interface set used by applications and Framework components to exchange requests and callbacks.
• Service Capability Server (SCS) - The network-side system that offers service capability features to the Framework for registration and discovery.
• Service Capability Feature (SCF) - A service function or capability that can be registered, discovered, subscribed to, and used through the Framework.
• Unified Modelling Language (UML) - The notation used in this standard to describe classes, methods, state models, and sequence diagrams.
• Challenge Handshake Authentication Protocol (CHAP) - The authentication method referenced for the challenge-response exchange in the security flow.

Who uses SIST ES 204 915-3 V1.1.1:2008?

The main users are application developers, service platform vendors, network operators, and enterprise operators. Application developers use it to discover services, request access, subscribe to services, and handle callbacks. Service and network teams use it to register service capability features, manage availability, and support load and fault management.

It is also relevant to quality managers and buyers who need to confirm that an OSA/Parlay 6 implementation supports the required Framework behavior. Enterprise operator teams use the subscription and account management functions to control which client applications and service profiles are allowed to use particular services.

What changed in SIST ES 204 915-3 V1.1.1:2008 from the previous edition?

SIST ES 204 915-3 V1.1.1:2008 is based on ES 203 915 and adds the new requirements for OSA Phase 4. The scope also states that OSA Phase 4 incorporates 3GPP OSA Release 7 and is known as Parlay 6.0.

Annex F records the evolution of the API by listing new, deprecated, modified, and removed interfaces, methods, data definitions, service properties, and exceptions. That makes the standard useful not only as a current interface specification but also as a change guide for implementations moving from the earlier version.

Which standards are used with SIST ES 204 915-3 V1.1.1:2008?

• ETSI ES 204 915-1 - Provides the overview part of the OSA API and supplies the terms, abbreviations, and provisions referenced by this part.
• ETSI ES 204 915-2 - Provides common data definitions that the Framework part refers to when a type is not defined directly in this document.
• RFC 1994 - Supplies the CHAP challenge packet format used in the authentication exchanges.
• RFC 2630 - Supplies the CMS Signed-data structure used for service agreement signatures and interface-termination signatures.
• UML - Provides the modeling notation used for the interface classes, methods, sequence diagrams, and state models.

What does the SIST ES 204 915-3 V1.1.1:2008 document contain?

The document contains UML-based class diagrams, sequence diagrams, and state transition diagrams for the Framework interfaces. It also contains detailed interface and method descriptions for discovery, authentication, access control, service agreement management, integrity management, event notification, service subscription, and service-side registration functions.

Clause 10 provides service property tables and property type descriptions used for registration and discovery. Clause 11 provides the data type definitions that support the API, and Clause 12 lists the exception classes used by the operations.

Annex A provides the OMG IDL form of the Framework interfaces, Annex B provides the WSDL form, and Annex C provides the Java™ API view. Annexes D and E give additional descriptive material for 3GPP OSA R7 and 3GPP2 cdma2000 network contexts.

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.: [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, 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.: [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, 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.: [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, 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
...