Module org.refcodes.web

Package org.refcodes.web

Enum Class BasicAuthResponse

java.lang.Object

java.lang.Enum<BasicAuthResponse>

org.refcodes.web.BasicAuthResponse

All Implemented Interfaces:

Serializable, Comparable<BasicAuthResponse>, Constable

public enum BasicAuthResponse
extends Enum<BasicAuthResponse>

The enumeration for a Basic-Auth response. Usually used by a BasicAuthObserver to signal the status of a Basic-Auth evaluation.

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
BASIC_AUTH_FAILURE	Basic-Auth was considered having failed.
BASIC_AUTH_REQUIRED	Basic-Auth was considered to be required.
BASIC_AUTH_SKIP	Basic-Auth was considered being irrelevant.
BASIC_AUTH_SUCCESS	Basic-Auth was considered being successful.

Method Summary

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

BASIC_AUTH_SUCCESS

public static final BasicAuthResponse BASIC_AUTH_SUCCESS

Basic-Auth was considered being successful.

BASIC_AUTH_FAILURE

public static final BasicAuthResponse BASIC_AUTH_FAILURE

Basic-Auth was considered having failed.

BASIC_AUTH_REQUIRED

public static final BasicAuthResponse BASIC_AUTH_REQUIRED

Basic-Auth was considered to be required.

BASIC_AUTH_SKIP

public static final BasicAuthResponse BASIC_AUTH_SKIP

Basic-Auth was considered being irrelevant.

Method Details

values

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