com.communote.server.core.common.ldap

Class LdapUtils

java.lang.Object

com.communote.server.core.common.ldap.LdapUtils

public class LdapUtils
extends Object

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static void	closeNamingEnumeration(NamingEnumeration<?> enumeration) Close a naming enumeration to free up resources.
static String	convertToByteFormatString(byte[] bytes) Converts the bytes to a string in LDAP bytes format.
static boolean	dnConformsToSearchBaseDefinitions(String dn, Collection<LdapSearchBaseDefinition> searchBaseDefs) Tests whether a DN conforms to at least on of the search bases.
static String	escapeLdapSearchFilterValue(String value) Escapes an LDAP search filter value according to RFC 2254 (Section 4).
static List<String>	getAttributeValues(Attributes attributes, String ldapAttributeName) Returns the values for the named LDAP attribute.
static ExternalUserVO	queryUserByName(String emailOrAlias) Do an LDAP query for a user by email or alias.
static void	setSynchronizationFields(ExternalUserVO userVO) Sets the fields of the user to be updated.
static Pair<String,String>	splitAfterFirstRdn(String dn) Strips the first RDN from a DN and returns a pair where the left element is the stripped of RDN and the right element holds the rest.

Methods inherited from class java.lang.Object

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

Method Detail

closeNamingEnumeration

public static void closeNamingEnumeration(NamingEnumeration<?> enumeration)

Close a naming enumeration to free up resources.

Parameters:

enumeration - the enumeration to close. If null, this method does nothing.

convertToByteFormatString

public static String convertToByteFormatString(byte[] bytes)

Converts the bytes to a string in LDAP bytes format. This string will be a backslash separated concatenation of the hexadecimal value of each bytes, e.g. '\0a\0b\99\ff'.

Parameters:

bytes - the bytes to convert

Returns:

the string representation

dnConformsToSearchBaseDefinitions

public static boolean dnConformsToSearchBaseDefinitions(String dn,
                                                        Collection<LdapSearchBaseDefinition> searchBaseDefs)

Tests whether a DN conforms to at least on of the search bases. This ignores the case for the attribute names.

Parameters:

dn - the DN to test

searchBaseDefs - the search base definition

Returns:

true if the DN conforms to at least on of the search bases, false otherwise

escapeLdapSearchFilterValue

public static String escapeLdapSearchFilterValue(String value)

Escapes an LDAP search filter value according to RFC 2254 (Section 4).

Parameters:

value - the value to be escaped

Returns:

the escaped value

getAttributeValues

public static List<String> getAttributeValues(Attributes attributes,
                                              String ldapAttributeName)
                                       throws LdapAttributeMappingException

Returns the values for the named LDAP attribute. If the LDAP attribute is not contained null is returned. If the attribute has no values the list will be empty. If one of the values is null an empty string will be added to the list.

Parameters:

attributes - the attributes from which the value should be extracted

ldapAttributeName - the name of the attribute in LDAP

Returns:

the list of values converted to strings

Throws:

LdapAttributeMappingException - if there was an error while retrieving the value

queryUserByName

public static ExternalUserVO queryUserByName(String emailOrAlias)

Do an LDAP query for a user by email or alias.

Parameters:

emailOrAlias - email or alias of LDAP user

Returns:

the VO or null if not found

setSynchronizationFields

public static void setSynchronizationFields(ExternalUserVO userVO)

Sets the fields of the user to be updated.

Parameters:

userVO - the VO

splitAfterFirstRdn

public static Pair<String,String> splitAfterFirstRdn(String dn)

Strips the first RDN from a DN and returns a pair where the left element is the stripped of RDN and the right element holds the rest. In case there is no remainder the right element will be null. Example DN 'cn=abc,O=u,OU=dc' will be split into 'cn=abc' and 'O=u,OU=dc'

Parameters:

dn - the DN to split

Returns:

A pair where the left element is the stripped of RDN and the right element holds the rest.