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
Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-017 Message exchange pattern

Requirement

Title

Application message exchange pattern

Identifier

SWIM-SERV-210

Requirement

A service description shall include or refer to information about the application message exchange pattern(s) used by the service.

Rationale

The message exchange pattern helps understanding how the information interaction with the service works.

Verification

Completeness: Verify that the information is included.

Consistency: Verify that the information is consistent with the selected service interface binding.

Correctness: Not Applicable.

Examples/Notes

Note: Typical message exchange patterns (as from the SWIM Technical Infrastructure Yellow Profile [RD 4]):

  • Request/Reply (synchronous or asynchronous);
  • Publish/Subscribe (Push or Pull);
  • One Way (also known as Fire and Forget).

Level of Implementation

Mandatory

Guidance

This requirement refers to the application message exchange pattern used by the service.

The document MEP identification, developed in the SWIM-TEC community, provides information on the various notions of message exchange pattern (MEP). 

  • it introduces the concept of MEP
  • it explains the difference between primitive MEPs and application MEPs.
  • it provides the semantic of each MEP in text and diagram

Verification Support

Completeness

Check that:

[  ] The service description includes or refers to information about the application message exchange pattern(s) used by the service.
Consistency

Check that:

[  ] The information is consistent with the selected service interface binding.

Examples

The following example shows the content as a table.

application message exchange pattern

Synchronous Request Reply

The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Example of SWIM-SERV-210 using Service Metadata Schema
"serviceCategorisation": {
 "applicationMessageExchangePattern": [{
  "name": "SYNCHRONOUS_REQUEST_REPLY"
 }]
}

Complete examples are available at Example service description.


  • No labels