Package org.mockserver.mock

Enum Class HttpState.ControlPlaneAuthOutcome

java.lang.Object

java.lang.Enum<HttpState.ControlPlaneAuthOutcome>

org.mockserver.mock.HttpState.ControlPlaneAuthOutcome

All Implemented Interfaces:

Serializable, Comparable<HttpState.ControlPlaneAuthOutcome>, Constable

Enclosing class:

HttpState

public static enum HttpState.ControlPlaneAuthOutcome
extends Enum<HttpState.ControlPlaneAuthOutcome>

The outcome of the control-plane authn + authz decision.

• ALLOWED — proceed (this is the value returned when no control-plane authentication is configured, so default behaviour is unchanged).
• UNAUTHENTICATED — no/invalid credentials → 401-equivalent.
• FORBIDDEN — verified principal lacks the required role → 403-equivalent.

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
ALLOWED
FORBIDDEN
UNAUTHENTICATED

Method Summary

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

ALLOWED

public static final HttpState.ControlPlaneAuthOutcome ALLOWED

UNAUTHENTICATED

public static final HttpState.ControlPlaneAuthOutcome UNAUTHENTICATED

FORBIDDEN

public static final HttpState.ControlPlaneAuthOutcome FORBIDDEN

Method Details

values

public static HttpState.ControlPlaneAuthOutcome[] 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 HttpState.ControlPlaneAuthOutcome 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