ETSI TS 102 440 V1.2.1 (2008-11)

WS-Session; Web Services for Application Session Services

RTS/ECMA-00350

General Information

• Status: Published
• Publication Date: 05-Nov-2008
• Technical Committee: Ecma - Standardizing information and communications systems
• Current Stage: 12 - Completion
• Due Date: 29-Oct-2008
• Completion Date: 06-Nov-2008

Standards Content (Sample)

ETSI TS 102 440 V1.2.1 (2008-11)
Technical Specification


WS-Session:
Web Services for Application Session Services

---------------------- Page: 1 ----------------------
2 ETSI TS 102 440 V1.2.1 (2008-11)



Reference
RTS/ECMA-00350
Keywords
CSTA, service, XML
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, 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.
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 ETSI TS 102 440 V1.2.1 (2008-11)
Contents
Intellectual Property Rights . 5
Foreword . 5
Introduction . 5
1 Scope . 6
2 Conformance . . 6
3 References . 7
3.1 Normative references . 7
3.2 Informative references . 8
4 Definitions . . 8
4.1 Service Requester . 8
4.2 Service Provider . 8
4.3 Namespaces . 8
5 Service Provider WSDL Abstract Definitions . 9
6 Service Provider WSDL SOAP Binding . 11
7 Event Subscription and Notification . 13
Annex A (normative): Event Subscription Using WS-Eventing Option . 14
A.1 Wrapped Delivery Mode Event Sink WSDL for Service Requester and Its SOAP Binding . 15
A.2 Unwrapped Delivery Mode Event Sink WSDL Specification and Its SOAP Binding . 16
Annex B (normative): Subscription Using WS-BaseNotification Option . 17
B.1 Wrapped Delivery Mode Event Sink WSDL for Service Requester and Its SOAP Binding . 17
B.2 Unwrapped Delivery Mode Event Sink WSDL for Service Requester and Its SOAP Binding . 17
Annex C (normative): Asynchronous Response to Subscription Request Option . 18
Annex D (informative): Service Provider WSDL with SOAP/HTTP Binding . 19
Annex E (informative): SOAP XML Templates for ECMA-354 Messages . 20
E.1 StartApplicationSession request message template . 20
E.1.1 StartApplicationSession Positive response message template . 20
E.1.2 StartApplicationSession negative response message template . 20
E.2 StopApplicationSession request message template . 21
E.2.1 StopApplicationSession positive response message template . 21
E.2.2 StopApplicationSession negative response message template . 21
E.3 ResetApplicationSessionTimer request message template. 22
E.3.1 ResetApplicationSessionTimer positive response message template . 22
E.3.2 Reset Application Session Timer negative response message template . 22
E.4 ApplicationSessionTerminated . 23
E.4.1 Template of ApplicationSessionTerminated event notification for unwrapped event sink which applies
to both WS-Eventing and WS-BaseNotification options . 23
E.4.2 Template of ApplicationSessionTerminated event notification to wrapped event sink of WS-Eventing . 23
E.4.3 Template of ApplicationSessionTerminated event notification to wrapped event sink of WS-
BaseNotification . 24
Annex F (informative): WS-Eventing SOAP XML Message Templates . 25
F.1 ApplicationSessionTerminated Event Subscription SOAP message template . 25
ETSI

---------------------- Page: 3 ----------------------
4 ETSI TS 102 440 V1.2.1 (2008-11)
F.2 Template of positive response to the event subscription . 25
F.3 Template of negative response (fault) to event subscription . 26
F.4 Template of Unsubscribe message . 26
F.5 Template of positive response to Unsubscribe message . 27
Annex G (informative): WS-BaseNotification SOAP XML Message Templates . 28
G.1 ApplicationSessionTerminated Event Subscription SOAP message template . 28
G.2 Template of positive response to the event subscription . 28
G.3 Template of negative response to the event subscription . 29
G.4 Template of Unsubscribe message . 29
G.5 Template of positive response to Unsubscribe message . 30
Annex H (informative): Summary of Changes . 31
History . 32

ETSI

---------------------- Page: 4 ----------------------
5 ETSI TS 102 440 V1.2.1 (2008-11)
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 Technical Specification (TS) has been produced by ECMA on behalf of its members and those of the European
Telecommunications Standards Institute (ETSI).
Introduction
ECMA-354, Application Session Services, specifies XML protocols that can be used to create and manage application
sessions that are independent of the transport layer protocols. The present document (WS-Session) specifies Web
services for ECMA-354 [1].
The ApplicationSessionTerminated operation of the present document is an outbound asynchronous event notification.
For Service Requester to receive the event notification from the Service Provider and from web services
(e.g. ECMA-348) that use the present document for session management, it standardized WS-Eventing and
WS-BaseNotification as two Options.
ETSI

---------------------- Page: 5 ----------------------
6 ETSI TS 102 440 V1.2.1 (2008-11)
1 Scope
The present document specifies Web Services (in WSDL, in clause 5) and a SOAP binding (in clause 6) for the
Application Session Services defined in ECMA-354 [1]. The Application Session Services allow Applications to create
and maintain a relationship with Servers termed Application Session. The Web services specified herein, allow Service
Requesters (Applications in ECMA-354 [1]) and Service Providers (Servers in ECMA-354 [1]) to create and maintain
such Application Sessions.
The present document builds upon and imports the XML schema definitions from ECMA-354 [1]. The method of
making the WSDL description of the specified services available to Service Provider and Requester is out of the scope
of the present document.
The ApplicationSessionTerminated operation of the present document is an outbound asynchronous event notification
that Service Requesters receive from the Service Provider. Service Requester may also receive the event notification
from web services, e.g. ECMA-348, that use the present document for session management.
Clause 7 specifies the event subscription and notification behaviours supported by the two options defined in annex A
and B.
Annex A specifies the event subscription mechanism using WS-Eventing.
Annex B specifies the event subscription mechanism using WS-BaseNotification.
Annex C specifies the asynchronous subscription response Option for the two event subscription mechanisms.
Annex D shows an example WS-Session WSDL binding with SOAP/HTTP.
Annex E lists SOAP XML Templates for ECMA-354 [1] messages.
Annex F lists some SOAP XML Templates for WS-Eventing messages.
Annex G lists some SOAP XML Templates for WS-BaseNotification messages.
Annex H provides a summary of changes.
2 Conformance
The Service Requester and Service Provider conform to the Application and Server conformance specified in
ECMA-354 [1], using the WSDL definitions, SOAP bindings, and event subscription and notification specified in
clauses 5, 6 and 7 respectively.
The Service Provider implements at least one of the WS-Eventing and WS-BaseNotification event subscription options
as specified in annexes A and B.
Service Provider’s WSDL for the present document shall include the implemented operations from annex A, annex B
and the WSDL specified in clause 5.
The Service Requester shall itself initiate or delegate event subscription as specified in annexes A and B.
The Service Provider supports synchronous responses to Event Subscriptions and may implement the asynchronous
response Option specified in annex C.
ETSI

---------------------- Page: 6 ----------------------
7 ETSI TS 102 440 V1.2.1 (2008-11)
3 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
3.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
Ecma references
[1] ECMA-354: "Application Session Services, June 2004":.http://www.ecma-
international.org/publications/standards/Ecma-354.htm.
W3C references
[2] SOAP 1.1: "Simple Object Access Protocol 1.1", W3C Note 08 May 2000.
[3] WSDL 1.1 "Web Service Description Language 1.1", W3C Note 15 March 2001.
[4] XML Schema 1.0: "XML Schema Language Part 1: Structure", W3C Recommendation
28 October 2004.
"XML Schema Language Part 2: Data Types", W3C Recommendation 28 October 2004.
[5] WS-Addressing 1.0: "Web Services Addressing 1.0" - Core W3C Recommendation 9 May 2006.
Web Services Addressing 1.0 - "SOAP Binding" W3C Recommendation 9 May 2006.
Web Services Addressing 1.0 - "Metadata", W3C Recommendation 4 September 2007.
[6] WS-Eventing "Web Services Eventing (WS-Eventing)" W3C Member Submission
15 March 2006.
[7] WS-BaseNotification 1.3: "Web Services Base Notification 1.3" (WS-BaseNotification) OASIS
Standard, 1 October 2006.
ETSI

---------------------- Page: 7 ----------------------
8 ETSI TS 102 440 V1.2.1 (2008-11)
3.2 Informative references
The following referenced documents are not essential to the use of the present document but they assist the user with
regard to a particular subject area. For non-specific references, the latest version of the referenced document (including
any amendments) applies.
Not applciable.
4 Definitions
Consult ECMA-354 [1] for Application Session Services specific terms.
The present document refers to these Web services terms:
4.1 Service Requester
Web Service equivalent of Application in ECMA-354 [1]
4.2 Service Provider
Web Service equivalent of Server in ECMA-354 [1]
4.3 Namespaces
The present document uses these Ecma prefixes and namespaces:
1) aps (http://www.ecma-international.org/standards/ecma-354/appl_session): The present document imports all
XML messages defined in ECMA-354 [1] from the aps namespace.
2) wss (http://www.ecma-international.org/standards/ecma-366/ws-session/ed2): The WSDL target namespace
for the present document.
3) gsk (http://www.ecma-international.org/standards/ecma-366/ws-session/ed2/generic_sink): The target
namespace of the wrapped sink WSDL.
The present document refers to these other prefixes and namespaces:
1) wsdl (http://schemas.xmlsoap.org/wsdl): This contains the W3C WSDL 1.1 schema[3].
2) xs (http://www.w3.org/2001/XMLSchema): This contains the W3C XML Schema definition [4].
3) S (http://schemas.xmlsoap.org/wsdl/soap): This contains the W3C SOAP bindings for WSDL 1.1 [3].
4) wsa (http://www.w3.org/2005/08/addressing): The namespace for WS-Addressing 1.0 [5]
5) wse (http://schemas.xmlsoap.org/ws/2004/08/eventing): The target namespace for WS-Eventing
Web Service [6]
6) wsnt (http://docs.oasis-open.org/wsn/b-2.xsd): The target namespace for WS-BaseNotfication 1.3 [7]
ETSI

---------------------- Page: 8 ----------------------
9 ETSI TS 102 440 V1.2.1 (2008-11)
5 Service Provider WSDL Abstract Definitions
This clause specifies the abstract WSDL definitions to support the services specified in ECMA-354 [1].

xmlns="http://schemas.xmlsoap.org/wsdl/"

xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:aps="http://www.ecma-international.org/standards/ecma-354/appl_session"

xmlns:wss="http://www.ecma-international.org/standards/ecma-366/ws-session/ed2"
targetNamespace="http://www.ecma-international.org/standards/ecma-366/ws-session/ed2">


 

  schemaLocation="http://www.ecma-international.org/standards/ecma-354/appl_session/start-application-session.xsd"/>

  schemaLocation="http://www.ecma-international.org/standards/ecma-354/appl_session/stop-application-session.xsd"/>

  schemaLocation="http://www.ecma-international.org/standards/ecma-354/appl_session/reset-application-session-timer.xsd"/>

  schemaLocation="http://www.ecma-international.org/standards/ecma-354/appl_session/application-session-terminated.xsd"/>

 



 




 



 




 



 



 
 

 

 
 
 


 



 





ETSI

---------------------- Page: 9 ----------------------
10 ETSI TS 102 440 V1.2.1 (2008-11)


 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 




ETSI

---------------------- Page: 10 ----------------------
11 ETSI TS 102 440 V1.2.1 (2008-11)
6 Service Provider WSDL SOAP Binding
This clause specifies the binding template of the abstract WSDL definitions in clause 5 with SOAP Messages without a
specific transport protocol. Any SOAP binding to transport shall contain elements and attributes in this binding
template.
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:aps="http://www.ecma-international.org/standards/ecma-354/appl_session"
xmlns:wss="http://www.ecma-international.org/standards/ecma-354/ws-session/ed2"
targetNamespace="http://www.ecma-international.org/standards/ecma-366/ws-session/ed2">
 location="http://www.ecma-international.org/standards/ecma-366/ws-session/ed2/ws-session-wsdl-abstract-
definitions.wsdl" />

 
 
 
  
 
 
  
 
 
  

 
 
 
  
 
 
  
 
 
  

 
 
 
  
 
 
  
 
 
  

 
 
 
  
 
 



ETSI

---------------------- Page: 11 ----------------------
12 ETSI TS 102 440 V1.2.1 (2008-11)
ECMA-354 [1] requires Applications to include the aps:sessionID in the service requests that address the established
session. To standardize this requirement in Web services that exchange SOAP messages, the placement of
aps:sessionID shall follow these rules.
1) The SOAP subscription message for WS-Eventing [6] and WS-BaseNotification [7] subscriptions shall include
the aps:sessionID as a SOAP header block annotated with attribute: wsa:IsReferenceParameter="true".
2) Other SOAP messages within a session shall include the aps:sessionID as a header block.
The negative responses from Service Providers shall be bound to the SOAP 1.1 [2] fault properties: faultcode,
faultstring and detail, using the following template.

xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:aps="http://www.ecma-international.org/standards/ecma-354/appl_session">


 
  [faultcode]

  [faultstring]
  [detail]

 





The contents of fault properties are defined by the following table for each type of negative response.
Table 1 — Fault names and properties for WS-Session services
Fault Name StartFault
Faultcode ECMA-354 [1] defined standard error names: invalidApplicationInfo,
requestedProtocolVersionNotSupported, serverResourcesBusy, maxNumberSessions, or
application error name.
Faultstring For ECMA-354 [1] standard errors, it is the Description of corresponding error in table 4-3 of
ECMA-354 [1]. Additional text can be provided to elaborate the error message, for example, the
maximal session number allowed by the service provider. For application errors, a proper English
description shall be provided.
Detail Element aps:StartApplicationSessionNegResponse.
Fault Name StopFault
Faultcode ECMA-354 [1] defined standard error names: invalidSessionID, or application error name.
Faultstring For ECMA-354 [1] standard errors, it is the Description of corresponding error in table 4-6 of
ECMA-354 [1]. Additional text can be provided to elaborate the error message, for example, the valid
session ID format allowed by the service provider. For application errors, a proper English
description shall be provided.
Detail Element aps:StopApplicationSessionNegResponse.
Fault Name ResetFault
Faultcode ECMA-354 [1] defined standard error names: invalidSessionID,
serverCannotResetSessionDuration, or application error name.
Faultstring For ECMA-354 [1] standard errors, it is the Description of corresponding error in table 4-9 of
ECMA-354 [1]. Additional text can be provided to elaborate the error message, for example, the
duration allowed by the service provider. For application errors, a proper English description shall be
provided.
Detail Element aps:ResetApplicationSessionTimerNegResponse.

ETSI

---------------------- Page: 12 ----------------------
13 ETSI TS 102 440 V1.2.1 (2008-11)
7 Event Subscription and Notification
The ApplicationSessionTerminated operation is an outbound asynchronous event notification.
The Service Requester shall subscribe to receive the event notification from the Service Provider according to the event
subscription mechanism of the Service Provider. It shall provide the event sink URI as defined in annexes A and B, and
shall make the said event sink WSDL available to the Service Provider.
The Service Requester shall subscribe to receive the ApplicationSessionTerminated event immediately after the
successful completion of the StartApplicationSession operation.
The Service Provider and Requester shall implement WS-Addressing defined by (WS-Addressing 1.0 [5]).
The subscription message shall include the unique aps:sessionID obtained from the StartApplicationSession operation.
The aps:sessionID element shall be the first level child element of the subscription endpoint reference parameters
(WS-Addressing 1.0 [5]) , and the element is bound to the SOAP message as a header block as defined in clause 6.
The Service Requester and Provider shall support the push mode of WS-Eventing [6] or push-style of
WS-BaseNotification [7] to deliver the event notification. The Service Provider shall send event notifications to each of
the valid event sink endpoints declared in the event subscription message.
The event notification message from the Service Provider shall include the sink endpoint reference parameters, if any,
so that the Service Requester can correlate the event notification obtained from the Service Provider using those
parameters.
If the application session terminates abnormally, before the ApplicationSessionTerminated event can be subscribed to,
the subsequent subscription of ApplicationSessionTerminated event by the Service Requester shall result in a SOAP
fault message as defined by the subscription protocol specified in annexes A and B.
When a session terminates, any subscription associated with the session is deemed invalid.
ETSI

---------------------- Page: 13 ----------------------
14 ETSI TS 102 440 V1.2.1 (2008-11)
Annex A (normative):
Event Subscription Using WS-Eventing Option
The Service Provider shall implement the wse:SubscribeOp operation defined in the EventSource portType of
WS-
...