Package de.dlr.proseo.logging.messages

Enum Class OAuthMessage

java.lang.Object

java.lang.Enum<OAuthMessage>

de.dlr.proseo.logging.messages.OAuthMessage

All Implemented Interfaces:

ProseoMessage, Serializable, Comparable<OAuthMessage>, Constable

public enum OAuthMessage
extends Enum<OAuthMessage>
implements ProseoMessage

A collection of messages needed for OAuth2 authentication.

Author:

Dr. Thomas Bassler

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCESS_TOKEN_MISSING
TOKEN_REQUEST_FAILED
TOKEN_RESPONSE_EMPTY
TOKEN_RESPONSE_INVALID

Method Summary

Modifier and Type	Method	Description
int	getCode()	Get the message's code.
String	getDescription()	Get a more detailed description of the message's purpose.
org.slf4j.event.Level	getLevel()	Get the message's level.
String	getMessage()	Get the message.
boolean	getSuccess()	Get the message''s success.
static OAuthMessage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OAuthMessage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOKEN_REQUEST_FAILED

public static final OAuthMessage TOKEN_REQUEST_FAILED

TOKEN_RESPONSE_INVALID

public static final OAuthMessage TOKEN_RESPONSE_INVALID

ACCESS_TOKEN_MISSING

public static final OAuthMessage ACCESS_TOKEN_MISSING

TOKEN_RESPONSE_EMPTY

public static final OAuthMessage TOKEN_RESPONSE_EMPTY

Method Details

values

public static OAuthMessage[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OAuthMessage valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

Get the message's code.

Specified by:

getCode in interface ProseoMessage

Returns:

The message code.

getDescription

public String getDescription()

Get a more detailed description of the message's purpose.

Specified by:

getDescription in interface ProseoMessage

Returns:

A description of the message.

getLevel

public org.slf4j.event.Level getLevel()

Get the message's level.

Specified by:

getLevel in interface ProseoMessage

Returns:

The message level.

getMessage

public String getMessage()

Get the message.

Specified by:

getMessage in interface ProseoMessage

Returns:

The message.

getSuccess

public boolean getSuccess()

Get the message''s success.

Specified by:

getSuccess in interface ProseoMessage

Returns:

The message's success.