001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 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.wsclient.user;
021
022import org.sonar.wsclient.internal.EncodingUtils;
023
024import javax.annotation.Nullable;
025import java.util.HashMap;
026import java.util.Map;
027
028/**
029 * @since 3.6
030 */
031public class UserQuery {
032  static final String BASE_URL = "/api/users/search";
033
034  private final Map<String, Object> params = new HashMap<String, Object>();
035
036  private UserQuery() {
037  }
038
039  public static UserQuery create() {
040    return new UserQuery();
041  }
042
043  public UserQuery includeDeactivated() {
044    params.put("includeDeactivated", "true");
045    return this;
046  }
047
048  public UserQuery logins(String... s) {
049    params.put("logins", EncodingUtils.toQueryParam(s));
050    return this;
051  }
052
053  public UserQuery searchText(@Nullable String s) {
054    if (s != null) {
055      params.put("s", s);
056    } else {
057      params.remove("s");
058    }
059    return this;
060  }
061
062  Map<String, Object> urlParams() {
063    return params;
064  }
065}