Package org.ldaptive

Class SearchConnectionValidator

  • All Implemented Interfaces:
    java.util.function.Function<Connection,​java.lang.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.
    Author:
    Middleware Services
    • 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​(java.time.Duration period,
                                         java.time.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
      • applyAsync

        public void applyAsync​(Connection conn,
                               java.util.function.Consumer<java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object