Error Reporting error-reporting

Overview overview

Error reporting in Adobe Pass Authentication is currently implemented in two different ways:

Advanced Error Reporting advanced-error-reporting

AccessEnabler JavaScript SDK accessenabler-javascript-sdk

The new error reporting system is left optional, therefore the implementor can explicitly register an error handler callback to receive advanced error reports. The system includes the ability to register and unregister multiple error callbacks dynamically. In addition, you can register any new error callbacks as soon as the AccessEnabler JavaScript SDK is loaded, without the need to perform any other initialization (before calling setRequestor()), meaning that you have the ability to receive advanced reports on initialization and configuration errors.

Implementation access-enab-js-imp

yourErrorHandler(errorData:Object)

Your error handler callback function will receive a single object (a map) with the following structure:

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

1. Bind bind

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

Attaches a handler for an event.

eventType - ONLY the “errorEvent” value results in the AccessEnabler JavaScript SDK triggering advanced error reports callbacks.

handlerName - a string specifying the name of the errors handler function.

Both bind parameters must use only characters from the following set: [0-9a-zA-Z][-._a-zA-Z0-9]; that is, parameters must start with a number or letter, and can then include only hyphens, periods, underscores, and alpha-numeric characters. In addition, parameters cannot exceed 1024 characters.

Example of binding error handlers:

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

Due to technical limitations you cannot bind a closure or an anonymous function. You must specify the name of the method in the second parameter.

2. Unbind unbind

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

Removes a previously-attached event handler.

eventType - ONLY the ‘errorEvent’ value results in the AccessEnabler JavaScript SDK triggering advanced error reports callbacks.

handlerName - a string specifying the name of the errors handler function, if is null or missing all attached handlers for the specified eventType will be removed.

Both bind parameters must use only characters from the following set: [0-9a-zA-Z][-._a-zA-Z0-9]; that is, parameters must start with a number or letter, and can then include only hyphens, periods, underscores, and alpha-numeric characters. In addition, parameters cannot exceed 1024 characters.

Example of removing a single error handler:

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

Example removing all error handlers:

accessEnabler.unbind('errorEvent');

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

The new error reporting system is mandatory, therefore the implementor must explicitly conform to the new Objective C “EntitlementStatus” protocol. This new approach allows programmers to receive advanced error reporting.

Implementation accessenab-ios-tvossdk-imp

An implementor needs to conform to the following EntitlementStatus protocol:

EntitlementStatus.h

    #import <Foundation/Foundation.h>

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

Your status function will receive a single object (an NSDictionary) with the following structure:

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

1. Declaration

    @interface MyEntitlementStatusDelegate : NSObject <EntitlementStatus>

2. Implementation

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

AccessEnabler Android SDK accessenabler-android-sdk

The new error reporting system is mandatory, because the implementor must explicitly conform to the IAccessEnablerDelegate interface defined protocol. This new approach allows programmers to receive advanced error reporting.

Implementation access-enablr-androidsdk-imp

An implementor needs to handle the new status method from the interfaceIAccessEnablerDelegate. The status function will receive a single AdvancedStatus object having the following model:

    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
    }

Sample

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

        Log.i(LOG_TAG, status);
    }

AccessEnabler FireOS SDK accessenabler-fireos-sdk

The new error reporting system is mandatory, because the implementor must explicitly conform to the IAccessEnablerDelegate interface defined protocol. This new approach allows programmers to receive advanced error reporting.

Implementation access-enab-fireos-sdk-

An implementor needs to handle the new statusmethod from the interfaceIAccessEnablerDelegate. The status function will receive a single AdvancedStatus object having the following model:

    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
    }

Sample

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

        Log.i(LOG_TAG, status);
    }

Advanced Error Codes Reference advanced-error-codes-reference

The following table lists and describes the error codes exposed by the newer error API, along with suggested actions to be taken to correct them:

Original Error Reporting original-error-reporting

This section describes the original error reporting system, along with the original error codes. In the original error reporting system, the AccessEnabler passes errors to these two callback functions: setAuthenticationStatus() after a call to checkAuthentication(); tokenRequestFailed(), after the failure of a call to checkAuthorization() or getAuthorization().

The original error reporting and status API’s continue to work exactly as before. However, going forward the original error reporting API’s will not be updated. All new error reporting and updates on the old errors will be reflected ONLY in the newe Advanced Error Reporting system.

For examples of using the original error reporting system, see the JavaScript API Reference:setAuthenticationStatus() and tokenRequestFailed() functions, iOS/tvOS API Reference: setAuthenticationStatus()and tokentRequestFailed(), Android API Reference: setAuthenticationStatus() and tokenRequestFailed().

Original Callback Error Codes original-callback-error-codes