org.sonar.server.component.ws.ResourcesWs 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.component.ws;

import com.google.common.io.Resources;
import org.sonar.api.server.ws.RailsHandler;
import org.sonar.api.server.ws.WebService;

import static org.sonar.server.ws.KeyExamples.KEY_PROJECT_EXAMPLE_001;

public class ResourcesWs implements WebService {

  @Override
  public void define(Context context) {
    NewController controller = context.createController("api/resources")
      .setDescription("Former components web service")
      .setSince("2.10");

    defineIndexAction(controller);
    defineSearchAction(controller);

    controller.done();
  }

  private void defineIndexAction(NewController controller) {
    NewAction action = controller.createAction("index")
      .setDescription("Gets a list of components. Requires Browse permission on resource.
" +
        "The web service is deprecated and you're invited to use the alternatives: " +
        "" +
        "if you need one component without measures: api/components/show" +
        "if you need one component with measures: api/measures/component" +
        "if you need several components without measures: api/components/tree" +
        "if you need several components with measures: api/measures/component_tree" +
        "" +
        "When you provide one metric, the number of results is limited to 500. When several metrics are provided, the number of measures is limited to 10000. " +
        "The number of components is limited to 500." +
        "This is a known limitation and it won't be fixed. You're invited to use the alternatives suggested above.")
      .setSince("2.10")
      .setDeprecatedSince("5.4")
      .setHandler(RailsHandler.INSTANCE)
      .setResponseExample(Resources.getResource(this.getClass(), "resources-example-index.json"));

    action.createParam("resource")
      .setDescription("id or key of the resource")
      .setExampleValue(KEY_PROJECT_EXAMPLE_001);

    action.createParam("metrics")
      .setDescription("Comma-separated list of metric keys/ids. " +
        "Load measures on selected metrics. If only one metric is set, then measures are ordered by value")
      .setExampleValue("lines,blocker_violations");

    action.createParam("depth")
      .setDescription("Used only when resource is set:
" +
        "" +
        "0: only selected resource" +
        "-1: all children, including selected resource" +
        ">0: depth toward the selected resource" +
        "")
      .setDefaultValue("0")
      .setExampleValue("-1");

    action.createParam("scopes")
      .setDescription("Comma-separated list of scopes:
" +
        "" +
        "PRJ: project/module" +
        "DIR: directory (like Java package)" +
        "FIL: file" +
        "")
      .setExampleValue("PRJ,DIR");

    action.createParam("qualifiers")
      .setDescription("Comma-separated list of qualifiers:
" +
        "" +
        "VW: view" +
        "SVW: sub-view" +
        "TRK: project" +
        "BRC: module" +
        "UTS: unit test" +
        "DIR: directory" +
        "FIL: file" +
        "DEV: developer" +
        "")
      .setExampleValue("TRK,BRC");

    action.createParam("verbose")
      .setDescription("Add some data to response")
      .setBooleanPossibleValues()
      .setDefaultValue(String.valueOf(false));

    action.createParam("limit")
      .setDescription("Limit the number of results. Only used if one metric, and only one, is set")
      .setExampleValue("10");

    action.createParam("includetrends")
      .setDescription("Include period variations in response: add nodes <p*> for period variations")
      .setDefaultValue(String.valueOf(false))
      .setBooleanPossibleValues();

    action.createParam("includealerts")
      .setDescription("Include alerts data: add nodes <alert> (ERROR, WARN, OK) and <alert_text>")
      .setBooleanPossibleValues()
      .setDefaultValue(String.valueOf(false));

    action.createParam("rules")
      .setDescription("Filter on rules: setting it to true will return rules id and rule name for measure having such info " +
        "(such as 'blocker_violations', 'critical_violations', ..., 'new_blocker_violations', ...). Possible values: true | false | list of rule ids")
      .setBooleanPossibleValues()
      .setDefaultValue(String.valueOf(true));

    RailsHandler.addFormatParam(action);
  }

  private void defineSearchAction(NewController controller) {
    NewAction action = controller.createAction("search")
      .setDescription("Search for components")
      .setSince("3.3")
      .setDeprecatedSince("5.4")
      .addPagingParams(10)
      .setInternal(true)
      .setHandler(RailsHandler.INSTANCE)
      .setResponseExample(Resources.getResource(this.getClass(), "resources-example-search.json"));

    action.createParam("s")
      .setDescription("To filter on resources containing a specified text in their name")
      .setExampleValue("sonar");

    action.createParam("display_key")
      .setDescription("Return the resource key instead of the resource id")
      .setBooleanPossibleValues()
      .setDefaultValue(String.valueOf(false));

    action.createParam("q")
      .setDescription("Comma-separated list of qualifiers")
      .setExampleValue("TRK,BRC");

    action.createParam("qp")
      .setDescription("Resource Property")
      .setExampleValue("supportsMeasureFilters");

    action.createParam("f")
      .setDescription("If 's2', then it will return a select2 compatible format")
      .setExampleValue("s2");

    RailsHandler.addJsonOnlyFormatParam(action);
  }

}