Informes de errores error-reporting

Información general overview

Los informes de errores en la autenticación de Adobe Pass se implementan actualmente de dos formas diferentes:

Informes de errores avanzados advanced-error-reporting

SDK de JavaScript de AccessEnabler accessenabler-javascript-sdk

El nuevo sistema de informes de errores se deja opcional, por lo que el implementador puede registrar explícitamente una llamada de retorno del controlador de errores para recibir informes de errores avanzados. El sistema incluye la capacidad de registrar y anular el registro de varias llamadas de retorno de error de forma dinámica. Además, puede registrar cualquier llamada de retorno de error nueva en cuanto se cargue el SDK de JavaScript de AccessEnabler, sin necesidad de realizar ninguna otra inicialización (antes de llamar a setRequestor()), lo que significa que puede recibir informes avanzados sobre los errores de inicialización y configuración.

Implementación access-enab-js-imp

yourErrorHandler(errorData:Object)

La función de devolución de llamada del controlador de errores recibirá un único objeto (un mapa) con la siguiente estructura:

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

1. Vincular bind

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

Adjunta un controlador para un evento.

eventType: SOLO el valor "errorEvent" provoca que el SDK de JavaScript de AccessEnabler active las devoluciones de llamadas de los informes de errores avanzados.

handlerName: una cadena que especifica el nombre de la función de controlador de errores.

Ambos parámetros de enlace deben utilizar únicamente caracteres del siguiente conjunto: [0-9a-zA-Z][-._a-zA-Z0-9]; es decir, los parámetros deben comenzar con un número o una letra y, a continuación, pueden incluir sólo guiones, puntos, guiones bajos y caracteres alfanuméricos. Además, los parámetros no pueden superar los 1024 caracteres.

Ejemplo de controladores de error de enlace:

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

Debido a limitaciones técnicas, no se puede enlazar un cierre ni una función anónima. Debe especificar el nombre del método en el segundo parámetro.

2. Desenlazar unbind

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

Quita un controlador de eventos previamente adjunto.

eventType: SOLAMENTE el valor 'errorEvent' provoca que el SDK de JavaScript de AccessEnabler active las devoluciones de llamadas de informes de error avanzadas.

handlerName: se quitará una cadena que especifica el nombre de la función de controlador de errores, si es nula o falta, todos los controladores adjuntos para el eventType especificado.

Ambos parámetros de enlace deben utilizar únicamente caracteres del siguiente conjunto: [0-9a-zA-Z][-._a-zA-Z0-9]; es decir, los parámetros deben comenzar con un número o una letra y, a continuación, pueden incluir sólo guiones, puntos, guiones bajos y caracteres alfanuméricos. Además, los parámetros no pueden superar los 1024 caracteres.

Ejemplo de quitar un solo controlador de error:

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

Ejemplo eliminando todos los controladores de error:

accessEnabler.unbind('errorEvent');

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

El nuevo sistema de notificación de errores es obligatorio, por lo que el implementador debe ajustarse explícitamente al nuevo protocolo Objective C "EntitlementStatus". Este nuevo enfoque permite a los programadores recibir informes de errores avanzados.

Implementación accessenab-ios-tvossdk-imp

Un implementador debe cumplir con el siguiente protocolo EntitlementStatus:

EntitlementStatus.h

    #import <Foundation/Foundation.h>

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

Su función status recibirá un solo objeto (un NSDictionary) con la siguiente estructura:

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

1. Declaración

    @interface MyEntitlementStatusDelegate : NSObject <EntitlementStatus>

2. Implementación

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

SDK de Android de AccessEnabler accessenabler-android-sdk

El nuevo sistema de informe de errores es obligatorio, ya que el implementador debe cumplir explícitamente con el protocolo definido en la interfaz IAccessEnablerDelegate. Este nuevo enfoque permite a los programadores recibir informes de errores avanzados.

Implementación access-enablr-androidsdk-imp

Un implementador debe controlar el nuevo método status desde la interfaz IAccessEnablerDelegate. La función status recibirá un único objeto AdvancedStatus con el siguiente modelo:

    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
    }

Muestra

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

        Log.i(LOG_TAG, status);
    }

SDK de AccessEnabler FireOS accessenabler-fireos-sdk

El nuevo sistema de informe de errores es obligatorio, ya que el implementador debe cumplir explícitamente con el protocolo definido en la interfaz IAccessEnablerDelegate. Este nuevo enfoque permite a los programadores recibir informes de errores avanzados.

Implementación access-enab-fireos-sdk-

Un implementador necesita controlar el nuevo método statusdesde la interfazIAccessEnablerDelegate. La función status recibirá un único objeto AdvancedStatus con el siguiente modelo:

    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
    }

Muestra

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

        Log.i(LOG_TAG, status);
    }

Referencia de códigos de error avanzados advanced-error-codes-reference

En la tabla siguiente se enumeran y describen los códigos de error expuestos por la API de error más reciente, junto con las acciones sugeridas para corregirlos:

Informe de errores original original-error-reporting

En esta sección se describe el sistema original de informe de errores, junto con los códigos de error originales. En el sistema original de informes de errores, AccessEnabler pasa errores a estas dos funciones de devolución de llamada: setAuthenticationStatus() después de una llamada a checkAuthentication(); tokenRequestFailed(), después del error de una llamada a checkAuthorization() o getAuthorization().

Los informes de errores y las API de estado originales siguen funcionando exactamente como antes. Sin embargo, en adelante, las API de informes de errores originales no se actualizarán. Todos los informes de errores nuevos y las actualizaciones de los errores antiguos se reflejarán SOLAMENTE en el nuevo sistema de informes de errores avanzados.

Para ver ejemplos del uso del sistema de notificación de errores original, consulte las funciones JavaScript API Reference:setAuthenticationStatus() y tokenRequestFailed(), iOS/tvOS API Reference: setAuthenticationStatus()y tokentRequestFailed(), Android API Reference: setAuthenticationStatus() y tokenRequest3}Request Failed().

Códigos de error de devolución de llamada original original-callback-error-codes