Package org.hawaiiframework.logging.oidc

Enum Class OidcKibanaLogFieldNames

java.lang.Object

java.lang.Enum<OidcKibanaLogFieldNames>

org.hawaiiframework.logging.oidc.OidcKibanaLogFieldNames

All Implemented Interfaces:

Serializable, Comparable<OidcKibanaLogFieldNames>, Constable, KibanaLogField

public enum OidcKibanaLogFieldNames
extends Enum<OidcKibanaLogFieldNames>
implements KibanaLogField

Kibana Log Field Names for OIDC fields.

Since:

3.0.0.M21

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
AUDIENCE	The audience.
AUTHORIZED_PARTY	The authorized party.
SUBJECT	The subject.
USER_ID	The user id.

Method Summary

Modifier and Type	Method	Description
static OidcKibanaLogFieldNames	fromKey(String key)	Lookup method that does not throw an exception if the specified key is not found.
String	getLogName()	Get the name with which this field will appear in the log.
static OidcKibanaLogFieldNames	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OidcKibanaLogFieldNames[]	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

Methods inherited from interface org.hawaiiframework.logging.model.KibanaLogField

matches

Enum Constant Details

SUBJECT

public static final OidcKibanaLogFieldNames SUBJECT

The subject.

AUDIENCE

public static final OidcKibanaLogFieldNames AUDIENCE

The audience.

AUTHORIZED_PARTY

public static final OidcKibanaLogFieldNames AUTHORIZED_PARTY

The authorized party.

USER_ID

public static final OidcKibanaLogFieldNames USER_ID

The user id.

Method Details

values

public static OidcKibanaLogFieldNames[] 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 OidcKibanaLogFieldNames 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

getLogName

public String getLogName()

Description copied from interface: KibanaLogField

Get the name with which this field will appear in the log.

Specified by:

getLogName in interface KibanaLogField

Returns:

the log name of the field

fromKey

public static OidcKibanaLogFieldNames fromKey(String key)

Lookup method that does not throw an exception if the specified key is not found.

Parameters:

key - the key to look for

Returns:

the KibanaLogField with the given name, or null