Requirements

Persistency KVS Module Requirements		status: valid security: NO safety: ASIL_B
realizes: wp__requirements_comp
doc__persistency_kvs_requirements		Generic Document

Key Naming		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_keys
The component shall accept keys that consist solely of alphanumeric characters, underscores, or dashes.
comp_req__persistency__key_naming		Component Requirement

Key Encoding		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_keys
The component shall encode each key as valid UTF-8.
comp_req__persistency__key_encoding		Component Requirement

Key Uniqueness		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_keys
The component shall guarantee that each key is unique.
comp_req__persistency__key_uniqueness		Component Requirement

Key Length		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_keys
The component shall limit the maximum length of a key to 32 bytes.
comp_req__persistency__key_length		Component Requirement

Value Data Types		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_value
The component shall accept only values of the following data types: Number, String, Null, Array[Value], or Dictionary{Key:Value}.
comp_req__persistency__value_data_types		Component Requirement

Value Serialization		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_value
The component shall serialize and deserialize all values to and from JSON.
comp_req__persistency__value_serialize		Component Requirement

Value Length		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_value
The component shall limit the maximum length of a value to 1024 bytes.
comp_req__persistency__value_length		Component Requirement

Value Default		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_value, feat_req__persistency__default_values
The component shall support unset values and shall provide a default value when a value is unset.
comp_req__persistency__value_default		Component Requirement

Value Reset		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__support_datatype_value, feat_req__persistency__default_values
The component shall allow resetting a value to its default if a default is defined.
comp_req__persistency__value_reset		Component Requirement

Default Value Datatypes		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__default_values, feat_req__persistency__default_value_get, feat_req__persistency__default_value_reset, feat_req__persistency__default_value_file
The component shall accept default values of only permitted value data types.
comp_req__persistency__default_value_types		Component Requirement

Default Value Query		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__default_values, feat_req__persistency__default_value_get, feat_req__persistency__default_value_reset, feat_req__persistency__default_value_file
The component shall provide an API to retrieve default values.
comp_req__persistency__default_value_query		Component Requirement

Default Value Config		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__default_values, feat_req__persistency__default_value_get, feat_req__persistency__default_value_reset, feat_req__persistency__default_value_file
The component shall allow configuration of default values in code or in a separate configuration file.
comp_req__persistency__default_value_config		Component Requirement

Default Value Checksum		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__default_values, feat_req__persistency__default_value_get, feat_req__persistency__default_value_reset, feat_req__persistency__default_value_file
The component shall secure the configuration file for default values with an associated checksum file when default values are stored in a file.
comp_req__persistency__default_value_checksum		Component Requirement

Constraint Configuration		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__config_file
The component shall allow configuration of KVS constraints at compile-time using source code constants or at runtime using a configuration file.
comp_req__persistency__constraints		Component Requirement

Concurrency		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__intra_process_comm
The component shall implement thread-safe mechanisms to enable concurrent access to data without data races.
comp_req__persistency__concurrency		Component Requirement

Multi-Instance		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__multiple_kvs
The component shall manage all runtime variables within an instance to enable creation and use of multiple KVS instances concurrently within a single software architecture element.
comp_req__persistency__multi_instance		Component Requirement

Persistent Data Storage Components		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__persistency, feat_req__persistency__integrity_check, feat_req__persistency__persist_data
The component shall use the file API and the JSON data format to persist data.
comp_req__persistency__persist_data_store_com		Component Requirement

Persistent Data Storage Checksum Write		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__persistency, feat_req__persistency__integrity_check, feat_req__persistency__persist_data
The component shall generate a checksum for each data file and shall store it alongside the data.
comp_req__persistency__pers_data_csum_write		Component Requirement

Persistent Data Storage Checksum Verify		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__persistency, feat_req__persistency__integrity_check, feat_req__persistency__persist_data
The component shall verify the checksum when loading data.
comp_req__persistency__pers_data_csum_verify		Component Requirement

Persistent Data Storage Backend		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__persistency, feat_req__persistency__integrity_check, feat_req__persistency__persist_data
The component shall use the file API to persist data.
comp_req__persistency__pers_data_store_bend		Component Requirement

Persistent Data Storage Format		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__persistency, feat_req__persistency__integrity_check, feat_req__persistency__persist_data
The component shall use the JSON data format to persist data.
comp_req__persistency__pers_data_store_fmt		Component Requirement

Persistent Data Versioning		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__versioning, feat_req__persistency__update_mechanism
The component shall not provide built-in versioning.
comp_req__persistency__pers_data_version		Component Requirement

Persistent Data Schema		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__versioning, feat_req__persistency__update_mechanism
The component shall use a JSON file storage format that enables the application to implement versioning, including upgrade and downgrade paths, as needed.
comp_req__persistency__pers_data_schema		Component Requirement

Snapshot Creation		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__snapshots
The component shall create a snapshot each time data is stored.
comp_req__persistency__snapshot_creation		Component Requirement

Snapshot Maximum Number		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__snapshots
The component shall maintain a configurable maximum number of snapshots.
comp_req__persistency__snapshot_max_num		Component Requirement

Snapshot IDs		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__snapshots
The component shall assign the ID 1 to the newest snapshot and shall increment the IDs of older snapshots accordingly.
comp_req__persistency__snapshot_id		Component Requirement

Snapshot Rotation		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__snapshots
The component shall rotate and delete the oldest snapshot when the maximum number is reached.
comp_req__persistency__snapshot_rotate		Component Requirement

Snapshot Restore		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__snapshots
The component shall allow restoration of a snapshot by its ID.
comp_req__persistency__snapshot_restore		Component Requirement

Snapshot Deletion		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__snapshots
The component shall allow deletion of individual snapshots.
comp_req__persistency__snapshot_delete		Component Requirement

Engineering Mode		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__eng_mode
The component shall provide an engineering mode that can be enabled during build time to display debugging and internal information.
comp_req__persistency__eng_mode		Component Requirement

Field Mode		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__field_mode
The component shall provide a field mode that can be enabled during build time to restrict access as much as possible.
comp_req__persistency__field_mode		Component Requirement

Async API		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__async_api
The component shall provide an asynchronous API in addition to the standard API.
comp_req__persistency__async_api		Component Requirement

Permission Control		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__access_control
The component shall rely on the underlying filesystem for access and permission management and shall not implement its own access or permission controls.
comp_req__persistency__permission_control		Component Requirement

Permission Error Handling		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__access_control
The component shall report any access or permission errors encountered at the filesystem level to the application.
comp_req__persistency__permission_err_handle		Component Requirement

Callback Support		status: valid security: NO safety: ASIL_B
reqtype: Functional satisfies: feat_req__persistency__events
The component shall provide an API for registering callbacks that are triggered by data change events.
comp_req__persistency__callback_support		Component Requirement