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.user;
021    
022    import org.sonar.api.ServerComponent;
023    
024    import javax.annotation.CheckForNull;
025    import java.util.List;
026    import java.util.Map;
027    
028    /**
029     * @since 3.6
030     */
031    public interface RubyUserService extends ServerComponent {
032    
033      @CheckForNull
034      User findByLogin(String login);
035    
036      /**
037       * Search for users
038       * <p/>
039       * Optional parameters are:
040       * <ul>
041       *   <li><code>s</code> to match all the logins or names containing this search query</li>
042       *   <li><code>logins</code>, as an array of strings (['simon', 'julien']) or a comma-separated list of logins ('simon,julien')</li>
043       *   <li><code>includeDeactivated</code> as a boolean. By Default deactivated users are excluded from query.</li>
044       * </ul>
045       */
046      List<User> find(Map<String, Object> params);
047    }