de.skuzzle.tinyplugz

Interface PluginSourceBuilder

All Known Implementing Classes:

PluginSourceBuilderImpl

public interface PluginSourceBuilder

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. A default instance can also be obtained by PluginSource.builder().

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
default PluginSourceBuilder	addAllPluginJars(Path folder) Adds all jar files from the given folder as plugin.
PluginSourceBuilder	addAllPluginJars(Path folder, Predicate<Path> filter) Adds all jar files from the given folder for which the given predicate holds true as plugin.
PluginSourceBuilder	addPlugin(URL url) Adds a plugin which is located by the given URL.
PluginSourceBuilder	addPluginJar(Path jarFile) Adds the given jar file as plugin.
PluginSourceBuilder	addUnpackedPlugin(Path folder) Adds a plugin which is not packed into a jar but which contents are contained in the given folder.
PluginSource	createSource() Creates a PluginSource from the configured URLs.
PluginSourceBuilder	include(PluginSource source) Includes all plugins from the given source in the source which is to be built by this builder.
static void	noPlugins(PluginSourceBuilder source) No-op PluginSourceBuilder consumer method for specifying no plugins when configuring a TinyPlugz instance.

Method Detail

noPlugins

static void noPlugins(PluginSourceBuilder source)

No-op PluginSourceBuilder 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(PluginSourceBuilder::noPlugins).deploy();
 

Parameters:

source - The plugin source.

include

PluginSourceBuilder include(PluginSource source)

Includes all plugins from the given source in the source which is to be built by this builder. The URLS from the source's stream will be eagerly processed by this method.

Parameters:

source - The source to include.

Returns:

This instance.

addPlugin

PluginSourceBuilder addPlugin(URL url)

Adds a plugin which is located by the given URL.

Parameters:

url - The URL of the plugin.

Returns:

This instance.

Since:

0.2.0

addUnpackedPlugin

PluginSourceBuilder 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

PluginSourceBuilder addPluginJar(Path jarFile)

Adds the given jar file as plugin.

Parameters:

jarFile - Path to the jar file.

Returns:

This instance.

addAllPluginJars

default PluginSourceBuilder 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

PluginSourceBuilder 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.

createSource

PluginSource createSource()

Creates a PluginSource from the configured URLs.

Returns:

The new PluginSource.