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     */
020    package org.sonar.api.security;
021    
022    import java.util.Collection;
023    
024    /**
025     * Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.
026     *
027     * @since 2.14
028     * @see SecurityRealm
029     */
030    public abstract class ExternalGroupsProvider {
031    
032      /**
033       * @return list of groups associated with specified user, or null if such user doesn't exist
034       * @throws RuntimeException in case of unexpected error such as connection failure
035       */
036      public abstract Collection<String> doGetGroups(String username);
037    
038    }