Tech-
invite
3GPP
space
IETF
RFCs
SIP
Quick
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
TS 29.198-14
Open Service Access (OSA) API –
Part 14: Presence and Availability Management (PAM) Service Capability Feature (SCF)
3GPP‑Page
ETSI‑search
ToC
↓
V9.0.0 (PDF)
2009/12 114 p.
V8.0.0
2008/06 114 p.
V7.0.0
2007/03 108 p.
V6.3.1
2006/07 107 p.
V5.7.1
2005/01 60 p.
Rapporteur:
Mr. Unmehopa, Musa
full Table of Contents for
TS 29.198-14
Word version: 9.0.0
0
Introduction
Word‑p. 9
1
Scope
Word‑p. 11
2
References
Word‑p. 11
3
Definitions and abbreviations
Word‑p. 11
3.1
Definitions
Word‑p. 11
3.2
Abbreviations
Word‑p. 12
4
Presence and Availability Management SCF
Word‑p. 12
4.1
Introduction
Word‑p. 12
4.2
Motivation
Word‑p. 12
4.3
Goals
Word‑p. 12
4.4
Concepts
Word‑p. 13
4.4.1
Identity
Word‑p. 13
4.4.2
Agent
Word‑p. 13
4.4.3
Presence
Word‑p. 14
4.4.4
Availability
Word‑p. 14
4.4.5
Events
Word‑p. 15
4.5
Scope of PAM information
Word‑p. 16
4.6
Security and privacy
Word‑p. 16
5
Sequence Diagrams
Word‑p. 17
5.1
Use of authentication tokens
Word‑p. 17
5.2
Event registration and notification
Word‑p. 18
6
Class Diagrams
Word‑p. 19
6.1
PAM Provisioning SCF Class Diagrams
Word‑p. 19
6.2
PAM Access SCF Class Diagrams
Word‑p. 21
6.3
PAM Event SCF Class Diagrams
Word‑p. 22
7
The Service Interface Specifications
Word‑p. 23
7.1
Interface Specification Format
Word‑p. 23
7.1.1
Interface Class
Word‑p. 23
7.1.2
Method descriptions
Word‑p. 24
7.1.3
Parameter descriptions
Word‑p. 24
7.1.4
State Model
Word‑p. 24
7.2
Base Interface
Word‑p. 24
7.2.1
Interface Class IpInterface
Word‑p. 24
7.3
Service Interfaces
Word‑p. 24
7.3.1
Overview
Word‑p. 24
7.4
Generic Service Interface
Word‑p. 24
7.4.1
Interface Class IpService
Word‑p. 24
7.4.1.1
Method setCallback()
Word‑p. 25
7.4.1.2
Method setCallbackWithSessionID()
Word‑p. 25
8
Presence and Availability Management Interface Classes
Word‑p. 26
8.1
PAM Provisioning SCF Interface Classes
Word‑p. 26
8.1.1
Interface Class IpPAMProvisioningManager
Word‑p. 26
8.1.1.1
Method getAuthToken()
Word‑p. 27
8.1.1.2
Method obtainInterface()
Word‑p. 27
8.1.1.3
Method getAccessControl()
Word‑p. 28
8.1.1.4
Method setAccessControl()
Word‑p. 28
8.1.2
Interface Class IpPAMIdentityManagement
Word‑p. 29
8.1.2.1
Method createIdentity()
Word‑p. 30
8.1.2.2
Method deleteIdentity()
Word‑p. 31
8.1.2.3
Method isIdentity()
Word‑p. 31
8.1.2.4
Method createGroupIdentity()
Word‑p. 32
8.1.2.5
Method deleteGroupIdentity()
Word‑p. 32
8.1.2.6
Method addToGroup()
Word‑p. 32
8.1.2.7
Method removeFromGroup()
Word‑p. 33
8.1.2.8
Method listMembers()
Word‑p. 33
8.1.2.9
Method isGroupIdentity()
Word‑p. 34
8.1.2.10
Method listGroupMembership()
Word‑p. 34
8.1.2.11
Method addAlias()
Word‑p. 35
8.1.2.12
Method removeAliases()
Word‑p. 35
8.1.2.13
Method listAliases()
Word‑p. 36
8.1.2.14
Method lookupByAlias()
Word‑p. 36
8.1.2.15
Method associateTypes()
Word‑p. 36
8.1.2.16
Method disassociateTypes()
Word‑p. 37
8.1.2.17
Method listTypesOfIdentity()
Word‑p. 37
8.1.2.18
Method hasType()
Word‑p. 38
8.1.2.19
Method getIdentityAttributes()
Word‑p. 38
8.1.2.20
Method setIdentityAttributes()
Word‑p. 39
8.1.3
Interface Class IpPAMAgentManagement
Word‑p. 39
8.1.3.1
Method createAgent()
Word‑p. 40
8.1.3.2
Method deleteAgent()
Word‑p. 41
8.1.3.3
Method isAgent()
Word‑p. 41
8.1.3.4
Method enableCapabilities()
Word‑p. 41
8.1.3.5
Method disableCapabilities()
Word‑p. 42
8.1.3.6
Method listEnabledCapabilities()
Word‑p. 42
8.1.3.7
Method listAllCapabilities()
Word‑p. 43
8.1.3.8
Method isCapableOf()
Word‑p. 43
8.1.3.9
Method associateTypes()
Word‑p. 44
8.1.3.10
Method disassociateTypes()
Word‑p. 44
8.1.3.11
Method listTypesOfAgent()
Word‑p. 45
8.1.3.12
Method hasType()
Word‑p. 45
8.1.3.13
Method getAgentAttributes()
Word‑p. 45
8.1.3.14
Method setAgentAttributes()
Word‑p. 46
8.1.4
Interface Class IpPAMAgentAssignment
Word‑p. 47
8.1.4.1
Method assignAgent()
Word‑p. 47
8.1.4.2
Method unassignAgent()
Word‑p. 48
8.1.4.3
Method listAssignedAgents()
Word‑p. 48
8.1.4.4
Method listAssociatedIdentitiesOfAgent()
Word‑p. 49
8.1.4.5
Method listAssignedAgentsByCapability()
Word‑p. 49
8.1.4.6
Method listCapabilitiesOfIdentity()
Word‑p. 49
8.1.4.7
Method isIdentityCapableOf()
Word‑p. 50
8.1.5
Interface Class IpPAMIdentityTypeManagement
Word‑p. 50
8.1.5.1
Method createIdentityAttribute()
Word‑p. 51
8.1.5.2
Method deleteIdentityAttribute()
Word‑p. 51
8.1.5.3
Method getIdentityAttributeDefinition()
Word‑p. 52
8.1.5.4
Method listAllIdentityAttributes()
Word‑p. 52
8.1.5.5
Method createIdentityType()
Word‑p. 52
8.1.5.6
Method deleteIdentityType()
Word‑p. 53
8.1.5.7
Method listIdentityTypes()
Word‑p. 53
8.1.5.8
Method addIdentityTypeAttributes()
Word‑p. 54
8.1.5.9
Method removeIdentityTypeAttributes()
Word‑p. 54
8.1.5.10
Method listIdentityTypeAttributes()
Word‑p. 55
8.1.6
Interface Class IpPAMAgentTypeManagement
Word‑p. 55
8.1.6.1
Method createAgentAttribute()
Word‑p. 56
8.1.6.2
Method deleteAgentAttribute()
Word‑p. 56
8.1.6.3
Method getAgentAttributeDefinition()
Word‑p. 57
8.1.6.4
Method listAllAgentAttributes()
Word‑p. 57
8.1.6.5
Method createAgentType()
Word‑p. 57
8.1.6.6
Method deleteAgentType()
Word‑p. 58
8.1.6.7
Method listAgentTypes()
Word‑p. 58
8.1.6.8
Method addAgentTypeAttributes()
Word‑p. 59
8.1.6.9
Method removeAgentTypeAttributes()
Word‑p. 59
8.1.6.10
Method listAgentTypeAttributes()
Word‑p. 60
8.1.7
Interface Class IpPAMCapabilityManagement
Word‑p. 60
8.1.7.1
Method createCapabilityAttribute()
Word‑p. 61
8.1.7.2
Method deleteCapabilityAttribute()
Word‑p. 61
8.1.7.3
Method getCapabilityAttributeDefinition()
Word‑p. 62
8.1.7.4
Method listAllCapabilityAttributes()
Word‑p. 62
8.1.7.5
Method createCapability()
Word‑p. 63
8.1.7.6
Method deleteCapability()
Word‑p. 63
8.1.7.7
Method listCapabilities()
Word‑p. 63
8.1.7.8
Method addCapabilityAttributes()
Word‑p. 64
8.1.7.9
Method removeCapabilityAttributes()
Word‑p. 64
8.1.7.10
Method listCapabilityAttributes()
Word‑p. 65
8.1.7.11
Method assignCapabilitiesToType()
Word‑p. 65
8.1.7.12
Method unassignCapabilitiesFromType()
Word‑p. 66
8.1.7.13
Method listCapabilitiesOfType()
Word‑p. 66
8.2
PAM Access SCF Interface Classes
Word‑p. 66
8.2.1
Interface Class IpPAMPresenceAvailabilityManager
Word‑p. 66
8.2.1.1
Method getAuthToken()
Word‑p. 67
8.2.1.2
Method obtainInterface()
Word‑p. 67
8.2.1.3
Method getAccessControl()
Word‑p. 68
8.2.1.4
Method setAccessControl()
Word‑p. 68
8.2.1.5
Method activateService()
Word‑p. 69
8.2.1.6
Method deactivateService()
Word‑p. 69
8.2.1.7
Method isActiveIdentity()
Word‑p. 69
8.2.2
Interface Class IpPAMIdentityPresence
Word‑p. 70
8.2.2.1
Method setIdentityPresence()
Word‑p. 70
8.2.2.2
Method setIdentityPresenceExpiration()
Word‑p. 71
8.2.2.3
Method getIdentityPresence()
Word‑p. 71
8.2.3
Interface Class IpPAMAvailability
Word‑p. 72
8.2.3.1
Method getAvailability()
Word‑p. 73
8.2.3.2
Method getPreference()
Word‑p. 74
8.2.3.3
Method setPreference()
Word‑p. 74
8.2.4
Interface Class IpPAMAgentPresence
Word‑p. 75
8.2.4.1
Method setAgentPresence()
Word‑p. 75
8.2.4.2
Method setCapabilityPresence()
Word‑p. 76
8.2.4.3
Method setAgentPresenceExpiration()
Word‑p. 76
8.2.4.4
Method setCapabilityPresenceExpiration()
Word‑p. 77
8.2.4.5
Method getAgentPresence()
Word‑p. 77
8.2.4.6
Method getCapabilityPresence()
Word‑p. 78
8.2.5
Interface Class IpAppPAMPreferenceCheck
Word‑p. 78
8.2.5.1
Method computeAvailability()
Word‑p. 79
8.3
PAM Event SCF Interface Classes
Word‑p. 79
8.3.1
Interface Class IpPAMEventManager
Word‑p. 79
8.3.1.1
Method getAuthToken()
Word‑p. 80
8.3.1.2
Method obtainInterface()
Word‑p. 80
8.3.1.3
Method getAccessControl()
Word‑p. 81
8.3.1.4
Method setAccessControl()
Word‑p. 81
8.3.1.5
Method activateService()
Word‑p. 82
8.3.1.6
Method deactivateService()
Word‑p. 82
8.3.1.7
Method isActiveIdentity()
Word‑p. 82
8.3.2
Interface Class IpAppPAMEventHandler
Word‑p. 83
8.3.2.1
Method eventNotify()
Word‑p. 83
8.3.2.2
Method eventNotifyErr()
Word‑p. 83
8.3.3
Interface Class IpPAMEventHandler
Word‑p. 84
8.3.3.1
Method isRegistered()
Word‑p. 84
8.3.3.2
Method registerAppInterface()
Word‑p. 85
8.3.3.3
Method registerForEvent()
Word‑p. 85
8.3.3.4
Method deregisterAppInterface()
Word‑p. 86
8.3.3.5
Method deregisterFromEvent()
Word‑p. 86
9
State Transition Diagrams
Word‑p. 86
10
PAM Service Properties
Word‑p. 87
10.1
PAM Access Service
Word‑p. 87
10.2
PAM Event Service
Word‑p. 87
11
PAM Data Definitions
Word‑p. 87
11.1
Entity Address Definitions
Word‑p. 87
11.1.1
TpPAMFQName
Word‑p. 87
11.1.2
TpPAMFQNameList
Word‑p. 88
11.2
Attribute Data Definitions
Word‑p. 88
11.2.1
TpPAMAttribute
Word‑p. 88
11.2.2
TpPAMAttributeList
Word‑p. 88
11.2.3
TpPAMAttributeDef
Word‑p. 88
11.2.4
TpPAMAttributeDefList
Word‑p. 88
11.3
Presence Data Definitions
Word‑p. 89
11.3.1
TpPAMCapability
Word‑p. 89
11.3.2
TpPAMCapabilityList
Word‑p. 89
11.3.3
TpPAMPresenceData
Word‑p. 89
11.3.4
TpPAMPresenceDataList
Word‑p. 89
11.4
Pre-defined Presence type
Word‑p. 89
11.4.1
Presentity
Word‑p. 89
11.5
Availability Data Definitions
Word‑p. 90
11.5.1
TpPAMAvailabilityProfile
Word‑p. 90
11.5.2
TpPAMAvailabilityProfileList
Word‑p. 90
11.5.3
TpPAMPrivacyCode
Word‑p. 90
11.6
Availability Context Data Definitions
Word‑p. 90
11.6.1
TpPAMContext
Word‑p. 90
11.6.2
TpPAMContextName
Word‑p. 91
11.6.3
TpPAMContextData
Word‑p. 91
11.6.4
TpPAMCommunicationContext
Word‑p. 91
11.6.5
TpPAMContextList
Word‑p. 91
11.7
Credential data definitions
Word‑p. 91
11.7.1
TpPAMCredential
Word‑p. 91
11.8
Availability and Access Control Preference Data Definitions
Word‑p. 91
11.8.1
IpAppPAMPreferenceCheckRef
Word‑p. 91
11.8.2
TpPAMAccessControlData
Word‑p. 92
11.8.3
TpPAMACLDefault
Word‑p. 92
11.8.4
TpPAMPreferenceOp
Word‑p. 92
11.8.5
TpPAMPreferenceType
Word‑p. 92
11.8.6
TpPAMPreferenceData
Word‑p. 92
11.9
Time data definitions
Word‑p. 93
11.9.1
TpPAMTimeInterval
Word‑p. 93
11.10
Pre-defined Entity Types and Attributes
Word‑p. 93
11.11
Interface name definitions
Word‑p. 93
11.11.1
TpPAMProvisioningInterfaceName
Word‑p. 93
11.11.2
TpPAMPresenceAvailabilityInterfaceName
Word‑p. 94
11.11.3
TpPAMEventInterfaceName
Word‑p. 94
11.12
Event data definitions
Word‑p. 94
11.12.1
IpAppPAMEventHandlerRef
Word‑p. 94
11.12.2
TpPAMClientID
Word‑p. 94
11.12.3
TpPAMEventID
Word‑p. 94
11.12.4
TpPAMEventName
Word‑p. 95
11.12.5
TpPAMEventNameList
Word‑p. 95
11.12.6
TpPAMEventInfo
Word‑p. 95
11.12.7
TpPAMEventInfoList
Word‑p. 96
11.12.8
TpPAMNotificationInfo
Word‑p. 96
11.12.9
TpPAMNotificationInfoList
Word‑p. 96
11.12.10
PAM_CE_IDENTITY_CREATED
Word‑p. 96
11.12.10.1
TpPAMICEventData
Word‑p. 96
11.12.10.2
TpPAMICNotificationData
Word‑p. 97
11.12.11
PAM_CE_IDENTITY_DELETED
Word‑p. 97
11.12.11.1
TpPAMIDEventData
Word‑p. 97
11.12.11.2
TpPAMIDNotificationData
Word‑p. 97
11.12.12
PAM_CE_GROUP_MEMBERSHIP_CHANGED
Word‑p. 97
11.12.12.1
TpPAMGMCEventData
Word‑p. 98
11.12.12.2
TpPAMGMCNotificationData
Word‑p. 98
11.12.13
PAM_CE_AGENT_CREATED
Word‑p. 98
11.12.13.1
TpPAMACEventData
Word‑p. 98
11.12.13.2
TpPAMACNotificationData
Word‑p. 98
11.12.14
PAM_CE_AGENT_DELETED
Word‑p. 98
11.12.14.1
TpPAMADEventData
Word‑p. 99
11.12.14.2
TpPAMADNotificationData
Word‑p. 99
11.12.15
PAM_CE_AGENT_ASSIGNED
Word‑p. 99
11.12.15.1
TpPAMAAEventData
Word‑p. 99
11.12.15.2
TpPAMAANotificationData
Word‑p. 99
11.12.16
PAM_CE_AGENT_UNASSIGNED
Word‑p. 100
11.12.16.1
TpPAMAUEventData
Word‑p. 100
11.12.16.2
TpPAMAUNotificationData
Word‑p. 100
11.12.17
PAM_CE_CAPABILITY_CHANGED
Word‑p. 100
11.12.17.1
TpPAMCCEventData
Word‑p. 100
11.12.17.2
TpPAMCCNotificationData
Word‑p. 101
11.12.18
PAM_CE_AGENT_CAPABILITY_PRESENCE_SET
Word‑p. 101
11.12.18.1
TpPAMACPSEventData
Word‑p. 101
11.12.18.2
TpPAMACPSNotificationData
Word‑p. 101
11.12.19
PAM_CE_AGENT_PRESENCE_SET
Word‑p. 101
11.12.19.1
TpPAMAPSEventData
Word‑p. 102
11.12.19.2
TpPAMAPSNotificationData
Word‑p. 102
11.12.20
PAM_CE_IDENTITY_PRESENCE_SET
Word‑p. 102
11.12.20.1
TpPAMIPSEventData
Word‑p. 102
11.12.20.2
TpPAMIPSNotificationData
Word‑p. 103
11.12.21
PAM_CE_AVAILABILITY_CHANGED
Word‑p. 103
11.12.21.1
TpPAMAVCEventData
Word‑p. 103
11.12.21.2
TpPAMAVCNotificationData
Word‑p. 103
11.12.22
PAM_CE_WATCHERS_CHANGED
Word‑p. 103
11.12.22.1
TpPAMWCEventData
Word‑p. 104
11.12.22.2
TpPAMWCNotificationData
Word‑p. 104
11.12.22.3
TpPAMwatcherChangeType
Word‑p. 104
11.13
Error Types
Word‑p. 104
11.13.1
TpPAMErrorCause
Word‑p. 104
11.13.2
TpPAMErrorInfo
Word‑p. 105
12
Presence and Availability Management Exception Classes
Word‑p. 106
A
(Normative) OMG IDL Description of Presence and Availability Management SCF
Word‑p. 107
B
W3C WSDL Description of the Presence and Availability Management SCFs
Word‑p. 108
C
Java™ API Description of the Presence and Availability Management SCFs
Word‑p. 109
D
Description of Presence and Availability Management for 3GPP2 cdma2000 networks
Word‑p. 110
D.1
General Exceptions
Word‑p. 110
D.2
Specific Exceptions
Word‑p. 110
D.2.1
Clause 1: Scope
Word‑p. 110
D.2.2
Clause 2: References
Word‑p. 110
D.2.3
Clause 3: Definitions and abbreviations
Word‑p. 110
D.2.4
Clause 4: Presence and Availability Management SCF
Word‑p. 110
D.2.5
Clause 5: Sequence Diagrams
Word‑p. 110
D.2.6
Clause 6 Class Diagrams
Word‑p. 111
D.2.7
Clause 7: The Service Interface Specifications
Word‑p. 111
D.2.8
Clause 8: Presence and Availability Management Interface Classes
Word‑p. 111
D.2.9
Clause 9: State Transition Diagrams
Word‑p. 111
D.2.10
Clause 10: PAM Service Properties
Word‑p. 111
D.2.11
Clause 11: PAM Data Definitions
Word‑p. 111
D.2.12
Clause 12: Presence and Availability Management Exception Classes
Word‑p. 111
D.2.13
Annex A (normative):OMG IDL Description of Presence and Availability Management SCF
Word‑p. 111
D.2.14
Annex C (informative): Java™ API Description of Presence and Availability Management SCF
Word‑p. 111
$
Change history
Word‑p. 112