public class

AtlassianPlugins

extends Object
java.lang.Object
   ↳ com.atlassian.plugin.main.AtlassianPlugins

Class Overview

Facade interface to the Atlassian Plugins framework. See the package Javadocs for usage information.

Summary

Constants
String TEMP_DIRECTORY_SUFFIX Suffix for temporary directories which will be removed on shutdown
Public Constructors
AtlassianPlugins(PluginsConfiguration config)
Constructs an instance of the plugin framework with the specified config.
Public Methods
OsgiContainerManager getOsgiContainerManager()
PluginAccessor getPluginAccessor()
PluginController getPluginController()
PluginEventManager getPluginEventManager()
void start()
Starts the plugins framework.
void stop()
Stops the framework.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String TEMP_DIRECTORY_SUFFIX

Suffix for temporary directories which will be removed on shutdown

Constant Value: ".tmp"

Public Constructors

public AtlassianPlugins (PluginsConfiguration config)

Constructs an instance of the plugin framework with the specified config. No additional validation is performed on the configuration, so it is recommended you use the PluginsConfigurationBuilder class to create a configuration instance.

Parameters
config The plugins configuration to use

Public Methods

public OsgiContainerManager getOsgiContainerManager ()

Returns
  • the underlying OSGi container manager

public PluginAccessor getPluginAccessor ()

Returns
  • the plugin accessor for accessing plugins

public PluginController getPluginController ()

Returns
  • the plugin controller for manipulating plugins

public PluginEventManager getPluginEventManager ()

Returns
  • the plugin event manager

public void start ()

Starts the plugins framework. Will return once the plugins have all been loaded and started. Should only be called once.

Throws
PluginParseException If there was any problems parsing any of the plugins

public void stop ()

Stops the framework.