Plugin Lifecycle

Former Member — Wed, 05 Aug 2020 14:18:33 GMT

Current Revision posted to Developer Training by Former Member on 08/05/2020 14:18:33

The [[api-documentation:PluginManager In-Process API Service|plugin manager]] orchestrates [[api-documentation:IPlugin Plugin Type|plugin]] enablement and configuration. It's management lifecycle begins when the platform is first accessed/started and continues until the platform process is terminated.

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom [[api-documentation:IApiDefinition Plugin Type|Apis]] are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

While plugins are being reloaded (the majority of the flowchart above), the platform utilizes a distributed lock, ensuring that only one instance of the platform (which exists on each web node and each job server node) performs a plugin reload at a time. This ensures that one time processes, for example, installation, only occur once per site instance and not once per platform instance.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] execute their BeforeInitialization(...) logic.
All platform and custom [[api-documentation:IApiDefinition Plugin Type|Apis]] are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Wed, 05 Aug 2020 14:17:38 GMT

Revision 9 posted to Developer Training by Former Member on 08/05/2020 14:17:38

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom [[api-documentation:IApiDefinition Plugin Type|Apis]] Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IBeforeInitializationPlugin Plugin Type|BeforeInitialization plugins]] execute their BeforeInitialization(...) logic.
All platform and custom [[api-documentation:IApiDefinition Plugin Type|Apis]] are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Wed, 05 Aug 2020 14:17:09 GMT

Revision 8 posted to Developer Training by Former Member on 08/05/2020 14:17:09

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IBeforeInitializationPlugin Plugin Type|BeforeInitialization plugins]] execute their BeforeInitialization(...) logic.
All platform and custom [[api-documentation:IApiDefinition Plugin Type|Apis]] Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Wed, 05 Aug 2020 14:16:25 GMT

Revision 7 posted to Developer Training by Former Member on 08/05/2020 14:16:25

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IBeforeInitializationPlugin Plugin Type|BeforeInitialization plugins]] execute their BeforeInitialization(...) logic.
All platform and custom [[api-documentation:IConfigurablePlugin Plugin Type|Apis]] Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Wed, 05 Aug 2020 14:15:43 GMT

Revision 6 posted to Developer Training by Former Member on 08/05/2020 14:15:43

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IBeforeInitializationPlugin Plugin Type|BeforeInitialization plugins]] execute their BeforeInitialization(...) logic.
All platform and custom Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Wed, 05 Aug 2020 14:12:33 GMT

Revision 5 posted to Developer Training by Former Member on 08/05/2020 14:12:33

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IConfigurablePlugin Plugin Type|Before Plugin Initialization plugins]] execute their BeforeInitialization(...) logic.
All platform and custom Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Tue, 04 Aug 2020 22:06:50 GMT

Revision 4 posted to Developer Training by Former Member on 08/04/2020 22:06:50

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IBeforeInitializationPlugin Plugin Type|Before Plugin Initialization plugins]] execute their BeforeInitialization(...) logic.
All platform and custom Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Tue, 04 Aug 2020 22:05:22 GMT

Revision 3 posted to Developer Training by Former Member on 08/04/2020 22:05:22

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IBeforeInitializationPlugin Plugin Type|Executing Code Before Plugin Initialization]] execute their BeforeInitialization(...) logic.
All platform and custom Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Former Member — Tue, 04 Aug 2020 22:04:02 GMT

Revision 2 posted to Developer Training by Former Member on 08/04/2020 22:04:02

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[api-documentation:IBeforeInitialization Plugin Type|Executing Code Before Plugin Initialization]] execute their BeforeInitialization(...) logic.
All platform and custom Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.

Plugin Lifecycle

Ben Tiedt — Thu, 13 Jun 2019 19:29:08 GMT

Revision 1 posted to Developer Training by Ben Tiedt on 06/13/2019 19:29:08

[toc]

Plugin Manager Lifecycle

When initialization or re-initialization is required, the [[api-documentation:PluginManager In-Process API Service|plugin manager]] executes the following process:

If changes were made to enabled plugins, any newly disabled [[api-documentation:PluginManager In-Process API Service|installable plugins]] are uninstalled.
The BeforeInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
All [[api-documentation:IPlugin Plugin Type|plugins]] are unloaded (all Plugin Manager references to plugins are removed, allowing the old instances of plugins to be cleaned up by the garbage collector).
All enabled plugins are instantiated one-by-one. As they are instantiated, [[api-documentation:ITranslatablePlugin Plugin Type|translatable plugins]] are given their translations and [[api-documentation:IConfigurablePlugin Plugin Type|configurable plugins]] are given their configuration.
Any [[Executing Code Before Plugin Initialization|IBeforeInitialization]] plugins execute.
All platform and custom Apis are registered.
All plugins' Initialize() methods are called. This is an appropriate time for plugins to register event handlers and interact with other plugins.
The AfterInitialization event is fired on [[api-documentation:PluginManager In-Process API Service|PluginManager]] and all event handlers are unregistered.
Any newly enabled or newly upgraded [[api-documentation:IInstallablePlugin Plugin Type|installable plugins]] are installed.

Plugin Lifecycle

From the perspective of a single plugin, the lifecycle appears as

Where the [[api-documentation:IPlugin Plugin Type|plugin]] is

Instantiated. A new instance of the [[api-documentation:IPlugin Plugin Type|plugin]] is created when [[api-documentation:PluginManager In-Process API Service|the plugin manager]] initializes or re-initializes plugins.
Translated. [[api-documentation:ITranslatablePlugin Plugin Type|Translatable plugins]] are given their translations.
Configured. [[api-documentation:IConfigurablePlugin Plugin Type|Configurable plugins]] are given their configuration.
Any [[IBeforeInitialization|Executing Code Before Plugin Initialization]] execute their BeforeInitialization(...) logic.
All platform and custom Apis are registered.
Initialized. All plugins are initialized. This is an appropriate time to register event handlers against the in-process API or reference other plugins via [[api-documentation:PluginManager In-Process API Service|PluginManager]].
Installed. [[api-documentation:IInstallablePlugin Plugin Type|Installable plugins']] Install() methods are called if the plugin was not previously installed or an earlier/later version was previously installed.
Executed. All plugins are allowed to execute normally. At this time, the platform will interact with [[api-documentation:Plugin API Documentation|special-use plugins]] and plugins will be notified whenever their registered events fire.
Destroyed. When [[api-documentation:PluginManager In-Process API Service|the plugin manager]] re-initializes, it removes all references to existing plugins and allows the .net garbage collector to clean up unreferenced plugins. If the plugin is [[api-documentation:IInstallablePlugin Plugin Type|installable]] and was newly disabled, it's Uninstall() method will be called.