classe ara::diag::ClientAuthenticationHandle

La méthode Append de la classe ara::diag::ClientAuthenticationHandle est utilisée par les applications pour ajouter une liste d'accès dynamique (dynamicAccessList) à la DynamicAccessList déjà existante d'une conversation de diagnostic active [SWS_DM_01152]. L'interface est fournie via l'en-tête ara/diag/client_authentication_handle.h AUTOSAR_AP_SWS_Diagnostics §8.6.1.1.3.1 « Append ».

L'appel est exécuté de manière synchrone et est spécifié comme noexcept [SWS_DM_01152]. En tant que paramètre d'entrée, la fonction accepte une DiagnosticServiceDynamicAccessList. Le type de retour ara::core::Result<void> signale l'achèvement réussi ou véhicule, en cas d'erreur, le code d'erreur DiagErrc::kServiceNotAvailable [SWS_DM_01152]. Ce dernier indique que des fonctions essentielles du Diagnostic Management sont actuellement indisponibles. Pour ce cas d'erreur, une sémantique de rollback s'applique, de sorte que l'état antérieur de la liste d'accès soit conservé [SWS_DM_01152].

En matière de concurrence, l'opération est considérée comme sûre vis-à-vis des exceptions (exception safe), mais est expressément classée comme non thread-safe (not thread-safe) [SWS_DM_01152]. En cas d'accès parallèles au même objet handle, une synchronisation externe par l'application appelante devrait donc être nécessaire. Question Q-f0da9a0538a86a16 (ouverte)

Le constructeur par défaut synchrone [SWS_DM_01146] crée une instance de la classe ara::diag::ClientAuthenticationHandle. L'appel ne prend aucun paramètre d'entrée et ne renvoie aucune valeur de retour. La fonction est déclarée comme noexcept et spécifiée comme étant sûre vis-à-vis des threads (thread-safe) ainsi que vis-à-vis des exceptions [SWS_DM_01146], de sorte qu'aucun code d'erreur ni aucune exception n'apparaît lors de la création.

Les restrictions suivantes s'appliquent à la transmission et au cycle de vie de l'objet créé :

• La construction par copie et l'assignation par copie sont explicitement supprimées ([SWS_DM_01150], [SWS_DM_01151]).
• Le constructeur de déplacement [SWS_DM_01148] et l'opérateur d'assignation par déplacement [SWS_DM_01149] sont pris en charge.
• Toutes les méthodes d'instance telles que Set [SWS_DM_01153], Append [SWS_DM_01152], Revoke [SWS_DM_01154] ainsi que le destructeur [SWS_DM_01147] sont définis comme non sûrs vis-à-vis des threads (not thread-safe).

Dans l'ensemble du système, le serveur de diagnostic fournit régulièrement des descripteurs actifs, liés à un client, via Authenticate [SWS_DM_01142] ou OverrideDefaultRoles [SWS_DM_01141] (AUTOSAR_AP_SWS_Diagnostics §7.3.2.3.3 « ClientAuthenticationHandle »). Une instance créée via le constructeur par défaut devrait donc servir d'espace réservé non lié qui ne reçoit un descripteur valide pour la commande des listes d'accès qu'après une assignation par déplacement [SWS_DM_01149] ultérieure. Question Q-ce182402bd1d4072 (ouverte)

La méthode Refresh de la classe ara::diag::ClientAuthenticationHandle (fichier d'en-tête #include "ara/diag/client_authentication_handle.h") permet à une application de prolonger les temporisateurs actifs d'authentification ou de rôle (AUTOSAR_AP_SWS_Diagnostics §8.6.1.1.3.2 « Refresh »). Elle réinitialise le temporisateur précédemment démarré par Authenticate ou OverrideDefaultRoles. Si les deux méthodes ont été appelées auparavant, l'appel renouvelle simultanément les deux temporisateurs [SWS_DM_01155].

L'appel synchrone (interprétation : retour direct sans Future asynchrone) s'effectue sans paramètre sur une instance existante de ClientAuthenticationHandle, que l'application a reçue du serveur de diagnostic après l'achèvement réussi de Authenticate ou OverrideDefaultRoles (AUTOSAR_AP_SWS_Diagnostics §7.3.2.3.3 « ClientAuthenticationHandle »). Question Q-b07e81ff4629ada7 (ouverte) La fonction est déclarée comme noexcept et sûre vis-à-vis des exceptions (exception safe), mais spécifiée comme non sûre pour les threads (not thread-safe) [SWS_DM_01155]. Les appels concurrents sur une même instance doivent donc être synchronisés par l'appelant.

Si l'opération échoue, la fonction renvoie le code d'erreur DiagErrc::kServiceNotAvailable via ara::core::Result<void> [SWS_DM_01155]. Cela indique, au moyen d'une sémantique de rollback, que l'appel n'a pas pu être exécuté parce que des fonctionnalités essentielles de Diagnostic Management (DM) sont actuellement indisponibles [SWS_DM_01155].

La méthode synchrone Revoke de la classe ara::diag::ClientAuthenticationHandle (SWS Diagnostics §8.6.1.1.3.3 « Revoke ») permet aux applications de désauthentifier un client de diagnostic préalablement authentifié et d'abandonner entièrement sa liste d'accès dynamique (DynamicAccessList) ainsi que ses rôles par défaut surchargés ([SWS_DM_01154], [SWS_DM_01216]).

La fonction ne comporte aucun paramètre d'entrée et renvoie un ara::core::Result<void> ([SWS_DM_01154]). En cas de succès, le statut d'authentification du client prend fin. Si une fonctionnalité essentielle du Diagnostic Manager n'est pas disponible au moment de l'appel, l'opération échoue et renvoie l'erreur DiagErrc::kServiceNotAvailable avec une sémantique de rollback ([SWS_DM_01154]).

En ce qui concerne la concurrence, l'interface est spécifiée comme sûre vis-à-vis des exceptions (exception safe), mais comme non thread-safe (not thread-safe) ([SWS_DM_01154]). Interprétation : lors d'accès concurrents à la même instance de handle depuis plusieurs threads, l'application appelante devrait dès lors devoir assurer une synchronisation externe. Question Q-8781261c9a2f5f8e (ouverte)

Dans le déroulement global, l'instance de ClientAuthenticationHandle est mise à disposition de l'application par l'instance de Diagnostic Server après une authentification réussie ou après la surcharge de rôles par défaut (SWS Diagnostics §7.3.2.3.3 « ClientAuthenticationHandle »). Tandis que le handle actif permet, outre la révocation, le remplacement ([SWS_DM_01213]) ou l'extension ([SWS_DM_01215]) de la DynamicAccessList, Revoke met définitivement fin à ces autorisations du client.

La méthode synchrone Set de la classe ara::diag::ClientAuthenticationHandle ([SWS_DM_01153]) permet à une application de définir ou de remplacer complètement la liste d'accès dynamique (DynamicAccessList) pour une conversation de diagnostic ou un client authentifié dans le Diagnostic Server ([SWS_DM_01213]). Le Diagnostic Manager gère pour chaque client authentifié une telle DynamicAccessList, qui peut octroyer au client des droits d'accès supplémentaires à des ressources de diagnostic, au-delà de la configuration enregistrée dans le Diagnostic Extract (AUTOSAR_AP_SWS_Diagnostics §7.3.2.3.3 « ClientAuthenticationHandle »).

Lors de l'utilisation, les aspects suivants sont déterminants :

• Contexte d'appel et paramètres : la fonction est appelée sur une instance de ara::diag::ClientAuthenticationHandle (déclarée dans #include "ara/diag/client_authentication_handle.h"). Une telle instance de handle est mise à disposition de l'application si ara::diag::ClientAuthentication::Authenticate ([SWS_DM_01206]) ou ara::diag::ClientAuthentication::OverrideDefaultRoles ([SWS_DM_01209]) s'est achevé préalablement avec succès. L'unique paramètre transmis est dynamicAccessList, de type DiagnosticServiceDynamicAccessList, qui définit la nouvelle liste d'accès ([SWS_DM_01153]).
• Valeur de retour et gestion des erreurs : la méthode est spécifiée comme noexcept et renvoie un ara::core::Result<void>. Elle fonctionne avec une sémantique de rollback : si l'appel ne peut pas être exécuté parce qu'une fonctionnalité essentielle de DM n'est pas disponible actuellement, l'appel échoue avec le code d'erreur DiagErrc::kServiceNotAvailable ([SWS_DM_01153]). En matière de gestion des exceptions, la méthode est classée comme sûre vis-à-vis des exceptions (exception safe).
• Concurrence : l'opération est explicitement définie comme non thread-safe (not thread-safe) ([SWS_DM_01153]). Si des appels sont effectués de manière concurrente sur la même instance de handle depuis plusieurs threads, la synchronisation requise incombe à l'application.

Utilisation et sémantique

La fonction ~ClientAuthenticationHandle() est le destructeur de la classe ara::diag::ClientAuthenticationHandle et est déclarée via le fichier d'en-tête ara/diag/client_authentication_handle.h ([SWS_DM_01147], AUTOSAR_AP_SWS_Diagnostics §8.6.1.1.1.3 « Destructor »). Elle ne prend aucun paramètre d'entrée et ne renvoie aucune valeur de retour. L'appel s'effectue généralement de manière implicite à la fin de la durée de vie de l'objet. Interprétation : toutes les ressources d'authentification client liées en interne par le handle devraient alors être libérées. Question Q-ea8f47232fd9951f (ouverte)

Gestion des erreurs et sécurité vis-à-vis des exceptions

Le destructeur est déclaré comme noexcept et explicitement spécifié comme exception safe ([SWS_DM_01147]). Par conséquent, aucune exception C++ n'est levée et aucun code d'erreur spécifique n'est signalé lors de la destruction de l'objet, de sorte que l'opération de nettoyage se termine de manière garantie sans erreur.

Concurrence et restrictions

La destruction d'un ClientAuthenticationHandle est classée comme not thread-safe conformément à la spécification ([SWS_DM_01147]). L'application appelante doit s'assurer qu'aucun autre thread n'accède en parallèle à la même instance pendant l'exécution du destructeur.