Segnalazione errori error-reporting

Panoramica overview

La segnalazione degli errori nell’autenticazione di Adobe Pass è attualmente implementata in due modi diversi:

Segnalazione avanzata degli errori advanced-error-reporting

SDK di AccessEnabler per JavaScript accessenabler-javascript-sdk

Il nuovo sistema di segnalazione degli errori rimane facoltativo, pertanto l’implementatore può registrare esplicitamente un callback del gestore degli errori per ricevere segnalazioni avanzate degli errori. Il sistema include la possibilità di registrare e annullare la registrazione di più callback di errore in modo dinamico. Inoltre, è possibile registrare qualsiasi nuovo callback di errore non appena viene caricato l'SDK JavaScript di AccessEnabler, senza dover eseguire altre inizializzazioni (prima di chiamare setRequestor()), il che significa che è possibile ricevere report avanzati sugli errori di inizializzazione e configurazione.

Implementazione access-enab-js-imp

yourErrorHandler(errorData:Object)

La funzione di callback del gestore degli errori riceverà un singolo oggetto (una mappa) con la seguente struttura:

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

1. Legare bind

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

Collega un gestore per un evento.

eventType - SOLO il valore "errorEvent" genera nell'SDK di AccessEnabler JavaScript l'attivazione di callback di report di errori avanzati.

handlerName - una stringa che specifica il nome della funzione del gestore errori.

Entrambi i parametri di associazione devono utilizzare solo i caratteri del seguente set: [0-9a-zA-Z][-._a-zA-Z0-9]. I parametri devono iniziare con un numero o una lettera e possono quindi includere solo trattini, punti, trattini bassi e caratteri alfanumerici. Inoltre, i parametri non possono superare i 1024 caratteri.

Esempio di gestori errori di associazione:

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

A causa di limitazioni tecniche, non è possibile associare una chiusura o una funzione anonima. È necessario specificare il nome del metodo nel secondo parametro.

2. Separa unbind

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

Rimuove un gestore eventi precedentemente associato.

eventType - SOLO il valore 'errorEvent' genera nell'SDK di AccessEnabler JavaScript l'attivazione di callback di report di errori avanzati.

handlerName - una stringa che specifica il nome della funzione del gestore errori, se è null o mancano tutti i gestori associati per il eventType specificato verrà rimossa.

Entrambi i parametri di associazione devono utilizzare solo i caratteri del seguente set: [0-9a-zA-Z][-._a-zA-Z0-9]. I parametri devono iniziare con un numero o una lettera e possono quindi includere solo trattini, punti, trattini bassi e caratteri alfanumerici. Inoltre, i parametri non possono superare i 1024 caratteri.

Esempio di rimozione di un singolo gestore errori:

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

Esempio rimozione di tutti i gestori errori:

accessEnabler.unbind('errorEvent');

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

Il nuovo sistema di segnalazione degli errori è obbligatorio, pertanto l’implementatore deve conformarsi esplicitamente al nuovo protocollo "EntitlementStatus" dell’Obiettivo C. Questo nuovo approccio consente ai programmatori di ricevere report avanzati sugli errori.

Implementazione accessenab-ios-tvossdk-imp

Un implementatore deve essere conforme al seguente protocollo EntitlementStatus:

StatoDiritto.h

    #import <Foundation/Foundation.h>

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

La funzione status riceverà un singolo oggetto (un NSDictionary) con la seguente struttura:

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

1. Dichiarazione

    @interface MyEntitlementStatusDelegate : NSObject <EntitlementStatus>

2. Implementazione

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

SDK di AccessEnabler per Android accessenabler-android-sdk

Il nuovo sistema di segnalazione errori è obbligatorio perché l'implementatore deve essere conforme in modo esplicito al protocollo definito dall'interfaccia IAccessEnablerDelegate. Questo nuovo approccio consente ai programmatori di ricevere report avanzati sugli errori.

Implementazione access-enablr-androidsdk-imp

Un implementatore deve gestire il nuovo metodo status dall'interfacciaIAccessEnablerDelegate. La funzione status riceverà un singolo oggetto AdvancedStatus con il seguente modello:

    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
    }

Esempio

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

        Log.i(LOG_TAG, status);
    }

SDK di AccessEnabler FireOS accessenabler-fireos-sdk

Il nuovo sistema di segnalazione errori è obbligatorio perché l'implementatore deve essere conforme in modo esplicito al protocollo definito dall'interfaccia IAccessEnablerDelegate. Questo nuovo approccio consente ai programmatori di ricevere report avanzati sugli errori.

Implementazione access-enab-fireos-sdk-

Un implementatore deve gestire il nuovo metodo status dall'interfacciaIAccessEnablerDelegate. La funzione status riceverà un singolo oggetto AdvancedStatus con il seguente modello:

    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
    }

Esempio

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

        Log.i(LOG_TAG, status);
    }

Riferimento codici di errore avanzati advanced-error-codes-reference

La tabella seguente elenca e descrive i codici di errore esposti dalla nuova API di errore, insieme alle azioni suggerite da intraprendere per correggerli:

Segnalazione errori originale original-error-reporting

Questa sezione descrive il sistema di segnalazione degli errori originale e i codici di errore originali. Nel sistema di segnalazione degli errori originale AccessEnabler trasmette gli errori alle due funzioni di callback seguenti: setAuthenticationStatus() dopo una chiamata a checkAuthentication(); tokenRequestFailed(), dopo l'errore di una chiamata a checkAuthorization() o getAuthorization().

La segnalazione degli errori originale e le API di stato continuano a funzionare esattamente come prima. Tuttavia, andando avanti le API di segnalazione errori originali non verranno aggiornate. Tutte le nuove segnalazioni di errori e gli aggiornamenti relativi ai vecchi errori verranno rispecchiati SOLO nel nuovo sistema Avanzato di Segnalazione errori.

Per esempi di utilizzo del sistema di segnalazione errori originale, vedere le funzioni Riferimento API di JavaScript:setAuthenticationStatus() e tokenRequestFailed(), Riferimento API di iOS/tvOS: setAuthenticationStatus()e tokentRequestFailed(), Riferimento API di Android: setAuthenticationStatus() e tokenRequestFailed() .

Codici di errore del callback originale original-callback-error-codes