Tech-invite 3GPPspace IETFspace

21 22 23 24 25 26 27 28 29 31 32 33 34 35 36 37 38 4‑5x

TS 29.198-01
Open Service Access (OSA) API –
Part 1: Overview

3GPP‑Page ETSI‑search ToC_↓

V9.0.0 (PDF) 2009/12 57 p.

V8.0.0 2008/12 57 p.

V7.0.0 2007/03 57 p.

V6.5.0 2006/12 57 p.

V5.8.3 2006/06 48 p.

V4.3.8 2005/12 16 p.

Rapporteur:: Mr. Unmehopa, Musa

full Table of Contents for TS 29.198-01 Word version: 9.0.0

0 Introduction p. 6

1 Scope p. 9

2 References p. 9

3 Definitions and abbreviations p. 9

3.1 Definitions p. 9

3.2 Abbreviations p. 10

4 Open Service Access APIs p. 11

5 Structure of the OSA API (29.198) and Mapping (29.998) documents p. 12

6 Methodology p. 14

6.1 Tools and Languages p. 14

6.2 Packaging p. 14

6.3 Colours p. 14

6.4 Naming scheme p. 14

6.5 State Transition Diagram text and text symbols p. 15

6.6 Exception handling and passing results p. 15

6.7 References p. 15

6.8 Strings and Collections p. 15

6.9 Prefixes p. 15

7 Introduction to OSA APIs p. 16

7.1 Interface Types p. 16

7.2 Service Factory p. 16

7.3 Use of Sessions p. 16

7.4 Interfaces and Sessions p. 16

7.5 Callback Interfaces p. 16

7.6 Setting Callbacks p. 17

7.7 Synchronous versus Asynchronous Methods p. 17

7.8 Out Parameters p. 17

7.9 Exception Hierarchy p. 17

7.10 Common Exceptions p. 18

7.11 Use of NULL p. 18

7.12 Notification Handling p. 18

8 Backwards Compatibility Considerations p. 19

8.1 Guidelines to enable backwards compatibility in implementations p. 19

8.2 Rule summary p. 19

8.2.1 Server side permitted changes p. 19

8.2.2 Client side permitted changes p. 20

8.2.3 Data type permitted changes p. 20

8.3 Implementation Guidelines for Server Programmers p. 20

8.4 Implementation Guidelines for Client Programmers p. 20

8.5 Tracking the changes in the specifications p. 20

8.5.1 New Tag p. 20

8.5.2 Deprecated Tag p. 21

8.6 Technology realization rules p. 21

8.6.1 Corba IDL Rules p. 21

8.6.2 Java rules p. 21

8.7 Rules for removal of deprecated items from the specifications p. 21

A (Normative) OMG IDL p. 22

A.1 Tools and Languages p. 22

A.2 Namespace p. 22

A.3 Object References p. 22

A.4 Mapping of Datatypes p. 22

A.4.1 Basic Datatypes p. 22

A.4.2 Constants p. 22

A.4.3 Collections p. 22

A.4.4 Sequences p. 23

A.4.5 Enumerations p. 23

A.4.6 Choices p. 23

A.5 Use of NULL p. 24

A.6 Exceptions p. 24

A.7 Naming space across CORBA modules p. 24

B W3C WSDL p. 25

B.1 Tools and Languages p. 25

B.2 Proposed Namespaces for the OSA WSDL p. 25

B.3 Object References p. 26

B.4 Mapping UML Data Types to XML Schema p. 26

B.4.1 Data Types p. 26

B.4.1.2 <<Constant>> p. 26

B.4.1.3 <<NameValuePair>> p. 27

B.4.1.4 <<SequenceOfDataElements>> p. 27

B.4.1.5 <<TypeDef>> p. 27

B.4.1.6 <<NumberedSetOfDataElements>> p. 28

B.4.1.7 <<TaggedChoiceOfDataElements>> p. 28

B.5 Mapping of UML Interfaces to WSDL p. 28

B.5.1 Mapping of UML Operations to WSDL message element p. 28

B.5.2 Mapping of Exception to WSDL message element p. 29

B.5.4 Mapping of Interface Class to WSDL portType and binding elements p. 29

B.5.5 Mapping of UML Interfaces to WSDL service element p. 30

C Java™ Realisation API p. 31

C.1 Java™ Realisation Overview p. 31

C.1.1 J2SE™ API p. 31

C.1.2 J2EE™ API p. 31

C.1.3 Javadoc™ p. 31

C.2 Tools and languages p. 32

C.3 Generic mappings (Elements common to J2SE™ and J2EE™) p. 32

C.3.1 Namespace p. 32

C.3.2 Package Naming Conventions p. 32

C.3.3 Object References p. 32

C.3.4 Element Naming p. 33

C.3.5 Element Naming Collisions p. 33

C.3.6 Data Type Definitions p. 33

C.3.6.1 Basic Data Types p. 33

C.3.6.2 Constants p. 33

C.3.6.3 NumberedSetsOfDataElements (Collections) p. 34

C.3.6.4 SequenceOfDataElements (Structures) p. 34

C.3.6.5 NameValuePair (Enumerations) p. 35

C.3.6.6 TaggedChoiceOfDataElements (Unions) p. 36

C.3.6.7 Exceptions p. 38

C.3.6.7.1 PlatformException p. 38

C.3.6.7.2 P_XXX_XXX Exceptions p. 39

C.3.6.7.3 TpCommonExceptions p. 39

C.3.6.7.4 TpCommonException's associated exceptions p. 40

C.3.6.7.5 Additional abstract exceptions p. 40

C.3.6.7.6 InvalidUnionAccessorException p. 41

C.3.6.7.7 InvalidEnumValueException p. 41

C.3.6.8 Deprecation p. 41

C.4 J2SE™ Specific Conventions p. 42

C.4.1 Removal of "Tp" Prefix p. 42

C.4.2 Constants p. 42

C.4.3 Removal of "Ip" prefix p. 43

C.4.4 Mapping of IpInterface p. 43

C.4.5 Mapping of IpService p. 43

C.4.6 Mapping of UML Operations p. 43

C.4.7 Mapping of TpSessionID p. 44

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

C.4.9 Callback Rule p. 47

C.4.10 Factory Rule p. 48

C.4.11 J2SE™ Specific Exceptions p. 50

C.4.11.1 PeerUnavailableException p. 50

C.4.11.2 IllegalStateException p. 50

C.4.12 User Interaction Specific Rules p. 51

C.4.12.1 Interfaces representing UML IpUI and IpUICall Rule p. 51

C.4.12.2 Naming Collisions of IpUI and IpUICall Rule p. 51

C.4.12.3 Naming Collisions of IpUICall and IpUIAdminManager Rule p. 51

C.5 J2EE™ Specific Conventions p. 51

C.5.1 Void

C.5.2 Remote Interface Definitions p. 51

C.5.2.1 IpInterface p. 51

C.5.2.2 Methods for Remote Interfaces p. 51

C.5.3 Local Interface Definitions p. 52

C.5.3.1 Methods for Local Interfaces p. 52

C.5.4 Multi Party Call Control Specific Rules p. 52

C.5.4.1 IpCallLeg and IpAppCallLeg method name conflicts p. 52

D Description of Overview for 3GPP2 cdma2000 networks p. 53

D.1 General Exceptions p. 53

D.2 Specific Exceptions p. 53

D.2.1 Clause 1: Scope p. 53

D2.2 Clause 2: References p. 53

D2.3 Clause 3: Definitions and abbreviations p. 53

D2.4 Clause 4: Open Service Access APIs p. 53

D2.5 Clause 5: Structure of the OSA API (29.198) and Mapping (29.998) documents p. 53

D.2.6 Clause 6: Methodology p. 54

D.2.7 Clause 7: Introduction to OSA APIs p. 54

D.2.8 Annex A (normative): OMG IDL p. 54

D.2.9 Annex B (informative): W3C WSDL p. 54

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

$ Change history p. 55