Package com.unboundid.ldap.sdk

Class ServerSetBlacklistManager

java.lang.Object
com.unboundid.ldap.sdk.ServerSetBlacklistManager
@Mutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ServerSetBlacklistManager extends Object
This class provides a mechanism for maintaining a blacklist of servers that have recently been found to be unacceptable for use by a server set. Server sets that use this class can temporarily avoid trying to access servers that may be experiencing problems.

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Indicates whether the blacklist is currently empty.
      Returns:
      true if the blacklist is currently empty, or false if it contains at least one server.

    • size

      public int size()
      Retrieves the number of servers currently on the blacklist.
      Returns:
      The number of servers currently on the blacklist.

    • getBlacklistedServers

      @NotNull public Set<ObjectPair<String,Integer>> getBlacklistedServers()
      Retrieves a list of the servers currently on the blacklist.
      Returns:
      A list of the servers currently on the blacklist.

    • isBlacklisted

      public boolean isBlacklisted(@NotNull String host, int port)
      Indicates whether the specified server is currently on the blacklist.
      Parameters:
      host - The address of the server for which to make the determination. It must not be null.
      port - The port of the server for which to make the determination. It must be between 1 and 65535, inclusive.
      Returns:
      true if the server is on the blacklist, or false if not.

    • isBlacklisted

      public boolean isBlacklisted(@NotNull ObjectPair<String,Integer> hostPort)
      Indicates whether the specified server is currently on the blacklist.
      Parameters:
      hostPort - An ObjectPair containing the address and port of the server for which to make the determination. It must not be null.
      Returns:
      true if the server is on the blacklist, or false if not.

    • shutDown

      public void shutDown()
      Shuts down the blacklist manager.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this server set blacklist manager.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this server set blacklist manager.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this server set blacklist manager to the provided buffer.
      Parameters:
      buffer - The buffer to which the information should be appended.