ProtocolInformation🔗

The protocol information of a network resource endpoint.

The protocol information of a network resource endpoint is defined in DIN SPEC 16593-2. After the release of DIN SPEC 16593-2, any required updates will be made. This class is not part of the metamodel.

The information in this class is a 1:1 copy from DIN SPEC 16593-2. Required changes need to be made by the related DIN working group.

See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/specification/interfaces-payload.html#ProtocolInformation

Properties 🔗

href: LocatorType 🔗
The endpoint address as a URL.
endpointProtocol: Optional[SchemeType] 🔗
Either scheme of ProtocolInformation.href or scheme plus further information.
The scheme denotes the highest level of doubtless transmission.
endpointProtocolVersion: Optional[List[NameType]] 🔗
Each entry represents one supported version at this very endpoint, the entry shall be formatted according to the regulations of the protocol specified in the ProtocolInformation.href
subprotocol: Optional[ShortIdType] 🔗
Allows for referencing sub-protocols that may be used in the context of that endpoint e.g. "OPC Basic SOAP" or UA Binary
subprotocolBody: Optional[TextType] 🔗
If the sub-protocol field is present, a subprotocol body might be given to hold extra information, e.g. node and namespace in an OPC UA server
subprotocolBodyEncoding: Optional[NameType] 🔗
If ProtocolInformation.subprotocolBody is present, the encoding might be explicitly defined, otherwise it shall default to subprotocols encoding scheme
securityAttributes: Optional[List[SecurityAttributeObject]] 🔗
Array of SecurityAttributeObject's. Each attribute has three properties:

SecurityAttributeObject.type: enum security type or standard:

  • NONE;
  • RFC_TLSA, TLSA according to RFC 6698; or
  • W3C_DID, W3C DID document.

SecurityAttributeObject.key: security attribute key according to standard definitions of the security type.

SecurityAttributeObject.value: security attribute value, e.g. , DANE TLSA Resource Record.

The SecurityAttributeObject's are treated as possible alternatives (logical "or").

Invariants 🔗

Usages

Endpoint Endpoint.protocolInformation