com.atlassian.oauth2.client.api

Enum ClientTokenMetadata.ClientTokenStatus

java.lang.Object

java.lang.Enum<ClientTokenMetadata.ClientTokenStatus>

com.atlassian.oauth2.client.api.ClientTokenMetadata.ClientTokenStatus

All Implemented Interfaces:

Serializable, Comparable<ClientTokenMetadata.ClientTokenStatus>

Enclosing interface:

ClientTokenMetadata

public static enum ClientTokenMetadata.ClientTokenStatus
extends Enum<ClientTokenMetadata.ClientTokenStatus>

Information about the state of the token, based on its last usage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECOVERABLE Indicates there was an error which occurred during last authorisation attempt.
UNKNOWN Indicates that this token hasn't been used yet.
UNRECOVERABLE Indicates that the token is permanently unrecoverable and new ClientToken must be obtained.
VALID Indicates that this token pair has been successfully used during last authorisation attempt.

Method Summary

Modifier and Type	Method and Description
static ClientTokenMetadata.ClientTokenStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientTokenMetadata.ClientTokenStatus[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final ClientTokenMetadata.ClientTokenStatus UNKNOWN

Indicates that this token hasn't been used yet.

VALID

public static final ClientTokenMetadata.ClientTokenStatus VALID

Indicates that this token pair has been successfully used during last authorisation attempt.

RECOVERABLE

public static final ClientTokenMetadata.ClientTokenStatus RECOVERABLE

Indicates there was an error which occurred during last authorisation attempt. The refresh token may be used to try to fix this problem. Without successful authorisation attempt it will eventually transition into UNRECOVERABLE.

UNRECOVERABLE

public static final ClientTokenMetadata.ClientTokenStatus UNRECOVERABLE

Indicates that the token is permanently unrecoverable and new ClientToken must be obtained. The refresh token can't be used to fix this problem.

Method Detail

values

public static ClientTokenMetadata.ClientTokenStatus[] 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 (ClientTokenMetadata.ClientTokenStatus c : ClientTokenMetadata.ClientTokenStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientTokenMetadata.ClientTokenStatus valueOf(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:

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

NullPointerException - if the argument is null