Activation Aware Plugin

Usages

This plugin type makes a plugin aware of the plugin install & uninstall events.

Common Use Cases:

• Register and unregister something when a plugin is installed and uninstalled from the system. 

• Create and clean resources when the plugin is installed and uninstalled from the system. 

Interface Class

org.joget.plugin.base.ActivationAwarePlugin

• This plugin interface can be used together with other plugin types

• The plugin implemented this interface will be aware of the plugin's installation and uninstalling events.

Interface Methods

afterRegister

public void afterRegister()

This method will be called after the plugin is registered with the service.

beforeUnregister

public void beforeUnregister()

This method will be called before the plugin is going to be unregistered from the service.

Sample Plugins

All Web Filter plugins are a sample of this plugin interface, as the web filter plugin uses it to auto-register and unregister the filter after installation and before uninstalling.

• SampleHeaderFilter

• Add a header to the response of /web/login.

• Run before the security chain and order after SampleLoginFormEncryption, even if it registers before it.

• SampleWebFilterPlugin

• Intercept /web/login request and auto-login as Admin when the saved URL is the assignment link. Then, it directs to the configured redirect URL or home.

• SampleLoginFormEncryption

• Intercept the /web/login to inject a script to encrypt the login credentials before the body end tag.

• Intercept /j_spring_security_check to decrypt the credentials before passing to the security chain.

• Run before the security chain.