/*
 * 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.sonar.scanner.bootstrap;

import java.util.List;
import java.util.Map;
import java.util.Set;
import org.sonar.scanner.mediumtest.LocalPlugin;

public interface PluginInstaller {

  /**
   * Loads/downloads all plugins that are installed on the server.
   * @return information about all installed plugins, grouped by key
   */
  Map<String, ScannerPlugin> installAllPlugins();

  /**
   * Gets the list of plugins that are not required for any specific languages and downloads them if not
   * already in local cache.
   * @return information about all installed plugins, grouped by key
   */
  Map<String, ScannerPlugin> installRequiredPlugins();

  /**
   * Loads/downloads plugins that are required for the given languageKeys.
   * @return information about any plugins installed by this call, grouped by key
   */
  Map<String, ScannerPlugin> installPluginsForLanguages(Set<String> languageKeys);

  /**
   * Used only by medium tests. Installs required plugins (phase 1)
   * @see org.sonar.scanner.mediumtest.ScannerMediumTester
   */
  List<LocalPlugin> installLocals();

  /**
   * Used only by medium tests. Installs optional plugins (phase 2)
   * @see org.sonar.scanner.mediumtest.ScannerMediumTester
   */
  List<LocalPlugin> installOptionalLocals(Set<String> languageKeys);
}
