Package org.ldaptive

Class AbstractConnectionValidator

java.lang.Object

org.ldaptive.AbstractConnectionValidator

All Implemented Interfaces:

Function<Connection,Boolean>, ConnectionValidator

Direct Known Subclasses:

CompareConnectionValidator, SearchConnectionValidator

public abstract class AbstractConnectionValidator
extends Object
implements ConnectionValidator

Base class for connection validator implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractConnectionValidator.AbstractBuilder<B,T extends AbstractConnectionValidator>	Base class for validator builders.

Field Summary

Fields

Modifier and Type	Field	Description
static Duration	DEFAULT_VALIDATE_PERIOD	Default validation period, value is 30 minutes.
static Duration	DEFAULT_VALIDATE_TIMEOUT	Default per connection validate timeout, value is 5 seconds.
protected Logger	logger	Logger for this class.
private Duration	validatePeriod	Validation period.
private Duration	validateTimeout	Maximum length of time a connection validation should block.

Constructor Summary

Constructors

Constructor	Description
AbstractConnectionValidator()

Method Summary

Modifier and Type	Method	Description
Boolean	apply(Connection conn)
Supplier<Boolean>	applyAsync(Connection conn)	Provides an asynchronous implementation of Function.apply(Object).
Duration	getValidatePeriod()	Returns the interval at which the validation task will be executed.
Duration	getValidateTimeout()	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

Methods inherited from interface java.util.function.Function

andThen, compose

Field Detail

DEFAULT_VALIDATE_PERIOD

public static final Duration DEFAULT_VALIDATE_PERIOD

Default validation period, value is 30 minutes.

DEFAULT_VALIDATE_TIMEOUT

public static final Duration DEFAULT_VALIDATE_TIMEOUT

Default per connection validate timeout, value is 5 seconds.

logger

protected final Logger logger

Logger for this class.

validatePeriod

private Duration validatePeriod

Validation period.

validateTimeout

private Duration validateTimeout

Maximum length of time a connection validation should block.

Constructor Detail

AbstractConnectionValidator

public AbstractConnectionValidator()

Method Detail

getValidatePeriod

public Duration getValidatePeriod()

Description copied from interface: ConnectionValidator

Returns the interval at which the validation task will be executed.

Specified by:

getValidatePeriod in interface ConnectionValidator

Returns:

validation period

setValidatePeriod

public void setValidatePeriod(Duration period)

getValidateTimeout

public Duration getValidateTimeout()

Description copied from interface: ConnectionValidator

Returns the time at which a validate operation should be abandoned.

Specified by:

getValidateTimeout in interface ConnectionValidator

Returns:

validation timeout

setValidateTimeout

public void setValidateTimeout(Duration timeout)

apply

public Boolean apply(Connection conn)

Specified by:

apply in interface Function<Connection,Boolean>

applyAsync

public Supplier<Boolean> applyAsync(Connection conn)

Description copied from interface: ConnectionValidator

Provides an asynchronous implementation of Function.apply(Object). The returned supplier will block until a validation result is received respecting ConnectionValidator.getValidateTimeout().

Specified by:

applyAsync in interface ConnectionValidator

Parameters:

conn - to validate

Returns:

supplier to retrieve the validation result