AddControlAuthenticationRequestHandler (Ldaptive 2.4.0 API)

java.lang.Object
- org.ldaptive.auth.AddControlAuthenticationRequestHandler

All Implemented Interfaces:

AuthenticationRequestHandler

Direct Known Subclasses:

PasswordPolicyAuthenticationRequestHandler
```
public class AddControlAuthenticationRequestHandler
extends Object
implements AuthenticationRequestHandler
```
Authentication request handler that adds RequestControls to the AuthenticationRequest.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AddControlAuthenticationRequestHandler.ControlFactory
Factory that produces RequestControls.

Field Summary

Fields
Modifier and Type	Field	Description
`private AddControlAuthenticationRequestHandler.ControlFactory`	`controlFactory`	Factory that produces request controls.
`protected Logger`	`logger`	Logger for this class.

Constructor Summary

Constructors
Constructor	Description
`AddControlAuthenticationRequestHandler(AddControlAuthenticationRequestHandler.ControlFactory factory)`	Creates a new add control authentication request handler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`handle(String dn, AuthenticationRequest request)`	Handle the request for an ldap authentication.

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

- Field Detail
  - logger
```
protected final Logger logger
```
    Logger for this class.
  - controlFactory
```
private final AddControlAuthenticationRequestHandler.ControlFactory controlFactory
```
    Factory that produces request controls.
- Constructor Detail
  - AddControlAuthenticationRequestHandler
```
public AddControlAuthenticationRequestHandler(AddControlAuthenticationRequestHandler.ControlFactory factory)
```
    Creates a new add control authentication request handler.
    
    Parameters:
    
    factory - to produce request controls
- Method Detail
  - handle
```
public void handle(String dn,
                   AuthenticationRequest request)
            throws LdapException
```
    Description copied from interface: AuthenticationRequestHandler
    
    Handle the request for an ldap authentication.
    
    Specified by:
    
    handle in interface AuthenticationRequestHandler
    
    Parameters:
    
    dn - distinguished name resolved for this request
    
    request - for this authentication event
    
    Throws:
    
    LdapException - if an error occurs handling an authentication request