org.sonar.server.qualitygate.ws.QGatesShowAction.java Source code

Introduction

Here is the source code for org.sonar.server.qualitygate.ws.QGatesShowAction.java

Source

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

import com.google.common.io.Resources;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.RequestHandler;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.core.qualitygate.db.QualityGateConditionDto;
import org.sonar.core.qualitygate.db.QualityGateDto;
import org.sonar.server.exceptions.BadRequestException;
import org.sonar.server.qualitygate.QualityGates;

import javax.annotation.Nullable;

import java.util.Collection;

public class QGatesShowAction implements RequestHandler {

    private final QualityGates qualityGates;

    public QGatesShowAction(QualityGates qualityGates) {
        this.qualityGates = qualityGates;
    }

    void define(WebService.NewController controller) {
        WebService.NewAction action = controller.createAction("show")
                .setDescription("Display the details of a quality gate").setSince("4.3")
                .setResponseExample(Resources.getResource(this.getClass(), "example-show.json")).setHandler(this);

        action.createParam(QGatesWs.PARAM_ID)
                .setDescription("ID of the quality gate. Either id or name must be set").setExampleValue("1");

        action.createParam(QGatesWs.PARAM_NAME)
                .setDescription("Name of the quality gate. Either id or name must be set")
                .setExampleValue("My Quality Gate");
    }

    @Override
    public void handle(Request request, Response response) {
        Long qGateId = request.paramAsLong(QGatesWs.PARAM_ID);
        String qGateName = request.param(QGatesWs.PARAM_NAME);
        checkOneOfIdOrNamePresent(qGateId, qGateName);

        QualityGateDto qGate = qGateId == null ? qualityGates.get(qGateName) : qualityGates.get(qGateId);
        qGateId = qGate.getId();

        JsonWriter writer = response.newJsonWriter().beginObject().prop(QGatesWs.PARAM_ID, qGate.getId())
                .prop(QGatesWs.PARAM_NAME, qGate.getName());
        Collection<QualityGateConditionDto> conditions = qualityGates.listConditions(qGateId);
        if (!conditions.isEmpty()) {
            writer.name("conditions").beginArray();
            for (QualityGateConditionDto condition : conditions) {
                QGatesWs.writeQualityGateCondition(condition, writer);
            }
            writer.endArray();
        }
        writer.endObject().close();
    }

    private void checkOneOfIdOrNamePresent(@Nullable Long qGateId, @Nullable String qGateName) {
        if (qGateId == null && qGateName == null) {
            throw new BadRequestException("Either one of 'id' or 'name' is required.");
        } else if (qGateId != null && qGateName != null) {
            throw new BadRequestException("Only one of 'id' or 'name' must be provided.");
        }
    }

}