OFBizActiveDirectoryAuthenticationHandler (OFBiz R18.12 API)

java.lang.Object
- org.apache.ofbiz.ldap.commons.AbstractOFBizAuthenticationHandler
- - org.apache.ofbiz.ldap.activedirectory.OFBizActiveDirectoryAuthenticationHandler

All Implemented Interfaces:

InterfaceOFBizAuthenticationHandler
```
public final class OFBizActiveDirectoryAuthenticationHandler
extends AbstractOFBizAuthenticationHandler
```
The OFBiz ActiveDirectory Authentication Handler.
The ACL of a user is still controlled by OFBiz.

Constructor Summary

Constructors
Constructor Description

OFBizActiveDirectoryAuthenticationHandler()
Public constructor, initializes some required member variables.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.naming.directory.SearchResult`	`getLdapSearchResult(java.lang.String username, java.lang.String password, org.w3c.dom.Element rootElement, boolean bindRequired)`	Get LDAP search result from a username, password and configuration.

Methods inherited from class org.apache.ofbiz.ldap.commons.AbstractOFBizAuthenticationHandler
getPartyId, getSecurityGroup, hasLdapLoggedOut, login, login, logout

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

- Constructor Detail
  - OFBizActiveDirectoryAuthenticationHandler
```
public OFBizActiveDirectoryAuthenticationHandler()
```
    Public constructor, initializes some required member variables.
- Method Detail
  - getLdapSearchResult
```
public javax.naming.directory.SearchResult getLdapSearchResult(java.lang.String username,
                                                               java.lang.String password,
                                                               org.w3c.dom.Element rootElement,
                                                               boolean bindRequired)
                                                        throws javax.naming.NamingException
```
    Description copied from interface: InterfaceOFBizAuthenticationHandler
    
    Get LDAP search result from a username, password and configuration.
    
    Specified by:
    
    getLdapSearchResult in interface InterfaceOFBizAuthenticationHandler
    
    Specified by:
    
    getLdapSearchResult in class AbstractOFBizAuthenticationHandler
    
    Parameters:
    
    username - String
    
    password - String
    
    rootElement - Element root element of ldap config file
    
    bindRequired - boolean if true, bind; false, just search the user in LDAP
    
    Returns:
    
    result SearchResult if ldap search successfully; otherwise, null.
    
    Throws:
    
    javax.naming.NamingException