org.sonar.server.computation.ws.ComponentAction.java Source code

Introduction

Here is the source code for org.sonar.server.computation.ws.ComponentAction.java

Source

/*
 * 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.computation.ws;

import java.util.List;
import org.apache.ibatis.session.RowBounds;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.web.UserRole;
import org.sonar.core.util.Uuids;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.ce.CeActivityDto;
import org.sonar.db.ce.CeActivityQuery;
import org.sonar.db.ce.CeQueueDto;
import org.sonar.server.user.UserSession;
import org.sonar.server.ws.WsUtils;

import static org.sonarqube.ws.WsCe.ProjectResponse;

public class ComponentAction implements CeWsAction {

    public static final String PARAM_COMPONENT_UUID = "componentId";

    private final UserSession userSession;
    private final DbClient dbClient;
    private final TaskFormatter formatter;

    public ComponentAction(UserSession userSession, DbClient dbClient, TaskFormatter formatter) {
        this.userSession = userSession;
        this.dbClient = dbClient;
        this.formatter = formatter;
    }

    @Override
    public void define(WebService.NewController controller) {
        WebService.NewAction action = controller.createAction("component")
                .setDescription(
                        "Get the pending tasks, in-progress tasks and the last executed task of a given component "
                                + "(usually a project). Requires the administration permission on the component.")
                .setSince("5.2").setResponseExample(getClass().getResource("component-example.json"))
                .setHandler(this);

        action.createParam(PARAM_COMPONENT_UUID).setRequired(true).setExampleValue(Uuids.UUID_EXAMPLE_01);
    }

    @Override
    public void handle(Request wsRequest, Response wsResponse) throws Exception {
        String componentUuid = wsRequest.mandatoryParam(PARAM_COMPONENT_UUID);
        userSession.checkComponentUuidPermission(UserRole.USER, componentUuid);

        DbSession dbSession = dbClient.openSession(false);
        try {
            List<CeQueueDto> queueDtos = dbClient.ceQueueDao().selectByComponentUuid(dbSession, componentUuid);
            CeActivityQuery activityQuery = new CeActivityQuery().setComponentUuid(componentUuid)
                    .setOnlyCurrents(true);
            List<CeActivityDto> activityDtos = dbClient.ceActivityDao().selectByQuery(dbSession, activityQuery,
                    new RowBounds(0, 1));

            ProjectResponse.Builder wsResponseBuilder = ProjectResponse.newBuilder();
            wsResponseBuilder.addAllQueue(formatter.formatQueue(dbSession, queueDtos));
            if (activityDtos.size() == 1) {
                wsResponseBuilder.setCurrent(formatter.formatActivity(dbSession, activityDtos.get(0)));
            }
            WsUtils.writeProtobuf(wsResponseBuilder.build(), wsRequest, wsResponse);

        } finally {
            dbClient.closeSession(dbSession);
        }
    }
}