Package com.unboundid.ldap.sdk.migrate.jndi

Class JNDIConverter

java.lang.Object
com.unboundid.ldap.sdk.migrate.jndi.JNDIConverter
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JNDIConverter extends Object implements Serializable
This utility class provides a set of methods that may be used to convert between data structures in the Java Naming and Directory Interface (JNDI) and the corresponding data structures in the UnboundID LDAP SDK for Java.
See Also:

  • Method Details

    • convertAttribute

      @Nullable public static Attribute convertAttribute(@Nullable Attribute a) throws NamingException
      Converts the provided JNDI attribute to an LDAP SDK attribute.
      Parameters:
      a - The attribute to be converted.
      Returns:
      The LDAP SDK attribute that corresponds to the provided JNDI attribute.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertAttribute

      @Nullable public static Attribute convertAttribute(@Nullable Attribute a)
      Converts the provided LDAP SDK attribute to a JNDI attribute.
      Parameters:
      a - The attribute to be converted.
      Returns:
      The JNDI attribute that corresponds to the provided LDAP SDK attribute.

    • convertAttributes

      @NotNull public static Attribute[] convertAttributes(@Nullable Attributes a) throws NamingException
      Converts the provided JNDI attributes to an array of LDAP SDK attributes.
      Parameters:
      a - The attributes to be converted.
      Returns:
      The array of LDAP SDK attributes that corresponds to the provided JNDI attributes.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertAttributes

      @NotNull public static Attributes convertAttributes(@Nullable Attribute... a)
      Converts the provided array of LDAP SDK attributes to a set of JNDI attributes.
      Parameters:
      a - The array of attributes to be converted.
      Returns:
      The JNDI attributes that corresponds to the provided LDAP SDK attributes.

    • convertAttributes

      @NotNull public static Attributes convertAttributes(@Nullable Collection<Attribute> a)
      Converts the provided collection of LDAP SDK attributes to a set of JNDI attributes.
      Parameters:
      a - The collection of attributes to be converted.
      Returns:
      The JNDI attributes that corresponds to the provided LDAP SDK attributes.

    • convertControl

      @Nullable public static Control convertControl(@Nullable Control c) throws NamingException
      Converts the provided JNDI control to an LDAP SDK control.
      Parameters:
      c - The control to be converted.
      Returns:
      The LDAP SDK control that corresponds to the provided JNDI control.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertControl

      @Nullable public static Control convertControl(@Nullable Control c)
      Converts the provided LDAP SDK control to a JNDI control.
      Parameters:
      c - The control to be converted.
      Returns:
      The JNDI control that corresponds to the provided LDAP SDK control.

    • convertControls

      @NotNull public static Control[] convertControls(@Nullable Control... c) throws NamingException
      Converts the provided array of JNDI controls to an array of LDAP SDK controls.
      Parameters:
      c - The array of JNDI controls to be converted.
      Returns:
      The array of LDAP SDK controls that corresponds to the provided array of JNDI controls.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertControls

      @NotNull public static Control[] convertControls(@Nullable Control... c)
      Converts the provided array of LDAP SDK controls to an array of JNDI controls.
      Parameters:
      c - The array of LDAP SDK controls to be converted.
      Returns:
      The array of JNDI controls that corresponds to the provided array of LDAP SDK controls.

    • convertExtendedRequest

      @Nullable public static ExtendedRequest convertExtendedRequest(@Nullable ExtendedRequest r) throws NamingException
      Converts the provided JNDI extended request to an LDAP SDK extended request.
      Parameters:
      r - The request to be converted.
      Returns:
      The LDAP SDK extended request that corresponds to the provided JNDI extended request.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertExtendedRequest

      @Nullable public static ExtendedRequest convertExtendedRequest(@Nullable ExtendedRequest r)
      Converts the provided LDAP SDK extended request to a JNDI extended request.
      Parameters:
      r - The request to be converted.
      Returns:
      The JNDI extended request that corresponds to the provided LDAP SDK extended request.

    • convertExtendedResponse

      @Nullable public static ExtendedResult convertExtendedResponse(@Nullable ExtendedResponse r) throws NamingException
      Converts the provided JNDI extended response to an LDAP SDK extended result.
      Parameters:
      r - The response to be converted.
      Returns:
      The LDAP SDK extended result that corresponds to the provided JNDI extended response.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertExtendedResult

      @Nullable public static ExtendedResponse convertExtendedResult(@Nullable ExtendedResult r)
      Converts the provided LDAP SDK extended result to a JNDI extended response.
      Parameters:
      r - The result to be converted.
      Returns:
      The JNDI extended response that corresponds to the provided LDAP SDK extended result.

    • convertModification

      @Nullable public static Modification convertModification(@Nullable ModificationItem m) throws NamingException
      Converts the provided JNDI modification item to an LDAP SDK modification.
      Parameters:
      m - The JNDI modification item to be converted.
      Returns:
      The LDAP SDK modification that corresponds to the provided JNDI modification item.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertModification

      @Nullable public static ModificationItem convertModification(@Nullable Modification m) throws NamingException
      Converts the provided LDAP SDK modification to a JNDI modification item.
      Parameters:
      m - The LDAP SDK modification to be converted.
      Returns:
      The JNDI modification item that corresponds to the provided LDAP SDK modification.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertModifications

      @NotNull public static Modification[] convertModifications(@Nullable ModificationItem... m) throws NamingException
      Converts the provided array of JNDI modification items to an array of LDAP SDK modifications.
      Parameters:
      m - The array of JNDI modification items to be converted.
      Returns:
      The array of LDAP SDK modifications that corresponds to the provided array of JNDI modification items.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertModifications

      @NotNull public static ModificationItem[] convertModifications(@Nullable Modification... m) throws NamingException
      Converts the provided array of LDAP SDK modifications to an array of JNDI modification items.
      Parameters:
      m - The array of LDAP SDK modifications to be converted.
      Returns:
      The array of JNDI modification items that corresponds to the provided array of LDAP SDK modifications.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertSearchEntry

      @Nullable public static Entry convertSearchEntry(@Nullable SearchResult r) throws NamingException
      Converts the provided JNDI search result object to an LDAP SDK entry.
      Parameters:
      r - The JNDI search result object to be converted.
      Returns:
      The LDAP SDK entry that corresponds to the provided JNDI search result.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertSearchEntry

      @Nullable public static Entry convertSearchEntry(@Nullable SearchResult r, @Nullable String contextBaseDN) throws NamingException
      Converts the provided JNDI search result object to an LDAP SDK entry.
      Parameters:
      r - The JNDI search result object to be converted.
      contextBaseDN - The base DN for the JNDI context over which the search result was retrieved. If it is non-null and non-empty, then it will be appended to the result of the getName method to obtain the entry's full DN.
      Returns:
      The LDAP SDK entry that corresponds to the provided JNDI search result.
      Throws:
      NamingException - If a problem is encountered during the conversion process.

    • convertSearchEntry

      @Nullable public static SearchResult convertSearchEntry(@Nullable Entry e)
      Converts the provided LDAP SDK entry to a JNDI search result.
      Parameters:
      e - The entry to be converted to a JNDI search result.
      Returns:
      The JNDI search result that corresponds to the provided LDAP SDK entry.

    • convertSearchEntry

      @Nullable public static SearchResult convertSearchEntry(@Nullable Entry e, @Nullable String contextBaseDN)
      Converts the provided LDAP SDK entry to a JNDI search result.
      Parameters:
      e - The entry to be converted to a JNDI search result.
      contextBaseDN - The base DN for the JNDI context over which the search result was retrieved. If it is non-null and non-empty, then it will be removed from the end of the entry's DN in order to obtain the name for the SearchResult that is returned.
      Returns:
      The JNDI search result that corresponds to the provided LDAP SDK entry.