de.skuzzle.tinyplugz

Class Options

java.lang.Object

de.skuzzle.tinyplugz.Options

public final class Options
extends Object

Holds constants which can be passed to the TinyPlugzConfigurator before deployment.

Author:

Simon Taddiken

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	ALL_DEFAULT_OPTIONS Unmodifiable set containing all known default options.
static String	FAIL_ON_MULTIPLE_PROVIDERS Configuration option which will cause the deployment to fail if there are multiple service providers on the class path.
static String	FORCE_DEFAULT Configuration property for disabling the TinyPlugz implementation lookup and always use the default implementation.
static String	FORCE_IMPLEMENTATION Configuration property for explicitly specifying the TinyPlugz implementation to use.
static String	PLUGIN_FOLDER Configuration property for specifying an additional folder to load plugins from.
static String	SERVICE_LOADER_WRAPPER Configuration property for specifying the service loader implementation to use.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_LOADER_WRAPPER

public static final String SERVICE_LOADER_WRAPPER

Configuration property for specifying the service loader implementation to use. The loader will be used to look up the TinyPlugz implementation. Different TinyPlugz implementations might use this loader for different purposes (like implementing TinyPlugz.getServices(Class) or TinyPlugz.findDeployListeners(ClassLoader).

• If the value is an instance of ServiceLoaderWrapper, then just that instance will be used.
• If the value is an instance of Class, then the class's default constructor will be invoked to create a ServiceLoaderWrapper instance.
• If the value is a String, that String will be interpreted as a full qualified name to class which extends ServiceLoaderWrapper. The class will be loaded by the parent Classloader and constructed via its default constructor.

Since:

0.3.0

See Also:

Constant Field Values

PLUGIN_FOLDER

public static final String PLUGIN_FOLDER

Configuration property for specifying an additional folder to load plugins from. The path must be given as a String. If the value for this property is a relative path, it is interpreted relative to current execution directory.

TinyPlugz will include all jar files contained in the provided folder as plugins, adding them to the user specified plugins (given by either TinyPlugzConfigurator.DefineProperties.withPlugins(java.util.function.Consumer) or TinyPlugzConfigurator.DefineProperties.withPlugins(PluginSource)).

Since:

0.2.0

See Also:

Constant Field Values

FORCE_IMPLEMENTATION

public static final String FORCE_IMPLEMENTATION

Configuration property for explicitly specifying the TinyPlugz implementation to use. It supports three different kind of value types:

• If the value is an instance of TinyPlugz, then just that instance will be deployed.
• If the value is an instance of Class, then the class's default constructor will be invoked to create a TinyPlugz instance.
• If the value is a String, that String will be interpreted as a full qualified name to class which implements TinyPlugz. The class will be loaded by the parent Classloader and constructed via its default constructor.

Note: The presence of this property AND FORCE_DEFAULT will raise an exception when deploying.

See Also:

Constant Field Values

FORCE_DEFAULT

public static final String FORCE_DEFAULT

Configuration property for disabling the TinyPlugz implementation lookup and always use the default implementation. Every non-null value will enable this feature.

Note: The presence of this property AND FORCE_IMPLEMENTATION will raise an exception when deploying.

See Also:

Constant Field Values

FAIL_ON_MULTIPLE_PROVIDERS

public static final String FAIL_ON_MULTIPLE_PROVIDERS

Configuration option which will cause the deployment to fail if there are multiple service providers on the class path. If not present, only a warning will be logged and an undefined provider will be chosen among the available. Every non-null value will enable this feature.

See Also:

Constant Field Values

ALL_DEFAULT_OPTIONS

public static final Set<String> ALL_DEFAULT_OPTIONS

Unmodifiable set containing all known default options.

Since:

0.2.0