Package org.ldaptive

Class BindConnectionInitializer

java.lang.Object
org.ldaptive.AbstractFreezable
org.ldaptive.BindConnectionInitializer
All Implemented Interfaces:
ConnectionInitializer, Freezable
public class BindConnectionInitializer extends AbstractFreezable implements ConnectionInitializer
Initializes a connection by performing a bind operation. Useful if you need all connections to bind as the same principal.

  • Field Details

    • logger

      protected final Logger logger
      Logger for this class.

    • bindDn

      private String bindDn
      DN to bind as before performing operations.

    • bindCredential

      private Credential bindCredential
      Credential for the bind DN.

    • bindSaslConfig

      private SaslConfig bindSaslConfig
      Configuration for bind SASL authentication.

    • bindControls

      private RequestControl[] bindControls
      Bind controls.

  • Constructor Details

    • BindConnectionInitializer

      public BindConnectionInitializer()
      Default constructor.

    • BindConnectionInitializer

      public BindConnectionInitializer(String dn, String credential)
      Creates a new bind connection initializer.
      Parameters:
      dn - bind dn
      credential - bind credential

    • BindConnectionInitializer

      public BindConnectionInitializer(String dn, Credential credential)
      Creates a new bind connection initializer.
      Parameters:
      dn - bind dn
      credential - bind credential

  • Method Details

    • freeze

      public void freeze()
      Description copied from interface: Freezable
      Freezes this object, making it immutable.
      Specified by:
      freeze in interface Freezable
      Overrides:
      freeze in class AbstractFreezable

    • getBindDn

      public final String getBindDn()
      Returns the bind DN.
      Returns:
      DN to bind as

    • setBindDn

      public final void setBindDn(String dn)
      Sets the bind DN to authenticate as before performing operations.
      Parameters:
      dn - to bind as

    • getBindCredential

      public final Credential getBindCredential()
      Returns the credential used with the bind DN.
      Returns:
      bind DN credential

    • setBindCredential

      public final void setBindCredential(Credential credential)
      Sets the credential of the bind DN.
      Parameters:
      credential - to use with bind DN

    • getBindSaslConfig

      public final SaslConfig getBindSaslConfig()
      Returns the bind sasl config.
      Returns:
      sasl config

    • setBindSaslConfig

      public final void setBindSaslConfig(SaslConfig config)
      Sets the bind sasl config.
      Parameters:
      config - sasl config

    • getBindControls

      public final RequestControl[] getBindControls()
      Returns the bind controls.
      Returns:
      controls

    • setBindControls

      public final void setBindControls(RequestControl... cntrls)
      Sets the bind controls.
      Parameters:
      cntrls - controls to set

    • initialize

      public Result initialize(Connection c) throws LdapException
      Description copied from interface: ConnectionInitializer
      Initialize the supplied connection.
      Specified by:
      initialize in interface ConnectionInitializer
      Parameters:
      c - connection to initialize
      Returns:
      result associated with the initialization or an empty result
      Throws:
      LdapException - if initialization fails

    • isEmpty

      public boolean isEmpty()
      Returns whether this connection initializer contains any configuration data.
      Returns:
      whether all properties are null

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static BindConnectionInitializer.Builder builder()
      Creates a builder for this class.
      Returns:
      new builder