TS 29.198
Open Service Access (OSA) API –
Part 1
V3.4.0 (PDF)
2001/06 161 p.
- Rapporteur:
- Mr. Unmehopa, Musa
full Table of Contents for TS 29.198 Word version: 3.4.0
1 Scope p. 11
2 References p. 12
3 Definitions and abbreviations p. 13
3.1 Definitions p. 13
3.2 Abbreviations p. 13
4 Open Service Architecture p. 14
5 Methodology p. 15
5.1 Tools and Languages p. 15
5.2 Packaging p. 15
5.3 Colours p. 15
5.4 Naming scheme p. 15
5.5 Error results p. 16
5.6 References p. 16
5.7 Number of out parameters p. 17
5.8 Strings and Collections p. 17
5.9 Prefixes p. 17
5.10 Naming space across CORBA modules p. 17
6 Class diagrams p. 18
6.1 Class diagrams common across OSA p. 18
6.2 Class diagrams for the Framework p. 20
6.2.1 Top level Framework packages p. 20
6.2.2 Service Discovery p. 21
6.2.3 Trust and Security Management p. 22
6.2.3.1 IpInitial p. 22
6.2.3.2 IpAppAuthentication p. 22
6.2.3.3 IpAuthentication p. 23
6.2.3.4 IpAccess p. 23
6.2.3.5 IpAppAccess p. 23
6.2.4 Integrity Management p. 24
6.2.4.1 IpHeartBeatMgmt p. 24
6.2.4.2 IpAppHeartBeatMgmt p. 24
6.2.4.3 IpHeartBeat p. 25
6.2.4.4 IpAppHeartBeat p. 25
6.2.4.5 IpLoadManager p. 25
6.2.4.6 IpAppLoadManager p. 26
6.2.4.7 IpFaultManager p. 26
6.2.4.8 IpAppFaultManager p. 26
6.2.4.9 IpOAM p. 27
6.2.4.10 IpAppOAM p. 27
6.2.5 Service Registration p. 27
6.2.6 Service Factory p. 28
6.3 Generic Call Control p. 28
6.3.1 Interface Classes p. 30
6.3.1.1 IpAppCallControlManager p. 30
6.3.1.2 IpCallControlManager p. 30
6.3.1.3 IpAppCall p. 30
6.3.1.4 IpCall p. 31
6.4 Generic User Interaction and Call User Interaction p. 31
6.4.1 Relation between IpCall and IpUICall during call related user interaction p. 32
6.4.2 Interface Classes p. 33
6.4.2.1 IpAppUIManager p. 33
6.4.2.2 IpUIManager p. 33
6.4.2.3 IpAppUI p. 33
6.4.2.4 IpUI p. 35
6.4.2.5 IpAppUICall p. 35
6.4.2.6 IpUICall p. 35
6.5 Data Session Control p. 36
6.5.1 Interface Classes p. 37
6.6 Network User Location p. 40
6.6.1 Network User Location SCF interface p. 40
6.6.2 Network User Location application interface p. 41
6.7 User Status p. 41
6.8 Terminal Capabilities p. 42
7 State Transition Diagrams p. 43
7.1 Framework p. 44
7.1.1 IpAuthentication p. 44
7.1.1.1 Idle state p. 44
7.1.1.2 Init Authentication state p. 45
7.1.1.3 Wait For Application Result state p. 45
7.1.1.4 Application Authenticated state p. 45
7.1.2 IpAccess p. 45
7.1.2.1 Active state p. 45
7.1.3 IpServiceDiscovery p. 46
7.1.3.1 Active state p. 46
7.1.4 IpLoadManager p. 47
7.1.4.1 Idle State p. 47
7.1.4.2 Registered State p. 47
7.1.4.3 Notifying p. 47
7.1.4.4 Suspending Notification p. 48
7.1.4.5 Normal Load state p. 48
7.1.4.6 Application overload state p. 48
7.1.4.7 Internal overload p. 48
7.1.4.8 Internal and application overload p. 49
7.1.5 IPFaultManager p. 49
7.1.5.1 Framework Active state p. 49
7.1.5.2 Framework Faulty state p. 49
7.1.5.3 The Service Activity Test state p. 49
7.1.5.4 The Framework Activity Test state p. 49
7.1.6 IpHeartbeatmgmt p. 50
7.1.7 IpHeartBeat p. 51
7.1.8 IpOAM p. 51
7.1.8.1 Active state p. 52
7.1.9 IpServiceRegistration p. 52
7.1.9.1 Registering SCF p. 52
7.1.9.2 SCF Registered p. 52
7.2 Generic Call Control p. 53
7.2.1 Call Control Manager p. 53
7.2.2 Call p. 54
7.3 User Interaction p. 56
7.4 Data Session p. 59
7.4.1 Active state p. 59
7.4.1.1 Setup state p. 59
7.4.1.2 Established state p. 60
7.4.2 Network Released state p. 60
7.4.3 Finished state p. 60
7.4.4 Application released state. p. 60
7.5 Network User Location p. 60
7.5.1 Active state p. 60
7.6 User Status p. 61
7.6.1 Active State p. 61
8 Data Definitions p. 61
8.1 Common Data definitions p. 61
8.1.1 Primitive Data Types p. 61
8.1.2 Structured data types classification p. 61
8.1.2.1 Structures made of data elements p. 61
8.1.2.2 Tagged choice of data elements (i.e.: Free unions) p. 62
8.1.2.3 Collection of data elements p. 62
8.1.2.4 References p. 62
8.1.3 Interface Definitions p. 63
8.1.3.1 IpOsa p. 63
8.1.3.2 IpOsaRef p. 63
8.1.3.3 IpOsaRefRef p. 63
8.1.3.4 IpService p. 63
8.1.3.5 IpServiceRef p. 63
8.1.3.6 IpServiceRefRef p. 63
8.1.4 Non primitive and structured type types definition p. 63
8.1.4.1 TpAssignmentID p. 63
8.1.4.2 TpSessionID p. 63
8.1.4.3 TpSessionIDSet p. 63
8.1.4.4 TpDuration p. 63
8.1.4.5 TpResult p. 64
8.1.4.6 TpResultType p. 64
8.1.4.7 TpResultFacility p. 64
8.1.4.8 TpResultInfo p. 64
8.1.4.9 TpDate p. 66
8.1.4.10 TpTime p. 66
8.1.4.11 TpDateAndTime p. 66
8.1.4.12 TpAddress p. 67
8.1.4.13 TpAddressSet p. 67
8.1.4.14 TpAddressPlan p. 68
8.1.4.15 TpAddressPresentation p. 68
8.1.4.16 TpAddressRange p. 68
8.1.4.17 TpAddressScreening p. 69
8.1.4.18 TpAddressError p. 69
8.1.4.19 TpURL p. 69
8.1.4.20 TpPrice p. 69
8.1.4.21 TpAoCInfo p. 69
8.1.4.22 TpAoCOrder p. 70
8.1.4.23 TpCallAoCOrderCategory p. 70
8.1.4.24 TpChargeAdviceInfo p. 70
8.1.4.25 TpCAIElements p. 70
8.1.4.26 TpChargePerTime p. 71
8.2 Framework Data Definitions p. 71
8.2.1 Common Framework Data Definitions p. 71
8.2.1.1 TpClientAppID p. 71
8.2.1.2 TpClientAppIDList p. 71
8.2.1.3 TpDomainID p. 71
8.2.1.4 TpDomainIDType p. 72
8.2.1.5 TpEntOpID p. 72
8.2.1.6 TpPropertyName p. 72
8.2.1.7 TpPropertyValue p. 72
8.2.1.8 TpProperty p. 72
8.2.1.9 TpPropertyList p. 72
8.2.1.10 TpEntOpIDList p. 72
8.2.1.11 TpFwID p. 72
8.2.1.12 TpService p. 72
8.2.1.13 TpServiceList p. 73
8.2.1.14 TpServiceDescription p. 73
8.2.1.15 TpServiceID p. 73
8.2.1.16 TpServiceIDList p. 73
8.2.1.17 TpServiceIDRef p. 73
8.2.1.18 TpServiceNameString p. 73
8.2.1.19 TpServiceSpecString p. 74
8.2.1.20 TpUniqueServiceNumber p. 74
8.2.1.21 TpServiceTypeProperty p. 74
8.2.1.22 TpServiceTypePropertyList p. 74
8.2.1.23 TpServicePropertyMode p. 74
8.2.1.24 TpServicePropertyTypeName p. 74
8.2.1.25 TpServicePropertyName p. 75
8.2.1.26 TpServicePropertyNameList p. 75
8.2.1.27 TpServicePropertyValue p. 75
8.2.1.28 TpServicePropertyValueList p. 75
8.2.1.29 TpServiceProperty p. 75
8.2.1.30 TpServicePropertyList p. 75
8.2.1.31 TpServiceSupplierID p. 75
8.2.1.32 TpServiceTypeDescription p. 75
8.2.1.33 TpServiceTypeName p. 76
8.2.1.34 TpServiceTypeNameList p. 76
8.2.2 Trust and Security Management Data Definitions p. 76
8.2.2.1 TpAccessType p. 76
8.2.2.2 TpAuthType p. 76
8.2.2.3 TpAuthCapability p. 76
8.2.2.4 TpAuthCapabilityList p. 77
8.2.2.5 TpEndAccessProperties p. 77
8.2.2.6 TpAuthDomain p. 77
8.2.2.7 TpInterfaceName p. 77
8.2.2.8 TpServiceAccessControl p. 77
8.2.2.9 TpServiceToken p. 78
8.2.2.10 TpSignatureAndServiceMgr p. 78
8.2.2.11 TpSigningAlgorithm p. 78
8.2.3 Integrity Management Data Definitions p. 78
8.2.3.1 TpActivityTestRes p. 78
8.2.3.2 TpFaultStatsRecord p. 78
8.2.3.3 TpFaultStats p. 79
8.2.3.4 TpFaultStatsSet p. 79
8.2.3.5 TpActivityTestID p. 79
8.2.3.6 TpInterfaceFault p. 79
8.2.3.7 TpSvcUnavailReason p. 79
8.2.3.8 TpFWUnavailReason p. 79
8.2.3.9 TpLoadLevel p. 80
8.2.3.10 TpLoadThreshold p. 80
8.2.3.11 TpLoadInitVal p. 80
8.2.3.12 TpTimeInterval p. 80
8.2.3.13 TpLoadPolicy p. 80
8.2.3.14 TpLoadStatistic p. 81
8.2.3.15 TpLoadStatisticList p. 81
8.2.3.16 TpLoadStatisticData p. 81
8.2.3.17 TpLoadStatisticEntityID p. 81
8.2.3.18 TpLoadStatisticEntityType p. 81
8.2.3.19 TpLoadStatisticInfo p. 82
8.2.3.20 TpLoadStatisticInfoType p. 82
8.2.3.21 TpLoadStatisticError p. 82
8.3 Generic Call Control Data Definitions p. 82
8.3.1 Interface definitions p. 82
8.3.1.1 IpAppCall p. 82
8.3.1.2 IpAppCallRef p. 82
8.3.1.3 IpAppCallRefRef p. 82
8.3.1.4 IpAppCallControlManager p. 83
8.3.1.5 IpAppCallControlManagerRef p. 83
8.3.1.6 IpCall p. 83
8.3.1.7 IpCallRef p. 83
8.3.1.8 IpCallRefRef p. 83
8.3.1.9 IpCallControlManager p. 83
8.3.1.10 IpCallControlManagerRef p. 83
8.3.2 Event Notification data definitions p. 83
8.3.2.1 TpCallEventName p. 83
8.3.2.2 TpCallEventCriteria p. 84
8.3.2.3 TpCallEventCriteriaResult p. 84
8.3.2.4 TpCallEventCriteriaResultSet p. 84
8.3.2.5 TpCallNotificationType p. 84
8.3.2.6 TpCallEventInfo p. 84
8.3.3 Generic Call Control Type definitions p. 85
8.3.3.1 TpCallAlertingMechanism p. 85
8.3.3.2 TpCallAppInfo p. 85
8.3.3.3 TpCallAppInfoType p. 85
8.3.3.4 TpCallAppInfoSet p. 86
8.3.3.5 TpCallBearerService p. 86
8.3.3.6 TpCallChargePlan p. 86
8.3.3.7 TpCallChargeOrder p. 87
8.3.3.8 TpCallChargeOrderCategory p. 87
8.3.3.9 TpCallEndedReport p. 87
8.3.3.10 TpCallError p. 88
8.3.3.11 TpCallAdditionalErrorInfo p. 88
8.3.3.12 TpCallErrorType p. 88
8.3.3.13 TpCallFault p. 88
8.3.3.14 TpCallIdentifier p. 89
8.3.3.15 TpCallIdentifierRef p. 89
8.3.3.16 TpCallInfoReport p. 89
8.3.3.17 TpCallInfoType p. 89
8.3.3.18 TpCallMonitorMode p. 90
8.3.3.19 TpCallNetworkAccessType p. 90
8.3.3.20 TpCallOverloadType p. 90
8.3.3.21 TpCallServiceCode p. 90
8.3.3.22 TpCallServiceCodeType p. 91
8.3.3.23 TpCallPartyCategory p. 91
8.3.3.24 TpCallReleaseCause p. 91
8.3.3.25 TpCallReport p. 92
8.3.3.26 TpCallAdditionalReportInfo p. 92
8.3.3.27 TpCallReportRequest p. 92
8.3.3.28 TpCallAdditionalReportCriteria p. 92
8.3.3.29 TpCallReportRequestSet p. 93
8.3.3.30 TpCallReportType p. 93
8.3.3.31 TpCallTeleService p. 94
8.3.3.32 TpCallSuperviseReport p. 94
8.3.3.33 TpCallSuperviseTreatment p. 95
8.4 User Interaction Data Definitions p. 95
8.4.1 Interface definitions p. 95
8.4.1.1 IpUI p. 95
8.4.1.2 IpUIRef p. 95
8.4.1.3 IpUIRefRef p. 95
8.4.1.4 IpUIManager p. 95
8.4.1.5 IpUIManagerRef p. 95
8.4.1.6 IpAppUI p. 96
8.4.1.7 IpAppUIRef p. 96
8.4.1.8 IpAppUIRefRef p. 96
8.4.1.9 IpAppUIManager p. 96
8.4.1.10 IpAppUIManagerRef p. 96
8.4.2 Type definitions p. 96
8.4.2.1 TpUICallIdentifier p. 96
8.4.2.2 TpUICallIdentifierRef p. 96
8.4.2.3 TpUICollectCriteria p. 96
8.4.2.4 TpUIError p. 97
8.4.2.5 TpUIEventCriteria p. 98
8.4.2.6 TpUIEventInfo p. 98
8.4.2.7 TpUIEventInfoDataType p. 98
8.4.2.8 TpUIFault p. 98
8.4.2.9 TpUIIdentifier p. 99
8.4.2.10 TpUIIdentifierRef p. 99
8.4.2.11 TpUIInfo p. 99
8.4.2.12 TpUIInfoType p. 99
8.4.2.13 TpUIReport p. 99
8.4.2.14 TpUIResponseRequest p. 100
8.4.2.15 TpUIVariableInfo p. 100
8.4.2.16 TpUIVariableInfoSet p. 100
8.4.2.17 TpUIVariablePartType p. 100
8.5 Data Session Control Data Definitions p. 101
8.5.1 Interface definitions p. 101
8.5.1.1 IpAppDataSession p. 101
8.5.1.2 IpAppDataSessionRef p. 101
8.5.1.3 IpAppDataSessionRefRef p. 101
8.5.1.4 IpAppDataSessionControlManager p. 101
8.5.1.5 IpAppDataSessionControlManagerRef p. 101
8.5.1.6 IpDataSession p. 101
8.5.1.7 IpDataSessionRef p. 101
8.5.1.8 IpDataSessionRefRef p. 101
8.5.1.9 IpDataSessionControlManager p. 101
8.5.1.10 IpDataSessionManagerRef p. 101
8.5.2 Event Notification data definitions p. 102
8.5.2.1 TpDataSessionEventName p. 102
8.5.2.2 TpDataSessionMonitorMode p. 102
8.5.2.3 TpDataSessionEventCriteria p. 102
8.5.2.4 TpDataSessionEventInfo p. 103
8.5.2.5 TpDataSessionChargePlan p. 103
8.5.2.6 TpDataSessionChargeOrder p. 103
8.5.2.7 TpDataSessionChargeOrderCategory p. 104
8.5.2.8 TpChargePerVolume p. 104
8.5.2.9 TpDataSessionIdentifier p. 104
8.5.2.10 TpDataSessionError p. 104
8.5.2.11 TpDataSessionAdditionalErrorInfo p. 105
8.5.2.12 TpDataSessionErrorType p. 105
8.5.2.13 TpDataSessionFault p. 105
8.5.2.14 TpDataSessionReleaseCause p. 105
8.5.2.15 TpDataSessionSuperviseVolume p. 106
8.5.2.16 TpDataSessionSuperviseReport p. 106
8.5.2.17 TpDataSessionSuperviseTreatment p. 106
8.5.2.18 TpDataSessionReport p. 106
8.5.2.19 TpDataSessionAdditionalReportInfo p. 107
8.5.2.20 TpDataSessionReportRequest p. 107
8.5.2.21 TpDataSessionReportRequestSet p. 107
8.5.2.22 TpDataSessionReportType p. 107
8.5.2.23 TpDataSessionEventCriteriaResultSetRef p. 107
8.5.2.24 TpDataSessionEventCriteriaResultSet p. 107
8.5.2.25 TpDataSessionEventCriteriaResult p. 108
8.6 Network User Location and User Status Data definitions p. 108
8.6.1 Interface Definitions p. 108
8.6.1.1 IpAppUserStatus p. 108
8.6.1.2 IpAppUserStatusRef p. 108
8.6.1.3 IpUserStatus p. 108
8.6.1.4 IpAppUserLocationCamel p. 108
8.6.1.5 IpAppUserLocationCamelRef p. 108
8.6.1.6 IpUserLocationCamel p. 108
8.6.2 Common Data Definitions for Network User Location and User Status p. 108
8.6.2.1 TpGeographicalPosition p. 108
8.6.2.2 TpLocationUncertaintyShape p. 110
8.6.2.3 TpMobilityDiagnostic p. 110
8.6.2.4 TpMobilityError p. 110
8.6.2.5 TpMobilityStopAssignmentData p. 111
8.6.2.6 TpMobilityStopScope p. 111
8.6.3 Network User Location Data Definitions p. 111
8.6.3.1 TpLocationCellIDOrLAI p. 112
8.6.3.2 TpLocationTriggerCamel p. 112
8.6.3.3 TpUserLocationCamel p. 112
8.6.3.4 TpUserLocationCamelSet p. 113
8.7 User Status Data Definitions p. 113
8.7.1 - p. 113
8.8 Terminal Capabilities Data Definitions p. 113
9 IDL Interface Definitions p. 115
9.1 Generic IDL p. 115
9.2 Framework IDL p. 118
9.2.1 Common Data Types for the Framework p. 118
9.2.2 Service Discovery IDL p. 120
9.2.3 Trust and Security Management IDL p. 121
9.2.4 Integrity Management IDL p. 124
9.2.5 Registration IDL p. 130
9.3 Call Control p. 131
9.3.1 Common Data Types for Call Control p. 131
9.3.2 Generic Call Control IDL p. 137
9.3.3 Enhanced Call Control IDL p. 140
9.4 User Interaction IDL p. 142
9.5 Data Session Control p. 147
9.6 Network User Location and User Status IDL p. 152
9.6.1 Common definitions for Network User Location and User Status: MM.idl p. 152
9.6.2 Network User Location: MMul.idl p. 153
9.6.3 User Status: MMus.idl p. 155
9.7 Terminal Capabilities: TERMCAP.idl p. 156
$ Change history p. 158
