org.uberfire.backend.plugin

Interface PluginProcessor

All Known Subinterfaces:

RuntimePluginProcessor

public interface PluginProcessor

A simple marker to keep track of all plugins processors.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PluginProcessor.PluginProcessorType

Method Summary

Modifier and Type	Method and Description
static boolean	isAValidPluginFileExtension(String fileName) Checks if a plugin file has the valid extension
boolean	isRegistered(String pluginName) Checks if a plugin with the given name is registered.
void	process(String pluginName, String pluginDeploymentDir, boolean notifyClients) Processes a deployed plugin and optionally notifies clients
void	removeAll() Removes all plugins from this processor.
boolean	shouldProcess(String pluginName) Checks if this processor should process a given plugin

Method Detail

isAValidPluginFileExtension

static boolean isAValidPluginFileExtension(String fileName)

Checks if a plugin file has the valid extension

Parameters:

fileName - the file name of the plugin

shouldProcess

boolean shouldProcess(String pluginName)

Checks if this processor should process a given plugin

Parameters:

pluginName - the name of the plugin, must not be null.

removeAll

void removeAll()

Removes all plugins from this processor.

process

void process(String pluginName,
             String pluginDeploymentDir,
             boolean notifyClients)

Processes a deployed plugin and optionally notifies clients

Parameters:

pluginName - the name of the plugin, must not be null.

pluginDeploymentDir - the directory to deploy plugin contents to, must not be null.

notifyClients - trigger a event after plugin processing

isRegistered

boolean isRegistered(String pluginName)

Checks if a plugin with the given name is registered.

Parameters:

pluginName - the name of the plugin, must not be null.

Returns:

true if registered, otherwise false.