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

static String

TEMP_DIRECTORY_SUFFIX Suffix for temporary directories which will be removed on shutdown

Constructor Summary

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

Method Summary

void	afterPropertiesSet()
void	destroy()
com.atlassian.event.api.EventPublisher	getEventPublisher()
OsgiContainerManager	getOsgiContainerManager()
PluginAccessor	getPluginAccessor()
PluginController	getPluginController()
PluginEventManager	getPluginEventManager()
SplitStartupPluginSystemLifecycle	getPluginSystemLifecycle()
void	onPluginFrameworkShutdownEvent(PluginFrameworkShutdownEvent event)
void	onPluginFrameworkStartedEvent(PluginFrameworkStartedEvent event)
void	start() Deprecated. Use afterPropertiesSet(), getPluginSystemLifecycle().init().
void	stop() Deprecated. Use getPluginSystemLifecycle().shutdown(), destroy().

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

afterPropertiesSet

public void afterPropertiesSet()

destroy

public void destroy()

start

@Deprecated
public void start()
           throws PluginParseException

Deprecated. Use afterPropertiesSet(), getPluginSystemLifecycle().init().

Starts the plugins framework.

Throws:

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

stop

@Deprecated
public void stop()

Deprecated. Use getPluginSystemLifecycle().shutdown(), destroy().

Stops the framework.

getOsgiContainerManager

public OsgiContainerManager getOsgiContainerManager()

Returns:

the underlying OSGi container manager

getPluginEventManager

public PluginEventManager getPluginEventManager()

Returns:

the plugin event manager

getEventPublisher

public com.atlassian.event.api.EventPublisher getEventPublisher()

Returns:

the event publisher used by 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

getPluginSystemLifecycle

public SplitStartupPluginSystemLifecycle getPluginSystemLifecycle()

Returns:

the plugin system lifecycle for starting and stopping the plugin system

onPluginFrameworkStartedEvent

public void onPluginFrameworkStartedEvent(PluginFrameworkStartedEvent event)

onPluginFrameworkShutdownEvent

public void onPluginFrameworkShutdownEvent(PluginFrameworkShutdownEvent event)