All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonarsource.scanner.lib.ScannerProperties Maven / Gradle / Ivy

/*
 * SonarScanner Java Library
 * Copyright (C) 2011-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.sonarsource.scanner.lib;

/**
 * Properties used by the scanner bootstrapper.
 * See documentation
 * for more details.
 */
public final class ScannerProperties {

  private ScannerProperties() {
    // only constants
  }

  /**
   * URL of the Sonar server, default to SonarCloud
   */
  public static final String HOST_URL = "sonar.host.url";

  /**
   * Base URL for all REST-compliant API calls.
   */
  public static final String API_BASE_URL = "sonar.scanner.apiBaseUrl";

  /**
   * URL of the SonarCloud server, default to https://sonarcloud.io. Useful for testing purposes.
   */
  public static final String SONARCLOUD_URL = "sonar.scanner.sonarcloudUrl";

  /**
   * Working directory containing generated reports and temporary data.
   */
  public static final String WORK_DIR = "sonar.working.directory";

  /**
   * Base dir for various locations (cache, SSL, …). Default to ~/.sonar
   */
  public static final String SONAR_USER_HOME = "sonar.userHome";

  /**
   * Authentication token for connecting to the Sonar server.
   */
  public static final String SONAR_TOKEN = "sonar.token";

  /**
   * Authentication username for connecting to the Sonar server.
   */
  public static final String SONAR_LOGIN = "sonar.login";

  /**
   * Authentication password for connecting to the Sonar server.
   */
  public static final String SONAR_PASSWORD = "sonar.password";

  /**
   * HTTP client properties
   */
  public static final String SONAR_SCANNER_PROXY_PORT = "sonar.scanner.proxyPort";
  public static final String SONAR_SCANNER_CONNECT_TIMEOUT = "sonar.scanner.connectTimeout";
  public static final String SONAR_SCANNER_SOCKET_TIMEOUT = "sonar.scanner.socketTimeout";
  public static final String SONAR_SCANNER_RESPONSE_TIMEOUT = "sonar.scanner.responseTimeout";
  public static final String SONAR_SCANNER_PROXY_HOST = "sonar.scanner.proxyHost";
  public static final String SONAR_SCANNER_PROXY_USER = "sonar.scanner.proxyUser";
  public static final String SONAR_SCANNER_PROXY_PASSWORD = "sonar.scanner.proxyPassword";
  public static final String SONAR_SCANNER_KEYSTORE_PATH = "sonar.scanner.keystorePath";
  public static final String SONAR_SCANNER_KEYSTORE_PASSWORD = "sonar.scanner.keystorePassword";
  public static final String SONAR_SCANNER_TRUSTSTORE_PATH = "sonar.scanner.truststorePath";
  public static final String SONAR_SCANNER_TRUSTSTORE_PASSWORD = "sonar.scanner.truststorePassword";

  /**
   * Skip analysis.
   */
  public static final String SKIP = "sonar.scanner.skip";

  /**
   * Path of the java executable to be used by the scanner-engine.
   */
  public static final String JAVA_EXECUTABLE_PATH = "sonar.scanner.javaExePath";

  /**
   * Flag to skip the JRE provisioning.
   */
  public static final String SKIP_JRE_PROVISIONING = "sonar.scanner.skipJreProvisioning";

  /**
   * Name of the operating system to be used for JRE provisioning.
   * See {@link org.sonarsource.scanner.lib.internal.OsResolver.OperatingSystem} for possible values.
   */
  public static final String SCANNER_OS = "sonar.scanner.os";

  /**
   * Name of the architecture to be used for JRE provisioning.
   */
  public static final String SCANNER_ARCH = "sonar.scanner.arch";

  /**
   * Java options to be used by the scanner-engine.
   */
  public static final String SCANNER_JAVA_OPTS = "sonar.scanner.javaOpts";
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy