de.skuzzle.tinyplugz

Interface PluginSource

public interface PluginSource

Builder for configuring the plugins to be deployed by TinyPlugz. This interface is not intended to be implemented by clients. An instance of this interface can be consumed while configuring the TinyPlugz instance before deployment using the TinyPlugzConfigurator.

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
default PluginSource	addAllPluginJars(Path folder) Adds all jar files from the given folder as plugin.
PluginSource	addAllPluginJars(Path folder, Predicate<Path> filter) Adds all jar files from the given folder for which the given predicate holds true as plugin.
PluginSource	addPluginJar(Path jarFile) Adds the given jar file as plugin.
PluginSource	addUnpackedPlugin(Path folder) Adds a plugin which is not packed into a jar but which contents are contained in the given folder.
static void	noPlugins(PluginSource source) No-op method PluginSource consumer method for specifying no plugins when configuring a TinyPlugz instance.

Method Detail

noPlugins

static void noPlugins(PluginSource source)

No-op method PluginSource consumer method for specifying no plugins when configuring a TinyPlugz instance. This is required because specifying plugins is the last step in the configurator's fluent builder API. So if you do not want to load any plugins, you might configure your TinyPlugz like this:

 TinyPlugzConfigurator.setup().withPlugins(PluginSource::noPlugins).deploy();
 

Parameters:

source - The plugin source.

addUnpackedPlugin

PluginSource addUnpackedPlugin(Path folder)

Adds a plugin which is not packed into a jar but which contents are contained in the given folder.

Parameters:

folder - The folder.

Returns:

This instance.

Throws:

IllegalArgumentException - If the given path does not denote a folder.

addPluginJar

PluginSource addPluginJar(Path jarFile)

Adds the given jar file as plugin.

Parameters:

jarFile - Path to the jar file.

Returns:

This instance.

addAllPluginJars

default PluginSource addAllPluginJars(Path folder)

Adds all jar files from the given folder as plugin. The search is not done recursively in sub folders.

Parameters:

folder - The folder containing the files.

Returns:

This instance.

Throws:

IllegalArgumentException - If the given path does not denote a folder.

addAllPluginJars

PluginSource addAllPluginJars(Path folder,
                              Predicate<Path> filter)

Adds all jar files from the given folder for which the given predicate holds true as plugin. The search is not done recursively in sub folders.

Parameters:

folder - The folder containing the files.

filter - The filter.

Returns:

This instance.

Throws:

IllegalArgumentException - If the given path does not denote a folder.