org.sonar.server.batch.UsersAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.server.batch;

import java.io.IOException;
import java.io.OutputStream;
import java.util.Iterator;
import java.util.List;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.scanner.protocol.input.ScannerInput;
import org.sonar.server.user.UserSession;
import org.sonar.server.user.index.UserDoc;
import org.sonar.server.user.index.UserIndex;
import org.sonarqube.ws.MediaTypes;

public class UsersAction implements BatchWsAction {

  private static final String PARAM_LOGINS = "logins";

  private final UserIndex userIndex;
  private final UserSession userSession;

  public UsersAction(UserIndex userIndex, UserSession userSession) {
    this.userIndex = userIndex;
    this.userSession = userSession;
  }

  @Override
  public void define(WebService.NewController controller) {
    WebService.NewAction action = controller.createAction("users")
      .setDescription("Return user details.")
      .setSince("5.2")
      .setResponseExample(getClass().getResource("users-example.proto"))
      .setInternal(true)
      .setHandler(this);

    action
      .createParam(PARAM_LOGINS)
      .setRequired(true)
      .setDescription("A comma separated list of user logins")
      .setExampleValue("ada.lovelace,grace.hopper");
  }

  @Override
  public void handle(Request request, Response response) throws Exception {
    userSession.checkLoggedIn();
    List logins = request.mandatoryParamAsStrings(PARAM_LOGINS);

    response.stream().setMediaType(MediaTypes.PROTOBUF);
    ScannerInput.User.Builder userBuilder = ScannerInput.User.newBuilder();
    OutputStream output = response.stream().output();
    try {
      for (Iterator userDocIterator = userIndex.selectUsersForBatch(logins); userDocIterator.hasNext();) {
        handleUser(userDocIterator.next(), userBuilder, output);
      }
    } finally {
      output.close();
    }
  }

  private static void handleUser(UserDoc user, ScannerInput.User.Builder userBuilder, OutputStream out) {
    userBuilder
      .clear()
      .setLogin(user.login())
      .setName(user.name());
    try {
      userBuilder.build().writeDelimitedTo(out);
    } catch (IOException e) {
      throw new IllegalStateException("Unable to serialize user", e);
    }
    userBuilder.clear();
  }
}