org.sonarqube.ws.client.sources.SourcesService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-ws Show documentation
Open source platform for continuous inspection of code quality
The newest version!
/*
 * SonarQube
 * Copyright (C) 2009-2024 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.sonarqube.ws.client.sources;

import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
import org.sonarqube.ws.client.WsConnector;

/**
 * @see Further information about this web service online
 */
@Generated("sonar-ws-generator")
public class SourcesService extends BaseService {

  public SourcesService(WsConnector wsConnector) {
    super(wsConnector, "api/sources");
  }

  /**
   *
   * This is part of the internal API.
   * This is a GET request.
   * @see Further information about this action online (including a response example)
   * @since 5.0
   */
  public String index(IndexRequest request) {
    return call(
      new GetRequest(path("index"))
        .setParam("from", request.getFrom())
        .setParam("resource", request.getResource())
        .setParam("to", request.getTo())
        .setMediaType(MediaTypes.JSON)
      ).content();
  }

  /**
   *
   * This is part of the internal API.
   * This is a GET request.
   * @see Further information about this action online (including a response example)
   * @since 5.0
   */
  public String issueSnippets(IssueSnippetsRequest request) {
    return call(
      new GetRequest(path("issue_snippets"))
        .setParam("issueKey", request.getIssueKey())
        .setMediaType(MediaTypes.JSON)
    ).content();
  }

  /**
   *
   * This is part of the internal API.
   * This is a GET request.
   * @see Further information about this action online (including a response example)
   * @since 5.0
   */
  public String lines(LinesRequest request) {
    return call(
      new GetRequest(path("lines"))
        .setParam("branch", request.getBranch())
        .setParam("from", request.getFrom())
        .setParam("key", request.getKey())
        .setParam("pullRequest", request.getPullRequest())
        .setParam("to", request.getTo())
        .setParam("uuid", request.getUuid())
        .setMediaType(MediaTypes.JSON)
      ).content();
  }

  /**
   *
   * This is part of the internal API.
   * This is a GET request.
   * @see Further information about this action online (including a response example)
   * @since 5.0
   */
  public String raw(RawRequest request) {
    return call(
      new GetRequest(path("raw"))
        .setParam("branch", request.getBranch())
        .setParam("key", request.getKey())
        .setParam("pullRequest", request.getPullRequest())
        .setMediaType(MediaTypes.JSON)
      ).content();
  }

  /**
   *
   * This is part of the internal API.
   * This is a GET request.
   * @see Further information about this action online (including a response example)
   * @since 4.4
   */
  public String scm(ScmRequest request) {
    return call(
      new GetRequest(path("scm"))
        .setParam("commits_by_line", request.getCommitsByLine())
        .setParam("from", request.getFrom())
        .setParam("key", request.getKey())
        .setParam("to", request.getTo())
        .setMediaType(MediaTypes.JSON)
      ).content();
  }

  /**
   *
   * This is part of the internal API.
   * This is a GET request.
   * @see Further information about this action online (including a response example)
   * @since 4.4
   */
  public String show(ShowRequest request) {
    return call(
      new GetRequest(path("show"))
        .setParam("from", request.getFrom())
        .setParam("key", request.getKey())
        .setParam("to", request.getTo())
        .setMediaType(MediaTypes.JSON)
      ).content();
  }
}