cf.janga.hook.core

Class SimplePluginPlatform

java.lang.Object

cf.janga.hook.core.SimplePluginPlatform

All Implemented Interfaces:

PluginPlatform

public class SimplePluginPlatform
extends Object
implements PluginPlatform

A simple implementation of the PluginPlatform interface. It manually loads all jars and puts all classes in the classpath for the application.

Author:

Emerson Loureiro

Constructor Summary

Constructors

Constructor and Description
SimplePluginPlatform()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimplePluginPlatform

public SimplePluginPlatform()

Method Detail

init

public void init()
          throws PlatformException

Description copied from interface: PluginPlatform

Initializes this plugin platform.

Specified by:

init in interface PluginPlatform

Throws:

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

loadPlugins

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

Description copied from interface: PluginPlatform

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.

Specified by:

loadPlugins in interface PluginPlatform

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

public void stop()
          throws PlatformException

Description copied from interface: PluginPlatform

Stops this plugin platform.

Specified by:

stop in interface PluginPlatform

Throws:

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

getPluginRegistry

public PluginRegistry getPluginRegistry()

Description copied from interface: PluginPlatform

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

Specified by:

getPluginRegistry in interface PluginPlatform

Returns:

PluginRegistry