EUROCONTROL
EUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States.
Aeronautical Data Set Subscription Service 1.0.0
Abstract
The Aeronautical Data Set Subscription Service allows the service consumer to subscribe to the service. The service consumer can define the scope of the subscription e.g. to be notified when new or changed data sets for a given location are made available by aeronautical information service (AIS) providers using the data set store.
The service is part of a series of services that supports the provision of digital data sets as defined by ICAO Annex 15.
Service Type
SWIM_DEFINITION
Business Activity Type
INFORMATION_MANAGEMENT
Intended Consumer
Information Exchange Category
AERONAUTICAL_INFORMATION_EXCHANGE
Application Message Exchange Pattern Entity
Other
General
Operational Needs
The service consumer shall be able to subscribe to data sets and data set series within the data set store. This will ensure that there is no need to continually search the store in order to check for updates.
Note: It is possible that a general user management system handles the subscription aspects.
IER1 - Service consumers create and manage subscriptions.
The selection criteria within the subscription specify what updates should be notified. The selection criteria include:
metadata on data set and data set series, e.g., selection on locations such as an FIR, selection on data set types, selection on a given data set series;
kind of events in data set store (such as new data set or update to a data set series).
IER2 - Service consumers receive notification messages when the selection criteria in the subscription is met. The message describes the update that occurred in the data set store.
Capabilities
The service offers subscription and distribution capabilities.
Functionality
The service consumer shall be able to subscribe to receive information concerning changes in the data set store matching a series of criteria.
The service consumer shall be able to manage a subscription such as changing its state and unsubscribing
When there is an update in the data set store matching the criteria, information about it shall be distributed to the subscribers.
Access and Use
Consumer and provider authentication shall be ensured.
The service shall ensure consumer authentication in accordance with the EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of a X.509 certificate or the use of a username/password (SASL).
The service shall ensure provider authentication in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of a X.509 certificate.
The service shall ensure that satisfactory authorisation is put in place according to EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile requirement SWIM-TIYP-0070.
The service shall ensure point-to-point confidentiality in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of Transport Layer Security (TLS) 1.2 or above.
The service shall ensure point-to-point integrity in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of Transport Layer Security (TLS) 1.2 or above.
Quality of Service
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
The service shall ensure confidentiality by using SWIM Technical Infrastructure (TI) Yellow Profile bindings.
The service shall ensure integrity by using SWIM Technical Infrastructure (TI) Yellow Profile bindings.
Quality Of Data
Validation
Abbreviations
Aeronautical Fixed Telecommunication Network
Aeronautical Information Services
Flight Information Region
Hypertext Transfer Protocol
International Civil Aviation Organisation
Information Exchange Requirement
System Wide Information Managemen
Technical Infrastructure
Web Service
Yellow Profile
Information
Information Definition
https://ext.eurocontrol.int/swim_confluence/display/ASW/Aeronautical+Data+Set+Information+Definition
Source of Information
This field is left empty.
Technical
Service Monitoring
A heartbeat service shall be used to periodically check the status of the service and determine whether it is available. This may take the form of AFTN pings.
Behaviour
The service behaviour shall be in accordance with the patterns detailed in Message Exchange Patterns: Identification Guidelines.
An AMQP 1.0 implementation implementation shall be used for the basic behaviour.
The typical PUBLISH_SUBSCRIBE behaviour means that:
A request-reply implementation handles the subscription.
An AMQP 1.0 implementation handles the distribution of the messages.
Note: see https://reference.swim.aero/technical-infrastructure/guidance-for-pub-s….
The following error codes may be of interest to implementers, covering common failures applicable to this resource invocation. Implementers are free to use a suitable subset of the ones proposed or complement it with additional ones to cover particular implementation needs.
* 400 Bad Request: Indicated for malformed requests on the part of the client.
* 401 Unauthorized: Indicated for authentication errors (e.g. the authentication is not provided, the credentials used do not exists, the authentication mechanism used is not validâ¦).
* 403 Forbidden: Indicated for authorization errors (e.g. the authenticated credentials are not allowed to perform this operation on the resource).
* 404 Not Found: The requested resource cannot be found (e.g. the <subscription_id> does not exist).
* 405 Method Not Allowed: The HTTP method used is not supported by the resource.
* 500 Internal Server Error: Catch-all error for unexpected internal errors during the processing of the request.
Interfaces
The interface groups the operations that allows querying metadata and retrieving files.
Operations
This operation allows a service consumer to request the subscription to a particular topic of the service.
Idempotent
IDEMPOTENT
Operation Message
This operation allows a service consumer to unsubscribe from a particular topic of the service.
Idempotent
IDEMPOTENT
Operation Message
This operation allows a service consumer to pause the publishing of messages for a particular topic subscription.
Idempotent
IDEMPOTENT
Operation Message
This operation allows a service consumer to resume a subscription that had been paused.
Note: Due to the stateless implementation of the API, this operation is performed in exactly the same way as the pause changing the subscription_status in the body of the message to âACTIVEâ.
Idempotent
IDEMPOTENT
Operation Message
This operation allows a service consumer to obtain information on a specific subscription.
Idempotent
IDEMPOTENT
Operation Message
This operation allows a service consumer to request the list of topics available for subscription.
Idempotent
IDEMPOTENT
Operation Message
This operation allows a service consumer to obtain information on a specific topic.
Idempotent
IDEMPOTENT
Operation Message
Service Interface Binding
EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile version 1.1
Network Interface Binding
The service shall use the network bindings of the SWIM TIYP.
Messages
-
Operations
This operation allows the service provider to publish information to service consumers based on their subscriptions.
Idempotent
IDEMPOTENT
Service Interface Binding
EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile
Network Interface Binding
AMQP 1.0 is used to distribute messages as explained in: https://reference.swim.aero/technical-infrastructure/guidance-for-pub-s…
References
Service Documents
Guidelines on implementing the publish subscribe message exchange patterns
Reference
Publish/Subscribe Push MEP: Implementation Guidance
http://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.htm
Implemented Standards
Revision Save Date
Thu, 08/31/2023 - 11:29
Schema version
v2