SIST ES 204 915-16 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. This specification describes the OSA Service Broker SCF. The present document is part 16 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 Service Broker Service Capability Feature (SCF) aspects of the interface. All aspects of the Service Broker SCF are defined here, these being:; • Sequence Diagrams.; • Class Diagrams.; • Interface specification plus detailed method descriptions.; • State Transition diagrams.; • Data Definitions.; • IDL 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-16 V1.1.1 (2008-05) - Open Service Access (OSA); Application Programming Interface (API); Part 16: Service Broker SCF (Parlay 6)

SIST ES 204 915-16 V1.1.1:2008 is an ETSI Standard for Open Service Access (OSA) Application Programming Interface (API), Part 16 covering the Service Broker Service Capability Feature (SCF) in Parlay 6. It specifies how an application registers interest in service interactions so the Service Broker can direct traffic to the right endpoint. The document is for developers, integrators and testers who need the Service Broker interface, its data types, its exceptions and its UML-based API description.

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

SIST ES 204 915-16 V1.1.1:2008 specifies the Stage 3 API for the Service Broker SCF within OSA. It defines the interface behavior, object relationships and data definitions needed to implement service brokering in an open, standardised network API.

The standard is organized as a technical specification with clauses on scope, references, definitions, the Service Broker SCF itself, interface descriptions, properties, data definitions and exception classes. It uses Unified Modelling Language (UML) to describe the interfaces and object interactions.

Annex	What it covers
A	Normative OMG IDL description of the Service Broker SCF
B	Informative W3C WSDL description of the Service Broker SCF
C	Informative Java API description of the Service Broker SCF
D	Informative contents of 3GPP OSA R7 Service Broker
E	Informative description of Service Broker for 3GPP2 cdma2000 networks
F	Informative record of changes

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

SIST ES 204 915-16 V1.1.1:2008 focuses on how an implementation exposes the Service Broker SCF and how applications register, unregister and receive callbacks. The practical point is that the API is not just a list of methods - it defines how those methods behave, what data they take and which errors they raise.

Method support and error handling

Clause 4.1 says an implementation that supports a method shall support that method for at least one valid set of parameter values. If a service interface method is not supported, the implementation shall return P_METHOD_NOT_SUPPORTED. This matters when you are checking conformance or deciding whether a platform really implements a feature you plan to use.

Interface structure and callbacks

Clause 7 defines the interface specification format, including synchronous and asynchronous methods, parameter direction and state models. The standard uses callback interfaces named IpApp<name> or IpSvc<name> so the service can return results or reports. In practice, this means application developers must provide the right callback interface when they expect asynchronous interaction.

Clause 7.4 defines the generic service interface IpService with setCallback() and setCallbackWithSessionID(). setCallback() is for callbacks that are not tied to a session, while setCallbackWithSessionID() is for callbacks linked to a specific TpSessionID. That distinction matters if your service interaction is tied to a call, call leg or similar session-based context.

Service Broker registration and unregistration

Clause 8 defines IpServiceBroker, which has two synchronous methods: register() and unregister(). The application provides a clientBrokerID, an endpointAddress and optionally a serviceKey to register(), and receives a TpAssignmentID back. In practice, the assignment ID is the handle you must keep if you later want to remove that registration.

The registration behavior supports repeated registrations. The same clientBrokerID can be used multiple times, which can support load sharing or primary-secondary traffic distribution, and a single application may use more than one clientBrokerID to partition subscribers. If the same clientBrokerID, endpointAddress and serviceKey are used again, the service broker returns the same assignmentID.

Clause 8 also defines the error cases. P_INVALID_CRITERIA applies when the same clientBrokerID is used on different service managers, and P_INVALID_SERVICE_INTERACTION applies when the Service Broker entity has insufficient knowledge to process the request. For unregister(), P_INVALID_ASSIGNMENT_ID is returned when the supplied assignment ID does not match a prior registration.

Addressing and service key data

Clause 10 defines the P_ADDRESSPLAN service property as an INTEGER_SET indicating the supported address plans. This matters because the application must use an endpoint address format the service broker can handle.

Clause 11 defines TpEndpointAddress as a tagged choice with P_NETWORK_ADDRESS or P_SS7_ADDRESS, and TpServiceKey as a tagged choice with P_SERVICE_KEY. It also defines clientBrokerID as the identifier for the application or service requesting interaction. In practice, these data types tell you how to format routing information and how to identify the service interaction being provisioned.

Exception reporting

Clause 12 defines P_INVALID_SERVICE_INTERACTION and the shared ExtraInformation field carried by exceptions. This helps implementations return a machine-readable reason and a short diagnostic hint, which is useful in testing and troubleshooting.

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

• Service Broker SCF - The Service Capability Feature that lets an application register interest in particular service interactions so traffic can be directed to it.
• OSA - Open Service Access, the architecture that gives application developers access to network functionality through an open standardised interface.
• clientBrokerID - The name that identifies the application or service requiring the service interaction.
• TpEndpointAddress - A tagged choice that specifies the endpoint address where network traffic should be sent.
• TpServiceKey - A tagged choice that identifies the service for which interaction is requested.
• TpAssignmentID - The identifier returned by register() and used later by unregister().
• IpServiceBroker - The service interface class that contains register() and unregister().
• UML - Unified Modelling Language, the object-modelling method used to describe the interfaces and their relationships.

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

SIST ES 204 915-16 V1.1.1:2008 is used by application developers and service developers building OSA-based network applications. It is also used by network platform engineers and system integrators who implement the Service Broker SCF or connect applications to it.

Test and quality teams use it to verify method behavior, callback handling, registration rules and exception handling. It is also relevant to teams designing traffic steering, load sharing, hot standby or subscriber partitioning through service brokering.

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

SIST ES 204 915-16 V1.1.1:2008 is the Parlay 6.0 version of the Service Broker SCF and is equivalent to 3GPP TS 29.198-16 V1.0.0 (Release 7). Annex F records the revision history by interfaces, methods, data definitions, service properties and exceptions, grouping items as new, deprecated, modified or removed.

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

• ETSI ES 204 915-1 - Provides the OSA overview, the shared terms and abbreviations, and the reference framework used by this part.
• ETSI ES 204 915-2 - Provides common data definitions for types referenced in this part but defined elsewhere in the OSA series.

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

The document contains the Service Broker SCF interface model in UML, including class diagrams, interface specifications, method descriptions, parameter descriptions and state models. It also contains the service properties table, the Service Broker data definitions and the exception classes used by the API.

Annex A provides the OMG IDL form of the interface, Annex B the W3C WSDL form and Annex C Java API realizations for J2SE and J2EE. Annex D maps the content to 3GPP OSA R7 Service Broker, while Annex E gives cdma2000-specific interpretation notes and exceptions for 3GPP2 environments. Annex F is the change record for the release history.

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

Reference
DES/TISPAN-01032-16-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-16 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Service Broker SCF.7
4.1 General requirements on support of methods.7
5 Sequence Diagrams.7
6 Class Diagrams.8
7 The Service Interface Specifications.8
7.1 Interface Specification Format .8
7.1.1 Interface Class.8
7.1.2 Method descriptions.8
7.1.3 Parameter descriptions.8
7.1.4 State Model.9
7.2 Base Interface.9
7.2.1 Interface Class IpInterface .9
7.3 Service Interfaces.9
7.3.1 Overview.9
7.4 Generic Service Interface .9
7.4.1 Interface Class IpService .9
7.4.1.1 Method setCallback().10
7.4.1.2 Method setCallbackWithSessionID().10
8 Service Broker Interface Classes.10
8.1 Interface Class IpServiceBroker.10
8.1.1 Method register().11
8.1.2 Method unregister().12
9 State Transition Diagrams.12
10 Service Broker Service Properties.12
11 Data Definitions.12
11.1 Service Broker Data Definitions .12
11.1.1 clientBrokerID.12
11.1.2 TpEndpointAddress .13
11.1.3 TpEndpointAddressCategory.13
11.1.4 TpServiceKey.13
11.1.5 TpServiceKeyType.13
12 Exception Classes.13
Annex A (normative): OMG IDL Description of Service Broker SCF .14
Annex B (informative): W3C WSDL Description of Service Broker SCF.15
Annex C (informative): Java API Description of the Service Broker SCF .16
Annex D (informative): Contents of 3GPP OSA R7 Service Broker .17
Annex E (informative): Description of Service Broker for 3GPP2 cdma2000 networks.18
ETSI
4 Final draft ETSI ES 204 915-16 V1.1.1 (2008-02)
E.1 General Exceptions.18
E.2 Specific Exceptions.18
E.2.1 Clause 1: Scope .18
E.2.2 Clause 2: References .18
E.2.3 Clause 3: Definitions and abbreviations.18
E.2.4 Clause 4: Service Broker SCF.18
E.2.5 Clause 5: Sequence Diagrams .18
E.2.6 Clause 6: Class Diagrams.18
E.2.7 Clause 7: The Service Interface Specifications .18
E.2.8 Clause 8: Service Broker Interface Classes.19
E.2.9 Clause 9: State Transition Diagrams .19
E.2.10 Clause 10: Service Broker Service Properties.19
E.2.11 Clause 11: Data Definitions.19
E.2.12 Annex A (normative): OMG IDL Description of Service Broker SCF.19
E.2.13 Annex B (informative): W3C WSDL Description of Service Broker SCF.19
Annex F (informative): Record of changes .20
F.1 Interfaces.20
F.1.1 New.20
F.1.2 Deprecated.20
F.1.3 Removed.20
F.2 Methods.20
F.2.1 New.20
F.2.2 Deprecated.20
F.2.3 Modified.21
F.2.4 Removed.21
F.3 Data Definitions.21
F.3.1 New.21
F.3.2 Modified.21
F.3.3 Removed.21
F.4 Service Properties.21
F.4.1 New.21
F.4.2 Deprecated.22
F.4.3 Modified.22
F.4.4 Removed.22
F.5 Exceptions.22
F.5.1 New.22
F.5.2 Modified.22
F.5.3 Removed.22
F.6 Others.22
History .23

ETSI
5 Final draft ETSI ES 204 915-16 V1.1.1 (2008-02)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
The present document is part 16 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 204 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy Management SCF";
Part 14: "Presence and Availability Management SCF";
Part 15: "Multi-Media Messaging SCF";
Part 16: "Service Broker SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 6.0 set of specifications.
The present document is equivalent to 3GPP TS 29.198-16 V1.0.0 (Release 7).
ETSI
6 Final draft ETSI ES 204 915-16 V1.1.1 (2008-02)
1 Scope
The present document is part 16 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 Service Broker Service Capability Feature (SCF) aspects of the interface. All
aspects of the Service Broker SCF are defined here, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL 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).
2 References
The references listed in clause 2 of ES 204 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 204 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 6)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 204 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 204 915-1 apply.
ETSI
7 Final draft ETSI ES 204 915-16 V1.1.1 (2008-02)
4 Service Broker SCF
The following clauses describe each aspect of the Service Broker Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause shows how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions
are well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data Definitions clause shows a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part ES 204 915-2.
4.1 General requirements on support of methods
An implementation of this API which supports or implements a method described in the present document, shall
support or implement the functionality described for that method, for at least one valid set of values for the parameters
of that method.
Where a method is not supported by an implementation of a Service interface, the exception
P_METHOD_NOT_SUPPORTED shall be returned to any call of that method.
Where a me
...

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

Reference
DES/TISPAN-01032-16-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-16 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Service Broker SCF.7
4.1 General requirements on support of methods.7
5 Sequence Diagrams.7
6 Class Diagrams.8
7 The Service Interface Specifications.8
7.1 Interface Specification Format .8
7.1.1 Interface Class.8
7.1.2 Method descriptions.8
7.1.3 Parameter descriptions.8
7.1.4 State Model.9
7.2 Base Interface.9
7.2.1 Interface Class IpInterface .9
7.3 Service Interfaces.9
7.3.1 Overview.9
7.4 Generic Service Interface .9
7.4.1 Interface Class IpService .9
7.4.1.1 Method setCallback().10
7.4.1.2 Method setCallbackWithSessionID().10
8 Service Broker Interface Classes.10
8.1 Interface Class IpServiceBroker.10
8.1.1 Method register().11
8.1.2 Method unregister().12
9 State Transition Diagrams.12
10 Service Broker Service Properties.12
11 Data Definitions.12
11.1 Service Broker Data Definitions .12
11.1.1 clientBrokerID.12
11.1.2 TpEndpointAddress .13
11.1.3 TpEndpointAddressCategory.13
11.1.4 TpServiceKey.13
11.1.5 TpServiceKeyType.13
12 Exception Classes.13
Annex A (normative): OMG IDL Description of Service Broker SCF .14
Annex B (informative): W3C WSDL Description of Service Broker SCF.15
Annex C (informative): Java API Description of the Service Broker SCF .16
Annex D (informative): Contents of 3GPP OSA R7 Service Broker .17
Annex E (informative): Description of Service Broker for 3GPP2 cdma2000 networks.18
ETSI
4 ETSI ES 204 915-16 V1.1.1 (2008-05)
E.1 General Exceptions.18
E.2 Specific Exceptions.18
E.2.1 Clause 1: Scope .18
E.2.2 Clause 2: References .18
E.2.3 Clause 3: Definitions and abbreviations.18
E.2.4 Clause 4: Service Broker SCF.18
E.2.5 Clause 5: Sequence Diagrams .18
E.2.6 Clause 6: Class Diagrams.18
E.2.7 Clause 7: The Service Interface Specifications .18
E.2.8 Clause 8: Service Broker Interface Classes.19
E.2.9 Clause 9: State Transition Diagrams .19
E.2.10 Clause 10: Service Broker Service Properties.19
E.2.11 Clause 11: Data Definitions.19
E.2.12 Annex A (normative): OMG IDL Description of Service Broker SCF.19
E.2.13 Annex B (informative): W3C WSDL Description of Service Broker SCF.19
Annex F (informative): Record of changes .20
F.1 Interfaces.20
F.1.1 New.20
F.1.2 Deprecated.20
F.1.3 Removed.20
F.2 Methods.20
F.2.1 New.20
F.2.2 Deprecated.20
F.2.3 Modified.21
F.2.4 Removed.21
F.3 Data Definitions.21
F.3.1 New.21
F.3.2 Modified.21
F.3.3 Removed.21
F.4 Service Properties.21
F.4.1 New.21
F.4.2 Deprecated.22
F.4.3 Modified.22
F.4.4 Removed.22
F.5 Exceptions.22
F.5.1 New.22
F.5.2 Modified.22
F.5.3 Removed.22
F.6 Others.22
History .23

ETSI
5 ETSI ES 204 915-16 V1.1.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 16 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 204 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy Management SCF";
Part 14: "Presence and Availability Management SCF";
Part 15: "Multi-Media Messaging SCF";
Part 16: "Service Broker SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 6.0 set of specifications.
The present document is equivalent to 3GPP TS 29.198-16 V1.0.0 (Release 7).
ETSI
6 ETSI ES 204 915-16 V1.1.1 (2008-05)
1 Scope
The present document is part 16 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 Service Broker Service Capability Feature (SCF) aspects of the interface. All
aspects of the Service Broker SCF are defined here, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL 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).
2 References
The references listed in clause 2 of ES 204 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 204 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 6)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 204 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 204 915-1 apply.
ETSI
7 ETSI ES 204 915-16 V1.1.1 (2008-05)
4 Service Broker SCF
The following clauses describe each aspect of the Service Broker Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause shows how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions
are well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data Definitions clause shows a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part ES 204 915-2.
4.1 General requirements on support of methods
An implementation of this API which supports or implements a method described in the present document, shall
support or implement the functionality described for that method, for at least one valid set of values for the parameters
of that method.
Where a method is not supported by an implementation of a Service interface, the exception
P_METHOD_NOT_SUPPORTED shall be returned to any call of that method.
Where a
...

SLOVENSKI STANDARD
01-september-2008
Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 16. del:
Lastnost storitvene zmožnosti (SCF) za storitvenega posrednika (Parlay 6)
Open Service Access (OSA) - Application Programming Interface (API) - Part 16: Service
Broker SCF (Parlay 6)
Ta slovenski standard je istoveten z: ES 204 915-16 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 16: Service Broker SCF
(Parlay 6)
�
2 ETSI ES 204 915-16 V1.1.1 (2008-05)

Reference
DES/TISPAN-01032-16-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-16 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Service Broker SCF.7
4.1 General requirements on support of methods.7
5 Sequence Diagrams.7
6 Class Diagrams.8
7 The Service Interface Specifications.8
7.1 Interface Specification Format .8
7.1.1 Interface Class.8
7.1.2 Method descriptions.8
7.1.3 Parameter descriptions.8
7.1.4 State Model.9
7.2 Base Interface.9
7.2.1 Interface Class IpInterface .9
7.3 Service Interfaces.9
7.3.1 Overview.9
7.4 Generic Service Interface .9
7.4.1 Interface Class IpService .9
7.4.1.1 Method setCallback().10
7.4.1.2 Method setCallbackWithSessionID().10
8 Service Broker Interface Classes.10
8.1 Interface Class IpServiceBroker.10
8.1.1 Method register().11
8.1.2 Method unregister().12
9 State Transition Diagrams.12
10 Service Broker Service Properties.12
11 Data Definitions.12
11.1 Service Broker Data Definitions .12
11.1.1 clientBrokerID.12
11.1.2 TpEndpointAddress .13
11.1.3 TpEndpointAddressCategory.13
11.1.4 TpServiceKey.13
11.1.5 TpServiceKeyType.13
12 Exception Classes.13
Annex A (normative): OMG IDL Description of Service Broker SCF .14
Annex B (informative): W3C WSDL Description of Service Broker SCF.15
Annex C (informative): Java API Description of the Service Broker SCF .16
Annex D (informative): Contents of 3GPP OSA R7 Service Broker .17
Annex E (informative): Description of Service Broker for 3GPP2 cdma2000 networks.18
ETSI
4 ETSI ES 204 915-16 V1.1.1 (2008-05)
E.1 General Exceptions.18
E.2 Specific Exceptions.18
E.2.1 Clause 1: Scope .18
E.2.2 Clause 2: References .18
E.2.3 Clause 3: Definitions and abbreviations.18
E.2.4 Clause 4: Service Broker SCF.18
E.2.5 Clause 5: Sequence Diagrams .18
E.2.6 Clause 6: Class Diagrams.18
E.2.7 Clause 7: The Service Interface Specifications .18
E.2.8 Clause 8: Service Broker Interface Classes.19
E.2.9 Clause 9: State Transition Diagrams .19
E.2.10 Clause 10: Service Broker Service Properties.19
E.2.11 Clause 11: Data Definitions.19
E.2.12 Annex A (normative): OMG IDL Description of Service Broker SCF.19
E.2.13 Annex B (informative): W3C WSDL Description of Service Broker SCF.19
Annex F (informative): Record of changes .20
F.1 Interfaces.20
F.1.1 New.20
F.1.2 Deprecated.20
F.1.3 Removed.20
F.2 Methods.20
F.2.1 New.20
F.2.2 Deprecated.20
F.2.3 Modified.21
F.2.4 Removed.21
F.3 Data Definitions.21
F.3.1 New.21
F.3.2 Modified.21
F.3.3 Removed.21
F.4 Service Properties.21
F.4.1 New.21
F.4.2 Deprecated.22
F.4.3 Modified.22
F.4.4 Removed.22
F.5 Exceptions.22
F.5.1 New.22
F.5.2 Modified.22
F.5.3 Removed.22
F.6 Others.22
History .23

ETSI
5 ETSI ES 204 915-16 V1.1.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 16 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 204 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy Management SCF";
Part 14: "Presence and Availability Management SCF";
Part 15: "Multi-Media Messaging SCF";
Part 16: "Service Broker SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 6.0 set of specifications.
The present document is equivalent to 3GPP TS 29.198-16 V1.0.0 (Release 7).
ETSI
6 ETSI ES 204 915-16 V1.1.1 (2008-05)
1 Scope
The present document is part 16 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 Service Broker Service Capability Feature (SCF) aspects of the interface. All
aspects of the Service Broker SCF are defined here, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL 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).
2 References
The references listed in clause 2 of ES 204 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 204 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 6)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 204 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 204 915-1 apply.
ETSI
7 ETSI ES 204 915-16 V1.1.1 (2008-05)
4 Service Broker SCF
The following clauses describe each aspect of the Service Broker Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause shows how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions
are well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data Definitions clause shows a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part ES 204 915-2.
4.1 General requirements on support of methods
An implementation of this API which supports or implements a method described in the present document, shall
support or implement the functionality described for that method, for
...