Package org.ldaptive
Class AbstractConnectionValidator
java.lang.Object
org.ldaptive.AbstractConnectionValidator
- All Implemented Interfaces:
Function<Connection,
,Boolean> ConnectionValidator
- Direct Known Subclasses:
CompareConnectionValidator
,SearchConnectionValidator
Base class for connection validator implementations.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
Base class for validator builders. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Duration
Default validation period, value is 30 minutes.static final Duration
Default per connection validate timeout, value is 5 seconds.protected final org.slf4j.Logger
Logger for this class.private Duration
Validation period.private Duration
Maximum length of time a connection validation should block. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapply
(Connection conn) applyAsync
(Connection conn) Provides an asynchronous implementation ofFunction.apply(Object)
.Returns the interval at which the validation task will be executed.Returns the time at which a validate operation should be abandoned.void
setValidatePeriod
(Duration period) void
setValidateTimeout
(Duration timeout) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.ldaptive.ConnectionValidator
applyAsync
-
Field Details
-
DEFAULT_VALIDATE_PERIOD
Default validation period, value is 30 minutes. -
DEFAULT_VALIDATE_TIMEOUT
Default per connection validate timeout, value is 5 seconds. -
logger
protected final org.slf4j.Logger loggerLogger for this class. -
validatePeriod
Validation period. -
validateTimeout
Maximum length of time a connection validation should block.
-
-
Constructor Details
-
AbstractConnectionValidator
public AbstractConnectionValidator()
-
-
Method Details
-
getValidatePeriod
Description copied from interface:ConnectionValidator
Returns the interval at which the validation task will be executed.- Specified by:
getValidatePeriod
in interfaceConnectionValidator
- Returns:
- validation period
-
setValidatePeriod
-
getValidateTimeout
Description copied from interface:ConnectionValidator
Returns the time at which a validate operation should be abandoned.- Specified by:
getValidateTimeout
in interfaceConnectionValidator
- Returns:
- validation timeout
-
setValidateTimeout
-
apply
- Specified by:
apply
in interfaceFunction<Connection,
Boolean>
-
applyAsync
Description copied from interface:ConnectionValidator
Provides an asynchronous implementation ofFunction.apply(Object)
. The returned supplier will block until a validation result is received respectingConnectionValidator.getValidateTimeout()
.- Specified by:
applyAsync
in interfaceConnectionValidator
- Parameters:
conn
- to validate- Returns:
- supplier to retrieve the validation result
-