Package org.ldaptive
Class SearchConnectionValidator
java.lang.Object
org.ldaptive.AbstractConnectionValidator
org.ldaptive.SearchConnectionValidator
- All Implemented Interfaces:
Function<Connection,
,Boolean> ConnectionValidator
Validates a connection is healthy by performing a search operation. Validation is considered successful if the search
result contains a result code.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Search validator builder.Nested classes/interfaces inherited from class org.ldaptive.AbstractConnectionValidator
AbstractConnectionValidator.AbstractBuilder<B,
T extends AbstractConnectionValidator> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate SearchRequest
Search request to perform validation with.Fields inherited from class org.ldaptive.AbstractConnectionValidator
DEFAULT_VALIDATE_PERIOD, DEFAULT_VALIDATE_TIMEOUT, logger
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new search validator.SearchConnectionValidator
(Duration period, Duration timeout, SearchRequest request) Creates a new search validator.Creates a new search validator. -
Method Summary
Modifier and TypeMethodDescriptionvoid
applyAsync
(Connection conn, Consumer<Boolean> function) Provides an asynchronous implementation ofFunction.apply(Object)
.builder()
Creates a builder for this class.Returns the search request.void
Sets the search request.toString()
Methods inherited from class org.ldaptive.AbstractConnectionValidator
apply, applyAsync, getValidatePeriod, getValidateTimeout, setValidatePeriod, setValidateTimeout
-
Field Details
-
searchRequest
Search request to perform validation with.
-
-
Constructor Details
-
SearchConnectionValidator
public SearchConnectionValidator()Creates a new search validator. -
SearchConnectionValidator
Creates a new search validator.- Parameters:
sr
- to use for searches
-
SearchConnectionValidator
Creates a new search validator.- Parameters:
period
- execution periodtimeout
- execution timeoutrequest
- to use for searches
-
-
Method Details
-
getSearchRequest
Returns the search request.- Returns:
- search request
-
setSearchRequest
Sets the search request.- Parameters:
sr
- search request
-
applyAsync
Description copied from interface:ConnectionValidator
Provides an asynchronous implementation ofFunction.apply(Object)
. The supplied consumer will be invoked with the validation result.ConnectionValidator.getValidateTimeout()
must be enforced by the caller.- Parameters:
conn
- to validatefunction
- to consume the validation result
-
toString
-
builder
Creates a builder for this class.- Returns:
- new builder
-