org.sonar.api.user.RubyUserService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation

There is a newer version: 5.1

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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  02110-1301, USA.
 */
package org.sonar.api.user;

import org.sonar.api.ServerComponent;

import javax.annotation.CheckForNull;
import java.util.List;
import java.util.Map;

/**
 * @since 3.6
 */
public interface RubyUserService extends ServerComponent {

  @CheckForNull
  User findByLogin(String login);

  /**
   * Search for users
   * 
   * Optional parameters are:
   * 

   *   s to match all the logins or names containing this search query
   *   logins, as an array of strings (['simon', 'julien']) or a comma-separated list of logins ('simon,julien')
   *   includeDeactivated as a boolean. By Default deactivated users are excluded from query.
   * 
   */
  List find(Map params);
}