org.keycloak.models

Enum CredentialValidationOutput.Status

java.lang.Object

java.lang.Enum<CredentialValidationOutput.Status>

org.keycloak.models.CredentialValidationOutput.Status

All Implemented Interfaces:

Serializable, Comparable<CredentialValidationOutput.Status>

Enclosing class:

CredentialValidationOutput

public static enum CredentialValidationOutput.Status
extends Enum<CredentialValidationOutput.Status>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATED User was successfully authenticated.
CONTINUE Federation provider did not fully authenticate user.
FAILED Federation provider failed to authenticate user.
FALLBACK Federation provider was not able to recognize the user.

Method Summary

Modifier and Type	Method and Description
static CredentialValidationOutput.Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static CredentialValidationOutput.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTHENTICATED

public static final CredentialValidationOutput.Status AUTHENTICATED

User was successfully authenticated. The CredentialValidationOutput.getAuthenticatedUser() must return authenticated user when this is used

FAILED

public static final CredentialValidationOutput.Status FAILED

Federation provider failed to authenticate user. This is typically used when user storage provider recognizes the user, but credentials are incorrect, so federation provider can mark whole authentication as not successful without eventual fallback to other user storage provider

FALLBACK

public static final CredentialValidationOutput.Status FALLBACK

Federation provider was not able to recognize the user. It is possible that credential was valid, but fereration provider was not able to lookup the user in it's storage. Fallback to other user storage provider in the chain might be possible

CONTINUE

public static final CredentialValidationOutput.Status CONTINUE

Federation provider did not fully authenticate user. It may be needed to ask user for further challenge to then re-try authentication with same federation provider

Method Detail

values

public static CredentialValidationOutput.Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CredentialValidationOutput.Status c : CredentialValidationOutput.Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CredentialValidationOutput.Status valueOf(String name)

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 name

NullPointerException - if the argument is null