Package org.apache.juneau.rest.server.auth

Enum Class ApiKeyGuard.Source

java.lang.Object

java.lang.Enum<ApiKeyGuard.Source>

org.apache.juneau.rest.server.auth.ApiKeyGuard.Source

All Implemented Interfaces:

Serializable, Comparable<ApiKeyGuard.Source>, Constable

Enclosing class:

ApiKeyGuard

public static enum ApiKeyGuard.Source
extends Enum<ApiKeyGuard.Source>

Source of the API-key string.

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
COOKIE	Read from a cookie.
HEADER	Read from a request header (default; default header name is X-API-Key).
QUERY	Read from a query parameter.

Method Summary

Modifier and Type	Method	Description
static ApiKeyGuard.Source	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiKeyGuard.Source[]	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

HEADER

public static final ApiKeyGuard.Source HEADER

Read from a request header (default; default header name is X-API-Key).

QUERY

public static final ApiKeyGuard.Source QUERY

Read from a query parameter.

COOKIE

public static final ApiKeyGuard.Source COOKIE

Read from a cookie.

Method Details

values

public static ApiKeyGuard.Source[] 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 ApiKeyGuard.Source 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