Versions Compared

Version Old Version 4 New Version Current
Changes made by

WILSON Scott

WILSON Scott

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
Task Status
Task Status
nopaneltrue

Advanced Message Queuing Protocol (AMQP)

Table of Contents

Service implementations can use the AMQP standard: See https://www.amqp.org/.

See:https://

Introduction

Service design is a step in the service orientation process detailed on the SWIM reference website (https://reference.swim.aero/

technical-infrastructure

knowledge/

guidance

service-

for-pub-sub-push-implementation.html
  • https://reference.swim.aero/technical-infrastructure/binding-selection-guidelines.html

    • v1.0

    Questions to address:

    An example for an AMQP1.0 message payload can be given, e.g.
    "serviceInterface": [{
     "messages": [{
      "name": "AMQP message body",
      "description": "The AMQP message body contains the OPMET data in IWXXM3.0",
      "schema": {
       "url": "https://schemas.wmo.int/iwxxm/3.0.0/"
      }
     }],
    ...
    }]

    orientation-process.html#design). One outcome is a service model (service interface(s), service operation(s), service behaviour).

    This page provides guidance on some aspects of service design.

    Table of Contents

    Naming conventions

    The following section shows how the names appear in a service definition.

    In general:

    • nouns/roles should be as clear as possible.

    • verbs should be from an agreed list (of examples).

    Info

    The following documents will help.

    SWIM-DEFN-140 Service functions

    The functionality expresses the business view of the service. The requirements asks for information about:

    • the functions expected to be offered by the service in support of its capabilities; and

    • their expected real world effects.

    The service metadata schema introduces the need to name the function.

    Natural language is preferred when naming the function. The example below uses two formulations:

    • Provide ...

    • ... Provision

    It is not possible to have a best practice on which is preferred. Both formulations are allowed. The important this to remember is that it is a name and should be as clear and descriptive as possible.

    Example of SWIM-SERV-140 using Service Metadata Schema
    Code Block
    languagejs
    "generalDescription": {
 "functionality": [{
  "name": "Provide Turbulence Forecast Information",
  "description": "A detailed and product-specific description on the delivered product.",
  "realWorldEffect": "Information is provided continually; the service consumer gets the subscribed data."
 }, {
  "name": "Meteorological Forecast Provision",
  "description": "...",
  "realWorldEffect": "..."
 }]
}

    SWIM-DEFN-240 Service interfaces

    Advice on naming service interfaces is given in the note to SWIM-SERV-240.

    A service may contain multiple interfaces. Some of these may be private or at least interfaces for specific purposes, e.g. Monitoring or Reporting interfaces. Only exposed service interface need to be documented.

    Info

    SWIM-SERV-240

    Note: To improve readability across service descriptions, it is best practice to apply the following conventions for a service interface name

    • be represented using UpperCamelCase; and

    • use the <noun> <role> pattern where <noun> is a topic related to the service and <role> describes the roles in a composition/interaction sequence, based on the Message Exchange Pattern that is used.

    Example service interface names: FlightPlanCoordinator, FlightPlanSubmitter, ForecastProvider, ForecastConsumer, ClearanceRequester, ClearanceManager, PreDepartureSequencer, FlightInformationPublisher, AlertListener.

    Info

    It is best to avoid mention of a broker. Indeed, a broker is not necessary when using AMQP.

    Examples based on this from the SWIM Registry:

    SWIM-DEFN-270 Service operations

    Advice for naming service operations is given in the note to SWIM-SERV-270.

    Info

    SWIM-SERV-270

    Note: To improve readability across service descriptions, it is best practice to apply following conventions for a service operation name:

    • include a verb and a noun; and

    • be represented using lowerCamelCase.

    Example service operation names: getAlerts; requestTrajectoryAnalysis; publishAirportMETInducedCapacity; setCoordinationAndTransferData; proposeARESDeActivation; setTargetOffBlockTime.

    An example of this convention can be seen in the Web Feature Service standard's getFeature, getCapabilities and getFeatureType operations.

    The AMQP 1.0 standard uses message queues. A service consumer can subscribe to a specific endpoint (which is user specific) to get a message.

    Operations from the service provider point of view, e.g., when a broker is used (see BROKERED_PUBLISH_SUBSCRIBE_WITH_PUSH_MECHANISM) could be publishTurbulenceForecast. The use of the broker should be transparent to the service consumer.

    Info

    Note that there is no need to document operations if a standardised implementation is used. See Documenting the use of standardised implementations for more information.

    Categorisation

    SWIM-DEFN-100 Service categories

    The following example shows how to add a service categorisation for a Web Feature Service.

    Note

    The URL used in the example does not exist yet. It is waiting for the service category page to be updated.

    Example of SWIM-SERV-100 using Service Metadata Schema
    Code Block
    languagejs
    "serviceCategorisation": {
 "other": [{
  "name": "SERVICE_TYPE",
  "value": "FEATURE_ACCESS_SERVICE",
  "categorisationScheme": {
   "url": "http://reference.swim.aero/information-services/service-categories/CodeServiceType"
  }
 }]
}

    Application Message Exchange Patterns

    SWIM-DEFN-210 Application message exchange pattern

    Guidance on the selection of the application message exchange pattern can be found on the SWIM reference resource pages.

    In general: