Package io.undertow.security.api
Enum AuthenticationMechanism.AuthenticationMechanismOutcome
java.lang.Object
java.lang.Enum<AuthenticationMechanism.AuthenticationMechanismOutcome>
io.undertow.security.api.AuthenticationMechanism.AuthenticationMechanismOutcome
- All Implemented Interfaces:
Serializable
,Comparable<AuthenticationMechanism.AuthenticationMechanismOutcome>
,java.lang.constant.Constable
- Enclosing interface:
- AuthenticationMechanism
public static enum AuthenticationMechanism.AuthenticationMechanismOutcome
extends Enum<AuthenticationMechanism.AuthenticationMechanismOutcome>
The AuthenticationOutcome is used by an AuthenticationMechanism to indicate the outcome of the call to authenticate, the
overall authentication process will then used this along with the current AuthenticationState to decide how to proceed
with the current request.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionBased on the current request the mechanism has successfully performed authentication.The mechanism did not attempt authentication on this request, most likely due to not discovering any applicable security tokens for this mechanisms in the request.The mechanism attempted authentication but it did not complete, this could either be due to a failure validating the tokens from the client or it could be due to the mechanism requiring at least one additional round trip with the client - either way the request will return challenges to the client. -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this type with the specified name.values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
AUTHENTICATED
Based on the current request the mechanism has successfully performed authentication. -
NOT_ATTEMPTED
The mechanism did not attempt authentication on this request, most likely due to not discovering any applicable security tokens for this mechanisms in the request. -
NOT_AUTHENTICATED
The mechanism attempted authentication but it did not complete, this could either be due to a failure validating the tokens from the client or it could be due to the mechanism requiring at least one additional round trip with the client - either way the request will return challenges to the client.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-