JSON Component Architecture

JSON Architecture		status: draft safety: ASIL_B
realizes: wp__component_arch
doc__json_architecture		Generic Document

Overview

The component JSON implements functionality for reading/parsing JSON data and also to write. It provides currently only a C++ API.

Requirements Linked to Component Architecture

See the “fulfils” links in static and dynamic architecture below.

Description

JSON provides an abstraction layer to underlying implementations, in first iteration there is only one implementation provided. But generally there is a “Wrapper” and an “Implementation” lower-level component.

Design Decisions:

It was decided to use the nlohman_json OSS library (see nlohman/json). This decision still has to be documented (TBD).

JSON writing functionality is implemented in the “Wrapper”, i.e. the nlohman_json OSS library is not used for this. Reasoning is that this functionality is reused from an already qualified baselibs implementation.

Design Constraints:

The feature description states that this component provides a “JSON abstraction layer that can switch between different parsers/serializers under the hood.”

Rationale Behind Architecture Decomposition

The decomposition in a wrapper and an implemetation component already comes from the feature definition, the main driver is to re-use existing implementation(s), enable switch of implementation but providing a stable API.

Static Architecture

JSON		status: valid security: YES safety: ASIL_B
fulfils: comp_req__json__deserialization, comp_req__json__serialization, comp_req__json__user_format, comp_req__json__lang_idioms, comp_req__json__lang_infra, comp_req__json__type_compatibility, comp_req__json__full_testability, comp_req__json__asil implements: logic_arc_int__baselibs__json includes: comp_arc_sta__baselibs__json_wrapper, comp_arc_sta__baselibs__nlohman_json included by: mod_view_sta__baselibs__baselibs
comp_arc_sta__baselibs__json		Component & Component Package Diagram

Dynamic Architecture

JSON dynamic arch		status: invalid security: YES safety: ASIL_B
fulfils: comp_req__json__deserialization, comp_req__json__serialization, comp_req__json__user_format, comp_req__json__lang_idioms, comp_req__json__lang_infra, comp_req__json__type_compatibility, comp_req__json__full_testability, comp_req__json__asil
put here a sequence diagram (TBD)
comp_arc_dyn__baselibs__json_dynamic_view		Component Sequence Diagram

Interfaces

IJson		status: valid security: YES safety: ASIL_B
implemented by: comp_arc_sta__baselibs__json, comp_arc_sta__baselibs__json_wrapper used by: comp_arc_sta__lifecycle__launch_manager, comp_arc_sta__com__ipc_binding included by: feat_arc_sta__baselibs__static_view_arch includes: logic_arc_int_op__baselibs__parse, logic_arc_int_op__baselibs__write
logic_arc_int__baselibs__json		Logical Interface & Feature Interface View

Parse		status: valid security: YES safety: ASIL_B
included by: logic_arc_int__baselibs__json
logic_arc_int_op__baselibs__parse		Logical Interface Operation

Write		status: valid security: YES safety: ASIL_B
included by: logic_arc_int__baselibs__json
logic_arc_int_op__baselibs__write		Logical Interface Operation

Lower Level Components

JSON-Wrapper		status: valid security: YES safety: ASIL_B
fulfils: comp_req__json__user_format, comp_req__json__lang_idioms, comp_req__json__lang_infra, comp_req__json__type_compatibility, comp_req__json__full_testability, comp_req__json__serialization, comp_req__json__asil implements: logic_arc_int__baselibs__json included by: comp_arc_sta__baselibs__json
comp_arc_sta__baselibs__json_wrapper		Component & Component Package Diagram

nlohman-JSON		status: valid security: YES safety: ASIL_B
fulfils: comp_req__json__deserialization, comp_req__json__asil included by: comp_arc_sta__baselibs__json
comp_arc_sta__baselibs__nlohman_json		Component & Component Package Diagram