com.atlassian.plugin.exception

Interface PluginExceptionInterception

All Known Implementing Classes:

NoOpPluginExceptionInterception

@Internal
public interface PluginExceptionInterception

This allows the Host application to intercept a plugin exception and do something meaningful with it. Its is not intended for plugin developers to consume at all.

Since:

v3.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	onEnableException(Plugin plugin, java.lang.Exception pluginException) This is called when a plugin cant be enabled because an exception has been thrown.

Method Detail

onEnableException

boolean onEnableException(Plugin plugin,
                        java.lang.Exception pluginException)

This is called when a plugin cant be enabled because an exception has been thrown.

This is an intercept point for the host to do something meaningful like better logging or failed plugin tracking.

It must NOT propagate the exception out of this block because this will stop the plugin system in general for starting.

Parameters:

plugin - the plugin that has failed to be enabled

pluginException - the exception that was thrown during plugin enable

Returns:

true if the underlying plugin system should log a message. If this is false then the assumption is that host application has done the appropriate logging