@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum PassThroughAuthenticationResultCode extends java.lang.Enum<PassThroughAuthenticationResultCode>
PassThroughAuthenticationResult
objects.Enum Constant and Description |
---|
ACCOUNT_NOT_USABLE
Indicates that the pass-through authentication attempt filed because the
mapped account in the external authentication service is not in a usable
state (e.g., the password is expired, the account is locked, etc.).
|
EXTERNAL_SERVICE_ERROR
Indicates that the pass-through authentication attempt failed because the
external service reported an error result.
|
EXTERNAL_SERVICE_UNAVAILABLE
Indicates that the pass-through authentication attempt failed because the
external service is unavailable.
|
MUST_CHANGE_PASSWORD
Indicates that the pass-through authentication attempt failed because the
password for the mapped account must be changed before the account can be
used.
|
NO_SUCH_USER
Indicates that the pass-through authentication attempt failed because the
pass-through authentication handler could not identify exactly one account
in the external service that corresponds to the account in the local
server.
|
NON_SPECIFIC_AUTHENTICATION_FAILURE
Indicates that the pass-through authentication attempt failed, but the
server did not provide enough information to identify a specific reason
(e.g., whether the user doesn't exist, the wrong password was provided, the
account is in an unusable state, etc.).
|
OTHER_FAILURE
Indicates that the pass-through authentication attempt failed for a reason
that is not suited to any other defined result code.
|
SUCCESS
Indicates that pass-through authentication attempt succeeded.
|
TIMEOUT
Indicates that the pass-through authentication attempt failed because the
external service did not return a response within an expected timeout
period.
|
WRONG_PASSWORD
Indicates that the pass-through authentication attempt failed because the
client provided the wrong password for the target user.
|
Modifier and Type | Method and Description |
---|---|
static PassThroughAuthenticationResultCode |
forName(java.lang.String name)
Retrieves the
PassThroughAuthenticationResultCode value that
corresponds to the provided name. |
java.lang.String |
getName()
Retrieves the human-readable name for this result code.
|
java.lang.String |
toString()
Retrieves the human-readable name for this
IndexType . |
static PassThroughAuthenticationResultCode |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static PassThroughAuthenticationResultCode[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final PassThroughAuthenticationResultCode SUCCESS
public static final PassThroughAuthenticationResultCode NO_SUCH_USER
public static final PassThroughAuthenticationResultCode WRONG_PASSWORD
public static final PassThroughAuthenticationResultCode MUST_CHANGE_PASSWORD
public static final PassThroughAuthenticationResultCode ACCOUNT_NOT_USABLE
public static final PassThroughAuthenticationResultCode NON_SPECIFIC_AUTHENTICATION_FAILURE
public static final PassThroughAuthenticationResultCode EXTERNAL_SERVICE_ERROR
public static final PassThroughAuthenticationResultCode EXTERNAL_SERVICE_UNAVAILABLE
public static final PassThroughAuthenticationResultCode TIMEOUT
public static final PassThroughAuthenticationResultCode OTHER_FAILURE
public static PassThroughAuthenticationResultCode[] values()
for (PassThroughAuthenticationResultCode c : PassThroughAuthenticationResultCode.values()) System.out.println(c);
public static PassThroughAuthenticationResultCode valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null@NotNull public java.lang.String getName()
@Nullable public static PassThroughAuthenticationResultCode forName(@NotNull java.lang.String name)
PassThroughAuthenticationResultCode
value that
corresponds to the provided name.name
- The name for which to retrieve the corresponding result code.
It must not be null
.null
if there is no
result code with the provided name.@NotNull public java.lang.String toString()
IndexType
.toString
in class java.lang.Enum<PassThroughAuthenticationResultCode>
IndexType
.