Rapport d’erreurs (hérité) error-reporting

Vue d’ensemble overview

Le rapport d’erreur dans l’authentification Adobe Pass est actuellement implémenté de deux manières différentes :

Rapports d’erreur avancés advanced-error-reporting

SDK JavaScript AccessEnabler accessenabler-javascript-sdk

Le nouveau système de rapport d’erreur reste facultatif. Par conséquent, l’implémentateur peut enregistrer explicitement un rappel de gestionnaire d’erreurs pour recevoir des rapports d’erreur avancés. Le système offre la possibilité d’enregistrer et de désenregistrer dynamiquement plusieurs rappels d’erreur. En outre, vous pouvez enregistrer de nouveaux rappels d’erreur dès que le SDK JavaScript AccessEnabler est chargé, sans avoir à effectuer d’autres initialisations (avant d’appeler setRequestor()), ce qui signifie que vous pouvez recevoir des rapports avancés sur les erreurs d’initialisation et de configuration.

Mise en œuvre access-enab-js-imp

yourErrorHandler(errorData:Object)

Votre fonction de rappel de gestionnaire d’erreurs recevra un seul objet (une carte) avec la structure suivante :

    {
      errorId: "CFG410",
      level: "error",
      message: "This a fancy message",  // Optional
      .
      .                                 // Optional key/value pairs
      .
    }

1. Liaison bind

.bind(eventType:String, handlerName:String):void

Associe un gestionnaire pour un événement.

eventType - SEULE la valeur « errorEvent » entraîne le déclenchement de rappels de rapports d’erreur avancés par le SDK JavaScript AccessEnabler.

handlerName - une chaîne spécifiant le nom de la fonction de gestionnaire d’erreurs.

Les deux paramètres de liaison doivent utiliser uniquement des caractères du jeu suivant : [0-9a-zA-Z][-._a-zA-Z0-9] ; en d’autres termes, les paramètres doivent commencer par un nombre ou une lettre et ne peuvent ensuite inclure que des tirets, des points, des traits de soulignement et des caractères alphanumériques. En outre, les paramètres ne peuvent pas dépasser 1 024 caractères.

Exemple de gestionnaires d’erreur de liaison :

accessEnabler.bind('errorEvent', 'myCustomErrorHandler');
accessEnabler.bind('errorEvent', 'errorLogger');

En raison de limitations techniques, vous ne pouvez pas lier une fonction de fermeture ou anonyme. Vous devez spécifier le nom de la méthode dans le deuxième paramètre.

2. Dissocier unbind

.unbind(eventType:String, handlerName:String=null):void

Supprime un gestionnaire d'événements précédemment associé.

eventType - SEULE la valeur « errorEvent » entraîne le déclenchement de rappels de rapports d’erreur avancés par le SDK JavaScript AccessEnabler.

handlerName - Une chaîne spécifiant le nom de la fonction de gestionnaire d’erreurs, si est null ou s’il manque tous les gestionnaires joints pour la eventType spécifiée sera supprimée.

Les deux paramètres de liaison doivent utiliser uniquement des caractères du jeu suivant : [0-9a-zA-Z][-._a-zA-Z0-9] ; en d’autres termes, les paramètres doivent commencer par un nombre ou une lettre et ne peuvent ensuite inclure que des tirets, des points, des traits de soulignement et des caractères alphanumériques. En outre, les paramètres ne peuvent pas dépasser 1 024 caractères.

Exemple de suppression d’un seul gestionnaire d’erreurs :

accessEnabler.unbind('errorEvent', 'errorLogger');

Exemple suppression de tous les gestionnaires d’erreur :

accessEnabler.unbind('errorEvent');

SDK AccessEnabler iOS/tvOS accessenabler-ios-tvos-sdk

Le nouveau système de rapport d’erreurs est obligatoire. Par conséquent, l’implémentateur doit explicitement se conformer au nouveau protocole « EntitlementStatus » de l’objectif C. Cette nouvelle approche permet aux programmeurs de recevoir des rapports d’erreur avancés.

Mise en œuvre accessenab-ios-tvossdk-imp

Un implémenteur doit se conformer au protocole EntitlementStatus suivant :

EntitlementStatus.h

    #import <Foundation/Foundation.h>

    @protocol EntitlementStatus <NSObject>
    - (void)status:(NSDictionary *)statusDictionary;
    @end

Votre fonction status recevra un seul objet (un NSDictionary) avec la structure suivante :

    {
          errorId: "CFG410",
          level: "error",
          message: "This a fancy message",  // Optional
      .
      .                                 // Optional key/value pairs
      .
    }

1. Déclaration

    @interface MyEntitlementStatusDelegate : NSObject <EntitlementStatus>

2. Implémentation

    @implementation DemoAppAppDelegate
    // very simple implementation
    - (void)status:(NSDictionary *)statusDict {
        NSLog(@"%@:\n%@", statusDict[@"level"], statusDict);
    }

SDK AccessEnabler Android accessenabler-android-sdk

Le nouveau système de rapport d’erreur est obligatoire, car l’implémentateur doit se conformer explicitement au protocole défini par l’interface IAccessEnablerDelegate. Cette nouvelle approche permet aux programmeurs de recevoir des rapports d’erreur avancés.

Mise en œuvre access-enablr-androidsdk-imp

Un implémenteur doit gérer la nouvelle méthode status à partir de l’interface IAccessEnablerDelegate. La fonction status recevra un seul objet AdvancedStatus ayant le modèle suivant :

    class AdvancedStatus {

    String id; // Not Null
    String level; // Not Null
    String message; // Might be null
    String resource; // Might be null

    AdvancedStatus(String id, String level, String message, String resource) {
        this.id = id;
        this.level = level;
        this.message = message;
        this.resource = resource;
    }

    //other private/public methods
    }

Exemple

    @Override
    public void status(AdvancedStatus advancedStatus) {
        String status = "status(" + advancedStatus.id + ", " + advancedStatus.level + ", " + advancedStatus.message + ", " + advancedStatus.resource + ")";

        Log.i(LOG_TAG, status);
    }

SDK FireOS AccessEnabler accessenabler-fireos-sdk

Le nouveau système de rapport d’erreur est obligatoire, car l’implémentateur doit se conformer explicitement au protocole défini par l’interface IAccessEnablerDelegate. Cette nouvelle approche permet aux programmeurs de recevoir des rapports d’erreur avancés.

Mise en œuvre access-enab-fireos-sdk-

Un implémenteur doit gérer la nouvelle statusméthode à partir de l’interfaceIAccessEnablerDelegate. La fonction status recevra un seul objet AdvancedStatus ayant le modèle suivant :

    class AdvancedStatus {

    String id; // Not Null
    String level; // Not Null
    String message; // Might be null
    String resource; // Might be null

    AdvancedStatus(String id, String level, String message, String resource) {
        this.id = id;
        this.level = level;
        this.message = message;
        this.resource = resource;
    }

    //other private/public methods
    }

Exemple

    @Override
    public void status(AdvancedStatus advancedStatus) {
        String status = "status(" + advancedStatus.id + ", " + advancedStatus.level + ", " + advancedStatus.message + ", " + advancedStatus.resource + ")";

        Log.i(LOG_TAG, status);
    }

Référence des codes d’erreur avancés advanced-error-codes-reference

Le tableau suivant répertorie et décrit les codes d’erreur exposés par la nouvelle API d’erreur, ainsi que les actions suggérées pour les corriger :

Rapport d’erreurs d’origine original-error-reporting

Cette section décrit le système de rapport d’erreurs d’origine, ainsi que les codes d’erreur d’origine. Dans le système de rapport d’erreur d’origine, AccessEnabler transmet les erreurs à ces deux fonctions de rappel : setAuthenticationStatus() après un appel à checkAuthentication() ; tokenRequestFailed(), après l’échec d’un appel à checkAuthorization() ou getAuthorization().

Les API de rapport d’erreur et de statut d’origine continuent à fonctionner exactement comme auparavant. Toutefois, les API de rapports d’erreurs d’origine ne seront pas mises à jour à l’avenir. Tous les nouveaux rapports d’erreurs et les mises à jour des anciennes erreurs seront répercutés UNIQUEMENT dans le nouveau système avancé de rapports d’erreurs.

Pour obtenir des exemples d’utilisation du système de rapports d’erreurs d’origine, consultez les fonctions Référence de l’API JavaScript:setAuthenticationStatus() et tokenRequestFailed(), Référence de l’API iOS/tvOS : setAuthenticationStatus()et tokentRequestFailed(), Référence de l’API Android: setAuthenticationStatus() et tokenRequestFailed().

Codes d’erreur de rappel d’origine original-callback-error-codes