Class DefaultDirContextValidator
java.lang.Object
org.springframework.ldap.pool2.validation.DefaultDirContextValidator
- All Implemented Interfaces:
DirContextValidator
Default
Configuration:
DirContext validator that executes DirContext.search(String, String, SearchControls). The
name, filter and SearchControls are all configurable. There is no special handling for read only versus
read write DirContexts.
Configuration:
| Property | Description | Required | Default |
|---|---|---|---|
| base | The name parameter to the search method. | No | "" |
| filter | The filter parameter to the search method. | No | "objectclass=*" |
| searchControls |
The SearchControls parameter to the search method.
|
No |
SearchControls.setCountLimit(long) = 1SearchControls.setReturningAttributes(String[]) = new String[] { "objectclass" }SearchControls.setTimeLimit(int) = 500
|
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprotected final org.slf4j.LoggerLogger for this class and sub-classes -
Constructor Summary
ConstructorsConstructorDescriptionCreate the default validator, createsSearchControlswith search scopeOBJECT_SCOPE, a countLimit of 1, returningAttributes of objectclass and timeLimit of 500.DefaultDirContextValidator(int searchScope) Create a validator with all the defaults of the default constructor, but with the search scope set to the referred value. -
Method Summary
Modifier and TypeMethodDescriptiongetBase()voidvoidvoidsetSearchControls(SearchControls searchControls) booleanvalidateDirContext(DirContextType contextType, DirContext dirContext) Validates theDirContext.
-
Field Details
-
DEFAULT_FILTER
- See Also:
-
logger
protected final org.slf4j.Logger loggerLogger for this class and sub-classes
-
-
Constructor Details
-
DefaultDirContextValidator
public DefaultDirContextValidator()Create the default validator, createsSearchControlswith search scopeOBJECT_SCOPE, a countLimit of 1, returningAttributes of objectclass and timeLimit of 500. The default base is an empty string and the default filter is objectclass=* -
DefaultDirContextValidator
public DefaultDirContextValidator(int searchScope) Create a validator with all the defaults of the default constructor, but with the search scope set to the referred value.- Parameters:
searchScope- The searchScope to be set in the defaultSearchControls
-
-
Method Details
-
getBase
- Returns:
- the baseName
-
setBase
- Parameters:
base- the baseName to set
-
getFilter
- Returns:
- the filter
-
setFilter
- Parameters:
filter- the filter to set
-
getSearchControls
- Returns:
- the searchControls
-
setSearchControls
- Parameters:
searchControls- the searchControls to set
-
validateDirContext
Description copied from interface:DirContextValidatorValidates theDirContext. A validDirContextshould be able to answer queries and if applicable write to the directory.- Specified by:
validateDirContextin interfaceDirContextValidator- Parameters:
contextType- The type of theDirContext, refers to ifContextSource.getReadOnlyContext()orContextSource.getReadWriteContext()was called to create theDirContextdirContext- TheDirContextto validate.- Returns:
trueif theDirContextoperated correctly during validation.- See Also:
-