ETSI ES 204 915-14 V1.1.1 (2008-05)

Final draft ETSI ES 204 915-14 V1.1.1 (2008-02)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 14: Presence and Availability Management SCF
(Parlay 6)



�

---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 204 915-14 V1.1.1 (2008-02)



Reference
DES/TISPAN-01032-14-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: +33 4 92 94 42 00  Fax: +33 4 93 65 47 16

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
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
within ETSI Secretariat.
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
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.

TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI

---------------------- Page: 2 ----------------------
3 Final draft ETSI ES 204 915-14 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.9
Foreword.9
1 Scope.10
2 References.10
3 Definitions and abbreviations.10
3.1 Definitions.10
3.2 Abbreviations.10
4 Presence and Availability Management SCF.11
4.1 Introduction.11
4.2 Motivation.11
4.3 Goals.11
4.4 Concepts.12
4.4.1 Identity.12
4.4.2 Agent.12
4.4.3 Presence.13
4.4.4 Availability .14
4.4.5 Events.15
4.5 Scope of PAM information .15
4.6 Security and privacy.15
5 Sequence Diagrams.16
5.1 Use of authentication tokens .17
5.2 Event registration and notification .18
6 Class Diagrams.18
6.1 PAM Provisioning SCF Class Diagrams.19
6.2 PAM Access SCF Class Diagrams.20
6.3 PAM Event SCF Class Diagrams.21
7 The Service Interface Specifications.22
7.1 Interface Specification Format .22
7.1.1 Interface Class.22
7.1.2 Method descriptions.22
7.1.3 Parameter descriptions.23
7.1.4 State Model.23
7.2 Base Interface.23
7.2.1 Interface Class IpInterface .23
7.3 Service Interfaces.23
7.3.1 Overview.23
7.4 Generic Service Interface .23
7.4.1 Interface Class IpService .23
7.4.1.1 Method setCallback().24
7.4.1.2 Method setCallbackWithSessionID().24
8 Presence and Availability Management Interface Classes.24
8.1 PAM Provisioning SCF Interface Classes.25
8.1.1 Interface Class IpPAMProvisioningManager .25
8.1.1.1 Method getAuthToken().25
8.1.1.2 Method obtainInterface().26
8.1.1.3 Method getAccessControl().26
8.1.1.4 Method setAccessControl().26
8.1.2 Interface Class IpPAMIdentityManagement .27
8.1.2.1 Method createIdentity().28
8.1.2.2 Method deleteIdentity().28
8.1.2.3 Method isIdentity().29
ETSI

---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 204 915-14 V1.1.1 (2008-02)
8.1.2.4 Method createGroupIdentity().29
8.1.2.5 Method deleteGroupIdentity().29
8.1.2.6 Method addToGroup().30
8.1.2.7 Method removeFromGroup().30
8.1.2.8 Method listMembers().30
8.1.2.9 Method isGroupIdentity().31
8.1.2.10 Method listGroupMembership().31
8.1.2.11 Method addAlias().32
8.1.2.12 Method removeAliases().32
8.1.2.13 Method listAliases().32
8.1.2.14 Method lookupByAlias().33
8.1.2.15 Method associateTypes().33
8.1.2.16 Method disassociateTypes().33
8.1.2.17 Method listTypesOfIdentity().34
8.1.2.18 Method hasType().34
8.1.2.19 Method getIdentityAttributes().35
8.1.2.20 Method setIdentityAttributes().35
8.1.3 Interface Class IpPAMAgentManagement .36
8.1.3.1 Method createAgent().37
8.1.3.2 Method deleteAgent().37
8.1.3.3 Method isAgent().37
8.1.3.4 Method enableCapabilities() .38
8.1.3.5 Method disableCapabilities() .38
8.1.3.6 Method listEnabledCapabilities().38
8.1.3.7 Method listAllCapabilities().39
8.1.3.8 Method isCapableOf().39
8.1.3.9 Method associateTypes().39
8.1.3.10 Method disassociateTypes().40
8.1.3.11 Method listTypesOfAgent().40
8.1.3.12 Method hasType().41
8.1.3.13 Method getAgentAttributes().41
8.1.3.14 Method setAgentAttributes().42
8.1.4 Interface Class IpPAMAgentAssignment.42
8.1.4.1 Method assignAgent().43
8.1.4.2 Method unassignAgent().43
8.1.4.3 Method listAssignedAgents().44
8.1.4.4 Method listAssociatedIdentitiesOfAgent().44
8.1.4.5 Method listAssignedAgentsByCapability() .45
8.1.4.6 Method listCapabilitiesOfIdentity() .45
8.1.4.7 Method isIdentityCapableOf().45
8.1.5 Interface Class IpPAMIdentityTypeManagement .46
8.1.5.1 Method createIdentityAttribute().46
8.1.5.2 Method deleteIdentityAttribute().47
8.1.5.3 Method getIdentityAttributeDefinition().47
8.1.5.4 Method listAllIdentityAttributes().47
8.1.5.5 Method createIdentityType().48
8.1.5.6 Method deleteIdentityType().48
8.1.5.7 Method listIdentityTypes().48
8.1.5.8 Method addIdentityTypeAttributes().49
8.1.5.9 Method removeIdentityTypeAttributes().49
8.1.5.10 Method listIdentityTypeAttributes().49
8.1.6 Interface Class IpPAMAgentTypeManagement .50
8.1.6.1 Method createAgentAttribute().50
8.1.6.2 Method deleteAgentAttribute().51
8.1.6.3 Method getAgentAttributeDefinition().51
8.1.6.4 Method listAllAgentAttributes().51
8.1.6.5 Method createAgentType().52
8.1.6.6 Method deleteAgentType().52
8.1.6.7 Method listAgentTypes().52
8.1.6.8 Method addAgentTypeAttributes().52
8.1.6.9 Method removeAgentTypeAttributes().53
8.1.6.10 Method listAgentTypeAttributes().53
ETSI

---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 204 915-14 V1.1.1 (2008-02)
8.1.7 Interface Class IpPAMCapabilityManagement .54
8.1.7.1 Method createCapabilityAttribute().54
8.1.7.2 Method deleteCapabilityAttribute().55
8.1.7.3 Method getCapabilityAttributeDefinition().55
8.1.7.4 Method listAllCapabilityAttributes() .55
8.1.7.5 Method createCapability().56
8.1.7.6 Method deleteCapability().56
8.1.7.7 Method listCapabilities().56
8.1.7.8 Method addCapabilityAttributes().57
8.1.7.9 Method removeCapabilityAttributes().57
8.1.7.10 Method listCapabilityAttributes().57
8.1.7.11 Method assignCapabilitiesToType() .58
8.1.7.12 Method unassignCapabilitiesFromType().58
8.1.7.13 Method listCapabilitiesOfType() .58
8.2 PAM Access SCF Interface Classes.59
8.2.1 Interface Class IpPAMPresenceAvailabilityManager .59
8.2.1.1 Method getAuthToken().59
8.2.1.2 Method obtainInterface().60
8.2.1.3 Method getAccessControl().60
8.2.1.4 Method setAccessControl().61
8.2.1.5 Method activateService().61
8.2.1.6 Method deactivateService().61
8.2.1.7 Method isActiveIdentity().62
8.2.2 Interface Class IpPAMIdentityPresence .62
8.2.2.1 Method setIdentityPresence().63
8.2.2.2 Method setIdentityPresenceExpiration().63
8.2.2.3 Method getIdentityPresence().63
8.2.3 Interface Class IpPAMAvailability.64
8.2.3.1 Method getAvailability().65
8.2.3.2 Method getPreference().66
8.2.3.3 Method setPreference().66
8.2.4 Interface Class IpPAMAgentPresence.67
8.2.4.1 Method setAgentPresence().67
8.2.4.2 Method setCapabilityPresence().68
8.2.4.3 Method setAgentPresenceExpiration().68
8.2.4.4 Method setCapabilityPresenceExpiration().69
8.2.4.5 Method getAgentPresence().69
8.2.4.6 Method getCapabilityPresence().70
8.2.5 Interface Class IpAppPAMPreferenceCheck.70
8.2.5.1 Method computeAvailability().70
8.3 PAM Event SCF Interface Classes.71
8.3.1 Interface Class IpPAMEventManager .71
8.3.1.1 Method getAuthToken().72
8.3.1.2 Method obtainInterface().72
8.3.1.3 Method getAccessControl().73
8.3.1.4 Method setAccessControl().73
8.3.1.5 Method activateService().74
8.3.1.6 Method deactivateService().74
8.3.1.7 Method isActiveIdentity().74
8.3.2 Interface Class IpPAMEventHandler.75
8.3.2.1 Method isRegistered().75
8.3.2.2 Method registerAppInterface().76
8.3.2.3 Method registerForEvent().76
8.3.2.4 Method deregisterAppInterface().76
8.3.2.5 Method deregisterFromEvent().77
8.3.3 Interface Class IpAppPAMEventHandler.77
8.3.3.1 Method eventNotify().77
8.3.3.2 Method eventNotifyErr().78
9 State Transition Diagrams.78
10 PAM Service Properties .78
ETSI

---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 204 915-14 V1.1.1 (2008-02)
10.1 PAM Access Service .79
10.2 PAM Event Service.79
11 PAM Data Definitions.79
11.1 Entity Address Definitions.79
11.1.1 TpPAMFQName.79
11.1.2 TpPAMFQNameList.79
11.2 Attribute Data Definit
...

SLOVENSKI STANDARD
SIST ES 204 915-14 V1.1.1:2008
01-september-2008
2GSUWLGRVWRSGRVWRULWYH26$$SOLNDFLMVNLSURJUDPVNLYPHVQLN$3,GHO
/DVWQRVWVWRULWYHQH]PRåQRVWL6&)]DXSUDYOMDQMHQDY]RþQRVWLLQUD]SRORåOMLYRVWL
3DUOD\
Open Service Access (OSA) - Application Programming Interface (API) - Part 14:
Presence and Availability Management SCF (Parlay 6)
Ta slovenski standard je istoveten z: ES 204 915-14 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 204 915-14 V1.1.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

SIST ES 204 915-14 V1.1.1:2008

---------------------- Page: 2 ----------------------

SIST ES 204 915-14 V1.1.1:2008

ETSI ES 204 915-14 V1.1.1 (2008-05)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 14: Presence and Availability Management SCF
(Parlay 6)



�

---------------------- Page: 3 ----------------------

SIST ES 204 915-14 V1.1.1:2008
 2 ETSI ES 204 915-14 V1.1.1 (2008-05)



Reference
DES/TISPAN-01032-14-OSA
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: +33 4 92 94 42 00  Fax: +33 4 93 65 47 16

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
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
within ETSI Secretariat.
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
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.

TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI

---------------------- Page: 4 ----------------------

SIST ES 204 915-14 V1.1.1:2008
 3 ETSI ES 204 915-14 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.9
Foreword.9
1 Scope.10
2 References.10
3 Definitions and abbreviations.10
3.1 Definitions.10
3.2 Abbreviations.10
4 Presence and Availability Management SCF.11
4.1 Introduction.11
4.2 Motivation.11
4.3 Goals.11
4.4 Concepts.12
4.4.1 Identity.12
4.4.2 Agent.12
4.4.3 Presence.13
4.4.4 Availability .14
4.4.5 Events.15
4.5 Scope of PAM information .15
4.6 Security and privacy.15
5 Sequence Diagrams.16
5.1 Use of authentication tokens .17
5.2 Event registration and notification .18
6 Class Diagrams.18
6.1 PAM Provisioning SCF Class Diagrams.19
6.2 PAM Access SCF Class Diagrams.20
6.3 PAM Event SCF Class Diagrams.21
7 The Service Interface Specifications.22
7.1 Interface Specification Format .22
7.1.1 Interface Class.22
7.1.2 Method descriptions.22
7.1.3 Parameter descriptions.23
7.1.4 State Model.23
7.2 Base Interface.23
7.2.1 Interface Class IpInterface .23
7.3 Service Interfaces.23
7.3.1 Overview.23
7.4 Generic Service Interface .23
7.4.1 Interface Class IpService .23
7.4.1.1 Method setCallback().24
7.4.1.2 Method setCallbackWithSessionID().24
8 Presence and Availability Management Interface Classes.24
8.1 PAM Provisioning SCF Interface Classes.25
8.1.1 Interface Class IpPAMProvisioningManager .25
8.1.1.1 Method getAuthToken().25
8.1.1.2 Method obtainInterface().26
8.1.1.3 Method getAccessControl().26
8.1.1.4 Method setAccessControl().26
8.1.2 Interface Class IpPAMIdentityManagement .27
8.1.2.1 Method createIdentity().28
8.1.2.2 Method deleteIdentity().28
8.1.2.3 Method isIdentity().29
ETSI

---------------------- Page: 5 ----------------------

SIST ES 204 915-14 V1.1.1:2008
 4 ETSI ES 204 915-14 V1.1.1 (2008-05)
8.1.2.4 Method createGroupIdentity().29
8.1.2.5 Method deleteGroupIdentity().29
8.1.2.6 Method addToGroup().30
8.1.2.7 Method removeFromGroup().30
8.1.2.8 Method listMembers().30
8.1.2.9 Method isGroupIdentity().31
8.1.2.10 Method listGroupMembership().31
8.1.2.11 Method addAlias().32
8.1.2.12 Method removeAliases().32
8.1.2.13 Method listAliases().32
8.1.2.14 Method lookupByAlias().33
8.1.2.15 Method associateTypes().33
8.1.2.16 Method disassociateTypes().33
8.1.2.17 Method listTypesOfIdentity().34
8.1.2.18 Method hasType().34
8.1.2.19 Method getIdentityAttributes().35
8.1.2.20 Method setIdentityAttributes().35
8.1.3 Interface Class IpPAMAgentManagement .36
8.1.3.1 Method createAgent().37
8.1.3.2 Method deleteAgent().37
8.1.3.3 Method isAgent().37
8.1.3.4 Method enableCapabilities() .38
8.1.3.5 Method disableCapabilities() .38
8.1.3.6 Method listEnabledCapabilities().38
8.1.3.7 Method listAllCapabilities().39
8.1.3.8 Method isCapableOf().39
8.1.3.9 Method associateTypes().39
8.1.3.10 Method disassociateTypes().40
8.1.3.11 Method listTypesOfAgent().40
8.1.3.12 Method hasType().41
8.1.3.13 Method getAgentAttributes().41
8.1.3.14 Method setAgentAttributes().42
8.1.4 Interface Class IpPAMAgentAssignment.42
8.1.4.1 Method assignAgent().43
8.1.4.2 Method unassignAgent().43
8.1.4.3 Method listAssignedAgents().44
8.1.4.4 Method listAssociatedIdentitiesOfAgent().44
8.1.4.5 Method listAssignedAgentsByCapability() .45
8.1.4.6 Method listCapabilitiesOfIdentity() .45
8.1.4.7 Method isIdentityCapableOf().45
8.1.5 Interface Class IpPAMIdentityTypeManagement .46
8.1.5.1 Method createIdentityAttribute().46
8.1.5.2 Method deleteIdentityAttribute().47
8.1.5.3 Method getIdentityAttributeDefinition().47
8.1.5.4 Method listAllIdentityAttributes().47
8.1.5.5 Method createIdentityType().48
8.1.5.6 Method deleteIdentityType().48
8.1.5.7 Method listIdentityTypes().48
8.1.5.8 Method addIdentityTypeAttributes().49
8.1.5.9 Method removeIdentityTypeAttributes().49
8.1.5.10 Method listIdentityTypeAttributes().49
8.1.6 Interface Class IpPAMAgentTypeManagement .50
8.1.6.1 Method createAgentAttribute().50
8.1.6.2 Method deleteAgentAttribute().51
8.1.6.3 Method getAgentAttributeDefinition().51
8.1.6.4 Method listAllAgentAttributes().51
8.1.6.5 Method createAgentType().52
8.1.6.6 Method deleteAgentType().52
8.1.6.7 Method listAgentTypes().52
8.1.6.8 Method addAgentTypeAttributes().52
8.1.6.9 Method removeAgentTypeAttributes().53
8.1.6.10 Method listAgentTypeAttributes().53
ETSI

---------------------- Page: 6 ----------------------

SIST ES 204 915-14 V1.1.1:2008
 5 ETSI ES 204 915-14 V1.1.1 (2008-05)
8.1.7 Interface Class IpPAMCapabilityManagement .54
8.1.7.1 Method createCapabilityAttribute().54
8.1.7.2 Method deleteCapabilityAttribute().55
8.1.7.3 Method getCapabilityAttributeDefinition().55
8.1.7.4 Method listAllCapabilityAttributes() .55
8.1.7.5 Method createCapability().56
8.1.7.6 Method deleteCapability().56
8.1.7.7 Method listCapabilities().56
8.1.7.8 Method addCapabilityAttributes().57
8.1.7.9 Method removeCapabilityAttributes().57
8.1.7.10 Method listCapabilityAttributes().57
8.1.7.11 Method assignCapabilitiesToType() .58
8.1.7.12 Method unassignCapabilitiesFromType().58
8.1.7.13 Method listCapabilitiesOfType() .58
8.2 PAM Access SCF Interface Classes.59
8.2.1 Interface Class IpPAMPresenceAvailabilityManager .59
8.2.1.1 Method getAuthToken().59
8.2.1.2 Method obtainInterface().60
8.2.1.3 Method getAccessControl().60
8.2.1.4 Method setAccessControl().61
8.2.1.5 Method activateService().61
8.2.1.6 Method deactivateService().61
8.2.1.7 Method isActiveIdentity().62
8.2.2 Interface Class IpPAMIdentityPresence .62
8.2.2.1 Method setIdentityPresence().63
8.2.2.2 Method setIdentityPresenceExpiration().63
8.2.2.3 Method getIdentityPresence().63
8.2.3 Interface Class IpPAMAvailability.64
8.2.3.1 Method getAvailability().65
8.2.3.2 Method getPreference().66
8.2.3.3 Method setPreference().66
8.2.4 Interface Class IpPAMAgentPresence.67
8.2.4.1 Method setAgentPresence().67
8.2.4.2 Method setCapabilityPresence().68
8.2.4.3 Method setAgentPresenceExpiration().68
8.2.4.4 Method setCapabilityPresenceExpiration().69
8.2.4.5 Method getAgentPresence().69
8.2.4.6 Method getCapabilityPresence().70
8.2.5 Interface Class IpAppPAMPreferenceCheck.70
8.2.5.1 Method computeAvailability().70
8.3 PAM Event SCF Interface Classes.71
8.3.1 Interface Class IpPAMEventManager .71
8.3.1.1 Method getAuthToken().72
8.3.1.2 Method obtainInterface().72
8.3.1.3 Method getAccessControl().73
8.3.1.4 Method setAccessControl().73
8.3.1.5 Method activateService().74
8.3.1.6 Method deactivateService().74
8.3.1.7 Method isActiveIdentity().74
8.3.2 Interface Class IpPAMEventHandler.75
8.3.2.1 Method isRegistered().75
8.3.2.2 Method registerAppInterface().76
8.3.2.3 Method registerForEvent().76
8.3.2.4 Method deregisterAppInterface().76
8.3.2.5 Method deregisterFromEvent().77
8.3.3 Interface Class IpAppPAMEventHandler.77
8.3.3.1 Method eventNotify().77
8.3.3.2 Method eventNotifyErr().78
9 State Transition Diagrams.78
10 PAM Service Properties .78
ETSI

---------------------- Page: 7 ----------------------

SIST ES 204 915-14 V1.1.1:2008
 6 ETSI ES 204 915-14 V1.1.1 (2008-05)
10.1
...