Package com.intellij.ide.plugins

Class PluginManagerCore

java.lang.Object

com.intellij.ide.plugins.PluginManagerCore

public final class PluginManagerCore
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginManagerCore.EssentialPluginMissingException

Field Summary

Fields

Modifier and Type	Field and Description
static PluginId	CORE_ID
static java.lang.String	CORE_PLUGIN_ID
static java.lang.String	DISABLE
static java.lang.String	DISABLED_PLUGINS_FILENAME
static java.lang.String	EDIT
static java.lang.String	ENABLE
static java.lang.String	IDEA_IS_INTERNAL_PROPERTY
static boolean	isUnitTestMode
static PluginId	JAVA_PLUGIN_ID
static java.lang.String	META_INF
static java.lang.String	ourPluginError
static java.util.Set<PluginId>	ourPluginsToDisable
static java.util.Set<PluginId>	ourPluginsToEnable
static java.lang.String	PLUGIN_XML
static java.lang.String	PLUGIN_XML_PATH
static java.lang.String	VENDOR_JETBRAINS

Constructor Summary

Constructors

Constructor and Description
PluginManagerCore()

Method Summary

Modifier and Type	Method and Description
static void	addDisablePluginListener(java.lang.Runnable listener) Deprecated. Use PluginManager.addDisablePluginListener(java.lang.Runnable)
static boolean	arePluginsInitialized()
static java.util.Map<PluginId,IdeaPluginDescriptorImpl>	buildPluginIdMap()
static java.util.Map<PluginId,IdeaPluginDescriptorImpl>	buildPluginIdMap(java.util.List<IdeaPluginDescriptorImpl> descriptors)
static PluginException	createPluginException(java.lang.String errorMessage, java.lang.Throwable cause, java.lang.Class<?> pluginClass) This is an internal method, use PluginException.createByClass(String, Throwable, Class) instead.
static java.util.Set<PluginId>	disabledPlugins()
static boolean	disablePlugin(PluginId id)
static boolean	disablePlugin(java.lang.String id) Deprecated. Use disablePlugin(PluginId)
static void	dontLoadDisabledPlugins()
static boolean	enablePlugin(PluginId id)
static boolean	enablePlugin(java.lang.String id) Deprecated. Use enablePlugin(PluginId)
static IdeaPluginDescriptor	findPluginByModuleDependency(PluginId id)
static java.util.List<java.lang.String>	getDisabledPlugins() Deprecated. Bad API, sorry. Please use isDisabled(PluginId) to check plugin's state, enablePlugin(PluginId)/disablePlugin(PluginId) for state management, disabledPlugins() to get an unmodifiable collection of all disabled plugins (rarely needed).
static java.util.List<IdeaPluginDescriptorImpl>	getEnabledPluginRawList() Think twice before use and get approve from core team.
static java.util.List<? extends IdeaPluginDescriptor>	getLoadedPlugins() Returns descriptors of plugins which are successfully loaded into IDE.
static java.util.List<IdeaPluginDescriptorImpl>	getLoadedPlugins(java.lang.ClassLoader coreClassLoader)
static Logger	getLogger()
static IdeaPluginDescriptor	getPlugin(PluginId id)
static PluginId	getPluginByClassName(java.lang.String className)
static PluginDescriptor	getPluginDescriptorOrPlatformByClassName(java.lang.String className)
static PluginId	getPluginOrPlatformByClassName(java.lang.String className)
static IdeaPluginDescriptor []	getPlugins() Returns list of all available plugin descriptors (bundled and custom, include disabled ones).
static java.lang.String	getPluginsCompatibleBuild()
static void	initClassLoader(IdeaPluginDescriptorImpl rootDescriptor)
static java.util.concurrent.CompletionStage<java.util.List<IdeaPluginDescriptorImpl>>	initPlugins(java.lang.ClassLoader coreClassLoader)
static void	invalidatePlugins()
static boolean	isBrokenPlugin(IdeaPluginDescriptor descriptor)
static boolean	isCompatible(IdeaPluginDescriptor descriptor)
static boolean	isCompatible(IdeaPluginDescriptor descriptor, BuildNumber buildNumber)
static boolean	isDisabled(PluginId pluginId)
static boolean	isDisabled(java.lang.String pluginId) Deprecated. Use isDisabled(PluginId)
static boolean	isIncompatible(IdeaPluginDescriptor descriptor)
static boolean	isIncompatible(IdeaPluginDescriptor descriptor, BuildNumber buildNumber)
static boolean	isModuleDependency(PluginId dependentPluginId)
static boolean	isPluginInstalled(PluginId id)
static boolean	isRunningFromSources()
static IdeaPluginDescriptorImpl	loadDescriptor(java.io.File file, java.lang.String fileName) Deprecated. Use PluginManager.loadDescriptor(Path, String)
static IdeaPluginDescriptorImpl	loadDescriptor(java.nio.file.Path file, boolean isBundled, com.intellij.ide.plugins.DescriptorListLoadingContext parentContext)
static void	loadDisabledPlugins(java.lang.String configPath, java.util.Collection<PluginId> disabledPlugins)
static java.util.List<? extends IdeaPluginDescriptor>	loadUncachedDescriptors() Think twice before use and get approve from core team.
static boolean	processAllDependencies(IdeaPluginDescriptor rootDescriptor, boolean withOptionalDeps, java.util.function.Function<IdeaPluginDescriptor,java.nio.file.FileVisitResult> consumer) You must not use this method in cycle, in this case use processAllDependencies(IdeaPluginDescriptor, boolean, Map, Function) instead (to reuse result of buildPluginIdMap()).
static boolean	processAllDependencies(IdeaPluginDescriptor rootDescriptor, boolean withOptionalDeps, java.util.Map<PluginId,IdeaPluginDescriptorImpl> idToMap, java.util.function.Function<IdeaPluginDescriptor,java.nio.file.FileVisitResult> consumer)
static void	registerExtensionPointAndExtensions(java.nio.file.Path pluginRoot, java.lang.String fileName, ExtensionsArea area) Load extensions points and extensions from a configuration file in plugin.xml format
static void	removeDisablePluginListener(java.lang.Runnable listener) Deprecated. Use PluginManager.addDisablePluginListener(java.lang.Runnable)
static void	saveDisabledPlugins(java.util.Collection<PluginId> ids, boolean append)
static void	saveDisabledPlugins(java.lang.String configPath, java.util.Collection<PluginId> ids, boolean append)
static void	savePluginsList(java.util.Collection<PluginId> ids, java.nio.file.Path file, boolean append)
static void	scheduleDescriptorLoading()
static void	setDisabledPluginListener(java.lang.Runnable value)
static java.util.List<? extends IdeaPluginDescriptor>	testLoadDescriptorsFromClassPath(java.lang.ClassLoader loader)
static void	writePluginsList(java.util.Collection<PluginId> ids, java.io.Writer writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

META_INF

public static final java.lang.String META_INF

See Also:

Constant Field Values

IDEA_IS_INTERNAL_PROPERTY

public static final java.lang.String IDEA_IS_INTERNAL_PROPERTY

See Also:

Constant Field Values

DISABLED_PLUGINS_FILENAME

public static final java.lang.String DISABLED_PLUGINS_FILENAME

See Also:

Constant Field Values

CORE_ID

public static final PluginId CORE_ID

CORE_PLUGIN_ID

public static final java.lang.String CORE_PLUGIN_ID

See Also:

Constant Field Values

JAVA_PLUGIN_ID

public static final PluginId JAVA_PLUGIN_ID

PLUGIN_XML

public static final java.lang.String PLUGIN_XML

See Also:

Constant Field Values

PLUGIN_XML_PATH

public static final java.lang.String PLUGIN_XML_PATH

See Also:

Constant Field Values

VENDOR_JETBRAINS

public static final java.lang.String VENDOR_JETBRAINS

See Also:

Constant Field Values

DISABLE

public static final java.lang.String DISABLE

See Also:

Constant Field Values

ENABLE

public static final java.lang.String ENABLE

See Also:

Constant Field Values

EDIT

public static final java.lang.String EDIT

See Also:

Constant Field Values

isUnitTestMode

public static volatile boolean isUnitTestMode

ourPluginError

public static java.lang.String ourPluginError

ourPluginsToDisable

public static java.util.Set<PluginId> ourPluginsToDisable

ourPluginsToEnable

public static java.util.Set<PluginId> ourPluginsToEnable

Constructor Detail

PluginManagerCore

public PluginManagerCore()

Method Detail

getPluginsCompatibleBuild

public static java.lang.String getPluginsCompatibleBuild()

setDisabledPluginListener

public static void setDisabledPluginListener(java.lang.Runnable value)

getPlugins

public static IdeaPluginDescriptor [] getPlugins()

Returns list of all available plugin descriptors (bundled and custom, include disabled ones). Use getLoadedPlugins() if you need to get loaded plugins only.

Do not call this method during bootstrap, should be called in a copy of PluginManager, loaded by PluginClassLoader.

getLoadedPlugins

public static java.util.List<? extends IdeaPluginDescriptor> getLoadedPlugins()

Returns descriptors of plugins which are successfully loaded into IDE. The result is sorted in a way that if each plugin comes after the plugins it depends on.

getLoadedPlugins

public static java.util.List<IdeaPluginDescriptorImpl> getLoadedPlugins(java.lang.ClassLoader coreClassLoader)

arePluginsInitialized

public static boolean arePluginsInitialized()

loadDisabledPlugins

public static void loadDisabledPlugins(java.lang.String configPath,
                                       java.util.Collection<PluginId> disabledPlugins)

dontLoadDisabledPlugins

public static void dontLoadDisabledPlugins()

getDisabledPlugins

@Deprecated
public static java.util.List<java.lang.String> getDisabledPlugins()

Deprecated. Bad API, sorry. Please use isDisabled(PluginId) to check plugin's state, enablePlugin(PluginId)/disablePlugin(PluginId) for state management, disabledPlugins() to get an unmodifiable collection of all disabled plugins (rarely needed).

disabledPlugins

public static java.util.Set<PluginId> disabledPlugins()

isDisabled

public static boolean isDisabled(PluginId pluginId)

isDisabled

@Deprecated
public static boolean isDisabled(java.lang.String pluginId)

Deprecated. Use isDisabled(PluginId)

isBrokenPlugin

public static boolean isBrokenPlugin(IdeaPluginDescriptor descriptor)

savePluginsList

public static void savePluginsList(java.util.Collection<PluginId> ids,
                                   java.nio.file.Path file,
                                   boolean append)
                            throws java.io.IOException

Throws:

java.io.IOException

writePluginsList

public static void writePluginsList(java.util.Collection<PluginId> ids,
                                    java.io.Writer writer)
                             throws java.io.IOException

Throws:

java.io.IOException

disablePlugin

@Deprecated
public static boolean disablePlugin(java.lang.String id)

Deprecated. Use disablePlugin(PluginId)

disablePlugin

public static boolean disablePlugin(PluginId id)

enablePlugin

public static boolean enablePlugin(PluginId id)

enablePlugin

@Deprecated
public static boolean enablePlugin(java.lang.String id)

Deprecated. Use enablePlugin(PluginId)

saveDisabledPlugins

public static void saveDisabledPlugins(java.util.Collection<PluginId> ids,
                                       boolean append)
                                throws java.io.IOException

Throws:

java.io.IOException

saveDisabledPlugins

public static void saveDisabledPlugins(java.lang.String configPath,
                                       java.util.Collection<PluginId> ids,
                                       boolean append)
                                throws java.io.IOException

Throws:

java.io.IOException

isModuleDependency

public static boolean isModuleDependency(PluginId dependentPluginId)

createPluginException

public static PluginException createPluginException(java.lang.String errorMessage,
                                                    java.lang.Throwable cause,
                                                    java.lang.Class<?> pluginClass)

This is an internal method, use PluginException.createByClass(String, Throwable, Class) instead.

getPluginByClassName

public static PluginId getPluginByClassName(java.lang.String className)

getPluginOrPlatformByClassName

public static PluginId getPluginOrPlatformByClassName(java.lang.String className)

getPluginDescriptorOrPlatformByClassName

public static PluginDescriptor getPluginDescriptorOrPlatformByClassName(java.lang.String className)

invalidatePlugins

public static void invalidatePlugins()

isRunningFromSources

public static boolean isRunningFromSources()

loadDescriptor

@Deprecated
public static IdeaPluginDescriptorImpl loadDescriptor(java.io.File file,
                                                      java.lang.String fileName)

Deprecated. Use PluginManager.loadDescriptor(Path, String)

loadDescriptor

public static IdeaPluginDescriptorImpl loadDescriptor(java.nio.file.Path file,
                                                      boolean isBundled,
                                                      com.intellij.ide.plugins.DescriptorListLoadingContext parentContext)

testLoadDescriptorsFromClassPath

public static java.util.List<? extends IdeaPluginDescriptor> testLoadDescriptorsFromClassPath(java.lang.ClassLoader loader)
                                                                                       throws java.util.concurrent.ExecutionException,
                                                                                              java.lang.InterruptedException

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

loadUncachedDescriptors

public static java.util.List<? extends IdeaPluginDescriptor> loadUncachedDescriptors()

Think twice before use and get approve from core team. Returns enabled plugins only.

scheduleDescriptorLoading

public static void scheduleDescriptorLoading()

getEnabledPluginRawList

public static java.util.List<IdeaPluginDescriptorImpl> getEnabledPluginRawList()

Think twice before use and get approve from core team. Returns enabled plugins only.

initPlugins

public static java.util.concurrent.CompletionStage<java.util.List<IdeaPluginDescriptorImpl>> initPlugins(java.lang.ClassLoader coreClassLoader)

initClassLoader

public static void initClassLoader(IdeaPluginDescriptorImpl rootDescriptor)

isCompatible

public static boolean isCompatible(IdeaPluginDescriptor descriptor)

isCompatible

public static boolean isCompatible(IdeaPluginDescriptor descriptor,
                                   BuildNumber buildNumber)

isIncompatible

public static boolean isIncompatible(IdeaPluginDescriptor descriptor)

isIncompatible

public static boolean isIncompatible(IdeaPluginDescriptor descriptor,
                                     BuildNumber buildNumber)

buildPluginIdMap

public static java.util.Map<PluginId,IdeaPluginDescriptorImpl> buildPluginIdMap(java.util.List<IdeaPluginDescriptorImpl> descriptors)

registerExtensionPointAndExtensions

public static void registerExtensionPointAndExtensions(java.nio.file.Path pluginRoot,
                                                       java.lang.String fileName,
                                                       ExtensionsArea area)

Load extensions points and extensions from a configuration file in plugin.xml format

Use it only for CoreApplicationEnvironment. Do not use otherwise. For IntelliJ Platform application and tests plugins are loaded in parallel (including other optimizations).

Parameters:

pluginRoot - jar file or directory which contains the configuration file

fileName - name of the configuration file located in 'META-INF' directory under pluginRoot

area - area which extension points and extensions should be registered (e.g. Extensions.getRootArea() for application-level extensions)

getLogger

public static Logger getLogger()

getPlugin

public static IdeaPluginDescriptor getPlugin(PluginId id)

findPluginByModuleDependency

public static IdeaPluginDescriptor findPluginByModuleDependency(PluginId id)

isPluginInstalled

public static boolean isPluginInstalled(PluginId id)

buildPluginIdMap

public static java.util.Map<PluginId,IdeaPluginDescriptorImpl> buildPluginIdMap()

processAllDependencies

public static boolean processAllDependencies(IdeaPluginDescriptor rootDescriptor,
                                             boolean withOptionalDeps,
                                             java.util.function.Function<IdeaPluginDescriptor,java.nio.file.FileVisitResult> consumer)

You must not use this method in cycle, in this case use processAllDependencies(IdeaPluginDescriptor, boolean, Map, Function) instead (to reuse result of buildPluginIdMap()). FileVisitResult.SKIP_SIBLINGS is not supported. Returns false if processing was terminated because of FileVisitResult.TERMINATE, and true otherwise.

processAllDependencies

public static boolean processAllDependencies(IdeaPluginDescriptor rootDescriptor,
                                             boolean withOptionalDeps,
                                             java.util.Map<PluginId,IdeaPluginDescriptorImpl> idToMap,
                                             java.util.function.Function<IdeaPluginDescriptor,java.nio.file.FileVisitResult> consumer)

addDisablePluginListener

@Deprecated
public static void addDisablePluginListener(java.lang.Runnable listener)

Deprecated. Use PluginManager.addDisablePluginListener(java.lang.Runnable)

removeDisablePluginListener

@Deprecated
public static void removeDisablePluginListener(java.lang.Runnable listener)

Deprecated. Use PluginManager.addDisablePluginListener(java.lang.Runnable)