class ara::diag::DynamicAccessListDiagServiceBuilder

use

The synchronous method Add of class ara::diag::DynamicAccessListDiagServiceBuilder serves to add a single byte (Byte value) to a DynamicAccessListPattern [SWS_DM_01175]. The passed byte value is checked for an exact match during the evaluation of access rights for diagnostic services [SWS_DM_01175]. By returning a reference to the instance of the same object (DynamicAccessListDiagServiceBuilder&), the function supports invocation as a fluent API [SWS_DM_01175].

Error Handling and Exception Safety

The operation is declared as noexcept and specified as exception safe (exception safe) [SWS_DM_01175]. Neither error codes nor return values of type ara::core::Result are returned; specific DET or DEM messages are not identified in the payload for this function.

Concurrency and Limitations

The method is specified as not thread-safe (not thread-safe) [SWS_DM_01175]. Interpretation: Calls on the same builder instance are therefore typically expected to occur sequentially within a single thread before the created access pattern is evaluated in the diagnostic server. Question Q-69d895fc6bf90cb4 (open)

Interaction

Within interface DynamicAccessListDiagServiceBuilder, this method complements related overloads of Add with which byte sequences via ByteString [SWS_DM_01176] or value ranges via ByteRange [SWS_DM_01177] can be added to a DynamicAccessListPattern.

The member function Add of class ara::diag::DynamicAccessListDiagServiceBuilder serves to add a byte sequence to a DynamicAccessListPattern [SWS_DM_01176]. Via the input parameter values of type ByteString, a byte sequence is passed that is checked for an exact match during the subsequent evaluation of access rights for diagnostic services [SWS_DM_01176]. As a return value, the method returns a reference to the same builder instance (DynamicAccessListDiagServiceBuilder&), which enables a fluent interface usage (Fluent API) by chaining multiple calls [SWS_DM_01176].

With regard to error handling, the function is declared as noexcept and specified as exception safe (exception safe) [SWS_DM_01176]. Neither error codes nor C++ exceptions are reported.

Regarding concurrency, the method is defined as not thread-safe (not thread-safe) [SWS_DM_01176]. If multiple threads access the same builder instance in parallel, the calls must be synchronized by the application. Interpretation: The call is likely to occur synchronously in the execution context of the configuring application thread, as no asynchronous mechanisms are specified. Question Q-d93498e82292a88e (open)

In the interaction of Diagnostic Management, this method complements related builder functions for defining dynamic access patterns: While complete byte sequences are registered with this function, single bytes ([SWS_DM_01175]) or value ranges ([SWS_DM_01177]) can alternatively be added to the pattern via overloaded Add functions.

The function Add of class ara::diag::DynamicAccessListDiagServiceBuilder serves applications to add a value range of bytes to a DynamicAccessListPattern [SWS_DM_01177]. The passed parameter range of type ByteRange defines a value interval that is checked for a match during the evaluation of access rights for diagnostic services [SWS_DM_01177].

For the call and integration into Diagnostic Management, the following properties apply:

• Invocation Context and Semantics: The call occurs synchronously. As a return value, the function returns an object reference to the same builder instance (DynamicAccessListDiagServiceBuilder&) in order to support fluent interface usage (Fluent API) through method chaining [SWS_DM_01177].
• Error Handling: The operation is declared as noexcept and possesses the specification property exception safe [SWS_DM_01177]. No specific error codes are returned, and no exceptions are thrown.
• Concurrency: The function is explicitly specified as not thread-safe [SWS_DM_01177]. Interpretation: If multiple threads of execution access the same builder instance, the calling application must synchronize access externally. Question Q-c51760a8fe29bd5f (open)
• Interplay: The method supplements related functions of the builder class for adding individual byte values via [SWS_DM_01175] as well as for defining byte sequences by means of [SWS_DM_01176] to configure flexible access patterns.

use

Method ara::diag::DynamicAccessListDiagServiceBuilder::Any is used by the application software to define wildcards in an access pattern ([SWS_DM_01178]). The synchronous call is executed on an instance of the builder. Parameter numberOfBytesToIgnore specifies how many consecutive bytes are indeed included in the access pattern, but ignored during subsequent pattern matching against incoming diagnostic requests ([SWS_DM_01220]). Returning an object reference to the same builder enables a fluent API call style (AUTOSAR_AP_SWS_Diagnostics §8.15.1.2.3.4 “Any”).

Error Handling and Exception Behavior

The function is specified as noexcept and exception safe (exception safe) ([SWS_DM_01178]). Neither error codes nor feedback to DET or DEM are provided. Interpretation: When passing the value 0 for numberOfBytesToIgnore, the call is likely to return without error and register no wildcard bytes in the pattern. Question Q-e372cda9f8840893 (open)

Concurrency and Limitations

The interface is explicitly designated as not thread-safe (not thread-safe) ([SWS_DM_01178]). Multiple builder calls on the same instance of DynamicAccessListDiagServiceBuilder must therefore strictly run sequentially or be synchronized by the caller.

Interaction

Placeholder definitions via Any are typically combined with patterns such as EndsWith ([SWS_DM_01221]). After assembling all pattern components, the configuration must be finalized using method Build ([SWS_DM_01222]) before the resulting access list is available for verifications (AUTOSAR_AP_SWS_Diagnostics §7.3.2 “Adding wildcards to a DynamicAccessList”).

use

The synchronous method Build of class ara::diag::DynamicAccessListDiagServiceBuilder ([SWS_DM_01166]) concludes the creation of a dynamic access list ([SWS_DM_01181]). The function accepts no input parameters and has no return value ([SWS_DM_01181]). Upon the call, the responsible Diagnostic Server instance takes over the assembled access rules ([SWS_DM_01222]).

Error handling

The operation is declared as noexcept and specified as exception safe ([SWS_DM_01181]). Neither error codes are returned nor exceptions are thrown.

Concurrency and Limitations

The method is classified as not thread-safe ([SWS_DM_01181]). Concurrent accesses to the same builder object from multiple execution contexts must therefore be protected externally. In addition, a strict ordering requirement exists: Build must mandatory be called before the service builder object is destroyed ([SWS_DM_01181]). Interpretation: If this call is omitted before the end of the object's life cycle, the previously configured patterns are likely to expire and not become effective for authorization. Question Q-445ea33ece339d42 (open)

Interaction

As part of list creation, service and request patterns are defined in advance, for example by wildcards via Any ([SWS_DM_01220]) or termination patterns via EndsWith ([SWS_DM_01221]), as described in SWS Diagnostics §7.3.2.3.4 “DynamicAccessList Creation and Update”. Build finalizes this construction process and passes the list to the server ([SWS_DM_01222]).

The synchronous method EndsWith of class ara::diag::DynamicAccessListDiagServiceBuilder is used by applications to define a single byte (Byte value) as the termination pattern of a dynamic access list [SWS_DM_01179]. Upon invocation, the Diagnostic Server instance assigns this pattern to the end of the DynamicAccessList in order to check it for an exact match when evaluating diagnostic service rights [SWS_DM_01221]. The function provides no return value.

Regarding error handling, the function is specified as exception safe (exception safe) and declared with noexcept [SWS_DM_01179]. Specific error codes, DET or DEM messages are not intended in the specification scope for this method call.

Regarding concurrency, the method is designated as not thread-safe (not thread-safe) [SWS_DM_01179]. For concurrent access to the same builder instance, external synchronization by the application is required. Interpretation: Setting the end pattern is likely to have to occur before calling Build [SWS_DM_01222], since the Diagnostic Server finalizes the DynamicAccessList with Build. Question Q-a0afa7deaafa306b (open)

In interaction with related requirements, alongside this single-value variant, an overload EndsWith(ByteRange range) [SWS_DM_01180] exists, which allows specifying a closed byte value range as the termination pattern SWS Diagnostics §8.15.1.2.3.6 “EndsWith(ByteRange)”. Both variants configure the end pattern of the same access list before its use [SWS_DM_01221].

use

The method EndsWith of class ara::diag::DynamicAccessListDiagServiceBuilder serves to define a closed byte interval (ByteRange range) at the end of the search pattern of a dynamic access list (DynamicAccessList) [SWS_DM_01180]. Upon the method call, the Diagnostic Server instance appends the specified pattern to the end of the DynamicAccessList [SWS_DM_01221]. This value range is subsequently used in the evaluation of access rights for diagnostic services AUTOSAR_AP_SWS_Diagnostics §8.15.1.2.3.6 “EndsWith(ByteRange)”. The call is synchronous and provides no return value (void) [SWS_DM_01180].

Error Handling and Concurrency

The operation is declared as noexcept and specified as exception safe (exception safe); specific error codes or exception handlings do not exist [SWS_DM_01180]. Regarding concurrency, the method is classified as not thread-safe (not thread-safe) [SWS_DM_01180]. Concurrent access to the same builder instance across multiple threads is not permitted without external synchronization.

Interaction and Lifecycle

Within the scope of pattern creation, in addition to this variant for value ranges, an alternative overload of EndsWith exists that defines a single byte (Byte value) for exact pattern matching at the end [SWS_DM_01179]. After configuring the pattern, the list must be finalized by calling Build [SWS_DM_01222] before the application can use the generated DynamicAccessList for authorization checks AUTOSAR_AP_SWS_Diagnostics §7.3.2 “End patterns of a DynamicAccessList”.