EDirectoryAuthenticationResponseHandler (LDAPTIVE PARENT 2.1.1 API)

java.lang.Object
- org.ldaptive.auth.ext.EDirectoryAuthenticationResponseHandler

All Implemented Interfaces:

AuthenticationResponseHandler
```
public class EDirectoryAuthenticationResponseHandler
extends java.lang.Object
implements AuthenticationResponseHandler
```
Attempts to parse the authentication response and set the account state using data associated with eDirectory. The Authenticator should be configured to return 'passwordExpirationTime' and 'loginGraceRemaining' attributes so they can be consumed by this handler. If this handler is assigned a warningPeriod, this handler will only emit warnings during that window before password expiration. Otherwise, a warning is always emitted if passwordExpirationTime is set.

Author:

Middleware Services

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String[] ATTRIBUTES
Attributes needed to enforce password policy.

Constructor Summary

Constructors
Constructor	Description
`EDirectoryAuthenticationResponseHandler()`	Default constructor.
`EDirectoryAuthenticationResponseHandler(java.time.Period warning)`	Creates a new edirectory authentication response handler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.time.Period`	`getWarningPeriod()`	Returns the amount of time before expiration to produce a warning.
`void`	`handle(AuthenticationResponse response)`	Handle the response from an ldap authentication.
`void`	`setWarningPeriod(java.time.Period period)`	Sets the amount of time before expiration to produce a warning.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ATTRIBUTES
```
public static final java.lang.String[] ATTRIBUTES
```
    Attributes needed to enforce password policy.
- Constructor Detail
  - EDirectoryAuthenticationResponseHandler
```
public EDirectoryAuthenticationResponseHandler()
```
    Default constructor.
  - EDirectoryAuthenticationResponseHandler
```
public EDirectoryAuthenticationResponseHandler(java.time.Period warning)
```
    Creates a new edirectory authentication response handler.
    
    Parameters:
    
    warning - length of time before expiration that should produce a warning
- Method Detail
  - handle
```
public void handle(AuthenticationResponse response)
```
    Description copied from interface: AuthenticationResponseHandler
    
    Handle the response from an ldap authentication.
    
    Specified by:
    
    handle in interface AuthenticationResponseHandler
    
    Parameters:
    
    response - produced from an authentication
  - getWarningPeriod
```
public java.time.Period getWarningPeriod()
```
    Returns the amount of time before expiration to produce a warning.
    
    Returns:
    
    warning period
  - setWarningPeriod
```
public void setWarningPeriod(java.time.Period period)
```
    Sets the amount of time before expiration to produce a warning.
    
    Parameters:
    
    period - warning period
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object