org.sonarqube.ws.client.system.SystemService 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
There is a newer version: 10.7.0.96327
/*
 * 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.system;

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.PostRequest;
import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.System.HealthResponse;
import org.sonarqube.ws.System.StatusResponse;

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

  public SystemService(WsConnector wsConnector) {
    super(wsConnector, "api/system");
  }

  /**
   *
   * This is part of the internal API.
   * This is a POST request.
   * @see Further information about this action online (including a response example)
   * @since 5.2
   */
  public void changeLogLevel(ChangeLogLevelRequest request) {
    call(
      new PostRequest(path("change_log_level"))
        .setParam("level", request.getLevel())
        .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.2
   */
  public String dbMigrationStatus() {
    return call(
      new GetRequest(path("db_migration_status"))
        .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 6.6
   */
  public HealthResponse health() {
    return call(
      new GetRequest(path("health")),
      HealthResponse.parser());
  }

  /**
   *
   * 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.1
   */
  public String info() {
    return call(
      new GetRequest(path("info"))
        .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.2
   */
  public String logs(LogsRequest request) {
    return call(
      new GetRequest(path("logs"))
        .setParam("process", request.getProcess())
        .setMediaType(MediaTypes.JSON)
      ).content();
  }

  /**
   *
   * This is part of the internal API.
   * This is a POST request.
   * @see Further information about this action online (including a response example)
   * @since 5.2
   */
  public String migrateDb() {
    return call(
      new PostRequest(path("migrate_db"))
        .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 6.3
   */
  public String ping() {
    return call(
      new GetRequest(path("ping"))
        .setMediaType(MediaTypes.JSON)
      ).content();
  }

  /**
   *
   * This is part of the internal API.
   * This is a POST request.
   * @see Further information about this action online (including a response example)
   * @since 4.3
   */
  public void restart() {
    call(
      new PostRequest(path("restart"))
        .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.2
   */
  public StatusResponse status() {
    return call(
      new GetRequest(path("status")),
      StatusResponse.parser());
  }

  /**
   *
   * 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.2
   */
  public String upgrades() {
    return call(
      new GetRequest(path("upgrades"))
        .setMediaType(MediaTypes.JSON)
      ).content();
  }
}