com.apptentive.android.sdk

Enum Apptentive.AuthenticationFailedReason

java.lang.Object

java.lang.Enum<Apptentive.AuthenticationFailedReason>

com.apptentive.android.sdk.Apptentive.AuthenticationFailedReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Apptentive.AuthenticationFailedReason>

Enclosing class:

Apptentive

public static enum Apptentive.AuthenticationFailedReason
extends java.lang.Enum<Apptentive.AuthenticationFailedReason>

A list of error codes you will encounter when a JWT failure for logged in conversations occurs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPIRED_TOKEN The expiration "exp" claim is expired.
INVALID_ALGORITHM Currently only the HS512 signature algorithm is supported.
INVALID_KEY_SIGNATURE_PAIR The Apptentive Key and Apptentive Signature fields do not match.
INVALID_SUB_CLAIM Internal use only.
INVALID_TOKEN The token is not signed properly, or can't be decoded.
MALFORMED_TOKEN The JWT structure is constructed improperly (missing a part, etc.)
MISMATCHED_SUB_CLAIM The JWT "sub" claim does not match the one previously registered to the internal Apptentive conversation.
MISSING_APP_KEY The Apptentive Key field was not specified during registration.
MISSING_APP_SIGNATURE The Apptentive Signature field was not specified during registration.
MISSING_SUB_CLAIM There is no "sub" property in the JWT claims.
REVOKED_TOKEN The JWT has been revoked.
UNKNOWN This should not happen.

Method Summary

Modifier and Type	Method and Description
java.lang.String	error()
static Apptentive.AuthenticationFailedReason	parse(java.lang.String errorType, java.lang.String error)
java.lang.String	toString()
static Apptentive.AuthenticationFailedReason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Apptentive.AuthenticationFailedReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final Apptentive.AuthenticationFailedReason UNKNOWN

This should not happen.

INVALID_ALGORITHM

public static final Apptentive.AuthenticationFailedReason INVALID_ALGORITHM

Currently only the HS512 signature algorithm is supported.

MALFORMED_TOKEN

public static final Apptentive.AuthenticationFailedReason MALFORMED_TOKEN

The JWT structure is constructed improperly (missing a part, etc.)

INVALID_TOKEN

public static final Apptentive.AuthenticationFailedReason INVALID_TOKEN

The token is not signed properly, or can't be decoded.

MISSING_SUB_CLAIM

public static final Apptentive.AuthenticationFailedReason MISSING_SUB_CLAIM

There is no "sub" property in the JWT claims. The "sub" is required, and should be an immutable, unique id for your user.

MISMATCHED_SUB_CLAIM

public static final Apptentive.AuthenticationFailedReason MISMATCHED_SUB_CLAIM

The JWT "sub" claim does not match the one previously registered to the internal Apptentive conversation. Internal use only.

INVALID_SUB_CLAIM

public static final Apptentive.AuthenticationFailedReason INVALID_SUB_CLAIM

Internal use only.

EXPIRED_TOKEN

public static final Apptentive.AuthenticationFailedReason EXPIRED_TOKEN

The expiration "exp" claim is expired. The "exp" claim is a UNIX timestamp in milliseconds. The JWT will receive this authentication failure when the "exp" time has elapsed.

REVOKED_TOKEN

public static final Apptentive.AuthenticationFailedReason REVOKED_TOKEN

The JWT has been revoked. This happens after a successful logout. In such cases, you will need a new JWT to login.

MISSING_APP_KEY

public static final Apptentive.AuthenticationFailedReason MISSING_APP_KEY

The Apptentive Key field was not specified during registration. You can get this from your app's Apptentive settings.

MISSING_APP_SIGNATURE

public static final Apptentive.AuthenticationFailedReason MISSING_APP_SIGNATURE

The Apptentive Signature field was not specified during registration. You can get this from your app's Apptentive settings.

INVALID_KEY_SIGNATURE_PAIR

public static final Apptentive.AuthenticationFailedReason INVALID_KEY_SIGNATURE_PAIR

The Apptentive Key and Apptentive Signature fields do not match. Make sure you got them from the same app's Apptentive settings page.

Method Detail

values

public static Apptentive.AuthenticationFailedReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Apptentive.AuthenticationFailedReason c : Apptentive.AuthenticationFailedReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Apptentive.AuthenticationFailedReason valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

error

public java.lang.String error()

parse

public static Apptentive.AuthenticationFailedReason parse(java.lang.String errorType,
                                                          java.lang.String error)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Apptentive.AuthenticationFailedReason>