Package com.unboundid.ldap.sdk

Class SingleServerSet

java.lang.Object
com.unboundid.ldap.sdk.ServerSet
com.unboundid.ldap.sdk.SingleServerSet
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SingleServerSet extends ServerSet
This class provides a server set implementation that only provides the ability to connect to a single server. It may be used in cases where a ServerSet is required but only a single server is needed.

  • Constructor Details

    • SingleServerSet

      public SingleServerSet(@NotNull String address, int port)
      Creates a new single server set with the specified address and port. It will use the default socket factory provided by the JVM to create the underlying socket.
      Parameters:
      address - The address of the directory server to which the connections should be established. It must not be null.
      port - The port of the directory server to which the connections should be established. It must be between 1 and 65535, inclusive.

    • SingleServerSet

      public SingleServerSet(@NotNull String address, int port, @Nullable LDAPConnectionOptions connectionOptions)
      Creates a new single server set with the specified address and port. It will use the default socket factory provided by the JVM to create the underlying socket.
      Parameters:
      address - The address of the directory server to which the connections should be established. It must not be null.
      port - The port of the directory server to which the connections should be established. It must be between 1 and 65535, inclusive.
      connectionOptions - The set of connection options to use for the underlying connections.

    • SingleServerSet

      public SingleServerSet(@NotNull String address, int port, @Nullable SocketFactory socketFactory)
      Creates a new single server set with the specified address and port, and using the provided socket factory.
      Parameters:
      address - The address of the directory server to which the connections should be established. It must not be null.
      port - The port of the directory server to which the connections should be established. It must be between 1 and 65535, inclusive.
      socketFactory - The socket factory to use to create the underlying connections.

    • SingleServerSet

      public SingleServerSet(@NotNull String address, int port, @Nullable SocketFactory socketFactory, @Nullable LDAPConnectionOptions connectionOptions)
      Creates a new single server set with the specified address and port, and using the provided socket factory.
      Parameters:
      address - The address of the directory server to which the connections should be established. It must not be null.
      port - The port of the directory server to which the connections should be established. It must be between 1 and 65535, inclusive.
      socketFactory - The socket factory to use to create the underlying connections.
      connectionOptions - The set of connection options to use for the underlying connections.

    • SingleServerSet

      public SingleServerSet(@NotNull String address, int port, @Nullable SocketFactory socketFactory, @Nullable LDAPConnectionOptions connectionOptions, @Nullable BindRequest bindRequest, @Nullable PostConnectProcessor postConnectProcessor)
      Creates a new single server set with the specified address and port, and using the provided socket factory.
      Parameters:
      address - The address of the directory server to which the connections should be established. It must not be null.
      port - The port of the directory server to which the connections should be established. It must be between 1 and 65535, inclusive.
      socketFactory - The socket factory to use to create the underlying connections.
      connectionOptions - The set of connection options to use for the underlying connections.
      bindRequest - The bind request that should be used to authenticate newly-established connections. It may be null if this server set should not perform any authentication.
      postConnectProcessor - The post-connect processor that should be invoked on newly-established connections. It may be null if this server set should not perform any post-connect processing.

  • Method Details

    • getAddress

      @NotNull public String getAddress()
      Retrieves the address of the directory server to which the connections should be established.
      Returns:
      The address of the directory server to which the connections should be established.

    • getPort

      public int getPort()
      Retrieves the port of the directory server to which the connections should be established.
      Returns:
      The port of the directory server to which the connections should be established.

    • getSocketFactory

      @NotNull public SocketFactory getSocketFactory()
      Retrieves the socket factory that will be used to establish connections.
      Returns:
      The socket factory that will be used to establish connections.

    • getConnectionOptions

      @NotNull public LDAPConnectionOptions getConnectionOptions()
      Retrieves the set of connection options that will be used by the underlying connections.
      Returns:
      The set of connection options that will be used by the underlying connections.

    • includesAuthentication

      public boolean includesAuthentication()
      Indicates whether connections created by this server set will be authenticated.
      Overrides:
      includesAuthentication in class ServerSet
      Returns:
      true if connections created by this server set will be authenticated, or false if not.

    • includesPostConnectProcessing

      public boolean includesPostConnectProcessing()
      Indicates whether connections created by this server set will have post-connect processing performed.
      Overrides:
      includesPostConnectProcessing in class ServerSet
      Returns:
      true if connections created by this server set will have post-connect processing performed, or false if not.

    • getConnection

      @NotNull public LDAPConnection getConnection() throws LDAPException
      Attempts to establish a connection to one of the directory servers in this server set. The connection that is returned must be established. The ServerSet.includesAuthentication() must return true if and only if the connection will also be authenticated, and the ServerSet.includesPostConnectProcessing() method must return true if and only if pre-authentication and post-authentication post-connect processing will have been performed. The caller may determine the server to which the connection is established using the LDAPConnection.getConnectedAddress() and LDAPConnection.getConnectedPort() methods.
      Specified by:
      getConnection in class ServerSet
      Returns:
      An LDAPConnection object that is established to one of the servers in this server set.
      Throws:
      LDAPException - If it is not possible to establish a connection to any of the servers in this server set.

    • getConnection

      @NotNull public LDAPConnection getConnection(@Nullable LDAPConnectionPoolHealthCheck healthCheck) throws LDAPException
      Attempts to establish a connection to one of the directory servers in this server set, using the provided health check to further validate the connection. The connection that is returned must be established. The ServerSet.includesAuthentication() must return true if and only if the connection will also be authenticated, and the ServerSet.includesPostConnectProcessing() method must return true if and only if pre-authentication and post-authentication post-connect processing will have been performed. The caller may determine the server to which the connection is established using the LDAPConnection.getConnectedAddress() and LDAPConnection.getConnectedPort() methods.
      Overrides:
      getConnection in class ServerSet
      Parameters:
      healthCheck - The health check to use to verify the health of the newly-created connection. It may be null if no additional health check should be performed. If it is non-null and this server set performs authentication, then the health check's ensureConnectionValidAfterAuthentication method will be invoked immediately after the bind operation is processed (regardless of whether the bind was successful or not). And regardless of whether this server set performs authentication, the health check's ensureNewConnectionValid method must be invoked on the connection to ensure that it is valid immediately before it is returned.
      Returns:
      An LDAPConnection object that is established to one of the servers in this server set.
      Throws:
      LDAPException - If it is not possible to establish a connection to any of the servers in this server set.

    • toString

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