Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Title | SWIM TI Profile and interface bindings |
Identifier | SWIM-SERV-018 |
Requirement | A service description shall include for each service interface,
|
Rationale | To support the concept of interoperability between the service provider and service consumer, the SWIM TI Profiles only allow a certain set of technical solutions, which can be chosen by the service designer. This is used by technical experts to assess feasibility to implement. |
Verification | Completeness: Verify that the reference information is provided for each provider side and consumer side interface. Consistency: Verify that the selected service interface binding, network interface binding and additionally supported requirements are consistent with the selected SWIM TI Profile and version. Correctness: Not Applicable. |
Examples/Notes | Note: If configuration options are available in the service interface binding, it is best practice to document them (e.g. use of GZIP compression, Message Transmission Optimization Mechanism (MTOM) encoding). Example additionally supported requirements:
|
Level of Implementation | Mandatory |
Guidance
Examples
See the TI Profile and interface bindings section within the Donlon TOBT Setting Service Description.
Guidance for JSON service description
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Guidance
Additional attributes to Interface type as described in SWIM-SERV-016 Service interfaces.
Rationale: To support the concept of interoperability between the service provider and service consumer, the SWIM TI Profiles only allow a certain set of technical solutions, which can be chosen by the service designer.
The TI profile and version are embedded within the selected code value for field serviceInterfaceBinding.
Interface - additional attributes
attribute name | description | type | guidance | rule |
---|---|---|---|---|
serviceInterfaceBinding | An interface binding that enables services to exchange data with consuming applications. | Select the appropriate code value. Rationale: To support the concept of interoperability between the service provider and service consumer, the SWIM TI Profiles only allow a certain set of technical solutions, which can be chosen by the service designer. The code value includes the TI profile and version.
| Mandatory | |
networkInterfaceBinding | An interface binding that enables the SWIM TI to exchange data with the network. | Select the appropriate code value. | Mandatory | |
interfaceBindingDescription | Complementary description of the protocols and other specifications used by the interface complementing the selected bindings, or any additional requirement specified in a SWIM TI Profile that is supported by the interface. [SWIM-SERV-018], [SWIM-SERV-019] | string | Provide here a textual description of additionally supported requirements as specified in the selected SWIM TI Profile, if any. This field is used as well by requirement SWIM-SERV-019 Protocols and data format) to list the service interface protocols. | Mandatory |
Example
"serviceInterface": [ { "serviceInterfaceBinding": "SWIM_TI_YP_1_0_WS-N_SOAP", "networkInterfaceBinding": "IPV4_UNICAST", "interfaceBindingDescription": "XML requests and replies embedded into SOAP messages, themselves embedded into HTTP requests and responses. Operation names are associated to SOAP requests. The interface does not use compression or message transmission optimization mechanism (MTOM).", } ],
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.