com.qcadoo.plugin.api

Interface Plugin

public interface Plugin

Plugin represents information from plugin's descriptor and holds all its modules. Plugin, Module and ModuleFactory are strongly connected. Below shows licecycle methods in the particular situations.

Starting application

For every plugin's description, for every module:

• ModuleFactory.parse(String, Element)

For every module factory, in proper order:

• ModuleFactory.preInit()
• Module.init() for every module belongs to this module factory, in plugin dependency order
• ModuleFactory.postInit()

Again for every module factory, in proper order:

• Module.enableOnStartup() or Module.disableOnStartup() for every module belongs to this module factory, in plugin dependency order
• Module.multiTenantEnableOnStartup() or Module.multiTenantDisableOnStartup() for every module belongs to this module factory, for every tenant, in plugin dependency order

For every module factory with state PluginState.ENABLING:

• Module.enable()
• Module.multiTenantEnable() for every tenant

Enabling plugin

For plugin in PluginState.DISABLED state.

• Module.enable()
• Module.multiTenantEnable() for every tenant

For plugin in PluginState.TEMPORARY state, the state is changed to PluginState.ENABLING and the system is restarted.

Disabling plugin

• Module.disable()
• Module.multiTenantDisable() for every tenant

Installing plugin

No additional method is called.

Uninstalling plugin

If the plugin is enabled, it will be disabled first. The system will be restarted.

Updating plugin

If the plugin is enabled, it will be disabled first. The state is set to PluginState.ENABLING and the system is restarted.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
int	compareVersion(Version version) Compares version of the plugin with given version.
String	getFilename() Returns name the file with plugin.
String	getIdentifier() Returns plugin's identifier, it is unique in the whole system.
PluginInformation	getPluginInformation() Returns additional information.
Set<PluginDependencyInformation>	getRequiredPlugins() Returns requirements information.
PluginState	getState() Returns state of the plugin, only PluginState.ENABLED plugins are usable in system.
Version	getVersion() Returns version of the plugin.
boolean	hasState(PluginState expectedState) Checks if plugin has expected state.
boolean	isSystemPlugin() Returns true for system plugin, it means that plugin cannot be disabled and removed.

Method Detail

compareVersion

int compareVersion(Version version)

Compares version of the plugin with given version.

Returns:

comparison result

See Also:

Version.compareTo(Version)

getFilename

String getFilename()

Returns name the file with plugin.

Returns:

filename

getIdentifier

String getIdentifier()

Returns plugin's identifier, it is unique in the whole system.

Returns:

identifier

getPluginInformation

PluginInformation getPluginInformation()

Returns additional information.

Returns:

additional information

getRequiredPlugins

Set<PluginDependencyInformation> getRequiredPlugins()

Returns requirements information.

Returns:

requirements information

getState

PluginState getState()

Returns state of the plugin, only PluginState.ENABLED plugins are usable in system.

Returns:

state

getVersion

Version getVersion()

Returns version of the plugin.

Returns:

version

hasState

boolean hasState(PluginState expectedState)

Checks if plugin has expected state.

Parameters:

expectedState - expected state

Returns:

true if plugin is in expected state

isSystemPlugin

boolean isSystemPlugin()

Returns true for system plugin, it means that plugin cannot be disabled and removed.

Returns:

true for system plugin