SIST ES 201 915-8 V1.4.1:2005

Open Service Access (OSA); Application Programming Interface (API); Part 8: Data Session Control SCF (Parlay 3)

Maintenance update of ES 201 915-8 v.1.3.1.  Updated document will also be known as Parlay 3.3.  Only those parts requiring modification will be updated ( most parts require maintenance fixes )

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 8. del: Krmiljenje podatkovne seje 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 201 915-8 V1.4.1 (2003-07) - Open Service Access (OSA); Application Programming Interface (API); Part 8: Data Session Control SCF (Parlay 3)

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 201 915-8 V1.4.1:2005
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 8.
del: Krmiljenje podatkovne seje SCF
Open Service Access (OSA); Application Programming Interface (API); Part 8: Data
Session Control SCF (Parlay 3)
Ta slovenski standard je istoveten z: ES 201 915-8 Version 1.4.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 201 915-8 V1.4.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

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

SIST ES 201 915-8 V1.4.1:2005

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

SIST ES 201 915-8 V1.4.1:2005

ETSI ES 201 915-8 V1.4.1 (2003-07)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 8: Data Session Control SCF
(Parlay 3)



�

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

SIST ES 201 915-8 V1.4.1:2005
 2 ETSI ES 201 915-8 V1.4.1 (2003-07)



Reference
RES/SPAN-120095-8
Keywords
API, OSA, IDL, 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 201 915-8 V1.4.1:2005
 3 ETSI ES 201 915-8 V1.4.1 (2003-07)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Data Session Control SCF.7
4.1 General requirements on support of methods.8
5 Sequence Diagrams.8
5.1 Enable Data Session Notification.8
5.2 Address Translation With Charging.9
6 Class Diagrams.10
7 The Service Interface Specifications.11
7.1 Interface Specification Format .11
7.1.1 Interface Class.11
7.1.2 Method descriptions.11
7.1.3 Parameter descriptions.11
7.1.4 State Model.11
7.2 Base Interface.11
7.2.1 Interface Class IpInterface .11
7.3 Service Interfaces.12
7.3.1 Overview.12
7.4 Generic Service Interface .12
7.4.1 Interface Class IpService .12
8 Data Session Control Interface Classes.13
8.1 Interface Class IpAppDataSession .13
8.2 Interface Class IpAppDataSessionControlManager .15
8.3 Interface Class IpDataSession .17
8.4 Interface Class IpDataSessionControlManager.20
9 State Transition Diagrams.24
9.1 State Transition Diagrams for IpDataSession.24
9.1.1 Network Released State .24
9.1.2 Finished State.24
9.1.3 Application Released State.25
9.1.4 Active State.25
9.1.5 Setup State.25
9.1.6 Established State.25
10 Data Session Control Service Properties.25
11 Data Definitions.26
11.1 Data Session Control Data Definitions.26
11.1.1 IpAppDataSession.26
11.1.2 IpAppDataSessionRef.26
11.1.3 IpAppDataSessionControlManager.26
11.1.4 IpAppDataSessionControlManagerRef.26
11.1.5 IpDataSession.27
11.1.6 IpDataSessionRef.27
11.1.7 IpDataSessionControlManager.27
11.1.8 IpDataSessionControlManagerRef.27
11.2 Event Notification data definitions.27
ETSI

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

SIST ES 201 915-8 V1.4.1:2005
 4 ETSI ES 201 915-8 V1.4.1 (2003-07)
11.2.1 TpDataSessionEventName.27
11.2.2 TpDataSessionMonitorMode.27
11.2.3 TpDataSessionEventCriteria.27
11.2.4 TpDataSessionEventInfo.28
11.2.5 TpDataSessionQosClass.28
11.2.6 TpDataSessionChargePlan.28
11.2.7 TpDataSessionChargeOrder.29
11.2.8 TpDataSessionChargeOrderCategory.29
11.2.9 TpChargePerVolume.30
11.2.10 TpDataSessionIdentifier.30
11.2.11 TpDataSessionError.30
11.2.12 TpDataSessionAdditionalErrorInfo.30
11.2.13 TpDataSessionErrorType.30
11.2.14 TpDataSessionFault.31
11.2.15 TpDataSessionReleaseCause.31
11.2.16 TpDataSessionSuperviseVolume.31
11.2.17 TpDataSessionSuperviseReport.31
11.2.18 TpDataSessionSuperviseTreatment.32
11.2.19 TpDataSessionReport.32
11.2.20 TpDataSessionAdditionalReportInfo.32
11.2.21 TpDataSessionReportRequest.32
11.2.22 TpDataSessionReportRequestSet.32
11.2.23 TpDataSessionReportType.33
11.2.24 TpDataSessionEventCriteriaResult.33
11.2.25 TpDataSessionEventCriteriaResultSet.33
12 Exception Classes.33
Annex A (normative): OMG IDL Description of Data Session Control SCF.34
Annex B (informative): Contents of 3GPP OSA R4 Data Session Control.35
Annex C (informative): Record of changes .36
C.1 Interfaces.36
C.1.1 New.36
C.1.2 Deprecated.36
C.1.3 Removed.36
C.2 Methods.36
C.2.1 New.36
C.2.2 Deprecated.36
C.2.3 Modified.37
C.2.4 Removed.37
C.3 Data Definitions.37
C.3.1 New.37
C.3.2 Modified.37
C.3.3 Removed.37
C.4 Service Properties.37
C.4.1 New.37
C.4.2 Deprecated.38
C.4.3 Modified.38
C.4.4 Removed.38
C.5 Exceptions.38
C.5.1 New.38
C.5.2 Modified.38
C.5.3 Removed.38
C.6 Others.38
History .39

ETSI

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

SIST ES 201 915-8 V1.4.1:2005
 5 ETSI ES 201 915-8 V1.4.1 (2003-07)
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).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Advanced
Networks (SPAN).
The present document is part 8 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 201 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control SCF";
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".
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 3.3 set of specifications.
The present document is equivalent to 3GPP TS 29.198-8 V4.6.0 (Release 4).
ETSI

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

SIST ES 201 915-8 V1.4.1:2005
 6 ETSI ES 201 915-8 V1.4.1 (2003-07)
1 Scope
The present document is part 8 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 Data Session Control Service Capability Feature (SCF) aspects of the interface. All
aspects of the Data Session Control 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 201 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 201 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply.
ETSI

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

SIST ES 201 915-8 V1.4.1:2005
 7 ETSI ES 201 915-8 V1.4.1 (2003-07)
4 Data Session Control SCF
The Data Session control network service capability feature consists of two interfaces:
1) Data Session manager, containing management functions for data session related issues;
2) Data Session, containing methods to control a session.
A session can be controlled by one Data Session Manager only. Data Session Manager can control several sessions.
1
Data Session Data Session
1 n
Manager

NOTE: The term "data session" is used in a broad sense to describe a data connection/session. For example, it
comprises a PDP context in GPRS.

Figure 1: Data Session control interfaces usage relationship
The Data Session Control service capability features are described in terms of the methods in the Data Session Control
interfaces. Table 1 gives an overview of the Data Session Control methods and to which interfaces these methods
belong.
Table 1: Overview of Data Session Control interfaces and their methods
Data Session Manager Data Session
createNotification connectReq
destroyNotification connectRes
dataSessionNotificationInterrupted connectErr
dataSessionNotificationContinued release
reportNotification superviseDataSessionReq
dataSessionAborted superviseDataSessionRes
getNotification superviseDataSessionErr
changeNotification dataSessionFaultDetected
setAdviceofCharge
setDataSessionChargePlan

The session manager interface provides the management functions to the data session service capability features. The
application programmer can use this interface to enable or disable data session-related event notifications.
The following clauses describe each aspect of the Data Session Control 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 of this specification.
ETSI

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

SIST ES 201 915-8 V1.4.1:2005
 8 ETSI ES 201 915-8 V1.4.1 (2003-07)
4.1 General requirements on support of methods
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.
Where a method is not supported by an implementation of an Application interface, a call to that method shall be
possible, and no exception shall be returned.
5 Sequence Diagrams
5.1 Enable Data Session Notification
Application Data Session Manager : Data Session :
IpDataSessionControlManager IpDataSession
1: createNotification( )

ETSI

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

SIST ES 201 915-8 V1.4.1:2005
 9 ETSI ES 201 915-8 V1.4.1 (2003-07)
5.2 Address Translation With Charging
Application Data Session Manager : Data Session :
IpDataSessionControlManager IpDat aSessi on
1: createNotification( )
2: reportNotification()
3: 'translate address'
4: setCallback( )
5: superviseDataSessionReq(  )
6: connectReq(  )
7: superviseDataSessionRes()
8: superviseDataSessionReq(  )
9: superviseDataSessionRes()
10: ConnectRes( )

ETSI

---------------------- Page: 11 ----------------------

SIST ES 201 915-8 V1.4.1:2005
 10 ETSI ES 201 915-8 V1.4.1 (2003-07)
6 Class Diagrams
Data Session Control Class Diagram:
<>
IpInterface
(from csapi)
<>
<>
IpAppDataSession
IpAppDataSessionControlManager
(from dsc)
(from dsc)
connectRes()
dataSessionAborted()
1100.nn
connectErr()
reportNotification()
superviseDataSessionRes()
dataSessionNotificationContinued()
superviseDataSessionErr()
dataSessionNotificationInterrupted()
dataSessionFaultDetected()
<>
<>
<>
<> IpDataSession
IpDataSessionControlManager
(from dsc)
(from dsc)
connectReq()
createNotification() release()
11 00.n.n
destroyNotification() superviseDataSessionReq()
changeNotification() setDataSessionChargePlan()
<> getNotification() setAdviceOfCharge()
<> getNotifications() deassignDataSession()
continueProcessing()
<>
IpService
(from csapi)
setCallback()
setCallbackWithSessionID()

Figure 2: Package Overview
ETSI

---------------------- Page: 12 ----------------------

SIST ES 201 915-8 V1.4.1:2005
 11 ETSI ES 201 915-8 V1.4.1 (2003-07)
7 The Service Interface Specifications
7.1 Interface Specification Format
This clause defines the interfaces, methods and parameters that form a part of the API specification. The Unified
Modelling Language (UML) is used to specify the interface classes. The general format of an interface specification is
described below.
7.1.1 Interface Class
This shows a UML interface class description of the methods supported by that interface, and the relevant parameters
and types. The Service and Framework interfaces for enterprise-based client applications are denoted by classes with
name Ip. The callback interfaces to the applications are denoted by classes with name IpApp. For
the interfaces between a Service and the Framework, the Service interfaces are typically denoted by classes with name
IpSvc, while the Framework interfaces are denoted by classes with name IpFw
7.1.2 Method descriptions
Each method (API method “call”) is described. Both synchronous and asynchronous methods are used in the API.
Asynchronous methods are identified by a 'Req' suffix for a method request, and, if applicable, are served by
asynchronous methods identified by either a 'Res' or 'Err' suffix for method results and errors, respectively. To handle
responses and reports, the application or service developer must implement the relevant IpApp or
IpSvc interfaces to provide the callback mechanism.
7.1.3 Parameter descriptions
Each method param
...