com.atlassian.confluence.plugin
Class ConfluencePluginUtils

java.lang.Object
  com.atlassian.confluence.plugin.ConfluencePluginUtils

public class ConfluencePluginUtils
extends Object

Field Summary

static String	CONFLUENCE_APPLICATION_KEY Deprecated. since 3.4
static Set<String>	CONFLUENCE_APPLICATION_KEYS
static String	PLUGIN_DESCRIPTOR_FILENAME

Constructor Summary

ConfluencePluginUtils()

Method Summary

static File	createDirectoryIfDoesntExist(String directoryLocation)
static File	getBundledPluginDirectory(BootstrapManager bootstrapManager) Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getBundledPluginDirectory If running before bootstrap use getBundledPluginDirectory(HomeLocator homeLocator), the homeLocator returns the correct confluence home even if bootstrap hasn't been initialised.
static File	getBundledPluginDirectory(com.atlassian.config.HomeLocator homeLocator) Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getBundledPluginDirectory Finds the bundled plugins directory in the confluence home. If it doesn't exist the directory is created.
static File	getPluginDirectory(BootstrapManager bootstrapManager) Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginDirectory
static File	getPluginsPersistentCacheDirectory(BootstrapManager bootstrapManager) Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginsPersistentCacheDirectory If running before bootstrap use getBundledPluginDirectory(HomeLocator homeLocator), the homeLocator returns the correct confluence home even if bootstrap hasn't been initialised.
static File	getPluginsPersistentCacheDirectory(com.atlassian.config.HomeLocator homeLocator) Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginsPersistentCacheDirectory Finds the plugins persistent cache directory in the confluence home. If it doesn't exist the directory is created.
static File	getPluginTempDirectory(BootstrapManager bootstrapManager) Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginTempDirectory If running before bootstrap use getPluginTempDirectory(HomeLocator homeLocator), the homeLocator returns the correct confluence home even if bootstrap hasn't been initialised.
static File	getPluginTempDirectory(com.atlassian.config.HomeLocator homeLocator) Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginTempDirectory Finds the plugins-temp directory in the confluence home. If it doesn't exist the directory is created.
static <T> T	instantiatePluginModule(com.atlassian.plugin.Plugin plugin, Class<T> cls) Instantiates a plugin module.

Methods inherited from class java.lang.Object

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

Field Detail

CONFLUENCE_APPLICATION_KEY

@Deprecated
public static final String CONFLUENCE_APPLICATION_KEY

Deprecated. since 3.4

See Also:

Constant Field Values

CONFLUENCE_APPLICATION_KEYS

public static final Set<String> CONFLUENCE_APPLICATION_KEYS

PLUGIN_DESCRIPTOR_FILENAME

public static final String PLUGIN_DESCRIPTOR_FILENAME

See Also:

Constant Field Values

Constructor Detail

ConfluencePluginUtils

public ConfluencePluginUtils()

Method Detail

getPluginDirectory

public static File getPluginDirectory(BootstrapManager bootstrapManager)

Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginDirectory

Parameters:

bootstrapManager - - used to get the confluence home directory

Returns:

the plugin directory

getPluginTempDirectory

public static File getPluginTempDirectory(BootstrapManager bootstrapManager)

Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginTempDirectory If running before bootstrap use getPluginTempDirectory(HomeLocator homeLocator), the homeLocator returns the correct confluence home even if bootstrap hasn't been initialised.

Parameters:

bootstrapManager - - used to get the confluence home directory

Returns:

the plugin temp directory

getPluginTempDirectory

public static File getPluginTempDirectory(com.atlassian.config.HomeLocator homeLocator)

Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginTempDirectory Finds the plugins-temp directory in the confluence home. If it doesn't exist the directory is created.

Parameters:

homeLocator - - used to get the confluence home directory

Returns:

the plugin temp directory

getBundledPluginDirectory

public static File getBundledPluginDirectory(BootstrapManager bootstrapManager)

Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getBundledPluginDirectory If running before bootstrap use getBundledPluginDirectory(HomeLocator homeLocator), the homeLocator returns the correct confluence home even if bootstrap hasn't been initialised.

Parameters:

bootstrapManager - - used to get the confluence home directory

Returns:

the bundled plugin directory

getBundledPluginDirectory

public static File getBundledPluginDirectory(com.atlassian.config.HomeLocator homeLocator)

Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getBundledPluginDirectory Finds the bundled plugins directory in the confluence home. If it doesn't exist the directory is created.

Parameters:

homeLocator - - used to get the confluence home directory

Returns:

the bundled plugins directory

getPluginsPersistentCacheDirectory

public static File getPluginsPersistentCacheDirectory(BootstrapManager bootstrapManager)

Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginsPersistentCacheDirectory If running before bootstrap use getBundledPluginDirectory(HomeLocator homeLocator), the homeLocator returns the correct confluence home even if bootstrap hasn't been initialised.

Parameters:

bootstrapManager - - used to get the confluence home directory

Returns:

the plugins persistent cache directory

getPluginsPersistentCacheDirectory

public static File getPluginsPersistentCacheDirectory(com.atlassian.config.HomeLocator homeLocator)

Deprecated. use com.atlassian.confluence.plugin.PluginDirectoryProvider#getPluginsPersistentCacheDirectory Finds the plugins persistent cache directory in the confluence home. If it doesn't exist the directory is created.

Parameters:

homeLocator - - used to get the confluence home directory

Returns:

the plugin persistent cache directory

instantiatePluginModule

public static <T> T instantiatePluginModule(com.atlassian.plugin.Plugin plugin,
                                            Class<T> cls)

Instantiates a plugin module. First tries to let the plugin autowire the class, if AutowireCapablePlugin is implemented, otherwise falls back to creation and autowiring by the internal Spring container.

Parameters:

plugin - The plugin that contains the module

cls - The class to instantiate and autowire

Returns:

The created and autowired object

createDirectoryIfDoesntExist

public static File createDirectoryIfDoesntExist(String directoryLocation)