001/* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * SonarQube is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020package org.sonar.api.security; 021 022import java.util.Collection; 023import javax.servlet.http.HttpServletRequest; 024 025/** 026 * Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses. 027 * 028 * @see SecurityRealm 029 * @since 2.14 030 */ 031public abstract class ExternalGroupsProvider { 032 033 /** 034 * @return list of groups associated with specified user, or null if such user doesn't exist 035 * @throws RuntimeException in case of unexpected error such as connection failure 036 * @deprecated replaced by {@link #doGetGroups(org.sonar.api.security.ExternalGroupsProvider.Context)} since v. 5.2 037 */ 038 @Deprecated 039 public Collection<String> doGetGroups(String username) { 040 return null; 041 } 042 043 /** 044 * Override this method in order to load user group information. 045 * 046 * @return list of groups associated with specified user, or null if such user doesn't exist 047 * @throws RuntimeException in case of unexpected error such as connection failure 048 * @since 5.2 049 */ 050 public Collection<String> doGetGroups(Context context) { 051 return doGetGroups(context.getUsername()); 052 } 053 054 public static final class Context { 055 private String username; 056 private HttpServletRequest request; 057 058 public Context(String username, HttpServletRequest request) { 059 this.username = username; 060 this.request = request; 061 } 062 063 public String getUsername() { 064 return username; 065 } 066 067 public HttpServletRequest getRequest() { 068 return request; 069 } 070 } 071}