Class DefaultModuleProvider

java.lang.Object

eu.cloudnetservice.driver.module.DefaultModuleProvider

All Implemented Interfaces:

ModuleProvider

@Singleton
@Provides(ModuleProvider.class)
public class DefaultModuleProvider
extends Object
implements ModuleProvider

Represents the default implementation of the module provider.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final dev.derklaro.aerogel.Element	DATA_DIRECTORY_ELEMENT
protected static final ModuleDependencyLoader	DEFAULT_DEP_LOADER
static final Path	DEFAULT_LIB_DIR
static final Path	DEFAULT_MODULE_DIR
protected static final org.slf4j.Logger	LOGGER
private static final dev.derklaro.aerogel.Element	MODULE_CONFIGURATION_ELEMENT
protected ModuleDependencyLoader	moduleDependencyLoader
protected Path	moduleDirectory
protected ModuleProviderHandler	moduleProviderHandler
protected final Collection<ModuleWrapper>	modules

Constructor Summary

Constructors

Constructor	Description
DefaultModuleProvider()	Creates a new default module provider by calling with the default library directory and the default dependency loader.
DefaultModuleProvider(@NonNull Path moduleDirectory, @NonNull ModuleDependencyLoader moduleDependencyLoader)	Creates a new default module provider with the given directory and dependency loader.

Method Summary

Modifier and Type	Method	Description
protected @NonNull Map<String,String>	collectModuleProvidedRepositories(@NonNull ModuleConfiguration configuration)	Collects all repositories provided in the given ModuleConfiguration to a standard url format.
protected @NonNull URL	doLoadDependency(@NonNull ModuleDependency dependency, @NonNull ModuleConfiguration configuration, @Nullable ModuleProviderHandler handler, @NonNull Callable<URL> loader)	Tries to load a module dependency.
protected @NonNull Optional<ModuleWrapper>	findModuleBySource(@NonNull URL fileSource)	Finds a loaded module based on the given file source url.
protected @NonNull Optional<ModuleConfiguration>	findModuleConfiguration(@NonNull URL moduleFile)	Finds the module.json file in the provided module file and deserializes it.
@NonNull ModuleProvider	loadAll()	Loads all modules which files are located at the module directory.
protected @NonNull eu.cloudnetservice.common.tuple.Tuple2<Set<URL>,Set<ModuleDependency>>	loadDependencies(@NonNull Map<String,String> repos, @NonNull ModuleConfiguration configuration)	Loads all dependencies defined in the module configuration file.
@Nullable ModuleWrapper	loadModule(@NonNull URL url)	Loads a module from the given url.
@Nullable ModuleWrapper	loadModule(@NonNull Path path)	Loads the module by the file provided by the given path.
@Nullable ModuleWrapper	module(@NonNull String name)	Get a module by the given name.
@NonNull ModuleDependencyLoader	moduleDependencyLoader()	Get the module dependency loader.
void	moduleDependencyLoader(@NonNull ModuleDependencyLoader moduleDependencyLoader)	Sets the module dependency loader which should be used by this provider.
@NonNull Path	moduleDirectoryPath()	Get the base directory of this module provider.
void	moduleDirectoryPath(@NonNull Path moduleDirectory)	Sets the base directory of this module provider.
@Nullable ModuleProviderHandler	moduleProviderHandler()	Get the module provider handler of this provider or null when no handler is specified.
void	moduleProviderHandler(@Nullable ModuleProviderHandler moduleProviderHandler)	Sets the module provider handler of this provider.
@NonNull Collection<ModuleWrapper>	modules()	Get all loaded, started, stopped modules provided by this provider.
@NonNull Collection<ModuleWrapper>	modules(@NonNull String group)	Get all loaded, started, stopped modules provided by this provider which have the specific given group.
void	notifyPostModuleLifecycleChange(@NonNull ModuleWrapper wrapper, @NonNull ModuleLifeCycle lifeCycle)	Called by an ModuleWrapper when the module changed its lifecycle state.
boolean	notifyPreModuleLifecycleChange(@NonNull ModuleWrapper wrapper, @NonNull ModuleLifeCycle lifeCycle)	Called by an ModuleWrapper when the module is about to change its lifecycle state.
@NonNull ModuleProvider	reloadAll()	Reloads all modules which are loaded by this provided and can change to the started state.
@NonNull ModuleProvider	startAll()	Starts all modules which are loaded by this provided and can change to the started state.
@NonNull ModuleProvider	stopAll()	Stops all modules which are loaded by this provided and can change to the stopped state.
@NonNull ModuleProvider	unloadAll()	Unloads all modules which are loaded by this provided and can change to the unloaded state.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LIB_DIR

public static final Path DEFAULT_LIB_DIR

DEFAULT_MODULE_DIR

public static final Path DEFAULT_MODULE_DIR

LOGGER

protected static final org.slf4j.Logger LOGGER

DEFAULT_DEP_LOADER

protected static final ModuleDependencyLoader DEFAULT_DEP_LOADER

MODULE_CONFIGURATION_ELEMENT

private static final dev.derklaro.aerogel.Element MODULE_CONFIGURATION_ELEMENT

DATA_DIRECTORY_ELEMENT

private static final dev.derklaro.aerogel.Element DATA_DIRECTORY_ELEMENT

modules

protected final Collection<ModuleWrapper> modules

moduleDirectory

protected Path moduleDirectory

moduleProviderHandler

protected ModuleProviderHandler moduleProviderHandler

moduleDependencyLoader

protected ModuleDependencyLoader moduleDependencyLoader

Constructor Details

DefaultModuleProvider

public DefaultModuleProvider()

Creates a new default module provider by calling with the default library directory and the default dependency loader.

The default library directory is DEFAULT_LIB_DIR. The default dependency loader is DEFAULT_DEP_LOADER

DefaultModuleProvider

public DefaultModuleProvider(@NonNull
 @NonNull Path moduleDirectory,
 @NonNull
 @NonNull ModuleDependencyLoader moduleDependencyLoader)

Creates a new default module provider with the given directory and dependency loader.

Parameters:

moduleDirectory - the directory where modules are stored.

moduleDependencyLoader - the dependency loader to load all module dependencies.

Throws:

NullPointerException - if the given module directory or dependency loader is null.

See Also:

• ModuleDependencyLoader

Method Details

moduleDirectoryPath

@NonNull
public @NonNull Path moduleDirectoryPath()

Get the base directory of this module provider. It will be used to provide the data directory for modules which did not specifically set a data directory.

Specified by:

moduleDirectoryPath in interface ModuleProvider

Returns:

the base directory of this module provider.

See Also:

• ModuleProvider.moduleDirectoryPath(Path)

moduleDirectoryPath

public void moduleDirectoryPath(@NonNull
 @NonNull Path moduleDirectory)

Sets the base directory of this module provider. It will be used to provide the data directory for modules which did not specifically set a data directory.

Specified by:

moduleDirectoryPath in interface ModuleProvider

Parameters:

moduleDirectory - the module directory to use.

See Also:

• ModuleProvider.moduleDirectoryPath()

moduleProviderHandler

@Nullable
public @Nullable ModuleProviderHandler moduleProviderHandler()

Get the module provider handler of this provider or null when no handler is specified.

Specified by:

moduleProviderHandler in interface ModuleProvider

Returns:

the module provider handler of this provider or null.

See Also:

• ModuleProvider.moduleProviderHandler(ModuleProviderHandler)

moduleProviderHandler

public void moduleProviderHandler(@Nullable
 @Nullable ModuleProviderHandler moduleProviderHandler)

Sets the module provider handler of this provider.

Specified by:

moduleProviderHandler in interface ModuleProvider

Parameters:

moduleProviderHandler - the new module provider to use or null when no handler should be used.

See Also:

• ModuleProvider.moduleProviderHandler()

moduleDependencyLoader

@NonNull
public @NonNull ModuleDependencyLoader moduleDependencyLoader()

Get the module dependency loader. It's used to load all dependencies of all modules.

This handler is by default DefaultModuleDependencyLoader.

Specified by:

moduleDependencyLoader in interface ModuleProvider

Returns:

the module provider handler used for this provider.

See Also:

• ModuleProvider.moduleDependencyLoader(ModuleDependencyLoader)
• DefaultModuleDependencyLoader

moduleDependencyLoader

public void moduleDependencyLoader(@NonNull
 @NonNull ModuleDependencyLoader moduleDependencyLoader)

Sets the module dependency loader which should be used by this provider.

Specified by:

moduleDependencyLoader in interface ModuleProvider

Parameters:

moduleDependencyLoader - the module dependency loader to use.

See Also:

• ModuleProvider.moduleDependencyLoader()
• DefaultModuleDependencyLoader

modules

@NonNull
public @NonNull Collection<ModuleWrapper> modules()

Get all loaded, started, stopped modules provided by this provider.

Specified by:

modules in interface ModuleProvider

Returns:

an immutable set of all loaded, started, stopped modules provided by this provider.

See Also:

• ModuleLifeCycle

modules

@NonNull
public @NonNull Collection<ModuleWrapper> modules(@NonNull
 @NonNull String group)

Get all loaded, started, stopped modules provided by this provider which have the specific given group.

Specified by:

modules in interface ModuleProvider

Parameters:

group - the group id of the modules to get.

Returns:

an immutable set of all loaded, started, stopped modules provided by this provider which have the specific given group.

See Also:

• ModuleLifeCycle

module

@Nullable
public @Nullable ModuleWrapper module(@NonNull
 @NonNull String name)

Get a module by the given name.

Specified by:

module in interface ModuleProvider

Parameters:

name - the name of the module to get.

Returns:

the module associated with the name or null if no such module is loaded.

loadModule

@Nullable
public @Nullable ModuleWrapper loadModule(@NonNull
 @NonNull URL url)

Loads a module from the given url.

Specified by:

loadModule in interface ModuleProvider

Parameters:

url - the url to load the module from.

Returns:

the loaded module or null if checks failed or a module from this url is already loaded.

loadModule

@Nullable
public @Nullable ModuleWrapper loadModule(@NonNull
 @NonNull Path path)

Loads the module by the file provided by the given path.

Specified by:

loadModule in interface ModuleProvider

Parameters:

path - the path to load the module from.

Returns:

the loaded module or null if checks failed or a module from this path is already loaded.

See Also:

• ModuleProvider.loadModule(URL)

loadAll

@NonNull
public @NonNull ModuleProvider loadAll()

Description copied from interface: ModuleProvider

Loads all modules which files are located at the module directory.

Specified by:

loadAll in interface ModuleProvider

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

startAll

@NonNull
public @NonNull ModuleProvider startAll()

Starts all modules which are loaded by this provided and can change to the started state.

Specified by:

startAll in interface ModuleProvider

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

reloadAll

@NonNull
public @NonNull ModuleProvider reloadAll()

Reloads all modules which are loaded by this provided and can change to the started state.

Specified by:

reloadAll in interface ModuleProvider

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

stopAll

@NonNull
public @NonNull ModuleProvider stopAll()

Stops all modules which are loaded by this provided and can change to the stopped state.

Specified by:

stopAll in interface ModuleProvider

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

unloadAll

@NonNull
public @NonNull ModuleProvider unloadAll()

Unloads all modules which are loaded by this provided and can change to the unloaded state.

Specified by:

unloadAll in interface ModuleProvider

Returns:

the same instance of the class, for chaining.

See Also:

• ModuleWrapper.moduleLifeCycle()
• ModuleLifeCycle.canChangeTo(ModuleLifeCycle)

notifyPreModuleLifecycleChange

public boolean notifyPreModuleLifecycleChange(@NonNull
 @NonNull ModuleWrapper wrapper,
 @NonNull
 @NonNull ModuleLifeCycle lifeCycle)

Called by an ModuleWrapper when the module is about to change its lifecycle state.

Specified by:

notifyPreModuleLifecycleChange in interface ModuleProvider

Parameters:

wrapper - the wrapper which is changing the lifecycle.

lifeCycle - the lifecycle the wrapper want's to change to.

Returns:

If the wrapper is allowed to change the lifecycle to the provided lifecycle.

notifyPostModuleLifecycleChange

public void notifyPostModuleLifecycleChange(@NonNull
 @NonNull ModuleWrapper wrapper,
 @NonNull
 @NonNull ModuleLifeCycle lifeCycle)

Called by an ModuleWrapper when the module changed its lifecycle state.

Specified by:

notifyPostModuleLifecycleChange in interface ModuleProvider

Parameters:

wrapper - the wrapper which changed the lifecycle.

lifeCycle - the lifecycle the wrapper changed to.

findModuleConfiguration

@NonNull
protected @NonNull Optional<ModuleConfiguration> findModuleConfiguration(@NonNull
 @NonNull URL moduleFile)
                                                                  throws IOException

Finds the module.json file in the provided module file and deserializes it.

Parameters:

moduleFile - the module file to find the module configuration of.

Returns:

the deserialized module configuration file located in the provided module file.

Throws:

IOException - if an I/O or deserialize exception occurs.

NullPointerException - if the given module file is null.

findModuleBySource

@NonNull
protected @NonNull Optional<ModuleWrapper> findModuleBySource(@NonNull
 @NonNull URL fileSource)
                                                       throws URISyntaxException

Finds a loaded module based on the given file source url.

Parameters:

fileSource - the source to find the associated module with.

Returns:

the associated module to the given url.

Throws:

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

NullPointerException - if the given file source is null.

collectModuleProvidedRepositories

@NonNull
protected @NonNull Map<String,String> collectModuleProvidedRepositories(@NonNull
 @NonNull ModuleConfiguration configuration)

Collects all repositories provided in the given ModuleConfiguration to a standard url format.

Parameters:

configuration - the module configuration to read the repositories from.

Returns:

all configured repositories in a standardized way.

Throws:

NullPointerException - if configuration is null.

loadDependencies

@NonNull
protected @NonNull eu.cloudnetservice.common.tuple.Tuple2<Set<URL>,Set<ModuleDependency>> loadDependencies(@NonNull
 @NonNull Map<String,String> repos,
 @NonNull
 @NonNull ModuleConfiguration configuration)

Loads all dependencies defined in the module configuration file.

Parameters:

repos - the repositories from which the dependencies can get loaded.

configuration - the configuration of the module to load the dependencies of.

Returns:

a pair, first are all the loaded dependencies; second are all the pending ones (module dependencies)

Throws:

AssertionError - if one dependency can't be loaded.

NullPointerException - if repos or configuration is null.

doLoadDependency

@NonNull
protected @NonNull URL doLoadDependency(@NonNull
 @NonNull ModuleDependency dependency,
 @NonNull
 @NonNull ModuleConfiguration configuration,
 @Nullable
 @Nullable ModuleProviderHandler handler,
 @NonNull
 @NonNull Callable<URL> loader)

Tries to load a module dependency. This method is fail-fast.

Parameters:

dependency - the dependency to load.

configuration - the configuration from which the dependency was declared.

handler - the provider handler if one is set and should be notified, else null.

loader - the callback which will load the dependency.

Returns:

the location of the loaded dependency in url form.

Throws:

AssertionError - if loader fails to load the dependency.

NullPointerException - if dependency, configuration, handler or loader is null.