cf.janga.hook.core

Interface PluginPlatform

All Known Implementing Classes:

SimplePluginPlatform

public interface PluginPlatform

A plugin platform is responsible for loading plugins and their extensions and managing their life-cycle. It also ensures all extensions are handed to their corresponding extension point to be handled. The platform also keeps tracks of all loaded plugins and their states via a PluginRegistry.

Author:

Emerson Loureiro

Method Summary

Modifier and Type	Method and Description
PluginRegistry	getPluginRegistry() Returns the plugin registry of this platform.
void	init() Initializes this plugin platform.
<T extends CoreAPI> boolean	loadPlugins(String path, HostApplication<T> application) Loads plugins found in the path provided.
void	stop() Stops this plugin platform.

Method Detail

init

void init()
   throws PlatformException

Initializes this plugin platform.

Throws:

PlatformException - If there's any error while initializing this platform.

loadPlugins

<T extends CoreAPI> boolean loadPlugins(String path,
                                        HostApplication<T> application)
                                 throws PlatformException

Loads plugins found in the path provided. If the path is a folder, all jar files will be read. The platform assumes, in this case, that all jar files correspond to a plugin, and will indeed treat them all as plugin jar files. If the jar file is intead an ordinary jar file, an error will be thrown and a record of that kept on this platforms PluginRegistry. If the path refers to a single jar file, on the other hand, then only that file will be loaded.

Type Parameters:

T - The type of the CoreAPI associated with the host application.

Parameters:

path - The path from where the plugins should be loaded from, or the path to the jar file of a plugin.

application - The application where the plugins to be loaded will be hosted.

Returns:

True if all plugins are loaded successfuly and false otherwise.

Throws:

PlatformException - If there's any error while loading the plugins.

stop

void stop()
   throws PlatformException

Stops this plugin platform.

Throws:

PlatformException - If there's any error while stopping this platform.

getPluginRegistry

PluginRegistry getPluginRegistry()

Returns the plugin registry of this platform. The plugin registry should always be available, even if no plugins are loaded.

Returns:

PluginRegistry