class ara::diag::ExternalAuthentication

The explicit constructor [SWS_DM_01193] initializes an instance of port class ara::diag::ExternalAuthentication [SWS_DM_01191] for authenticating external diagnostic clients (SWS Diagnostics §8.17 “Header: ara/diag/external_authentication.h”). As a parameter, the function expects a ara::core::InstanceSpecifier, which must reference an PortPrototype of an DiagnosticExternalAuthenticationInterface service instance modeled in the manifest [SWS_DM_01193].

The synchronous call is declared as noexcept and specified as both thread-safe and exception-safe [SWS_DM_01193]. Because no exceptions are thrown, modeling and configuration errors lead to defined framework violations [SWS_DM_01193]:

• InstanceSpecifierMappingIntegrityViolation: The specifier cannot be resolved in the context of the executable or references a model element other than an PortPrototype.
• PortInterfaceMappingViolation: The referenced PortPrototype is not typed by a DiagnosticExternalAuthenticationInterface.
• ProcessMappingViolation: No matching modeled runtime process exists for the reference.
• InstanceSpecifierAlreadyInUseViolation: The specifier is already in use by another instance in the running process.

Copy operations are explicitly prohibited for ExternalAuthentication [SWS_DM_01196] [SWS_DM_01197], whereas move operations are supported [SWS_DM_01194] [SWS_DM_01195]. In contrast to the constructor, the associated destructor is not thread-safe [SWS_DM_01198]. After successful instantiation, the object is used to query associated client authentication instances via methods such as Get or GetAll [SWS_DM_01201] [SWS_DM_01202].

The synchronous method ara::diag::ExternalAuthentication::Get is used by an adaptive application to retrieve the instance of ara::diag::ClientAuthentication responsible for a diagnostic request [SWS_DM_01199]. A reference to metaInfo (const ara::diag::MetaInfo&) is passed as a parameter, which provides meta-information from the context of the diagnostic request SWS Diagnostics §7.3.1.1 “MetaInfo class”. The return value of type ara::core::Result<ClientAuthentication> encapsulates the corresponding authentication object for managing the authentication state of the client [SWS_DM_01202].

If an error occurs, the returned Result contains the specific error code DiagErrc::kServiceNotAvailable [SWS_DM_01199]. This signals with rollback semantics that the call cannot be executed because essential functions of the Diagnostic Manager (DM) are not available at invocation time [SWS_DM_01199].

Regarding concurrency, the function is specified as thread-safe as well as exception safe and is declared with noexcept [SWS_DM_01199]. It can therefore be called safely from parallel threads without application-side locking mechanisms.

The method interacts with the overloaded variant Get(Address sourceAddress) [SWS_DM_01200], which enables the same retrieval directly via the client's source address [SWS_DM_01202]. The number of available instances is determined by model elements DiagnosticExternalAuthenticationIdentification SWS Diagnostics “Get ClientAuthentication Instance”. Interpretation: The function is likely to internally determine the source address required for the mapping from the transport data encapsulated in metaInfo. Question Q-50d416201ccb5825 (open)

The synchronous method Get of class ara::diag::ExternalAuthentication is used by an adaptive application to retrieve the instance of ClientAuthentication that manages the authentication state of the diagnostic client for the specified source address [SWS_DM_01200]. Here, the Diagnostic Manager resolves the responsible authentication object via the passed source address [SWS_DM_01202].

Usage and constraints comprise the following aspects:

• Invocation and parameters: sourceAddress of type Address is passed as a parameter [SWS_DM_01200]. In the system model, resolution is based on configured DiagnosticExternalAuthenticationIdentification elements that define fixed source addresses or address ranges SWS Diagnostics p. 129 “ClientAuthentication”. In addition, an overload of Get exists, which determines the instance via a MetaInfo object [SWS_DM_01199], [SWS_DM_01202].
• Return value and error handling: The function returns a ara::core::Result<ClientAuthentication> [SWS_DM_01200]. If execution is not possible because essential functions of the Diagnostic Manager are unavailable, error DiagErrc::kServiceNotAvailable is returned with rollback semantics [SWS_DM_01200].
• Concurrency: The operation is specified as thread-safe and exception safe as well as declared with noexcept, which is why calls from parallel threads can be performed in an exception-safe manner [SWS_DM_01200].

use

The method GetAll of class ara::diag::ExternalAuthentication (header file ara/diag/external_authentication.h) is used by applications to synchronously query all instances of ClientAuthentication currently managed by the Diagnostic Manager [SWS_DM_01201], [SWS_DM_01203]. The call is parameterless and returns a ara::core::Vector<ClientAuthentication> containing all associated authentication objects [SWS_DM_01201].

Error Handling and Return Values

The function is declared as exception safe and noexcept [SWS_DM_01201]. Specific error codes or reports to DET or DEM do not exist for this interface. If no authentication objects are available, this is not treated as an error; instead, the method returns an empty vector [SWS_DM_01201].

Concurrency and Limitations

The specification designates GetAll as thread-safe [SWS_DM_01201]. Interpretation: Calls from multiple parallel application threads are therefore likely to be permitted without additional application-side synchronization. Question Q-9f26d94068ebd3fe (open)

Interaction

The set of retrievable instances corresponds to the configured model elements of type DiagnosticExternalAuthenticationIdentification, which define fixed source addresses or address ranges AUTOSAR_AP_SWS_Diagnostics p. 129. While GetAll provides the totality of all instances [SWS_DM_01203], method Get allows the targeted query for a specific source address or meta-information [SWS_DM_01202].

The destructor ~ExternalAuthentication() terminates the lifecycle of an instance of class ara::diag::ExternalAuthentication from header ara/diag/external_authentication.h [SWS_DM_01198]. It is executed synchronously upon leaving the scope or when releasing the object, requires no parameters, and has no return value AUTOSAR_AP_SWS_Diagnostics §8.17.1.2.1.2 “Destructor”.

Regarding error handling, the function is provided with the specifier noexcept and formally defined as exception safe (exception safe) [SWS_DM_01198]. The call thus guarantees that, in the event of an error, no C++ exceptions interrupt the destruction process or are passed on to the caller.

Regarding concurrency and limitations, it must be noted that the destructor is specified as not thread-safe (not thread-safe) [SWS_DM_01198]. Calling components must therefore ensure that no simultaneous accesses to the same instance of ara::diag::ExternalAuthentication take place via separate threads during destruction. Presumably, all active diagnostic and authentication operations of this instance should be completely terminated before the call in order to avoid uncoordinated memory accesses. Question Q-67c112ea87f722d2 (open)

In the functional context, the interface implements the high-level requirement RS_Diag_04251 for Diagnostic Management (DM) AUTOSAR_AP_SWS_Diagnostics §8.17.1.2.1.2 “Destructor”. The tabular labeling as a destructor of a dynamic access list is likely an editorial inaccuracy of the specification, as scope and namespace establish the binding to ExternalAuthentication [SWS_DM_01198]. Question Q-30744aac322624cb (open)