LdapAuthenticationService (Alpine 1.9.2 API)

java.lang.Object
- alpine.auth.LdapAuthenticationService

All Implemented Interfaces:

AuthenticationService
```
public class LdapAuthenticationService
extends Object
implements AuthenticationService
```
Class that performs authentication against LDAP servers.

Since:

1.0.0

Author:

Steve Springett

Constructor Summary

Constructors
Constructor	Description
`LdapAuthenticationService(String username, String password)`	Authentication service validates credentials against a directory service (LDAP).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Principal`	`authenticate()`	Authenticates the username/password combo against the directory service and returns a Principal if authentication is successful.
`boolean`	`isSpecified()`	Returns whether the username/password combo was specified or not.

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

- Constructor Detail
  - LdapAuthenticationService
```
public LdapAuthenticationService(String username,
                                 String password)
```
    Authentication service validates credentials against a directory service (LDAP).
    
    Parameters:
    
    username - the asserted username
    
    password - the asserted password
    
    Since:
    
    1.0.0
- Method Detail
  - isSpecified
```
public boolean isSpecified()
```
    Returns whether the username/password combo was specified or not. In this case, since the constructor requires it, this method will always return true.
    
    Specified by:
    
    isSpecified in interface AuthenticationService
    
    Returns:
    
    always will return true
    
    Since:
    
    1.0.0
  - authenticate
```
public Principal authenticate()
                       throws AlpineAuthenticationException
```
    Authenticates the username/password combo against the directory service and returns a Principal if authentication is successful. Otherwise, returns an AuthenticationException.
    
    Specified by:
    
    authenticate in interface AuthenticationService
    
    Returns:
    
    a Principal if authentication was successful
    
    Throws:
    
    AlpineAuthenticationException - when authentication is unsuccessful
    
    Since:
    
    1.0.0