io.micronaut.security.errors

Enum ObtainingAuthorizationErrorCode

java.lang.Object

java.lang.Enum<ObtainingAuthorizationErrorCode>

io.micronaut.security.errors.ObtainingAuthorizationErrorCode

All Implemented Interfaces:

ErrorCode, java.io.Serializable, java.lang.Comparable<ObtainingAuthorizationErrorCode>

public enum ObtainingAuthorizationErrorCode
extends java.lang.Enum<ObtainingAuthorizationErrorCode>
implements ErrorCode

A single ASCII error code as described in Obtaining Authorization - Error Response seciton of OAuth 2.0 spec.

See Also:

Obtaining Authorization - Error Response

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_DENIED
INVALID_REQUEST
INVALID_SCOPE
SERVER_ERROR
TEMPORARILY_UNAVAILABLE
UNAUTHORIZED_CLIENT
UNSUPPORTED_RESPONSE_TYPE

Method Summary

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

INVALID_REQUEST

public static final ObtainingAuthorizationErrorCode INVALID_REQUEST

UNAUTHORIZED_CLIENT

public static final ObtainingAuthorizationErrorCode UNAUTHORIZED_CLIENT

ACCESS_DENIED

public static final ObtainingAuthorizationErrorCode ACCESS_DENIED

UNSUPPORTED_RESPONSE_TYPE

public static final ObtainingAuthorizationErrorCode UNSUPPORTED_RESPONSE_TYPE

INVALID_SCOPE

public static final ObtainingAuthorizationErrorCode INVALID_SCOPE

SERVER_ERROR

public static final ObtainingAuthorizationErrorCode SERVER_ERROR

TEMPORARILY_UNAVAILABLE

public static final ObtainingAuthorizationErrorCode TEMPORARILY_UNAVAILABLE

Method Detail

values

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

Returns:

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

valueOf

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

getErrorCode

public java.lang.String getErrorCode()

Specified by:

getErrorCode in interface ErrorCode

Returns:

A Single ASCII error code

getErrorCodeDescription

public java.lang.String getErrorCodeDescription()

Specified by:

getErrorCodeDescription in interface ErrorCode

Returns:

Error code description

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ObtainingAuthorizationErrorCode>

Returns:

An errorCode code.