com.atlassian.plugin.main

Class AtlassianPlugins

java.lang.Object

com.atlassian.plugin.main.AtlassianPlugins

public class AtlassianPlugins
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMP_DIRECTORY_SUFFIX Suffix for temporary directories which will be removed on shutdown

Constructor Summary

Constructors

Constructor and Description
AtlassianPlugins(PluginsConfiguration config) Constructs an instance of the plugin framework with the specified config.

Method Summary

Methods

Modifier and Type	Method and Description
OsgiContainerManager	getOsgiContainerManager()
PluginAccessor	getPluginAccessor()
PluginController	getPluginController()
PluginEventManager	getPluginEventManager()
void	start() Starts the plugins framework.
void	stop() Stops the framework.

Methods inherited from class java.lang.Object

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

Field Detail

TEMP_DIRECTORY_SUFFIX

public static final String TEMP_DIRECTORY_SUFFIX

Suffix for temporary directories which will be removed on shutdown

See Also:

Constant Field Values

Constructor Detail

AtlassianPlugins

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

Method Detail

start

public void start()
           throws PluginParseException

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

stop

public void stop()

Stops the framework.

getOsgiContainerManager

public OsgiContainerManager getOsgiContainerManager()

Returns:

the underlying OSGi container manager

getPluginEventManager

public PluginEventManager getPluginEventManager()

Returns:

the plugin event manager

getPluginController

public PluginController getPluginController()

Returns:

the plugin controller for manipulating plugins

getPluginAccessor

public PluginAccessor getPluginAccessor()

Returns:

the plugin accessor for accessing plugins