de.skuzzle.tinyplugz

Class TinyPlugzConfigurator

java.lang.Object

de.skuzzle.tinyplugz.TinyPlugzConfigurator

public final class TinyPlugzConfigurator
extends Object

Provides a fluent builder API for configuring an application wide single TinyPlugz instance.

Author:

Simon Taddiken

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TinyPlugzConfigurator.DefineProperties Part of the fluent configurator API.
static interface	TinyPlugzConfigurator.DeployTinyPlugz Part of the fluent configurator API.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Object	DEPLOY_LOCK Lock which synchronizes every non-trivial access to TinyPlugz.instance.
static @NonNull String	TINY_PLUGZ_CONFIG Default resource name of tiny plugz class path configuration

Method Summary

Modifier and Type	Method and Description
static TinyPlugzConfigurator.DefineProperties	setup() Sets up a TinyPlugz instance which uses the current thread's context Classloader as parent Classloader.
static TinyPlugzConfigurator.DefineProperties	setupUsingApplicationClassLoader() Sets up a TinyPlugz instance which uses the Classloader which loaded the TinyPlugzConfigurator class as parent Classloader.
static TinyPlugzConfigurator.DefineProperties	setupUsingParent(ClassLoader parentClassLoader) Sets up a TinyPlugz instance which uses the given Classloader as parent Classloader.

Methods inherited from class java.lang.Object

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

Field Detail

TINY_PLUGZ_CONFIG

public static final @NonNull String TINY_PLUGZ_CONFIG

Default resource name of tiny plugz class path configuration

See Also:

Constant Field Values

DEPLOY_LOCK

protected static final Object DEPLOY_LOCK

Lock which synchronizes every non-trivial access to TinyPlugz.instance.

Method Detail

setup

public static TinyPlugzConfigurator.DefineProperties setup()

Sets up a TinyPlugz instance which uses the current thread's context Classloader as parent Classloader.

This Classloader will be used for several purposes. First, it serves as parent Classloader for the plugin Classloader which is to be created to access classes and configurations from plugins. Second, the Classloader will be used to look up the TinyPlugz service provider either using the ServiceLoader or by looking up an explicit implementation class.

Returns:

Fluent builder object for further configuration.

setupUsingParent

public static TinyPlugzConfigurator.DefineProperties setupUsingParent(ClassLoader parentClassLoader)

Sets up a TinyPlugz instance which uses the given Classloader as parent Classloader.

This Classloader will be used for several purposes. First, it serves as parent Classloader for the plugin Classloader which is to be created to access classes and configurations from plugins. Second, the Classloader will be used to look up the TinyPlugz service provider either using the ServiceLoader or by looking up an explicit implementation class.

Parameters:

parentClassLoader - The parent Classloader to use.

Returns:

Fluent builder object for further configuration.

setupUsingApplicationClassLoader

public static TinyPlugzConfigurator.DefineProperties setupUsingApplicationClassLoader()

Sets up a TinyPlugz instance which uses the Classloader which loaded the TinyPlugzConfigurator class as parent Classloader.

This Classloader will be used for several purposes. First, it serves as parent Classloader for the plugin Classloader which is to be created to access classes and configurations from plugins. Second, the Classloader will be used to look up the TinyPlugz service provider either using the ServiceLoader or by looking up an explicit implementation class.

Returns:

Fluent builder object for further configuration.