Package org.ldaptive.auth

Class AccountState

java.lang.Object

org.ldaptive.auth.AccountState

Direct Known Subclasses:

ActiveDirectoryAccountState, EDirectoryAccountState, FreeIPAAccountState, PasswordExpirationAccountState, PasswordPolicyAccountState

public class AccountState
extends Object

Represents the state of an LDAP account based on account policies for that LDAP.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccountState.DefaultWarning	Default warning implementation.
static interface	AccountState.Error	Contains error information for an account state.
static interface	AccountState.Warning	Contains warning information for an account state.

Field Summary

Fields

Modifier and Type	Field	Description
private AccountState.Error[]	accountErrors	account error.
private AccountState.Warning[]	accountWarnings	account warning.

Constructor Summary

Constructors

Constructor	Description
AccountState(AccountState.Error... errors)	Creates a new account state.
AccountState(AccountState.Warning... warnings)	Creates a new account state.
AccountState(AccountState.Warning[] warnings, AccountState.Error[] errors)	Creates a new account state.
AccountState(AccountState.Warning warning, AccountState.Error error)	Creates a new account state.

Method Summary

Modifier and Type	Method	Description
AccountState.Error	getError()	Returns the first account state error or null if no errors exist.
AccountState.Error[]	getErrors()	Returns the account state errors.
AccountState.Warning	getWarning()	Returns the first account state warning or null if no warnings exist.
AccountState.Warning[]	getWarnings()	Returns the account state warnings.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

accountWarnings

private final AccountState.Warning[] accountWarnings

account warning.

accountErrors

private final AccountState.Error[] accountErrors

account error.

Constructor Detail

AccountState

public AccountState(AccountState.Warning warning,
                    AccountState.Error error)

Creates a new account state.

Parameters:

warning - associated with the account

error - associated with the account

AccountState

public AccountState(AccountState.Warning[] warnings,
                    AccountState.Error[] errors)

Creates a new account state.

Parameters:

warnings - associated with the account

errors - associated with the account

AccountState

public AccountState(AccountState.Warning... warnings)

Creates a new account state.

Parameters:

warnings - associated with the account

AccountState

public AccountState(AccountState.Error... errors)

Creates a new account state.

Parameters:

errors - associated with the account

Method Detail

getWarnings

public AccountState.Warning[] getWarnings()

Returns the account state warnings.

Returns:

account state warnings

getWarning

public AccountState.Warning getWarning()

Returns the first account state warning or null if no warnings exist.

Returns:

first account state warning

getErrors

public AccountState.Error[] getErrors()

Returns the account state errors.

Returns:

account state errors

getError

public AccountState.Error getError()

Returns the first account state error or null if no errors exist.

Returns:

first account state error

toString

public String toString()

Overrides:

toString in class Object