CompareLdapValidator (VT LDAP Libraries 3.3.8 API)

java.lang.Object
- edu.vt.middleware.ldap.pool.CompareLdapValidator

All Implemented Interfaces:

LdapValidator<Ldap>
```
public class CompareLdapValidator
extends java.lang.Object
implements LdapValidator<Ldap>
```
CompareLdapValidator validates an ldap connection is healthy by performing a compare operation.

Version:

$Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $

Author:

Middleware Services

Field Summary

Fields
Modifier and Type Field Description

protected org.apache.commons.logging.Log logger
Log for this class.

Constructor Summary

Constructors
Constructor	Description
`CompareLdapValidator()`	Default constructor.
`CompareLdapValidator(java.lang.String dn, SearchFilter filter)`	Creates a new `CompareLdapValidator` with the supplied compare dn and filter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getValidateDn()`	Returns the validate DN.
`SearchFilter`	`getValidateFilter()`	Returns the validate filter.
`void`	`setValidateDn(java.lang.String s)`	Sets the validate DN.
`void`	`setValidateFilter(SearchFilter filter)`	Sets the validate filter.
`boolean`	`validate(Ldap l)`	Validate the supplied ldap object.

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

- Field Detail
  - logger
```
protected final org.apache.commons.logging.Log logger
```
    Log for this class.
- Constructor Detail
  - CompareLdapValidator
```
public CompareLdapValidator()
```
    Default constructor.
  - CompareLdapValidator
```
public CompareLdapValidator(java.lang.String dn,
                            SearchFilter filter)
```
    Creates a new CompareLdapValidator with the supplied compare dn and filter.
    
    Parameters:
    
    dn - to use for compares
    
    filter - to use for compares
- Method Detail
  - getValidateDn
```
public java.lang.String getValidateDn()
```
    Returns the validate DN.
    
    Returns:
    
    validate DN
  - getValidateFilter
```
public SearchFilter getValidateFilter()
```
    Returns the validate filter.
    
    Returns:
    
    validate filter
  - setValidateDn
```
public void setValidateDn(java.lang.String s)
```
    Sets the validate DN.
    
    Parameters:
    
    s - DN
  - setValidateFilter
```
public void setValidateFilter(SearchFilter filter)
```
    Sets the validate filter.
    
    Parameters:
    
    filter - to compare with
  - validate
```
public boolean validate(Ldap l)
```
    Validate the supplied ldap object.
    
    Specified by:
    
    validate in interface LdapValidator<Ldap>
    
    Parameters:
    
    l - ldap object
    
    Returns:
    
    whether validation was successful