Package org.ldaptive

Class SearchConnectionValidator

java.lang.Object

org.ldaptive.AbstractConnectionValidator

org.ldaptive.SearchConnectionValidator

All Implemented Interfaces:

Function<Connection,Boolean>, ConnectionValidator

public class SearchConnectionValidator
extends AbstractConnectionValidator

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 Classes

Modifier and Type	Class	Description
static class	SearchConnectionValidator.Builder	Search 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 Logger	logger	Logger for this class.
private SearchRequest	searchRequest	Search request to perform validation with.

Fields inherited from class org.ldaptive.AbstractConnectionValidator

DEFAULT_VALIDATE_PERIOD, DEFAULT_VALIDATE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
SearchConnectionValidator()	Creates a new search validator.
SearchConnectionValidator(Duration period, Duration timeout, SearchRequest request)	Creates a new search validator.
SearchConnectionValidator(SearchRequest sr)	Creates a new search validator.

Method Summary

Modifier and Type	Method	Description
Boolean	apply(Connection conn)
static SearchConnectionValidator.Builder	builder()	Creates a builder for this class.
SearchRequest	getSearchRequest()	Returns the search request.
void	setSearchRequest(SearchRequest sr)	Sets the search request.
String	toString()

Methods inherited from class org.ldaptive.AbstractConnectionValidator

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

logger

private final Logger logger

Logger for this class.

searchRequest

private SearchRequest searchRequest

Search request to perform validation with.

Constructor Detail

SearchConnectionValidator

public SearchConnectionValidator()

Creates a new search validator.

SearchConnectionValidator

public SearchConnectionValidator(SearchRequest sr)

Creates a new search validator.

Parameters:

sr - to use for searches

SearchConnectionValidator

public SearchConnectionValidator(Duration period,
                                 Duration timeout,
                                 SearchRequest request)

Creates a new search validator.

Parameters:

period - execution period

timeout - execution timeout

request - to use for searches

Method Detail

getSearchRequest

public SearchRequest getSearchRequest()

Returns the search request.

Returns:

search request

setSearchRequest

public void setSearchRequest(SearchRequest sr)

Sets the search request.

Parameters:

sr - search request

apply

public Boolean apply(Connection conn)

toString

public String toString()

Overrides:

toString in class Object

builder

public static SearchConnectionValidator.Builder builder()

Creates a builder for this class.

Returns:

new builder