src/org/jsecurity/realm/ldap/LdapUtils.java

/*
 * Copyright 2005-2008 Jeremy Haile
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jsecurity.realm.ldap;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.ldap.LdapContext;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

/**
 * Utility class providing static methods to make working with LDAP
 * easier.
 *
 * @since 0.2
 * @author Jeremy Haile
 */
public class LdapUtils {

    /**
     * Commons logger.
     */
    private static final Log log = LogFactory.getLog(LdapUtils.class);

    /**
     *  Private constructor to prevent instantiation
     */
    private LdapUtils() {}

    /**
     * Closes an LDAP context, logging any errors, but not throwing 
     * an exception if there is a failure.
     * @param ctx the LDAP context to close.
     */
    public static void closeContext(LdapContext ctx) {
        try {
            if (ctx != null) {
                ctx.close();
            }
        } catch (NamingException e) {
            if( log.isErrorEnabled() ) {
                log.error("Exception while closing LDAP context. ", e);
            }
        }
    }


    /**
     * Helper method used to retrieve all attribute values from a particular context attribute.
     * @param attr the LDAP attribute.
     * @return the values of the attribute.
     * @throws javax.naming.NamingException if there is an LDAP error while reading the values.
     */
    public static Collection<String> getAllAttributeValues( Attribute attr ) throws NamingException {
        Set<String> values = new HashSet<String>();
        for ( NamingEnumeration e = attr.getAll(); e.hasMore(); ) {
            String value = (String)e.next();
            values.add( value );
        }
        return values;
    }


}