service definitions
Aeronautical Data Set Subscription Service - Service Definition
- WILSON Scott
Service Definition Identification
| service definition identification | title | Service definition for the Aeronautical Data Set Subscription Service |
|---|---|---|
edition | 00.06.00 | |
reference date | 2024-09-23 |
Service Identification
| service identification | service name | Aeronautical Data Set Subscription Service |
|---|
Service Abstract
| service 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 Definition Provider
| service definition provider | name | EUROCONTROL |
|---|---|---|
| description | EUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States. | |
| point of contact | ais.aixm@eurocontrol.int |
Geographical Extent of Information
Explanatory note
This field is left empty.
| geographical extent of information |
|---|
Service Categories
Service Standard Reference
Explanatory note
This field is left empty.
| service standard reference | reference | |
|---|---|---|
| implemented options | ||
| deviations/additions |
Operational Environment
| operational environment | 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. | |||
|---|---|---|---|---|---|
| capabilities | The service offers subscription and distribution capabilities. | ||||
information exchange requirements |
|
Service Functions
| service functions | function | name | Subscribe |
|---|---|---|---|
| description | The service consumer shall be able to subscribe to receive information concerning changes in the data set store matching a series of criteria. | ||
| real-world effect | The subscription is created. | ||
| function | name | Manage subscription | |
| description | The service consumer shall be able to manage a subscription such as changing its state and unsubscribing | ||
| real-world effect | The subscription is updated. | ||
| function | name | Distribution | |
| description | When there is an update in the data set store matching the criteria, information about it shall be distributed to the subscribers. | ||
| real-world effect | The service consumer receives information about the update of the data set store. |
Service Access and Use Conditions
Explanatory note
This field is left empty.
| service access and use conditions | legal constraints | ||
|---|---|---|---|
service policies | business policy | ||
operational policy | |||
technical policy | |||
service consumption constraints |
Security Constraints
| security constraints | authentication | 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. |
|---|---|---|
authorisation | 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. | |
confidentiality | 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. | |
integrity | 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
| performance | capacity | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. |
|---|---|---|
| response time | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. | |
| reliability | availability | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. |
| recoverability | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. | |
| security | confidentiality | The service shall ensure confidentiality by using SWIM Technical Infrastructure (TI) Yellow Profile bindings. |
| integrity | The service shall ensure integrity by using SWIM Technical Infrastructure (TI) Yellow Profile bindings. |
Quality of Data
Explanatory note
This field is left empty.
| quality of data |
|---|
Source of Information
Explanatory note
This field is left empty.
| source of information | source |
|---|
Service Validation Information
| service validation information | validation performed | NOT_VALIDATED |
|---|---|---|
| method used | ||
| summary of the validation steps performed | ||
| results achieved | ||
| how the service consumer may obtain the validation evidence |
Application Message Exchange Pattern
application message exchange pattern | PUBLISH_SUBSCRIBE |
|---|
Service Behaviour
| service behaviour | typical 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:
|
|---|---|---|
exception handling | 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. |
Service Monitoring
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. |
|---|
Service Interfaces
| service interfaces | interface | name | Subscription Interface |
|---|---|---|---|
description | Allows the service consumer to subscribe and to manage subscriptions. | ||
provider/consumer side | PROVIDER_SIDE_INTERFACE | ||
| message exchange pattern | SYNCHRONOUS_REQUEST_RESPONSE | ||
| interface | name | Distribution Interface | |
| description | Allows the service provider to distribute information concerning updates to the data set store. | ||
| provider/consumer side | PROVIDER_SIDE_INTERFACE | ||
| message exchange pattern | FIRE_AND_FORGET |
SWIM TI Profile and Interface Bindings
Subscription Interface
| SWIM TI profile and interface bindings | profile name | EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile |
|---|---|---|
profile version | 1.1 | |
selected service interface binding | ||
| selected network interface binding | The service shall use the network bindings of the SWIM TIYP. | |
description |
Distribution Interface
| SWIM TI profile and interface bindings | profile name | EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile |
|---|---|---|
profile version | 1.1 | |
selected service interface binding | ||
| selected network interface binding | The service shall use the network bindings of the SWIM TIYP. | |
description | AMQP 1.0 is used to distribute messages as explained in: https://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.html |
Service Interface Protocols and Data Format
| service interface protocols and data format | transport / messaging protocols | The service shall use TLS1.2 or later in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile. |
|---|---|---|
| data format | XML |
Service Operations
Subscription Interface
| service operations | operation | operation name | subscribe |
|---|---|---|---|
description | This operation allows a service consumer to request the subscription to a particular topic of the service. | ||
messages | SubscriptionRequest, SubscriptionReply | ||
| resources | /subscriptions/ | ||
| operation | operation name | unsubscribe | |
| description | This operation allows a service consumer to unsubscribe from a particular topic of the service. | ||
| messages | UnsubscriptionRequest, UnsubscriptionReply | ||
| resources | /subscriptions/<subscription_id> | ||
| operation | operation name | pause | |
| description | This operation allows a service consumer to pause the publishing of messages for a particular topic subscription. | ||
| messages | PauseRequest, PauseReply | ||
| resources | /subscriptions/<subscription_id> | ||
| operation | operation name | resume | |
| description | This operation allows a service consumer to resume a subscription that had been paused. | ||
| messages | ResumeRequest, ResumeReply | ||
| resources | /subscriptions/<subscription_id> | ||
| operation | operation name | getSubscriptionDetails | |
| description | This operation allows a service consumer to obtain information on a specific subscription. | ||
| messages | GetSubcriptionDetailsRequest, GetSubcriptionDetailsReply | ||
| resources | /subscriptions/<subscription_id> | ||
| operation | operation name | getTopics | |
| description | This operation allows a service consumer to request the list of topics available for subscription. | ||
| messages | GetTopicsRequest, GetTopicsReply | ||
| resources | /topics/ | ||
| operation | operation name | getTopic | |
| description | This operation allows a service consumer to obtain information on a specific topic. | ||
| messages | GetTopicRequest, GetTopicReply | ||
| resources | /topics/<topic> |
Distribution Interface
| service operations | operation | operation name | publish |
|---|---|---|---|
| description | This operation allows the service provider to publish information to service consumers based on their subscriptions. | ||
| messages | |||
| resources | /<queue> |
Service Messages
SubscriptionRequest
Request message to subscribe to a topic of interest.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscription | Subscription |
SubscriptionReply
Reply message to a subscription request.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionId | Identifier | |
| subscriptionStatus | SubscriptionStatus |
UnsubscriptionRequest
Request message to unsubscribe to a topic of interest.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionId | Identifier [1] |
UnsubscriptionReply
Reply message to an unsubscription request.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionStatus | SubscriptionStatus |
PauseRequest
Request message to pause a subscription.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionId | Identifier [1] |
PauseReply
Reply message to an pause request.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionStatus | SubscriptionStatus |
ResumeRequest
Request message to resume a subscription.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionId | Identifier [1] |
ResumeReply
Reply message to a resume request.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionStatus | SubscriptionStatus |
GetSubcriptionDetailsRequest
Request message to get the details on a specific subscription.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscriptionId | Identifier [1] |
GetSubcriptionDetailsReply
Reply message to a get subscription details request.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
| subscription | Subscription |
GetTopicsRequest
Request message to get a list of topics that are available for subscription.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
GetTopicsReply
Reply message to a get topics request.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
GetTopicRequest
Request message to get the details on a specific topic.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
GetTopicReply
Reply message to a get topic request.
| Property name | Type, Multiplicity | Definition |
|---|---|---|
Information Definition
| information definition | Aeronautical Data Set Information Definition |
|---|
Filter Encoding
Explanatory note
This field is left empty.
| filter encoding |
|---|
Machine-Readable Service Interface Definition
Explanatory note
This field is left empty.
machine-readable service interface definition |
|---|
Model View
Explanatory note
This field is left empty.
model view |
|---|
Abbreviations and Acronyms
| abbreviations and acronyms | abbreviation | code | AFTN |
|---|---|---|---|
| term | Aeronautical Fixed Telecommunication Network | ||
| abbreviation | code | AIS | |
| term | Aeronautical Information Services | ||
| abbreviation | code | FIR | |
term | Flight Information Region | ||
| abbreviation | code | HTTP | |
| term | Hypertext Transfer Protocol | ||
| abbreviation | code | ICAO | |
| term | International Civil Aviation Organisation | ||
| abbreviation | code | IER | |
term | Information Exchange Requirement | ||
| abbreviation | code | SWIM | |
term | System Wide Information Management | ||
| abbreviation | code | TI | |
| term | Technical Infrastructure | ||
| abbreviation | code | WS | |
| term | Web Service | ||
| abbreviation | code | YP | |
| term | Yellow Profile |
Appendix A: References
| references | reference | title | Publish/Subscribe Push MEP: Implementation Guidance |
|---|---|---|---|
| version | JULY 2nd, 2019 | ||
| description | Guidelines on implementing the publish subscribe message exchange patterns | ||
| url | http://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.htm | ||
| document type |