SIST ES 202 915-9 V1.1.1:2005

Open Service Access (OSA); Application Programming Interface (API); Part 9: Generic Messaging SCF

Edition PARLAY 4.0.

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 9. del: Generično sporočanje SCF

General Information

• 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-9 V1.1.1 (2003-01) - Open Service Access (OSA); Application Programming Interface (API); Part 9: Generic Messaging SCF

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 202 915-9 V1.1.1:2005
01-januar-2005
2GSUWLGRVWRSGRVWRULWYH26$±9PHVQLN]DDSOLNDFLMVNRSURJUDPLUDQMH$3,±
GHO*HQHULþQRVSRURþDQMH6&)
Open Service Access (OSA); Application Programming Interface (API); Part 9: Generic
Messaging SCF
Ta slovenski standard je istoveten z: ES 202 915-9 Version 1.1.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 202 915-9 V1.1.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

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

SIST ES 202 915-9 V1.1.1:2005

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

SIST ES 202 915-9 V1.1.1:2005

ETSI ES 202 915-9 V1.1.1 (2003-01)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 9: Generic Messaging SCF



�

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

SIST ES 202 915-9 V1.1.1:2005
 2 ETSI ES 202 915-9 V1.1.1 (2003-01)



Reference
DES/SPAN-120091-9
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

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

SIST ES 202 915-9 V1.1.1:2005
 3 ETSI ES 202 915-9 V1.1.1 (2003-01)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.7
2 References.7
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Generic Messaging SCF.8
5 Sequence Diagrams.8
5.1 Prepare Mailbox.8
5.2 Open Mailbox.9
5.3 Get Message.9
5.4 Get Folder Information.10
5.5 Close Mailbox.10
6 Class Diagrams.11
7 The Service Interface Specifications.12
7.1 Interface Specification Format .12
7.1.1 Interface Class.12
7.1.2 Method descriptions.12
7.1.3 Parameter descriptions.12
7.1.4 State Model.12
7.2 Base Interface.12
7.2.1 Interface Class IpInterface .12
7.3 Service Interfaces.13
7.3.1 Overview.13
7.4 Generic Service Interface .13
7.4.1 Interface Class IpService .13
7.4.1.1 Method setCallback().13
7.4.1.2 Method setCallbackWithSessionID().13
8 Generic Messaging Interface Classes.14
8.1 Interface Class IpMessagingManager .14
8.1.1 Method openMailbox().15
8.1.2 Method enableMessagingNotification().15
8.1.3 Method disableMessagingNotification().16
8.2 Interface Class IpAppMessagingManager.16
8.2.1 Method mailboxTerminated().17
8.2.2 Method mailboxFaultDetected().17
8.2.3 Method messagingEventNotify().17
8.2.4 Method messagingNotificationTerminated().18
8.3 Interface Class IpMailbox .18
8.3.1 Method close().18
8.3.2 Method lock().19
8.3.3 Method unlock().19
8.3.4 Method getInfoAmount().19
8.3.5 Method getInfoProperties().20
8.3.6 Method setInfoProperties().20
8.3.7 Method openFolder().21
8.3.8 Method createFolder().21
8.3.9 Method remove().22
8.4 Interface Class IpMailboxFolder.23
8.4.1 Method getInfoAmount().23
ETSI

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

SIST ES 202 915-9 V1.1.1:2005
 4 ETSI ES 202 915-9 V1.1.1 (2003-01)
8.4.2 Method getInfoProperties().23
8.4.3 Method setInfoProperties().24
8.4.4 Method putMessage().25
8.4.5 Method getMessage().25
8.4.6 Method close().26
8.4.7 Method remove().26
8.5 Interface Class IpMessage.27
8.5.1 Method getInfoAmount().27
8.5.2 Method getInfoProperties().28
8.5.3 Method setInfoProperties().28
8.5.4 Method remove().29
8.5.5 Method getContent().29
9 State Transition Diagrams.30
10 Data Definitions.30
10.1 Event notification Definitions.30
10.1.1 TpMessagingEventName.30
10.1.2 TpMessagingEventCriteria.30
10.1.3 TpGMSNewMessageArrivedCriteria.30
10.1.4 TpMessagingEventInfo.31
10.1.5 TpGMSNewMessageArrivedInfo.31
10.2 Generic Messaging Data Definitions.31
10.2.1 IpMessagingManager.31
10.2.2 IpMessagingManagerRef.31
10.2.3 IpAppMessagingManager.31
10.2.4 IpAppMessagingManagerRef.31
10.2.5 IpMailbox.31
10.2.6 IpMailboxRef.31
10.2.7 IpMailboxFolder.31
10.2.8 IpMailboxFolderRef.32
10.2.9 IpMessage.32
10.2.10 IpMessageRef.32
10.2.11 TpFolderInfoProperty.32
10.2.12 TpFolderInfoPropertyName.32
10.2.13 TpFolderInfoPropertySet.32
10.2.14 TpMailboxFolderIdentifier.32
10.2.15 TpMailboxIdentifier.33
10.2.16 TpMailboxInfoProperty.33
10.2.17 TpMailboxInfoPropertyName.33
10.2.18 TpMailboxInfoPropertySet.33
10.2.19 TpMessage.33
10.2.20 TpMessageFormat.33
10.2.21 TpMessageInfoProperty.34
10.2.22 TpMessageInfoPropertyName.34
10.2.23 TpMessageInfoPropertySet.34
10.2.24 TpMessagePriority.34
10.2.25 TpMessageStatus.35
10.2.26 TpMessagingFault.35
11 Exception Classes.35
Annex A (normative): OMG IDL Description of Generic Messaging SCF .36
Annex B (informative): W3C WSDL Description of Generic Messaging SCF.37
Annex C (informative): Record of changes .38
C.1 Interfaces.38
C.1.1 New.38
C.1.1 Deprecated.38
C.1.3 Removed.38
C.2 Methods.38
ETSI

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

SIST ES 202 915-9 V1.1.1:2005
 5 ETSI ES 202 915-9 V1.1.1 (2003-01)
C.2.1 New.38
C.2.2 Deprecated.38
C.2.3 Modified.39
C.2.4 Removed.39
C.3 Data Definitions.39
C.3.1 New.39
C.3.2 Modified.39
C.3.3 Removed.39
C.4 Service Properties.39
C.4.1 New.39
C.4.2 Deprecated.40
C.4.3 Modified.40
C.4.4 Removed.40
C.5 Exceptions.40
C.5.1 New.40
C.5.2 Modified.40
C.5.3 Removed.40
C.6 Others.40
History .41

ETSI

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

SIST ES 202 915-9 V1.1.1:2005
 6 ETSI ES 202 915-9 V1.1.1 (2003-01)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
All published ETSI deliverables shall include information which directs the reader to the above source of information.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Advanced
Networks (SPAN).
The present document is part 9 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 202 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy Management SCF";
Part 14: "Presence and Availability Management SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 4.0 set of specifications.
ETSI

---------------------- Page: 8 ----------------------

SIST ES 202 915-9 V1.1.1:2005
 7 ETSI ES 202 915-9 V1.1.1 (2003-01)
1 Scope
The present document is part 9 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Generic Messaging Service Capability Feature (SCF) aspects of the interface. All
aspects of the Generic Messaging SCF are defined here, these being:
• Sequence Diagrams
• Class Diagrams
• Interface specification plus detailed method descriptions
• State Transition diagrams
• Data Definitions
• IDL Description of the interfaces
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 202 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 202 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview".
ETSI ES 202 915-2: "Open Service Access (OSA); Application Programming Interface (API); Part 2: Common Data
Definitions".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 202 915-1 apply.
ETSI

---------------------- Page: 9 ----------------------

SIST ES 202 915-9 V1.1.1:2005
 8 ETSI ES 202 915-9 V1.1.1 (2003-01)
4 Generic Messaging SCF
The following clauses describe each aspect of the Generic Messaging Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause show how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions
are well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data Definitions clause show a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part ES 202 915-2.
An implementation of this API which supports or implements a method described in the present document, shall
support or implement the functionality described for that method, for at least one valid set of values for the parameters
of that method. Where a method is not supported by an implementation of a Service interface, the exception
P_METHOD_NOT_SUPPORTED shall be returned to any call of that method.
5 Sequence Diagrams
5.1 Prepare Mailbox
: : :
IpAppLogic IpAppMessagingManager IpMessagingManager
1: new()
2: enableMessagingNotification( )
3: messagingEventNotify(  )
4: 'forward event'

1: This message is used by the application to create an object implementing the IpAppMessagingManager interface.
2: This message is used to enable the notification mechanism so that events can be sent to the application.
When new mail, that matches the event criteria set in message 2, arrives a message indicating the presence of new mail
(not shown) is directed to the object implementing the IpMessagingManager.
ETSI

---------------------- Page: 10 ----------------------

SIST ES 202 915-9 V1.1.1:2005
 9 ETSI ES 202 915-9 V1.1.1 (2003-01)
3: This message is used to pass the new mail event to the object implementing the IpAppMessagingManager interface.
4: This message is used to forward message 3 to the IpAppLogic.
5.2 Open Mailbox
: : : IpMailbox
IpAppLogic IpMessagingManager
1: openMailbox( )
2: new()

1: This message requests the object implementing the IpMessagingManager interface to create an object implementing
the IpMailbox interface.
2: Assuming that the criteria for creating an object implementing the IpMailbox interface is met, message 2 is used to
create it.
5.3 Get Message
: : IpMailbox : IpMailboxFolder : IpMessage
IpAppLogic
1: openFolder( )
2: getInfoAmount( )
3: getInfoProperties(  )
4: getMessage( )
5: new()

1: This message requests a folder to be
...