package

com.atlassian.plugin.event.events

This package contains events that will be fired by the framework.

The most useful events are those concerning plugin and modules. This table gives an overview on the key events and when they will and will not fire:
Event When fired When not
PluginEnabledEvent
  • Plugin explicitly enabled via PluginController
  • Plugin refreshed as a result of the upgrade of a plugin that provides a package to it
  • Plugin enabled after being installed via startup and dynamic installation
  • Plugin enabled by starting OSGi bundle directly
  • OSGi bundle installed via OSGi apis
PluginDisabledEvent
  • Explicitly disabled via PluginController
  • A required package dependency is uninstalled
  • Stopping an OSGi bundle directly
  • A required package dependency is uninstalled
  • A required OSGi service dependency is gone.  Includes imported components
  • Plugin framework shutdown
PluginModuleEnabledEvent
  • Explicitly enabled via PluginController
  • Plugin enablement during startup and dynamic installation
  • Plugin refreshed as a result of the upgrade of a plugin that provides a package to it
  • Explicit plugin enablement via PluginController
  • Plugin enabled via starting OSGi bundle directly
  • OSGi bundle installed via OSGi apis
PluginModuleDisabledEvent
  • Explicitly disabled via PluginController
  • Explicit plugin disablement via PluginController
  • Plugin refreshed as a result of the upgrade of a plugin that provides a package to it
  • A required OSGi service dependency is gone.  Includes imported components
  • A required package dependency is uninstalled
  • Stopping OSGi bundle directly
  • Removal of ModuleDescriptor exposed as an OSGi service
  • Plugin framework shutdown
  • Failure loading subsequent plugin module exposed as osgi service
PluginUninstalledEvent
  • Explicitly uninstalled via PluginController
  • Plugin upgrade (process uninstalls old before installing new)

Classes

PluginContainerFailedEvent Event thrown when the container a plugin is installed into either rejects the plugin or fails altogether 
PluginContainerRefreshedEvent Event for when the container a plugin is installed into has been refreshed 
PluginContainerUnavailableEvent Event for when the container of a plugin is been shutdown, usually as a result of the OSGi bundle being stopped 
PluginDisabledEvent Event that signifies a plugin has been disabled, uninstalled or updated. 
PluginEnabledEvent Event fired when a plugin is enabled, installed or updated. 
PluginFrameworkShutdownEvent Event that signifies the plugin framework has been shutdown  
PluginFrameworkStartedEvent Event that signifies the plugin framework has been started and initialized  
PluginFrameworkStartingEvent Event that signifies the plugin framework is being started  
PluginFrameworkWarmRestartedEvent Signals a warm restart of the plugin framework has been completed 
PluginFrameworkWarmRestartingEvent Signals a warm restart of the plugin framework is about to begin 
PluginModuleAvailableEvent Signifies a plugin module is now available outside the usual installation process. 
PluginModuleDisabledEvent Event fired when a plugin module is disabled, which can also happen when its plugin is disabled or uninstalled. 
PluginModuleEnabledEvent Event fired when a plugin module is enabled, which can also happen when its plugin is enabled or installed. 
PluginModuleUnavailableEvent Signifies a plugin module is now unavailable outside the usual installation process. 
PluginRefreshedEvent Event fired when the plugin has been refreshed with no user interaction 
PluginUninstalledEvent Event fired when a plugin is explicited uninstalled (as opposed to as part of an upgrade). 
PluginUpgradedEvent Event that indicates a plugin has been upgraded at runtime