Package org.springframework.ldap.support

Class LdapNameBuilder

java.lang.Object
org.springframework.ldap.support.LdapNameBuilder
public final class LdapNameBuilder extends Object
Helper class for building LdapName instances. Note that the first part of a Distinguished Name is the least significant, which means that when adding components, they will be added to the beginning of the resulting string, e.g. 
         LdapNameBuilder.newInstance("dc=261consulting,dc=com").add("ou=people").build().toString();
will result in ou=people,dc=261consulting,dc=com.
Since:
2.0

  • Method Details

    • newInstance

      public static LdapNameBuilder newInstance()
      Construct a new instance, starting with a blank LdapName.
      Returns:
      a new instance.

    • newInstance

      public static LdapNameBuilder newInstance(Name name)
      Construct a new instance, starting with a copy of the supplied LdapName.
      Parameters:
      name - the starting point of the LdapName to be built.
      Returns:
      a new instance.

    • newInstance

      public static LdapNameBuilder newInstance(String name)
      Construct a new instance, starting with an LdapName constructed from the supplied string.
      Parameters:
      name - the starting point of the LdapName to be built.
      Returns:
      a new instance.

    • add

      public LdapNameBuilder add(String key, Object value)
      Add a Rdn to the built LdapName.
      Parameters:
      key - the rdn attribute key.
      value - the rdn value.
      Returns:
      this builder.

    • add

      public LdapNameBuilder add(Name name)
      Append the specified name to the currently built LdapName.
      Parameters:
      name - the name to add.
      Returns:
      this builder.

    • add

      public LdapNameBuilder add(String name)
      Append the LdapName represented by the specified string to the currently built LdapName.
      Parameters:
      name - the name to add.
      Returns:
      this builder.

    • build

      public LdapName build()
      Build the LdapName instance.
      Returns:
      the LdapName instance that has been built.