SIST ES 204 915-1 V1.1.1:2008

SLOVENSKI STANDARD
SIST ES 204 915-1 V1.1.1:2008
01-september-2008

Odprti dostop do storitve (OSA) - Aplikacijski programski vmesnik (API) - 1. del:

2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

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

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

If you find errors in the present document, please send your comment to one of the following services:

DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered

3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.

Intellectual Property Rights................................................................................................................................6

Foreword.............................................................................................................................................................6

1 Scope........................................................................................................................................................7

2 References................................................................................................................................................7

2.1 Normative references.........................................................................................................................................7

3 Definitions and abbreviations.................................................................................................................11

3.1 Definitions........................................................................................................................................................11

3.2 Abbreviations...................................................................................................................................................12

4 Open Service Access APIs.....................................................................................................................13

5 Document structure................................................................................................................................14

6 Methodology..........................................................................................................................................16

6.1 Tools and Languages........................................................................................................................................16

6.2 Packaging Structure..........................................................................................................................................16

6.3 Colours.............................................................................................................................................................18

6.4 Naming scheme................................................................................................................................................18

6.5 State Transition Diagram text and text symbols...............................................................................................19

6.6 Exception handling and passing results............................................................................................................19

6.7 References........................................................................................................................................................19

6.8 Strings and Collections.....................................................................................................................................19

6.9 Prefixes.............................................................................................................................................................19

7 Introduction to Parlay/OSA APIs...........................................................................................................20

7.1 Interface Types.................................................................................................................................................20

7.2 Service Factory.................................................................................................................................................20

7.3 Use of Sessions.................................................................................................................................................20

7.4 Interfaces and Sessions.....................................................................................................................................20

7.5 Callback Interfaces...........................................................................................................................................20

7.6 Setting Callbacks..............................................................................................................................................21

7.7 Synchronous versus Asynchronous Methods ...................................................................................................21

7.8 Out Parameters.................................................................................................................................................21

7.9 Exception Hierarchy.........................................................................................................................................21

7.10 Common Exceptions........................................................................................................................................22

7.11 Use of NULL....................................................................................................................................................22

7.12 Notification Handling.......................................................................................................................................22

8 Relationship between ETSI, Parlay and 3GPP OSA releases ................................................................23

9 Backwards Compatibility Considerations ..............................................................................................24

9.1 Guidelines to enable backwards compatibility in implementations .................................................................24

9.2 Rule summary..................................................................................................................................................25

9.2.1 Server side permitted changes ....................................................................................................................25

9.2.2 Client side permitted changes .....................................................................................................................25

9.2.3 Data type permitted changes.......................................................................................................................25

9.3 Implementation Guidelines for Server Programmers .......................................................................................25

9.4 Implementation Guidelines for Client Programmers........................................................................................26

9.5 Tracking the changes in the specifications .......................................................................................................26

9.5.1 New Tag.....................................................................................................................................................26

9.5.2 Deprecated Tag...........................................................................................................................................26

9.6 Technology realization rules ............................................................................................................................26

9.6.1 Corba IDL Rules.........................................................................................................................................26

9.6.2 Java rules....................................................................................................................................................26

9.7 Rules for removal of deprecated items from the specifications........................................................................27

Annex A (normative): OMG IDL .......................................................................................................28

A.1 Tools and languages ...............................................................................................................................28

A.2 Namespace.............................................................................................................................................28

A.3 Object References...................................................................................................................................28

A.4 Mapping of Datatypes ............................................................................................................................28

A.4.1 Basic Datatypes................................................................................................................................................28

A.4.2 Constants..........................................................................................................................................................28

A.4.3 Collections........................................................................................................................................................29

A.4.4 Sequences.........................................................................................................................................................29

A.4.5 Enumerations....................................................................................................................................................29

A.4.6 Choices.............................................................................................................................................................29

A.5 Use of NULL..........................................................................................................................................30

A.6 Exceptions..............................................................................................................................................30

A.7 Naming space across CORBA modules.................................................................................................30

Annex B (informative): W3C WSDL....................................................................................................31

B.1 Tools and Languages..............................................................................................................................31

B.2 Proposed Namespaces for the OSA WSDL ...........................................................................................31

B.3 Object References...................................................................................................................................32

B.4 Mapping UML Data Types to XML Schema.........................................................................................32

B.4.1 Data Types........................................................................................................................................................32

B.4.1.1 <>.............................................................................................................................................33

B.4.1.2 <>..................................................................................................................................33

B.4.1.3 <>..................................................................................................................33

B.4.1.4 <>.............................................................................................................................................34

B.4.1.5 <>...........................................................................................................34

B.4.1.6 <>..........................................................................................................34

B.5 Mapping of UML Interfaces to WSDL ..................................................................................................35

B.5.1 Mapping of UML Operations to WSDL message element...............................................................................35

B.5.2 Mapping of Exception to WSDL message element..........................................................................................35

B.5.3 Mapping of Interface Class to WSDL portType and binding elements............................................................36

B.5.4 Mapping of UML Interfaces to WSDL service element...................................................................................37

Annex C (informative): Java™ Realisation API .................................................................................38

C.1 Java™ Realisation Overview .................................................................................................................38

C.1.1 J2SE™ API......................................................................................................................................................38

C.1.2 J2EE™ API......................................................................................................................................................38

C 1.3 Javadoc™ .........................................................................................................................................................38

C.2 Tools and languages ...............................................................................................................................39

C.3 Generic Mappings (Elements common to J2SE™ and J2EE™)............................................................39

C.3.1 Namespace.......................................................................................................................................................39

C.3.2 Package Naming Conventions..........................................................................................................................39

C.3.3 Object References.............................................................................................................................................39

C.3.4 Element Naming...............................................................................................................................................40

C.3.5 Element Naming Collisions..............................................................................................................................40

C.3.6 Data Type Definitions ......................................................................................................................................40

C.3.6.1 Basic Data Types ........................................................................................................................................40

C.3.6.2 Constants ....................................................................................................................................................40

C.3.6.3 NumberedSetsOfDataElements (Collections).............................................................................................41

C.3.6.4 SequenceOfDataElements (Structures).......................................................................................................41

C.3.6.5 NameValuePair (Enumerations) .................................................................................................................42

C.3.6.6 TaggedChoiceOfDataElements (Unions) ...................................................................................................43

C.3.6.7 Exceptions...................................................................................................................................................45

C.3.6.7.1 PlatformException................................................................................................................................45

C.3.6.7.2 P_XXX_XXX Exceptions....................................................................................................................46

C.3.6.7.3 TpCommonExceptions..........................................................................................................................46

C.3.6.7.4 TpCommonException's associated exceptions......................................................................................47

C.3.6.7.5 Additional abstract exceptions ..............................................................................................................47

C.3.6.7.6 InvalidUnionAccessorException...........................................................................................................48

C.3.6.7.7 InvalidEnumValueException................................................................................................................48

C.3.6.8 Deprecation.................................................................................................................................................48

C.4 J2SE™ Specific Conventions.................................................................................................................49

C.4.1 Removal of "Tp" Prefix....................................................................................................................................49

C.4.2 Constants..........................................................................................................................................................49

C.4.3 Removal of "Ip" prefix .....................................................................................................................................49

C.4.4 Mapping of IpInterface.....................................................................................................................................50

C.4.5 Mapping of IpService.......................................................................................................................................50

C.4.6 Mapping of UML Operations...........................................................................................................................50

C.4.7 Mapping of TpSessionID .................................................................................................................................51

C.4.8 Mapping of TpAssignmentID to the creation of an Activity object .................................................................51

C.4.9 Callback Rule...................................................................................................................................................55

C.4.10 Factory Rule.....................................................................................................................................................55

C.4.11 J2SE™ Specific Exceptions .............................................................................................................................57

C.4.11.1 PeerUnavailableException..........................................................................................................................57

C.4.11.2 IllegalStateException..................................................................................................................................57

C.4.12 User Interaction Specific Rules ........................................................................................................................58

C.4.12.1 Interfaces representing UML IpUI and IpUICall Rule ...............................................................................58

C.4.12.2 Naming Collisions of IpUI and IpUICall Rule ...........................................................................................58

C.4.12.3 Naming Collisions of IpUICall and IpUIAdminManager Rule ..................................................................58

C.5 J2EE™ Specific Conventions ................................................................................................................58

C.5.1 Void..................................................................................................................................................................58

C.5.2 Remote Interface Definitions ...........................................................................................................................58

C.5.2.1 IpInterface...................................................................................................................................................58

C.5.2.2 Methods for Remote Interfaces...................................................................................................................58

C.5.3 Local Interface Definitions...............................................................................................................................59

C.5.3.1 Methods for Local Interfaces......................................................................................................................59

C.5.4 Multi Party Call Control Specific Rules...........................................................................................................59

C.5.4.1 IpCallLeg and IpAppCallLeg method name conflicts ................................................................................59

Annex D (informative): Description of Overview for 3GPP2 cdma2000 networks..........................60

D.1 General Exceptions.................................................................................................................................60

D.2 Specific Exceptions................................................................................................................................60

D.2.1 Clause 1: Scope ................................................................................................................................................60

D.2.2 Clause 2: References ........................................................................................................................................60

D.2.3 Clause 3: Definitions and abbreviations...........................................................................................................60

D.2.4 Clause 4: Open Service Access APIs ...............................................................................................................60

D.2.5 Clause 5: Structure of the OSA API (TS 129 198) and Mapping (TR 129 998) documents............................60

D.2.6 Clause 6: Methodology ....................................................................................................................................60

D.2.7 Clause 7: Introduction to OSA APIs ................................................................................................................60

D.2.8 Annex A (normative): OMG IDL.....................................................................................................................61

D.2.9 Annex B (informative): W3C WSDL...............................................................................................................61

D.2.10 Annex C (informative): Java™ API.................................................................................................................61

Annex E (informative): Bibliography...................................................................................................62

History ..............................................................................................................................................................64

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

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

This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet

The present document is part 1 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

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 is part 1 of the Stage 3 specification for an Application Programming Interface for Open Service

Access (OSA), and provides an overview of the content and structure of the various parts of the present document, and

The OSA specifications define an architecture that enables service application developers to make use of network

References are either specific (identified by date of publication and/or edition number or version number) or

• Non-specific reference may be made only to a complete document or a part thereof and only in the following