Package org.ldaptive
Class CompareConnectionValidator
java.lang.Object
org.ldaptive.AbstractConnectionValidator
org.ldaptive.CompareConnectionValidator
- All Implemented Interfaces:
Function<Connection,
,Boolean> ConnectionValidator
Validates a connection is healthy by performing a compare operation. Validation is considered successful if the
compare result contains a result code.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Compare validator builder.Nested classes/interfaces inherited from class org.ldaptive.AbstractConnectionValidator
AbstractConnectionValidator.AbstractBuilder<B,
T extends AbstractConnectionValidator> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate CompareRequest
Compare request to perform validation with.Fields inherited from class org.ldaptive.AbstractConnectionValidator
DEFAULT_VALIDATE_PERIOD, DEFAULT_VALIDATE_TIMEOUT, logger
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new compare validator.CompareConnectionValidator
(Duration period, Duration timeout, CompareRequest request) Creates a new compare validator.Creates a new compare 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 compare request.void
Sets the compare request.toString()
Methods inherited from class org.ldaptive.AbstractConnectionValidator
apply, applyAsync, getValidatePeriod, getValidateTimeout, setValidatePeriod, setValidateTimeout
-
Field Details
-
compareRequest
Compare request to perform validation with.
-
-
Constructor Details
-
CompareConnectionValidator
public CompareConnectionValidator()Creates a new compare validator. -
CompareConnectionValidator
Creates a new compare validator.- Parameters:
cr
- to use for compares
-
CompareConnectionValidator
Creates a new compare validator.- Parameters:
period
- execution periodtimeout
- execution timeoutrequest
- to use for searches
-
-
Method Details
-
getCompareRequest
Returns the compare request.- Returns:
- compare request
-
setCompareRequest
Sets the compare request.- Parameters:
cr
- compare 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
-