org.sonar.server.ce.ws.WorkerCountAction 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-2018 SonarSource SA
 * mailto:info 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.ce.ws;

import javax.annotation.Nullable;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.ce.configuration.WorkerCountProvider;
import org.sonar.server.user.UserSession;
import org.sonarqube.ws.Ce.WorkerCountResponse;

import static org.sonar.server.ws.WsUtils.writeProtobuf;
import static org.sonar.server.ce.ws.CeWsParameters.ACTION_WORKER_COUNT;

public class WorkerCountAction implements CeWsAction {

  private static final int DEFAULT_WORKER_COUNT = 1;

  private final UserSession userSession;
  private final WorkerCountProvider workerCountProvider;

  public WorkerCountAction(UserSession userSession, @Nullable WorkerCountProvider workerCountProvider) {
    this.userSession = userSession;
    this.workerCountProvider = workerCountProvider;
  }

  public WorkerCountAction(UserSession userSession) {
    this(userSession, null);
  }

  @Override
  public void define(WebService.NewController controller) {
    controller.createAction(ACTION_WORKER_COUNT)
      .setDescription("Return number of Compute Engine workers.
" +
        "Requires the system administration permission")
      .setResponseExample(getClass().getResource("worker_count-example.json"))
      .setSince("6.5")
      .setInternal(true)
      .setHandler(this);
  }

  @Override
  public void handle(Request wsRequest, Response wsResponse) throws Exception {
    userSession.checkIsSystemAdministrator();
    writeProtobuf(createResponse(), wsRequest, wsResponse);
  }

  private WorkerCountResponse createResponse(){
    WorkerCountResponse.Builder builder = WorkerCountResponse.newBuilder();
    if (workerCountProvider == null) {
      return builder
        .setValue(DEFAULT_WORKER_COUNT)
        .setCanSetWorkerCount(false)
        .build();
    }
    return builder
      .setValue(workerCountProvider.get())
      .setCanSetWorkerCount(true)
      .build();
  }

}