@InterfaceAudience.Private @InterfaceStability.Evolving public class LdapAuthenticationHandler extends Object implements AuthenticationHandler
LdapAuthenticationHandler implements the BASIC authentication
 mechanism for HTTP using LDAP back-end.
 The supported configuration properties are:
 | Modifier and Type | Field and Description | 
|---|---|
| static String | BASE_DNConstant for the configuration property that indicates the base
 distinguished name (DN) to be used with the LDAP server. | 
| static String | ENABLE_START_TLSConstant for the configuration property that indicates whether
 the LDAP server supports 'StartTLS' extension. | 
| static String | LDAP_BIND_DOMAINConstant for the configuration property that indicates the LDAP bind
 domain value to be used with the LDAP server. | 
| static String | PROVIDER_URLConstant for the configuration property that indicates the url of the LDAP
 server. | 
| static String | SECURITY_AUTHENTICATIONConstant that identifies the authentication mechanism to be used with the
 LDAP server. | 
| static String | TYPEConstant that identifies the authentication mechanism. | 
WWW_AUTHENTICATE| Constructor and Description | 
|---|
| LdapAuthenticationHandler() | 
| Modifier and Type | Method and Description | 
|---|---|
| AuthenticationToken | authenticate(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)Performs an authentication step for the given HTTP client request. | 
| void | destroy()Destroys the authentication handler instance. | 
| String | getType()Returns the authentication type of the authentication handler. | 
| void | init(Properties config)Initializes the authentication handler instance. | 
| boolean | managementOperation(AuthenticationToken token,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)Performs an authentication management operation. | 
| void | setDisableHostNameVerification(Boolean disableHostNameVerification)Configure the Host name verification for this handler. | 
| void | setEnableStartTls(Boolean enableStartTls)Configure StartTLS LDAP extension for this handler. | 
public static final String TYPE
public static final String SECURITY_AUTHENTICATION
public static final String PROVIDER_URL
public static final String BASE_DN
public static final String LDAP_BIND_DOMAIN
public static final String ENABLE_START_TLS
public void setEnableStartTls(Boolean enableStartTls)
enableStartTls - true If the StartTLS LDAP extension is to be enabled
          false otherwisepublic void setDisableHostNameVerification(Boolean disableHostNameVerification)
disableHostNameVerification - true to disable host-name verification
          false otherwisepublic String getType()
AuthenticationHandlergetType in interface AuthenticationHandlerpublic void init(Properties config) throws javax.servlet.ServletException
AuthenticationHandler
 This method is invoked by the AuthenticationFilter.init(javax.servlet.FilterConfig) method.
init in interface AuthenticationHandlerconfig - configuration properties to initialize the handler.javax.servlet.ServletException - thrown if the handler could not be initialized.public void destroy()
AuthenticationHandler
 This method is invoked by the AuthenticationFilter.destroy() method.
destroy in interface AuthenticationHandlerpublic boolean managementOperation(AuthenticationToken token, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException, AuthenticationException
AuthenticationHandlerThis is useful for handling operations like get/renew/cancel delegation tokens which are being handled as operations of the service end-point.
 If the method returns TRUE the request will continue normal
 processing, this means the method has not produced any HTTP response.
 
 If the method returns FALSE the request will end, this means 
 the method has produced the corresponding HTTP response.
managementOperation in interface AuthenticationHandlertoken - the authentication token if any, otherwise NULL.request - the HTTP client request.response - the HTTP client response.TRUE if the request should be processed as a regular
 request,
 FALSE otherwise.IOException - thrown if an IO error occurred.AuthenticationException - thrown if an Authentication error occurred.public AuthenticationToken authenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException, AuthenticationException
AuthenticationHandler
 This method is invoked by the AuthenticationFilter only if the HTTP client request is
 not yet authenticated.
 
Depending upon the authentication mechanism being implemented, a particular HTTP client may end up making a sequence of invocations before authentication is successfully established (this is the case of Kerberos SPNEGO).
 This method must return an AuthenticationToken only if the the HTTP client request has
 been successfully and fully authenticated.
 
 If the HTTP client request has not been completely authenticated, this method must take over
 the corresponding HTTP response and it must return null.
authenticate in interface AuthenticationHandlerrequest - the HTTP client request.response - the HTTP client response.AuthenticationToken if the HTTP client request has been authenticated,
         null otherwise (in this case it must take care of the response).IOException - thrown if an IO error occurred.AuthenticationException - thrown if an Authentication error occurred.Copyright © 2008–2023 Apache Software Foundation. All rights reserved.