org.ldaptive.provider.jndi

Class JndiUtils

java.lang.Object

org.ldaptive.provider.jndi.JndiUtils

public class JndiUtils
extends java.lang.Object

Provides methods for converting between JNDI specific objects and ldaptive specific objects.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IGNORE_CASE Whether to ignore case when creating basic attributes.
private SortBehavior	sortBehavior Ldap result sort behavior.

Constructor Summary

Constructors

Constructor and Description
JndiUtils() Default constructor.
JndiUtils(SortBehavior sb) Creates a new jndi util.

Method Summary

Modifier and Type	Method and Description
javax.naming.directory.ModificationItem[]	fromAttributeModification(AttributeModification[] mods) Returns jndi modification items using the supplied attribute modifications.
javax.naming.directory.Attribute	fromLdapAttribute(LdapAttribute attr) Returns a jndi attribute that represents the values in the supplied ldap attribute.
javax.naming.directory.Attributes	fromLdapAttributes(java.util.Collection<LdapAttribute> attrs) Returns a jndi attributes that represents the values in the supplied ldap attributes.
javax.naming.directory.SearchResult	fromSearchEntry(SearchEntry entry) Returns a jndi search result that represents the supplied search entry.
static javax.naming.ldap.SortKey[]	fromSortKey(SortKey[] keys) Returns jndi sort keys using the supplied sort keys.
protected static int	getAttributeModification(AttributeModificationType type) Returns the jndi modification integer constant for the supplied attribute modification type.
static java.lang.String	getAuthenticationType(Mechanism m) Returns the JNDI authentication string for the supplied authentication type.
static java.lang.String	getQualityOfProtection(QualityOfProtection qop) Returns the SASL quality of protection string for the supplied enum.
static java.lang.String	getSecurityStrength(SecurityStrength ss) Returns the SASL security strength string for the supplied enum.
LdapAttribute	toLdapAttribute(javax.naming.directory.Attribute attr) Returns an ldap attribute using the supplied jndi attribute.
SearchEntry	toSearchEntry(javax.naming.directory.SearchResult result) Returns a search entry using the supplied jndi search result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_IGNORE_CASE

public static final boolean DEFAULT_IGNORE_CASE

Whether to ignore case when creating basic attributes.

See Also:

Constant Field Values

sortBehavior

private final SortBehavior sortBehavior

Ldap result sort behavior.

Constructor Detail

JndiUtils

public JndiUtils()

Default constructor.

JndiUtils

public JndiUtils(SortBehavior sb)

Creates a new jndi util.

Parameters:

sb - sort behavior

Method Detail

fromLdapAttribute

public javax.naming.directory.Attribute fromLdapAttribute(LdapAttribute attr)

Returns a jndi attribute that represents the values in the supplied ldap attribute.

Parameters:

attr - ldap attribute

Returns:

jndi attribute

toLdapAttribute

public LdapAttribute toLdapAttribute(javax.naming.directory.Attribute attr)
                              throws javax.naming.NamingException

Returns an ldap attribute using the supplied jndi attribute.

Parameters:

attr - jndi attribute

Returns:

ldap attribute

Throws:

javax.naming.NamingException - if the attribute values cannot be read

fromLdapAttributes

public javax.naming.directory.Attributes fromLdapAttributes(java.util.Collection<LdapAttribute> attrs)

Returns a jndi attributes that represents the values in the supplied ldap attributes.

Parameters:

attrs - ldap attributes

Returns:

jndi attributes

fromSearchEntry

public javax.naming.directory.SearchResult fromSearchEntry(SearchEntry entry)

Returns a jndi search result that represents the supplied search entry.

Parameters:

entry - search entry

Returns:

jndi search result

toSearchEntry

public SearchEntry toSearchEntry(javax.naming.directory.SearchResult result)
                          throws javax.naming.NamingException

Returns a search entry using the supplied jndi search result.

Parameters:

result - jndi search result

Returns:

search entry

Throws:

javax.naming.NamingException - if the search result cannot be read

fromAttributeModification

public javax.naming.directory.ModificationItem[] fromAttributeModification(AttributeModification[] mods)

Returns jndi modification items using the supplied attribute modifications.

Parameters:

mods - attribute modifications

Returns:

jndi modification items

fromSortKey

public static javax.naming.ldap.SortKey[] fromSortKey(SortKey[] keys)

Returns jndi sort keys using the supplied sort keys.

Parameters:

keys - sort keys

Returns:

jndi sort keys

getAttributeModification

protected static int getAttributeModification(AttributeModificationType type)

Returns the jndi modification integer constant for the supplied attribute modification type.

Parameters:

type - attribute modification type

Returns:

integer constant

getQualityOfProtection

public static java.lang.String getQualityOfProtection(QualityOfProtection qop)

Returns the SASL quality of protection string for the supplied enum.

Parameters:

qop - quality of protection enum

Returns:

SASL quality of protection string

getSecurityStrength

public static java.lang.String getSecurityStrength(SecurityStrength ss)

Returns the SASL security strength string for the supplied enum.

Parameters:

ss - security strength enum

Returns:

SASL security strength string

getAuthenticationType

public static java.lang.String getAuthenticationType(Mechanism m)

Returns the JNDI authentication string for the supplied authentication type.

Parameters:

m - sasl mechanism

Returns:

JNDI authentication string