org.sonar.api.platform.PluginRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation

There is a newer version: 5.1

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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.api.platform;

import org.sonar.api.BatchComponent;
import org.sonar.api.Plugin;
import org.sonar.api.ServerComponent;

import javax.annotation.CheckForNull;
import java.util.Collection;

public interface PluginRepository extends BatchComponent, ServerComponent {
  @CheckForNull
  Plugin getPlugin(String key);

  /**
   * Metadata of installed plugins. Metadata includes all the fields available in update center
   * (plugin key, name, version, description, license, ...) and some technical information like
   * list of embedded libraries and classloader strategy.
   * 
   * @since 2.9
   */
  Collection getMetadata();

  /**
   * Search for an installed plugin. Returns null if the plugin is not installed.
   * @since 2.9
   */
  @CheckForNull
  PluginMetadata getMetadata(String pluginKey);
}