com.eibus.directory.soap

Class LDAPUtil

java.lang.Object

com.eibus.directory.soap.LDAPUtil

public class LDAPUtil
extends java.lang.Object

This class contains some helper functions to easily retrieve information about certain attributes in an LDAPEntry object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPUtil.AttrNameValue This class builds a attribute name/value pair.

Method Summary

Modifier and Type	Method and Description
static void	addClassToAttrSet(LDAPAttributeSet attrSet, ClassDefinition classDef) Adds the 'objectclass' attribute for the given class definition and its super classes to the given attribute set.
static LDAPAttributeSet	buildAttrSet(ClassDefinition classDef, LDAPUtil.AttrNameValue[] nameValuePairs) Builds an attribute set given a class definition and a set of attribute name/value pairs.
static LDAPModification[]	buildLDAPModificationArray(ClassDefinition classDef, int modificationType, LDAPUtil.AttrNameValue[] nameValuePairs) Builds an LDAP modification array a class definition and a set of attribute name/value pairs.
static LDAPEntry	cloneEntry(LDAPEntry entry) Return a copy of an LDAPEntry.
static java.lang.String	CN(java.lang.String value)
static java.lang.String	CN(java.lang.String value, java.lang.String parentDN)
static boolean	containsStringValue(LDAPAttribute attribute, java.lang.String expectedValue, boolean caseSensitive) Indicates whether the entry contains an attribute that contains the expected value.
static boolean	containsStringValue(LDAPEntry entry, AttributeDefinition attrDef, java.lang.String expected, boolean caseSensitive) Indicates whether the entry contains an attribute that contains the expected value.
static boolean	containsStringValue(LDAPEntry entry, java.lang.String attributeName, java.lang.String expectedValue, boolean caseSensitive) Indicates whether the entry contains an attribute that contains the expected value.
static byte[]	getBytesValue(LDAPEntry entry, AttributeDefinition attrDef) Returns the first byte-array value of the attribute in entry that has the specified name.
static byte[]	getBytesValue(LDAPEntry entry, java.lang.String attributeName) Returns the first byte-array value of the attribute in entry that has the specified name.
static java.lang.String	getCN(java.lang.String dn) Deprecated. Use getRDNValue(java.lang.String)
static java.lang.String	getDirectorySearchRoot()
static LDAPEntry	getEntry(LDAPDirectoryReader directoryReader, java.lang.String dn) Searches for an LDAP entry with the given DN
static LDAPEntry	getEntry(LDAPDirectoryReader directoryReader, java.lang.String dn, java.lang.String filter) Searches for an LDAP entry with the given DN
static java.lang.String	getEscapedFilter(java.lang.String filter)
static LDAPDirectory	getLdapDirectory()
static java.lang.String	getLDAPDisplayNameOnCurrentSchema(AttributeDefinition attribute)
static java.lang.String	getParentDn(java.lang.String dn)
static java.lang.String	getRDNString(java.lang.String dn)
static java.lang.String	getRDNType(java.lang.String dn)
static java.lang.String	getRDNValue(java.lang.String dn)
static java.lang.String	getStringValue(LDAPEntry entry, AttributeDefinition attrDef, java.lang.String defaultValue) Returns the first String value of the attribute in the entry, if it there is one, otherwise the default value.
static java.lang.String	getStringValue(LDAPEntry entry, java.lang.String attributeName, java.lang.String defaultValue) Returns the first String value of the attribute in the entry, if it there is one, otherwise the default value.
static java.lang.String[]	getStringValues(LDAPEntry entry, AttributeDefinition attrDef) Returns a String array containing all the String values of the attribute in entry that has the specified name.
static java.lang.String[]	getStringValues(LDAPEntry entry, java.lang.String attributeName) Returns a String array containing all the String values of the attribute in entry that has the specified name.
static int	getXMLNode(LDAPEntry entry, AttributeDefinition attrDef, Document document) Tries to parse the value of the attribute into an XML tree.
static int	getXMLNode(LDAPEntry entry, java.lang.String attributeName, Document document) Tries to parse the value of the attribute into an XML tree.
static boolean	isDN(java.lang.String possibleDN) Returns true if the possibleDN is an actual LDAP Distinguished Name.
static boolean	ldapDNEqualIgnoreCase(java.lang.String firstDN, java.lang.String secondDN) Compare two ldap dns if they are equal ignoring case according to the LDAP specification (http://www.ietf.org/rfc/rfc4518.txt) and case ignoring (http://www.ietf.org/rfc/rfc3454.txt) matching rules.
static boolean	ldapEqualIgnoreCase(java.lang.String firstValue, java.lang.String secondValue) Compare two ldap attribute values if they are equal ignoring case according to the LDAP specification (http://www.ietf.org/rfc/rfc4518.txt) and case ignoring (http://www.ietf.org/rfc/rfc3454.txt) matching rules.
static java.lang.String	normalizeValueIgnoreCase(java.lang.String value) Normalizes an ldap attribute values according to the LDAP specification (http://www.ietf.org/rfc/rfc4518.txt) and case ignoring (http://www.ietf.org/rfc/rfc3454.txt) matching rules.
static java.lang.String	O(java.lang.String value)
static java.lang.String	O(java.lang.String value, java.lang.String parentDN)
static void	setBytesValue(LDAPEntry entry, AttributeDefinition attrDef, byte[] value) Sets / adds a new byte value to the ldap attribute for the given entry.

Methods inherited from class java.lang.Object

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

Method Detail

getStringValues

public static java.lang.String[] getStringValues(LDAPEntry entry,
                                                 java.lang.String attributeName)

Returns a String array containing all the String values of the attribute in entry that has the specified name.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attributeName - The name of the attribute to retrieve from the entry.

Returns:

An array of length 0 if the entry is null or the attribute is not in it, else an array containing all values of the attribute

getStringValues

public static java.lang.String[] getStringValues(LDAPEntry entry,
                                                 AttributeDefinition attrDef)

Returns a String array containing all the String values of the attribute in entry that has the specified name.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attrDef - The attribute to retrieve from the entry.

Returns:

An array of length 0 if the entry is null or the attribute is not in it, else an array containing all values of the attribute

getBytesValue

public static byte[] getBytesValue(LDAPEntry entry,
                                   java.lang.String attributeName)

Returns the first byte-array value of the attribute in entry that has the specified name.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attributeName - The name of the attribute to retrieve from the entry.

Returns:

An array of length 0 if the entry is null or the attribute is not in it, else an array containing all values of the attribute

getBytesValue

public static byte[] getBytesValue(LDAPEntry entry,
                                   AttributeDefinition attrDef)

Returns the first byte-array value of the attribute in entry that has the specified name.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attrDef - The attribute to retrieve from the entry.

Returns:

An array of length 0 if the entry is null or the attribute is not in it, else an array containing all values of the attribute

setBytesValue

public static void setBytesValue(LDAPEntry entry,
                                 AttributeDefinition attrDef,
                                 byte[] value)

Sets / adds a new byte value to the ldap attribute for the given entry.

Parameters:

entry - The LDAP entry where to set the attribute

attrDef - The attribute to set the byte for.

value - the byte[] value for the entry.

cloneEntry

public static LDAPEntry cloneEntry(LDAPEntry entry)

Return a copy of an LDAPEntry. This method can be used when you want todo directory.modify on an existing LDAP entry The directory needs a cloned node in order to send the right update. A sample on how to change an attribute: AttributeDefinition attrDef = SchemaDefinition.getCurrent().attrKeystore; LDAPEntry clonedEntry = LDAPUtil.cloneEntry(foundEntry); LDAPAttribute attribute = clonedEntry.getAttributeSet().getAttribute(getLDAPDisplayNameOnCurrentSchema(attrDef)); if (attribute != null) { clonedEntry.getAttributeSet().remove(attribute); } LDAPAttribute newAttribute = new LDAPAttribute(getLDAPDisplayNameOnCurrentSchema(attrDef), storeInBytes.toByteArray()); clonedEntry.getAttributeSet().add(newAttribute); try { directory.modify(clonedEntry); } catch (LDAPException e) { throw new DirectoryException("Failed to modify",e); }

Parameters:

entry - the LDAPEntry to be cloned

Returns:

the cloned LDAP entry

getStringValue

public static java.lang.String getStringValue(LDAPEntry entry,
                                              java.lang.String attributeName,
                                              java.lang.String defaultValue)

Returns the first String value of the attribute in the entry, if it there is one, otherwise the default value.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attributeName - The name of the attribute to retrieve from the entry.

defaultValue - The value returned if the entry is null, or the attribute is not in there, or there are no values in the attribute.

Returns:

The value.

getStringValue

public static java.lang.String getStringValue(LDAPEntry entry,
                                              AttributeDefinition attrDef,
                                              java.lang.String defaultValue)

Returns the first String value of the attribute in the entry, if it there is one, otherwise the default value.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attrDef - The attribute to retrieve from the entry.

defaultValue - The value returned if the entry is null, or the attribute is not in there, or there are no values in the attribute.

Returns:

The value.

addClassToAttrSet

public static void addClassToAttrSet(LDAPAttributeSet attrSet,
                                     ClassDefinition classDef)

Adds the 'objectclass' attribute for the given class definition and its super classes to the given attribute set.

Parameters:

attrSet - the attribute set to be extended.

classDef - the class to add

buildAttrSet

public static LDAPAttributeSet buildAttrSet(ClassDefinition classDef,
                                            LDAPUtil.AttrNameValue[] nameValuePairs)

Builds an attribute set given a class definition and a set of attribute name/value pairs.

Parameters:

classDef - the definition of the LDAP class

nameValuePairs - the attribute name/value pairs

Returns:

the attribute set

buildLDAPModificationArray

public static LDAPModification[] buildLDAPModificationArray(ClassDefinition classDef,
                                                            int modificationType,
                                                            LDAPUtil.AttrNameValue[] nameValuePairs)

Builds an LDAP modification array a class definition and a set of attribute name/value pairs.

Parameters:

classDef - the definition of the LDAP class

nameValuePairs - the attribute name/value pairs

Returns:

the LDAP modification array

containsStringValue

public static boolean containsStringValue(LDAPEntry entry,
                                          java.lang.String attributeName,
                                          java.lang.String expectedValue,
                                          boolean caseSensitive)

Indicates whether the entry contains an attribute that contains the expected value. The value is compared to all values in the attribute.

Parameters:

entry - The LDAP entry from which to check the attribute values (can be null).

attributeName - The name of the attribute to search in the entry.

expectedValue - The value to search for in the attribute

caseSensitive - Determines whether the comparison of values should be case-sensitive or not.

Returns:

True if the entry contains an attribute with the specified name that has the specified value, and false if the entry is null, or if it does not contain an attribute with the specified name, or if the attribute does not contain the specified value.

containsStringValue

public static boolean containsStringValue(LDAPEntry entry,
                                          AttributeDefinition attrDef,
                                          java.lang.String expected,
                                          boolean caseSensitive)

Indicates whether the entry contains an attribute that contains the expected value. The value is compared to all values in the attribute.

Parameters:

entry - The LDAP entry from which to check the attribute values (can be null).

attrDef - The attribute to search in the entry.

expected - The value to search for in the attribute

caseSensitive - Determines whether the comparison of values should be case-sensitive or not.

Returns:

True if the entry contains an attribute with the specified name that has the specified value, and false if the entry is null, or if it does not contain an attribute with the specified name, or if the attribute does not contain the specified value.

containsStringValue

public static boolean containsStringValue(LDAPAttribute attribute,
                                          java.lang.String expectedValue,
                                          boolean caseSensitive)

Indicates whether the entry contains an attribute that contains the expected value. The value is compared to all values in the attribute.

Parameters:

attribute - The LDAP attribute from which to check the attribute values (can be null).

expectedValue - The value to search for in the attribute

caseSensitive - Determines whether the comparison of values should be case-sensitive or not.

Returns:

True if the entry contains an attribute with the specified name that has the specified value, and false if the entry is null, or if it does not contain an attribute with the specified name, or if the attribute does not contain the specified value.

ldapDNEqualIgnoreCase

public static boolean ldapDNEqualIgnoreCase(java.lang.String firstDN,
                                            java.lang.String secondDN)

Compare two ldap dns if they are equal ignoring case according to the LDAP specification (http://www.ietf.org/rfc/rfc4518.txt) and case ignoring (http://www.ietf.org/rfc/rfc3454.txt) matching rules.

Parameters:

firstDN - a DN

secondDN - a DN

Returns:

true if the two dns are equal according to the ldap specification.

ldapEqualIgnoreCase

public static boolean ldapEqualIgnoreCase(java.lang.String firstValue,
                                          java.lang.String secondValue)

Compare two ldap attribute values if they are equal ignoring case according to the LDAP specification (http://www.ietf.org/rfc/rfc4518.txt) and case ignoring (http://www.ietf.org/rfc/rfc3454.txt) matching rules.

Parameters:

firstValue - an ldap attribute value

secondValue - an ldap attribute value

Returns:

true if the two values are equal according to the ldap specification.

normalizeValueIgnoreCase

public static java.lang.String normalizeValueIgnoreCase(java.lang.String value)

Normalizes an ldap attribute values according to the LDAP specification (http://www.ietf.org/rfc/rfc4518.txt) and case ignoring (http://www.ietf.org/rfc/rfc3454.txt) matching rules.

Parameters:

value - an ldap attribute value

Returns:

the value normalized according to the ldap specification.

getXMLNode

public static int getXMLNode(LDAPEntry entry,
                             java.lang.String attributeName,
                             Document document)

Tries to parse the value of the attribute into an XML tree. For this, the document object is used to parse. If the attribute is not present, 0 is returned. If the value of the attribute does not contain valid XML, an XML exception occurs during parsing. This exception is not thrown, but 0 is returned.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attributeName - The name of the attribute to retrieve from the entry.

document - The document context used to parse the XML tree.

Returns:

The xml node or 0 if no xml node could be created for the attribute.

getXMLNode

public static int getXMLNode(LDAPEntry entry,
                             AttributeDefinition attrDef,
                             Document document)

Tries to parse the value of the attribute into an XML tree. For this, the document object is used to parse. If the attribute is not present, 0 is returned. If the value of the attribute does not contain valid XML, an XML exception occurs during parsing. This exception is not thrown, but 0 is returned.

Parameters:

entry - The LDAP entry from which to retrieve the attribute (can be null).

attrDef - The attribute to retrieve from the entry.

document - The document context used to parse the XML tree.

Returns:

The xml node or 0 if no xml node could be created for the attribute.

isDN

public static boolean isDN(java.lang.String possibleDN)

Returns true if the possibleDN is an actual LDAP Distinguished Name. That is, it should be of the form 'cn=abc,cn=xyz, etc.'

Parameters:

possibleDN - the string that possibly contains an DN

Returns:

true if the possibleDN has the proper DN format, false otherwise

getEscapedFilter

public static java.lang.String getEscapedFilter(java.lang.String filter)

getCN

@Deprecated
public static java.lang.String getCN(java.lang.String dn)

Deprecated. Use getRDNValue(java.lang.String)

Returns:

The value of the first element for the given string ldapDN.

CN

public static java.lang.String CN(java.lang.String value)

O

public static java.lang.String O(java.lang.String value)

CN

public static java.lang.String CN(java.lang.String value,
                                  java.lang.String parentDN)

O

public static java.lang.String O(java.lang.String value,
                                 java.lang.String parentDN)

getRDNValue

public static java.lang.String getRDNValue(java.lang.String dn)

Returns:

The value of the first element for the given string ldapDN.

getRDNString

public static java.lang.String getRDNString(java.lang.String dn)

Returns:

The first element for the given string ldapDN.

getRDNType

public static java.lang.String getRDNType(java.lang.String dn)

Returns:

The type of the first element for the given string ldapDN.

getParentDn

public static java.lang.String getParentDn(java.lang.String dn)

Returns:

The first parent dn for the given dn. Returns null if there is no parent.

getLDAPDisplayNameOnCurrentSchema

public static java.lang.String getLDAPDisplayNameOnCurrentSchema(AttributeDefinition attribute)

getLdapDirectory

public static LDAPDirectory getLdapDirectory()

Returns:

the default LDAP directory instance

getDirectorySearchRoot

public static java.lang.String getDirectorySearchRoot()

Returns:

The directory search root of the default LDAP directory instance.

getEntry

public static LDAPEntry getEntry(LDAPDirectoryReader directoryReader,
                                 java.lang.String dn)

Searches for an LDAP entry with the given DN

Parameters:

directoryReader - the reader to use for searching

dn - The dn to fetch.

Returns:

The corresponding LDAP entry, or null if none could be found.

getEntry

public static LDAPEntry getEntry(LDAPDirectoryReader directoryReader,
                                 java.lang.String dn,
                                 java.lang.String filter)

Searches for an LDAP entry with the given DN

Parameters:

directoryReader - the reader to use for searching

dn - the dn to fetch.

filter - ldap filter dn have to conform to

Returns:

The corresponding LDAP entry, or null if none could be found.