Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »


Requirement

 Requirement [+]

Title

Service interfaces

Identifier

SWIM-SERV-016

Requirement

A service description shall list the service interfaces (provider side and consumer side interfaces), including for each service interface,

  • the name of the service interface;
  • a textual description of the service interface including its purpose;
  • an indication that the interface is a provider side interface or a consumer side interface; and
  • for a provider side interface, the fully qualified network address at which the interface can be accessed.

Rationale

This information facilitates the unambiguous identification of the interface, the understanding of its purpose, and the location to access it.

Verification

Completeness: Verify that the list of interfaces is included; verify that the name, description and indication are included for each interface.

Consistency: For each provider side interface, verify that the network address is provided.

Correctness: Not Applicable.

Examples/Notes

Note: To improve readability across service descriptions, it is best practice to apply following conventions for a service interface name (the appendix B “ISRM naming conventions” of the SESAR 1 Modelling Guidelines [RD 6] is a good source for naming conventions):

  • 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.

Note: It is best practice to provide, in addition, the network address(es) for accessing the service instance(s) that can be used for testing and development purposes.

Level of Implementation

Mandatory

Guidance

Examples

See the Interface Overview section and a specific Interface section within the Donlon TOBT Setting Service Description.

  • No labels