Package org.ldaptive

Class CompareConnectionValidator

java.lang.Object

org.ldaptive.AbstractConnectionValidator

org.ldaptive.CompareConnectionValidator

All Implemented Interfaces:

Function<Connection,Boolean>, ConnectionValidator

public class CompareConnectionValidator
extends AbstractConnectionValidator

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 Classes

Modifier and Type	Class	Description
static class	CompareConnectionValidator.Builder	Compare validator builder.

Nested classes/interfaces inherited from class org.ldaptive.AbstractConnectionValidator

AbstractConnectionValidator.AbstractBuilder<B,T extends AbstractConnectionValidator>

Field Summary

Fields

Modifier and Type	Field	Description
private CompareRequest	compareRequest	Compare request to perform validation with.

Fields inherited from class org.ldaptive.AbstractConnectionValidator

DEFAULT_VALIDATE_PERIOD, DEFAULT_VALIDATE_TIMEOUT, logger

Constructor Summary

Constructors

Constructor	Description
CompareConnectionValidator()	Creates a new compare validator.
CompareConnectionValidator(Duration period, Duration timeout, CompareRequest request)	Creates a new compare validator.
CompareConnectionValidator(CompareRequest cr)	Creates a new compare validator.

Method Summary

Modifier and Type	Method	Description
void	applyAsync(Connection conn, Consumer<Boolean> function)	Provides an asynchronous implementation of Function.apply(Object).
static CompareConnectionValidator.Builder	builder()	Creates a builder for this class.
CompareRequest	getCompareRequest()	Returns the compare request.
void	setCompareRequest(CompareRequest cr)	Sets the compare request.
String	toString()

Methods inherited from class org.ldaptive.AbstractConnectionValidator

apply, applyAsync, getValidatePeriod, getValidateTimeout, setValidatePeriod, setValidateTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Field Detail

compareRequest

private CompareRequest compareRequest

Compare request to perform validation with.

Constructor Detail

CompareConnectionValidator

public CompareConnectionValidator()

Creates a new compare validator.

CompareConnectionValidator

public CompareConnectionValidator(CompareRequest cr)

Creates a new compare validator.

Parameters:

cr - to use for compares

CompareConnectionValidator

public CompareConnectionValidator(Duration period,
                                  Duration timeout,
                                  CompareRequest request)

Creates a new compare validator.

Parameters:

period - execution period

timeout - execution timeout

request - to use for searches

Method Detail

getCompareRequest

public CompareRequest getCompareRequest()

Returns the compare request.

Returns:

compare request

setCompareRequest

public void setCompareRequest(CompareRequest cr)

Sets the compare request.

Parameters:

cr - compare request

applyAsync

public void applyAsync(Connection conn,
                       Consumer<Boolean> function)

Description copied from interface: ConnectionValidator

Provides an asynchronous implementation of Function.apply(Object). The supplied consumer will be invoked with the validation result. ConnectionValidator.getValidateTimeout() must be enforced by the caller.

Parameters:

conn - to validate

function - to consume the validation result

toString

public String toString()

Overrides:

toString in class Object

builder

public static CompareConnectionValidator.Builder builder()

Creates a builder for this class.

Returns:

new builder