org.sonar.plugins.ldap.LdapGroupsProvider Maven / Gradle / Ivy

Go to download
/*
 * Sonar LDAP Plugin
 * Copyright (C) 2009 SonarSource
 * [email protected]
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.ldap;

import com.google.common.collect.Sets;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.security.ExternalGroupsProvider;
import org.sonar.api.utils.SonarException;

import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attributes;
import javax.naming.directory.SearchResult;

import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;

/**
 * @author Evgeny Mandrikov
 */
public class LdapGroupsProvider extends ExternalGroupsProvider {

  private static final Logger LOG = LoggerFactory.getLogger(LdapGroupsProvider.class);

  private final LdapContextFactory contextFactory;
  private final LdapUserMapping userMapping;
  private final LdapGroupMapping groupMapping;

  public LdapGroupsProvider(LdapContextFactory contextFactory, LdapUserMapping userMapping, LdapGroupMapping groupMapping) {
    this.contextFactory = contextFactory;
    this.userMapping = userMapping;
    this.groupMapping = groupMapping;
  }

  /**
   * @throws SonarException if unable to retrieve groups
   */
  public Collection doGetGroups(String username) {
    try {
      LOG.debug("Requesting groups for user {}", username);

      SearchResult searchResult = userMapping.createSearch(contextFactory, username)
          .returns(groupMapping.getRequiredUserAttributes())
          .findUnique();
      if (searchResult == null) {
        // user not found
        return Collections.emptyList();
      }

      NamingEnumeration result = groupMapping.createSearch(contextFactory, searchResult)
          .find();
      HashSet groups = Sets.newHashSet();
      while (result.hasMoreElements()) {
        SearchResult obj = (SearchResult) result.nextElement();
        Attributes attributes = obj.getAttributes();
        String groupId = (String) attributes.get(groupMapping.getIdAttribute()).get();
        groups.add(groupId);
      }
      return groups;
    } catch (NamingException e) {
      // just in case if Sonar silently swallowed exception
      LOG.debug(e.getMessage(), e);
      throw new SonarException("Unable to retrieve groups for user " + username, e);
    }
  }

}