Package org.ldaptive.auth.ext
Enum Class FreeIPAAccountState.Error
- All Implemented Interfaces:
Serializable
,Comparable<FreeIPAAccountState.Error>
,Constable
,AccountState.Error
- Enclosing class:
FreeIPAAccountState
public static enum FreeIPAAccountState.Error
extends Enum<FreeIPAAccountState.Error>
implements AccountState.Error
Enum to define FreeIPA errors.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionaccount disabled.account expired.account not found.credential not found.failed authentication.login lockout.login time limited.maximum logins exceeded.password expired.unknown state. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
getCode()
Returns the error code.Returns the error message.static FreeIPAAccountState.Error
parse
(ResultCode rc, String message) Parses the supplied error messages and returns the corresponding error enum.void
Throws the LoginException that best maps to this error.static FreeIPAAccountState.Error
valueOf
(int code) Returns the error for the supplied integer constant.static FreeIPAAccountState.Error
Returns the enum constant of this class with the specified name.static FreeIPAAccountState.Error[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNKNOWN
unknown state. -
FAILED_AUTHENTICATION
failed authentication. -
PASSWORD_EXPIRED
password expired. -
ACCOUNT_EXPIRED
account expired. -
MAXIMUM_LOGINS_EXCEEDED
maximum logins exceeded. -
LOGIN_TIME_LIMITED
login time limited. -
LOGIN_LOCKOUT
login lockout. -
ACCOUNT_NOT_FOUND
account not found. -
CREDENTIAL_NOT_FOUND
credential not found. -
ACCOUNT_DISABLED
account disabled.
-
-
Field Details
-
code
private final int codeunderlying error code.
-
-
Constructor Details
-
Error
private Error(int i) Creates a new freeipa error.- Parameters:
i
- error code
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getCode
public int getCode()Description copied from interface:AccountState.Error
Returns the error code.- Specified by:
getCode
in interfaceAccountState.Error
- Returns:
- error code
-
getMessage
Description copied from interface:AccountState.Error
Returns the error message.- Specified by:
getMessage
in interfaceAccountState.Error
- Returns:
- error message
-
throwSecurityException
Description copied from interface:AccountState.Error
Throws the LoginException that best maps to this error.- Specified by:
throwSecurityException
in interfaceAccountState.Error
- Throws:
LoginException
- for this account state error
-
valueOf
Returns the error for the supplied integer constant.- Parameters:
code
- to find error for- Returns:
- error
-
parse
Parses the supplied error messages and returns the corresponding error enum.- Parameters:
rc
- result codemessage
- to parse- Returns:
- freeipa error
-