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