SIST ES 202 915-14 V1.1.1:2005

• Abstract:

  Specify the presence and availability management aspect of the interface. Edition PARLAY 4.0.

• Status: Published
• Publication Date: 31-Dec-2004
• ICS: 33.040.01 - Telecommunication systems in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Jan-2005
• Due Date: 01-Jan-2005
• Completion Date: 01-Jan-2005
• Ref Project: ETSI ES 202 915-14 V1.1.1 (2003-01) - Open Service Access (OSA); Application Programming Interface (API); Part 14: Presence and Availability Management SCF

SIST ES 202 915-14 V1.1.1:2005 is the Slovenian version of ETSI ES 202 915-14, the Open Service Access (OSA) Application Programming Interface (API) Part 14 for Presence and Availability Management SCF. It specifies the interface for managing identities, agents, presence, availability, related events, and the data structures used to exchange that information. It is aimed at implementers of OSA platforms, service developers, and integrators who need a standard way to query, update, and subscribe to presence and availability information across networks and services.

What does SIST ES 202 915-14 V1.1.1:2005 specify?

SIST ES 202 915-14 V1.1.1:2005 specifies the Presence and Availability Management Service Capability Feature (SCF) aspects of the OSA API. It defines the interface behavior through sequence diagrams, class diagrams, detailed method descriptions, state transition diagrams, data definitions, and IDL.

The standard is organized as a Stage 3 API specification. Clauses 1 to 4 introduce the scope, references, definitions, and the PAM concepts; clauses 5 and 6 show interaction and class structures; clauses 7 to 12 define the service interface format, concrete interfaces, service properties, data definitions, and exception classes.

It focuses on managing presence and availability information, not on defining how an implementation stores that information. Storage design and storage requirements are left to the implementation.

Annex	What it covers
Annex A	Further PAM information, including UML models, a suggested model, architecture, access levels, and use cases
Annex B	Normative OMG IDL description of the Presence and Availability Management SCF
Annex C	Informative Java API description of the Presence and Availability Management SCFs
Annex D	Informative contents of 3GPP OSA R5 Presence and Availability Management
Annex E	Informative record of changes

What are the key requirements of SIST ES 202 915-14 V1.1.1:2005?

Scope and operating model

SIST ES 202 915-14 V1.1.1:2005 standardizes the management and sharing of identity, agent, capability, presence, availability, and event information across communication services and networks. Clause 4 makes clear that presence and availability are related but not the same, so implementations need to handle them as separate concepts.

In practice, this means an implementation may infer presence from underlying services or networks instead of storing it explicitly. That gives vendors flexibility, but the API still has to present a common model to client applications.

Authentication, credentials, and privacy

SIST ES 202 915-14 V1.1.1:2005 uses OSA Framework authentication for access to the PAM interfaces and also provides a service-level credential mechanism through TpPAMCredential. Clause 5.1 explains that a caller can obtain an authentication token with getAuthToken() and reuse it within the same session.

This matters because many calls may be made on behalf of an end user by a proxy, gateway, or application server. The caller must supply the right asker data so that availability results and access decisions can reflect privacy preferences.

Provisioning interfaces

SIST ES 202 915-14 V1.1.1:2005 defines provisioning interfaces for identities, agents, assignments, types, attributes, and capabilities in clause 8.1. These interfaces manage names, aliases, groups, agent capabilities, and the relationships between identities and agents.

In practice, the provisioning part is what you use to create and organize the objects that later appear in presence and availability queries. It also defines error handling for conditions such as unknown identities, duplicate names, cyclic group relationships, and invalid credentials.

Presence and availability interfaces

SIST ES 202 915-14 V1.1.1:2005 defines interfaces for setting and retrieving identity presence, agent presence, capability presence, availability, and preferences in clause 8.2. Identity presence can be updated, queried, and given an expiration; agent and capability presence have similar update and query methods.

This is the core of day-to-day use: a client can publish presence, retrieve it, and ask for availability in a specific context. Availability can also be computed through application logic using IpAppPAMPreferenceCheck, which lets the application decide access, subscription, or the final availability result.

Event subscription and notification

SIST ES 202 915-14 V1.1.1:2005 defines an event service in clause 8.3 for registering application callback interfaces and subscribing to PAM events. The service uses registerAppInterface(), registerForEvent(), deregisterAppInterface(), and deregisterFromEvent(), with notifications delivered through eventNotify() and eventNotifyErr().

In practice, this is how a client learns that something changed without polling. The document’s service properties also limit the predefined event types that a 3GPP implementation supports.

Service properties and supported interfaces

SIST ES 202 915-14 V1.1.1:2005 defines service properties in clause 10, including P_OBTAINABLE_INTERFACES and P_EVENT_TYPES. For the 3GPP-related profile, the standard states which interfaces can be obtained and which event types can be registered.

This matters for integration and conformance work because a client must know what the platform exposes before calling it. If a method is not supported, the implementation returns P_METHOD_NOT_SUPPORTED.

Predefined data and error handling

SIST ES 202 915-14 V1.1.1:2005 defines common PAM data in clause 11, including entity addresses, attributes, capabilities, presence data, availability profiles, credentials, contexts, event data, and notification data. It also predefines the identity type Presentity and a set of dynamic attributes for that type.

That means implementations must speak a shared data language, not just share method names. Clause 12 then lists the exception classes used across the API, covering existence conflicts, unknown objects, type mismatches, invalid credentials, and unavailable interfaces.

What terms does SIST ES 202 915-14 V1.1.1:2005 define?

• Open Service Access (OSA) - An architecture that lets application developers use network functionality through a standardized interface.
• Service Capability Feature (SCF) - A functional service area within the OSA API; this part covers Presence and Availability Management.
• Presence - Dynamic status information about an identity or agent, such as current state or location-related information.
• Availability - The preferences and computed result that describe whether an identity can be reached in a given context.
• Agent - A software or hardware device that represents communication capabilities in PAM.
• Presentity - The predefined identity type used in this version for all identities in the PAM service.
• TpPAMCredential - The data type used to carry authenticated asker information with PAM method calls.
• Unified Modelling Language (UML) - The modeling notation used in the standard to show classes, sequences, and interactions.

Who uses SIST ES 202 915-14 V1.1.1:2005?

SIST ES 202 915-14 V1.1.1:2005 is used by developers of communication management applications, OSA platform implementers, and vendors that expose network or service status through a standard API. It is also relevant to service providers building instant messaging, e-mail, fax, conferencing, or telephony systems that need shared presence and availability logic.

Enterprise administrators and integration teams use it when they want centralized control over identities, aliases, groups, policies, and communication preferences. Gateway and proxy implementers use it when one client or service acts on behalf of another and must pass credentials and registration data correctly.

Buyers and quality managers can use it to check whether a platform supports provisioning, presence queries, availability computation, and event subscription in a standard OSA form.

Which standards are used with SIST ES 202 915-14 V1.1.1:2005?

The document applies the terms and abbreviations from ETSI ES 202 915-1, and it uses the common data definitions from ETSI ES 202 915-2. Those parts provide the framework and shared vocabulary that this presence-and-availability part builds on.

The foreword says the document is harmonized with the IETF presence model in RFC 2778, and it notes that a subset appears in 3GPP TS 29.198-14 V5.1.0 (Release 5). It also states that the present document forms part of the Parlay 4 set of specifications.

What does the SIST ES 202 915-14 V1.1.1:2005 document contain?

The document contains sequence diagrams for authentication token use and event registration, followed by class diagrams for the provisioning, presence and availability, and event management services. It then gives the service interface specifications, including interface classes, methods, parameters, and the rules for unsupported methods.

It also includes a large set of PAM data definitions for identities, agents, capabilities, contexts, preferences, events, and notifications. Clause 12 provides the exception classes used by the API, with a structure for extra information to help identify the source of an error.

Annex A adds explanatory models, architecture sketches, access levels, and use cases. Annex B gives the normative OMG IDL, and Annex C gives a Java API description for implementers who need a programming-language view of the same services.

SLOVENSKI STANDARD
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) –
14. del: Upravljanje prisotnosti in razpoložljivosti SCF
Open Service Access (OSA); Application Programming Interface (API); Part 14:
Presence and Availability Management SCF
Ta slovenski standard je istoveten z: ES 202 915-14 Version 1.1.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

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

�
2 ETSI ES 202 915-14 V1.1.1 (2003-01)

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

Tel.: [phone]  Fax: [phone]

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, send your comment to:
[e-mail]
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 2003.
© The Parlay Group 2003.
All rights reserved.
TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI 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
3 ETSI ES 202 915-14 V1.1.1 (2003-01)
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.19
6.1 PAM Provisioning SCF Class Diagrams.19
6.2 PAM Presence and Availability SCF Class Diagrams .21
6.3 PAM Event SCF Class Diagrams.22
7 The Service Interface Specifications.22
7.1 Interface Specification Format .22
7.1.1 Interface Class.22
7.1.2 Method descriptions.23
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 .24
7.4.1 Interface Class IpService .24
7.4.1.1 Method setCallback().24
7.4.1.2 Method setCallbackWithSessionID().24
8 Presence and Availability Management Interface Classes.25
8.1 PAM Provisioning SCF Interface Classes.25
8.1.1 Interface Class IpPAMProvisioningManager .25
8.1.1.1 Method getAuthToken().26
8.1.1.2 Method obtainInterface().26
8.1.2 Interface Class IpPAMIdentityManagement .26
8.1.2.1 Method createIdentity().27
8.1.2.2 Method deleteIdentity().28
8.1.2.3 Method isIdentity().28
8.1.2.4 Method createGroupIdentity().29
8.1.2.5 Method deleteGroupIdentity().29
ETSI
4 ETSI ES 202 915-14 V1.1.1 (2003-01)
8.1.2.6 Method addToGroup().29
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().33
8.1.2.14 Method lookupByAlias().33
8.1.2.15 Method associateTypes().34
8.1.2.16 Method disassociateTypes().34
8.1.2.17 Method listTypesOfIdentity().34
8.1.2.18 Method hasType().35
8.1.2.19 Method getIdentityAttributes().35
8.1.2.20 Method setIdentityAttributes().36
8.1.3 Interface Class IpPAMAgentManagement .36
8.1.3.1 Method createAgent().37
8.1.3.2 Method deleteAgent().38
8.1.3.3 Method isAgent().38
8.1.3.4 Method enableCapabilities().39
8.1.3.5 Method disableCapabilities().39
8.1.3.6 Method listEnabledCapabilities().39
8.1.3.7 Method listAllCapabilities().40
8.1.3.8 Method isCapableOf().40
8.1.3.9 Method associateTypes().41
8.1.3.10 Method disassociateTypes().41
8.1.3.11 Method listTypesOfAgent().42
8.1.3.12 Method hasType().42
8.1.3.13 Method getAgentAttributes().43
8.1.3.14 Method setAgentAttributes().43
8.1.4 Interface Class IpPAMAgentAssignment.44
8.1.4.1 Method assignAgent().44
8.1.4.2 Method unassignAgent().45
8.1.4.3 Method listAssignedAgents().45
8.1.4.4 Method listAssociatedIdentitiesOfAgent().45
8.1.4.5 Method listAssignedAgentsByCapability().46
8.1.4.6 Method listCapabilitiesOfIdentity().46
8.1.4.7 Method isIdentityCapableOf().47
8.1.5 Interface Class IpPAMIdentityTypeManagement .47
8.1.5.1 Method createIdentityAttribute().48
8.1.5.2 Method deleteIdentityAttribute().48
8.1.5.3 Method getIdentityAttributeDefinition().49
8.1.5.4 Method listAllIdentityAttributes().49
8.1.5.5 Method createIdentityType().50
8.1.5.6 Method deleteIdentityType().50
8.1.5.7 Method listIdentityTypes().50
8.1.5.8 Method addIdentityTypeAttributes().51
8.1.5.9 Method removeIdentityTypeAttributes().51
8.1.5.10 Method listIdentityTypeAttributes().52
8.1.6 Interface Class IpPAMAgentTypeManagement .52
8.1.6.1 Method createAgentAttribute().53
8.1.6.2 Method deleteAgentAttribute().53
8.1.6.3 Method getAgentAttributeDefinition().54
8.1.6.4 Method listAllAgentAttributes().54
8.1.6.5 Method createAgentType().55
8.1.6.6 Method deleteAgentType().55
8.1.6.7 Method listAgentTypes().55
8.1.6.8 Method addAgentTypeAttributes().56
8.1.6.9 Method removeAgentTypeAttributes().56
8.1.6.10 Method listAgentTypeAttributes().57
8.1.7 Interface Class IpPAMCapabilityManagement .57
8.1.7.1 Method createCapabilityAttribute().58
ETSI
5 ETSI ES 202 915-14 V1.1.1 (2003-01)
8.1.7.2 Method deleteCapabilityAttribute().59
8.1.7.3 Method getCapabilityAttributeDefinition().59
8.1.7.4 Method listAllCapabilityAttributes().59
8.1.7.5 Method createCapability().60
8.1.7.6 Method deleteCapability().60
8.1.7.7 Method listCapabilities().61
8.1.7.8 Method addCapabilityAttributes().61
8.1.7.9 Method removeCapabilityAttributes().61
8.1.7.10 Method listCapabilityAttributes().62
8.1.7.11 Method assignCapabilitiesToType().62
8.1.7.12 Method unassignCapabilitiesFromType().63
8.1.7.13 Method listCapabilitiesOfType().63
8.2 PAM Presence and Availability SCF Interface Classes .64
8.2.1 Interface Class IpPAMPresenceAvailabilityManager .64
8.2.1.1 Method getAuthToken().64
8.2.1.2 Method obtainInterface().64
8.2.2 Interface Class IpPAMIdentityPresence .65
8.2.2.1 Method setIdentityPresence().65
8.2.2.2 Method setIdentityPresenceExpiration().66
8.2.2.3 Method getIdentityPresence().66
8.2.3 Interface Class IpPAMAvailability.67
8.2.3.1 Method getAvailability().68
8.2.3.2 Method getPreference().68
8.2.3.3 Method setPreference().69
8.2.4 Interface Class IpPAMAgentPresence.69
8.2.4.1 Method setAgentPresence().70
8.2.4.2 Method setCapabilityPresence().71
8.2.4.3 Method setAgentPresenceExpiration().71
8.2.4.4 Method setCapabilityPresenceExpiration().72
8.2.4.5 Method getAgentPresence().72
8.2.4.6 Method getCapabilityPresence().73
8.2.5 Interface Class IpAppPAMPreferenceCheck.73
8.2.5.1 Method allowAccess().74
8.2.5.2 Method allowSubscription().74
8.2.5.3 Method computeAvailability().75
8.3 PAM Event SCF Interface Classes.75
8.3.1 Interface Class IpPAMEventManager .75
8.3.1.1 Method getAuthToken().76
8.3.1.2 Method obtainInterface().76
8.3.2 Interface Class IpPAMEventHandler.76
8.3.2.1 Method isRegistered().77
8.3.2.2 Method registerAppInterface().77
8.3.2.3 Method registerForEvent().78
8.3.2.4 Method deregisterAppInterface().78
8.3.2.5 Method deregisterFromEvent().79
8.3.3 Interface Class IpAppPAMEventHandler.79
8.3.3.1 Method eventNotify().79
8.3.3.2 Method eventNotifyErr().80
9 State Transition Diagrams.80
10 PAM Service Properties .80
10.1 PAM Provisioning service properties.80
10.2 PAM Presence and Availability Service .80
10.3 PAM Event Service.81
11 PAM Data Definitions.81
11.1 Entity Address Definitions.81
11.1.1 TpPAMFQName.81
11.1.2 TpPAMFQNameList.81
11.2 Attribute Data Definitions .81
11.2.1 TpPAMAttribute.81
11.2.2 TpPAMAttributeList.82
ETSI
6 ETSI ES 202 915-14 V1.1.1 (2003-01)
11.2.3 TpPAMAttributeDef.82
11.2.4 TpPAMAttributeDefList.82
11.3 Presence Data Definitions .82
11.3.1 TpPAMCapability.82
11.3.2 TpPAMCapabilityList.82
11.3.3 TpPAMPresenceData.83
11.3.4 TpPAMPresenceDataList.83
11.4 Pre-defined Presence type .83
11.4.1 Presentity.83
11.5 Availability Data Definitions .83
11.5.1 TpPAMAvailabilityProfile.83
11.5.2 TpPAMAvailabilityProfileList.83
11.5.3 TpPAMPrivacyCode.83
11.6 Availability Context Data Definitions.84
11.6.1 TpPAMContext.84
11.6.2 TpPAMContextName.84
11.6.3 TpPAMContextData.84
11.6.4 TpPAMCommunicationContext.84
11.6.5 TpPAMContextList.84
11.7 Credential data definitions.85
11.7.1 TpPAMCredential.85
11.8 Availability and Access Control Preference Data Definitions .85
11.8.1 TpPAMAccessControlData.85
11.8.2 TpPAMACLDefault.85
11.8.3 TpPAMPreferenceOp.85
11.8.4 TpPAMPreferenceType.85
11.8.5 TpPAMPreferenceData.86
11.9 Time data definitions.86
11.9.1 TpPAMTimeInterval.86
11.10 Pre-defined Entity Types and Attributes .86
11.11 Interface name definitions.87
11.11.1 TpPAMProvisioningInterfaceName.87
11.11.2 TpPAMPresenceAvailabilityInterfaceName.87
11.11.3 TpPAMEventInterfaceName.87
11.12 Event data definitions.87
11.12.1 TpPAMClientID.87
11.12.2 TpPAMEventID.87
11.12.3 TpPAMEventName.88
11.12.4 TpPAMEventNameList.88
11.12.5 TpPAMEventInfo.88
11.12.6 TpPAMEventInfoList.88
11.12.7 TpPAMNotificationInfo.89
11.12.8 TpPAMNotificationInfoList.89
11.12.9 PAM_CE_IDENTITY_CREATED.89
11.12.9.1 TpPAMICEventData.89
11.12.9.2 TpPAMICNotificationData.89
11.12.10 PAM_CE_IDENTITY_DELETED.90
11.12.10.1 TpPAMIDEventData.90
11.12.10.2 TpPAMIDNotificationData.90
11.12.11 PAM_CE_GROUP_MEMBERSHIP_CHANGED.90
11.12.11.1 TpPAMGMCEventData.90
11.12.11.2 TpPAMGMCNotificationData.90
11.12.12 PAM_CE_AGENT_CREATED.91
11.12.12.1 TpPAMACEventData.91
11.12.12.2 TpPAMACNotificationData.91
11.12.13 PAM_CE_AGENT_DELETED.91
11.12.13.1 TpPAMADEventData.91
11.12.13.2 TpPAMADNotificationData.91
11.12.14 PAM_CE_AGENT_ASSIGNED.92
11.12.14.1 TpPAMAAEventData.92
11.12.14.2 TpPAMAANotificationData.92
11.12.15 PAM_CE_AGENT_UNASSIGNED.92
ETSI
7 ETSI ES 202 915-14 V1.1.1 (2003-01)
11.12.15.1 TpPAMAUEventData.92
11.12.15.2 TpPAMAUNotificationData.93
11.12.16 PAM_CE_CAPABILITY_CHANGED.93
11.12.16.1 TpPAMCCEventData.93
11.12.16.2 TpPAMCCNotificationData.94
11.12.17 PAM_CE_AGENT_CAPABILITY_PRESENCE_SET.94
11.12.17.1 TpPAMACPSEventData.94
11.12.17.2 TpPAMACPSNotificationData.94
11.12.18 PAM_CE_AGENT_PRESENCE_SET.95
11.12.18.1 TpPAMAPSEventData.95
11.12.18.2 TpPAMAPSNotificationData.95
11.12.19 PAM_CE_IDENTITY_PRESENCE_SET.95
11.12.19.1 TpPAMIPSEventData.95
11.12.19.2 TpPAMIPSNotificationData.96
11.12.20 PAM_CE_AVAILABILITY_CHANGED.96
11.12.20.1 TpPAMAVCEventData.96
11.12.20.2 TpPAMAVCNotificationData.97
11.12.21 PAM_CE_WATCHERS_CHANGED.97
11.12.21.1 TpPAMWCEventData.97
11.12.21.2 TpPAMWCNotificationData.97
11.12.21.3 TpPAMwatcherChangeType.98
11.13 Error Types.98
11.13.1 TpPAMErrorCause.98
11.13.2 TpPAMErrorInfo.98
12 Presence and Availability Management Exception Classes.98
Annex A (informative): Further PAM Information.100
A.1 UML Models.100
A.1.1 Identity.100
A.1.2 Agent.101
A.2 Model.101
A.3 Architecture.102
A.4 Levels of access.103
A.4.1 Application.104
A.4.2 Service.104
A.4.3 Thin client.
...