class ara::idsm::ReportingModeProvider

The class ara::idsm::ReportingModeProvider provides mechanisms to query and set reporting modes for security events in the Intrusion Detection System Manager [SWS_AIDSM_10600]. Instantiation is performed thread-safely via a ara::core::InstanceSpecifier for a modeled PPort [SWS_AIDSM_10601]. At runtime, the methods GetReportingMode and SetReportingMode allow reading as well as modifying the mode of a configured event. Since these methods are not thread-safe, concurrent access must be synchronized externally. For unknown event IDs, the methods return the error IdsmErrc::kUnknownEventId.

more ›

Context

The class ara::idsm::ReportingModeProvider is defined in the header ara/idsm/reporting_mode_provider.h and serves within the Adaptive module idsm to provide and dynamically control reporting modes for the Intrusion Detection System Manager (IdsM) [SWS_AIDSM_10600]. In a networked vehicle architecture, the IdsM monitors security events. Via the ReportingModeProvider, applications or responsible platform services can address configured security events in order to determine or define in which way an event shall be reported to the IdsM system. Binding to the architecture is established via a modeled PPort that is specified during instantiation [SWS_AIDSM_10601].

Lifecycle

The class is declared as final [SWS_AIDSM_10600], which excludes inheritance or polymorphic specialization. Creation of an object is performed via the explicit constructor ReportingModeProvider(const ara::core::InstanceSpecifier& instance) [SWS_AIDSM_10601]. Via the parameter instance, the binding to the concrete modeled PPort is established [SWS_AIDSM_10601]. Interpretation: The passed instance specifier presumably refers to the interface deployment configured in the AUTOSAR model for the IdsM service. Question Q-a7c5bdfa7e2ba42b (open)

Regarding concurrency, the constructor is specified as thread-safe (thread-safe) [SWS_AIDSM_10601]. The two operational methods for reading and writing the reporting modes, on the other hand, are expressly marked as not thread-safe (not thread-safe) [SWS_AIDSM_10602], [SWS_AIDSM_10603]. If multiple threads access the same instance of ReportingModeProvider in parallel, the caller must synchronize this access externally. The lifecycle of the instance is typically tied to the lifetime of the consuming application, which creates, manages, and destroys the object after the interaction has ended.

Usage Path

Typical usage is divided into initialization, querying the current state, and adapting the reporting mode as needed.

First, the application instantiates the provider for the intended port specifying the corresponding InstanceSpecifier [SWS_AIDSM_10601]. Subsequently, the current reporting mode for a specific configured event can be queried using the method GetReportingMode [SWS_AIDSM_10602]. The method returns a ara::core::Result<ReportingModeType> that encapsulates the mode or indicates an error that occurred [SWS_AIDSM_10602].

If the security situation or diagnostic configuration requires modification, SetReportingMode is called [SWS_AIDSM_10603]. This call accepts the identifier eventId as well as the new reportingMode and returns a ara::core::Result<void> [SWS_AIDSM_10603]. The application checks the result to ensure successful completion of the configuration change.

Sequence diagram: Typical usage path for querying and updating a reporting mode via the provider. Sources: [SWS_AIDSM_10601], [SWS_AIDSM_10602], [SWS_AIDSM_10603]

Error Scenarios

All methods of the class are declared with noexcept [SWS_AIDSM_10601], [SWS_AIDSM_10602], [SWS_AIDSM_10603]. Error handling is therefore performed entirely without C++ exceptions via the AUTOSAR-internal error model ara::core::Result.

Both when retrieving via GetReportingMode [SWS_AIDSM_10602] and when setting via SetReportingMode [SWS_AIDSM_10603], it is required that the passed eventId corresponds to a configured security event. If an unknown event identifier or one not stored in the system is passed, the operation fails and the Result contains the error code IdsmErrc::kUnknownEventId [SWS_AIDSM_10602], [SWS_AIDSM_10603]. Calling components must evaluate the Result prior to accessing the value and initiate appropriate error handling or logging in the event of an error.