Package eu.cloudnetservice.driver.module

Class DefaultModuleWrapper

java.lang.Object

eu.cloudnetservice.driver.module.DefaultModuleWrapper

All Implemented Interfaces:

InjectionLayerHolder<dev.derklaro.aerogel.SpecifiedInjector>, ModuleWrapper

public class DefaultModuleWrapper
extends Object
implements ModuleWrapper

Represents the default implementation of the module wrapper.

Since:

4.0

See Also:

• ModuleWrapper

Field Summary

Fields

Modifier and Type	Field	Description
private final URLClassLoader	classLoader
private final Path	dataDirectory
private final Set<ModuleDependency>	dependingModules
private final AtomicReference<ModuleLifeCycle>	lifeCycle
protected static final eu.cloudnetservice.common.log.Logger	LOGGER
private final Module	module
private final ModuleConfiguration	moduleConfiguration
private final InjectionLayer<dev.derklaro.aerogel.SpecifiedInjector>	moduleInjectionLayer
private final Lock	moduleLifecycleUpdateLock
private final ModuleProvider	provider
private final URL	source
private final URI	sourceUri
protected static final Comparator<ModuleTaskEntry>	TASK_COMPARATOR
private final Map<ModuleLifeCycle,List<ModuleTaskEntry>>	tasks

Constructor Summary

Constructors

Constructor	Description
DefaultModuleWrapper(@NonNull URL source, @NonNull Module module, @NonNull Path dataDirectory, @NonNull ModuleProvider provider, @NonNull URLClassLoader classLoader, @NonNull Set<ModuleDependency> dependingModules, @NonNull ModuleConfiguration moduleConfiguration, @NonNull InjectionLayer<dev.derklaro.aerogel.SpecifiedInjector> moduleInjectionLayer)	Creates a new instance of a default module wrapper.

Method Summary

Modifier and Type	Method	Description
@NonNull ClassLoader	classLoader()	Get the class loader which is responsible for this module.
@NonNull Path	dataDirectory()	Get the data directory of this module in which the module should store its configuration files.
@NonNull @Unmodifiable Set<ModuleDependency>	dependingModules()	Get all modules this module is depending on.
protected boolean	fireModuleTaskEntry(@NonNull ModuleTaskEntry entry)	Fires a specific module task entry.
@NonNull InjectionLayer<dev.derklaro.aerogel.SpecifiedInjector>	injectionLayer()	Get the injection layer which was used while creating this module instance and is used to inject module tasks.
@NonNull ModuleWrapper	loadModule()	Changes the lifecycle of this module to ModuleLifeCycle.LOADED if possible and fires all associated tasks.
@NonNull Module	module()	Get the wrapped module instance of this wrapper.
@NonNull ModuleConfiguration	moduleConfiguration()	Get the module configuration on which base the module was created.
@NonNull ModuleLifeCycle	moduleLifeCycle()	Get the current lifecycle of this wrapper.
@NonNull ModuleProvider	moduleProvider()	Get the module provider which loaded this module.
@NonNull Map<ModuleLifeCycle,List<ModuleTaskEntry>>	moduleTasks()	Get all module tasks which were detected in the main class of the module.
protected void	pushLifecycleChange(@NonNull ModuleLifeCycle lifeCycle, boolean notifyProvider)	Fires all handlers registered for the specified lifeCycle.
@NonNull ModuleWrapper	reloadModule()	Changes the lifecycle of this module to ModuleLifeCycle.RELOADING if possible and fires all associated tasks.
protected @NonNull Map<ModuleLifeCycle,List<ModuleTaskEntry>>	resolveModuleTasks(@NonNull Module module)	Resolves all module tasks in the main class of a module.
@NonNull ModuleWrapper	startModule()	Changes the lifecycle of this module to ModuleLifeCycle.STARTED if possible and fires all associated tasks.
@NonNull ModuleWrapper	stopModule()	Changes the lifecycle of this module to ModuleLifeCycle.STOPPED if possible and fires all associated tasks.
@NonNull ModuleWrapper	unloadModule()	Changes the lifecycle of this module to ModuleLifeCycle.UNLOADED if possible and fires all associated tasks.
@NonNull URI	uri()	Get the uri from where the module was loaded.
@NonNull URL	url()	Get the url from where the module was loaded.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

protected static final eu.cloudnetservice.common.log.Logger LOGGER

TASK_COMPARATOR

protected static final Comparator<ModuleTaskEntry> TASK_COMPARATOR

source

private final URL source

sourceUri

private final URI sourceUri

module

private final Module module

dataDirectory

private final Path dataDirectory

provider

private final ModuleProvider provider

classLoader

private final URLClassLoader classLoader

dependingModules

private final Set<ModuleDependency> dependingModules

moduleConfiguration

private final ModuleConfiguration moduleConfiguration

moduleInjectionLayer

private final InjectionLayer<dev.derklaro.aerogel.SpecifiedInjector> moduleInjectionLayer

moduleLifecycleUpdateLock

private final Lock moduleLifecycleUpdateLock

tasks

private final Map<ModuleLifeCycle,List<ModuleTaskEntry>> tasks

lifeCycle

private final AtomicReference<ModuleLifeCycle> lifeCycle

Constructor Details

DefaultModuleWrapper

public DefaultModuleWrapper(@NonNull
 @NonNull URL source,
 @NonNull
 @NonNull Module module,
 @NonNull
 @NonNull Path dataDirectory,
 @NonNull
 @NonNull ModuleProvider provider,
 @NonNull
 @NonNull URLClassLoader classLoader,
 @NonNull
 @NonNull Set<ModuleDependency> dependingModules,
 @NonNull
 @NonNull ModuleConfiguration moduleConfiguration,
 @NonNull
 @NonNull InjectionLayer<dev.derklaro.aerogel.SpecifiedInjector> moduleInjectionLayer)
                     throws URISyntaxException

Creates a new instance of a default module wrapper.

Parameters:

source - the module file from which this module was loaded initially.

module - the instance of the module main class constructed by the provider.

dataDirectory - the data directory of this module relative to the module provider directory.

provider - the provider which loaded this module.

classLoader - the class loader which was used to load the main class from the file.

dependingModules - the modules this module depends on and which need to get loaded first.

moduleConfiguration - the parsed module configuration located in the module file.

moduleInjectionLayer - the injection layer of the module.

Throws:

URISyntaxException - if the given module source is not formatted strictly according to RFC2396.

NullPointerException - if one of the given arguments is null.

Method Details

moduleTasks

@NonNull
public @NonNull Map<ModuleLifeCycle,List<ModuleTaskEntry>> moduleTasks()

Get all module tasks which were detected in the main class of the module.

Specified by:

moduleTasks in interface ModuleWrapper

Returns:

an immutable map of all module tasks which were detected in the main class of the module.

dependingModules

@NonNull
public @NonNull @Unmodifiable Set<ModuleDependency> dependingModules()

Get all modules this module is depending on.

Specified by:

dependingModules in interface ModuleWrapper

Returns:

an immutable set of all modules this module is depending on.

module

@NonNull
public @NonNull Module module()

Get the wrapped module instance of this wrapper.

Specified by:

module in interface ModuleWrapper

Returns:

the wrapped module instance of this wrapper.

moduleLifeCycle

@NonNull
public @NonNull ModuleLifeCycle moduleLifeCycle()

Get the current lifecycle of this wrapper.

Specified by:

moduleLifeCycle in interface ModuleWrapper

Returns:

the current lifecycle of this wrapper.

moduleProvider

@NonNull
public @NonNull ModuleProvider moduleProvider()

Get the module provider which loaded this module.

Specified by:

moduleProvider in interface ModuleWrapper

Returns:

the module provider which loaded this module.

moduleConfiguration

@NonNull
public @NonNull ModuleConfiguration moduleConfiguration()

Get the module configuration on which base the module was created.

Specified by:

moduleConfiguration in interface ModuleWrapper

Returns:

the module configuration on which base the module was created.

classLoader

@NonNull
public @NonNull ClassLoader classLoader()

Get the class loader which is responsible for this module.

Specified by:

classLoader in interface ModuleWrapper

Returns:

the class loader which is responsible for this module.

loadModule

@NonNull
public @NonNull ModuleWrapper loadModule()

Changes the lifecycle of this module to ModuleLifeCycle.LOADED if possible and fires all associated tasks.

Specified by:

loadModule in interface ModuleWrapper

Returns:

the same instance of this class, for chaining.

See Also:

• ModuleWrapper.moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

startModule

@NonNull
public @NonNull ModuleWrapper startModule()

Changes the lifecycle of this module to ModuleLifeCycle.STARTED if possible and fires all associated tasks.

Specified by:

startModule in interface ModuleWrapper

Returns:

the same instance of this class, for chaining.

See Also:

• ModuleWrapper.moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

reloadModule

@NonNull
public @NonNull ModuleWrapper reloadModule()

Changes the lifecycle of this module to ModuleLifeCycle.RELOADING if possible and fires all associated tasks.

Specified by:

reloadModule in interface ModuleWrapper

Returns:

the same instance of this class, for chaining.

See Also:

• ModuleWrapper.moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

stopModule

@NonNull
public @NonNull ModuleWrapper stopModule()

Changes the lifecycle of this module to ModuleLifeCycle.STOPPED if possible and fires all associated tasks.

Specified by:

stopModule in interface ModuleWrapper

Returns:

the same instance of this class, for chaining.

See Also:

• ModuleWrapper.moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

unloadModule

@NonNull
public @NonNull ModuleWrapper unloadModule()

Changes the lifecycle of this module to ModuleLifeCycle.UNLOADED if possible and fires all associated tasks. The module will be unregistered from the provider, the class loader will be closed and the state of this module changes to ModuleLifeCycle.UNUSABLE.

Specified by:

unloadModule in interface ModuleWrapper

Returns:

the same instance of this class, for chaining.

See Also:

• ModuleWrapper.moduleTasks()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)
• ModuleProvider.notifyPreModuleLifecycleChange(ModuleWrapper, ModuleLifeCycle)

dataDirectory

@NonNull
public @NonNull Path dataDirectory()

Get the data directory of this module in which the module should store its configuration files.

Specified by:

dataDirectory in interface ModuleWrapper

Returns:

the data directory of this module.

url

@NonNull
public @NonNull URL url()

Get the url from where the module was loaded.

Specified by:

url in interface ModuleWrapper

Returns:

the url from where the module was loaded.

uri

@NonNull
public @NonNull URI uri()

Get the uri from where the module was loaded.

Specified by:

uri in interface ModuleWrapper

Returns:

the uri from where the module was loaded.

injectionLayer

@NonNull
public @NonNull InjectionLayer<dev.derklaro.aerogel.SpecifiedInjector> injectionLayer()

Get the injection layer which was used while creating this module instance and is used to inject module tasks.

Specified by:

injectionLayer in interface InjectionLayerHolder<dev.derklaro.aerogel.SpecifiedInjector>

Specified by:

injectionLayer in interface ModuleWrapper

Returns:

the injection layer of the module.

resolveModuleTasks

@NonNull
protected @NonNull Map<ModuleLifeCycle,List<ModuleTaskEntry>> resolveModuleTasks(@NonNull
 @NonNull Module module)

Resolves all module tasks in the main class of a module. Declared methods are working as well. The returned map should only contain the tasks sorted as there will be no later step to sort them. Not all module lifecycle states must be in the returned map, if a lifecycle is missing it will be assumed that there is no tasks for that lifecycle.

Parameters:

module - the module instance (better known as the module main class) to resolve the tasks of.

Returns:

all sorted resolved tasks mapped to the lifecycle they will be called in.

pushLifecycleChange

protected void pushLifecycleChange(@NonNull
 @NonNull ModuleLifeCycle lifeCycle,
 boolean notifyProvider)

Fires all handlers registered for the specified lifeCycle.

Parameters:

lifeCycle - the lifecycle to fire the tasks of.

notifyProvider - if the module provider should be notified about the change or not.

fireModuleTaskEntry

protected boolean fireModuleTaskEntry(@NonNull
 @NonNull ModuleTaskEntry entry)

Fires a specific module task entry.

Parameters:

entry - the entry to fire.

Returns:

true if the entry couldn't be fired successfully, false otherwise.