com.unboundid.ldap.sdk.migrate.jndi
Class JNDIConverter

java.lang.Object
  extended by com.unboundid.ldap.sdk.migrate.jndi.JNDIConverter

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JNDIConverter
extends java.lang.Object

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.


Method Summary
static Attribute convertAttribute(javax.naming.directory.Attribute a)
          Converts the provided JNDI attribute to an LDAP SDK attribute.
static javax.naming.directory.Attribute convertAttribute(Attribute a)
          Converts the provided LDAP SDK attribute to a JNDI attribute.
static javax.naming.directory.Attributes convertAttributes(Attribute... a)
          Converts the provided array of LDAP SDK attributes to a set of JNDI attributes.
static Attribute[] convertAttributes(javax.naming.directory.Attributes a)
          Converts the provided JNDI attributes to an array of LDAP SDK attributes.
static javax.naming.directory.Attributes convertAttributes(java.util.Collection<Attribute> a)
          Converts the provided collection of LDAP SDK attributes to a set of JNDI attributes.
static Control convertControl(javax.naming.ldap.Control c)
          Converts the provided JNDI control to an LDAP SDK control.
static javax.naming.ldap.Control convertControl(Control c)
          Converts the provided LDAP SDK control to a JNDI control.
static Control[] convertControls(javax.naming.ldap.Control... c)
          Converts the provided array of JNDI controls to an array of LDAP SDK controls.
static javax.naming.ldap.Control[] convertControls(Control... c)
          Converts the provided array of LDAP SDK controls to an array of JNDI controls.
static ExtendedRequest convertExtendedRequest(javax.naming.ldap.ExtendedRequest r)
          Converts the provided JNDI extended request to an LDAP SDK extended request.
static javax.naming.ldap.ExtendedRequest convertExtendedRequest(ExtendedRequest r)
          Converts the provided LDAP SDK extended request to a JNDI extended request.
static ExtendedResult convertExtendedResponse(javax.naming.ldap.ExtendedResponse r)
          Converts the provided JNDI extended response to an LDAP SDK extended result.
static javax.naming.ldap.ExtendedResponse convertExtendedResult(ExtendedResult r)
          Converts the provided LDAP SDK extended result to a JNDI extended response.
static javax.naming.directory.ModificationItem convertModification(Modification m)
          Converts the provided LDAP SDK modification to a JNDI modification item.
static Modification convertModification(javax.naming.directory.ModificationItem m)
          Converts the provided JNDI modification item to an LDAP SDK modification.
static javax.naming.directory.ModificationItem[] convertModifications(Modification... m)
          Converts the provided array of LDAP SDK modifications to an array of JNDI modification items.
static Modification[] convertModifications(javax.naming.directory.ModificationItem... m)
          Converts the provided array of JNDI modification items to an array of LDAP SDK modifications.
static javax.naming.directory.SearchResult convertSearchEntry(Entry e)
          Converts the provided LDAP SDK entry to a JNDI search result.
static Entry convertSearchEntry(javax.naming.directory.SearchResult r)
          Converts the provided JNDI search result object to an LDAP SDK entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

convertAttribute

public static Attribute convertAttribute(javax.naming.directory.Attribute a)
                                  throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertAttribute

public static javax.naming.directory.Attribute convertAttribute(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

public static Attribute[] convertAttributes(javax.naming.directory.Attributes a)
                                     throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertAttributes

public static javax.naming.directory.Attributes convertAttributes(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

public static javax.naming.directory.Attributes convertAttributes(java.util.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

public static Control convertControl(javax.naming.ldap.Control c)
                              throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertControl

public static javax.naming.ldap.Control convertControl(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

public static Control[] convertControls(javax.naming.ldap.Control... c)
                                 throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertControls

public static javax.naming.ldap.Control[] convertControls(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

public static ExtendedRequest convertExtendedRequest(javax.naming.ldap.ExtendedRequest r)
                                              throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertExtendedRequest

public static javax.naming.ldap.ExtendedRequest convertExtendedRequest(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

public static ExtendedResult convertExtendedResponse(javax.naming.ldap.ExtendedResponse r)
                                              throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertExtendedResult

public static javax.naming.ldap.ExtendedResponse convertExtendedResult(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

public static Modification convertModification(javax.naming.directory.ModificationItem m)
                                        throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertModification

public static javax.naming.directory.ModificationItem convertModification(Modification m)
                                                                   throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertModifications

public static Modification[] convertModifications(javax.naming.directory.ModificationItem... m)
                                           throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertModifications

public static javax.naming.directory.ModificationItem[] convertModifications(Modification... m)
                                                                      throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertSearchEntry

public static Entry convertSearchEntry(javax.naming.directory.SearchResult r)
                                throws javax.naming.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:
javax.naming.NamingException - If a problem is encountered during the conversion process.

convertSearchEntry

public static javax.naming.directory.SearchResult convertSearchEntry(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.