Package org.ldaptive

Class CompareConnectionValidator

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