org.sonar.plugins.ldap.LdapUsersProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-ldap-plugin Show documentation
Show all versions of sonar-ldap-plugin Show documentation
Delegates authentication to LDAP.
The newest version!
/*
* 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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.security.ExternalUsersProvider;
import org.sonar.api.security.UserDetails;
import org.sonar.api.utils.SonarException;
import javax.annotation.Nullable;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.SearchResult;
import java.util.Map;
/**
* @author Evgeny Mandrikov
*/
public class LdapUsersProvider extends ExternalUsersProvider {
private static final Logger LOG = LoggerFactory.getLogger(LdapUsersProvider.class);
private final Map contextFactories;
private final Map userMappings;
public LdapUsersProvider(Map contextFactories, Map userMappings) {
this.contextFactories = contextFactories;
this.userMappings = userMappings;
}
private static String getAttributeValue(@Nullable Attribute attribute) throws NamingException {
if (attribute == null) {
return "";
}
return (String) attribute.get();
}
/**
* @return details for specified user, or null if such user doesn't exist
* @throws SonarException if unable to retrieve details
*/
public UserDetails doGetUserDetails(String username) {
LOG.debug("Requesting details for user {}", username);
// If there are no userMappings available, we can not retrieve user details.
if (userMappings.isEmpty()) {
String errorMessage = "Unable to retrieve details for user " + username + ": No user mapping found.";
LOG.debug(errorMessage);
throw new SonarException(errorMessage);
}
UserDetails details = null;
SonarException sonarException = null;
for (String serverKey : userMappings.keySet()) {
SearchResult searchResult = null;
try {
searchResult = userMappings.get(serverKey).createSearch(contextFactories.get(serverKey), username)
.returns(userMappings.get(serverKey).getEmailAttribute(), userMappings.get(serverKey).getRealNameAttribute())
.findUnique();
} catch (NamingException e) {
// just in case if Sonar silently swallowed exception
LOG.debug(e.getMessage(), e);
sonarException = new SonarException("Unable to retrieve details for user " + username + " in " + serverKey, e);
}
if (searchResult != null) {
try {
details = mapUserDetails(serverKey, searchResult);
// if no exceptions occur, we found the user and mapped his details.
break;
} catch (NamingException e) {
// just in case if Sonar silently swallowed exception
LOG.debug(e.getMessage(), e);
sonarException = new SonarException("Unable to retrieve details for user " + username + " in " + serverKey, e);
}
} else {
// user not found
LOG.debug("User {} not found in " + serverKey, username);
continue;
}
}
if (details == null && sonarException != null) {
// No user found and there is an exception so there is a reason the user could not be found.
throw sonarException;
}
return details;
}
/**
* Map the properties from LDAP to the {@link UserDetails}
*
* @param serverKey the LDAP index so we use the correct {@link LdapUserMapping}
* @return If no exceptions are thrown, a {@link UserDetails} object containing the values from LDAP.
* @throws NamingException In case the communication or mapping to the LDAP server fails.
*/
private UserDetails mapUserDetails(String serverKey, SearchResult searchResult) throws NamingException {
Attributes attributes = searchResult.getAttributes();
UserDetails details;
details = new UserDetails();
details.setName(getAttributeValue(attributes.get(userMappings.get(serverKey).getRealNameAttribute())));
details.setEmail(getAttributeValue(attributes.get(userMappings.get(serverKey).getEmailAttribute())));
return details;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy