co.cask.cdap.security.auth

Enum TokenState

java.lang.Object

java.lang.Enum<TokenState>

co.cask.cdap.security.auth.TokenState

All Implemented Interfaces:

Serializable, Comparable<TokenState>

public enum TokenState
extends Enum<TokenState>

Different states attained after validating the token

• MISSING - the access token is missing in the request
• INVALID - the token digest did not match the expected value
• EXPIRED - the token is past the expiration timestamp
• INTERNAL - another error occurred in processing (represented by the exception "cause")
• VALID - the token is valid

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPIRED
INTERNAL
INVALID
MISSING
VALID

Method Summary

Methods

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

MISSING

public static final TokenState MISSING

INVALID

public static final TokenState INVALID

EXPIRED

public static final TokenState EXPIRED

INTERNAL

public static final TokenState INTERNAL

VALID

public static final TokenState VALID

Method Detail

values

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

Returns:

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

valueOf

public static TokenState 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

getMsg

public String getMsg()

Returns:

the message associated with this token state describing the cause to be in this state

isValid

public boolean isValid()

Returns:

true if this token state is valid, false otherwise

toString

public String toString()

Overrides:

toString in class Enum<TokenState>