Package eu.cloudnetservice.driver.module

Class DefaultModuleProviderHandler

java.lang.Object

eu.cloudnetservice.driver.module.DefaultModuleProviderHandler

All Implemented Interfaces:

ModuleProviderHandler

@Singleton
public class DefaultModuleProviderHandler
extends Object
implements ModuleProviderHandler

Represents the default implementation of the module provider handler.

Since:

4.0

See Also:

• ModuleProviderHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final EventManager	eventManager
private static final eu.cloudnetservice.common.log.Logger	LOGGER
protected final ModuleProvider	moduleProvider
protected final ServiceRegistry	serviceRegistry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultModuleProviderHandler(@NonNull EventManager eventManager, @NonNull ModuleProvider moduleProvider, @NonNull ServiceRegistry serviceRegistry)

Method Summary

Modifier and Type	Method	Description
protected <T extends Event> T	callEvent(T event)	Shortcut for calling an event using EventManager.callEvent(Event)
void	handlePostInstallDependency(@NonNull ModuleConfiguration configuration, @NonNull ModuleDependency dependency)	Called when a dependency for a module was loaded.
void	handlePostModuleLoad(@NonNull ModuleWrapper moduleWrapper)	Called when a module was loaded.
void	handlePostModuleReload(@NonNull ModuleWrapper moduleWrapper)	Called when a module was reloaded.
void	handlePostModuleStart(@NonNull ModuleWrapper moduleWrapper)	Called when a module was started.
void	handlePostModuleStop(@NonNull ModuleWrapper moduleWrapper)	Called when a module was stopped.
void	handlePostModuleUnload(@NonNull ModuleWrapper moduleWrapper)	Called when a module was unloaded.
void	handlePreInstallDependency(@NonNull ModuleConfiguration configuration, @NonNull ModuleDependency dependency)	Called when a dependency for a module is about to get loaded.
boolean	handlePreModuleLoad(@NonNull ModuleWrapper moduleWrapper)	Called when a module is about to get loaded.
boolean	handlePreModuleReload(@NonNull ModuleWrapper moduleWrapper)	Called when a module is about to get reloaded.
boolean	handlePreModuleStart(@NonNull ModuleWrapper moduleWrapper)	Called when a module is about to get started.
boolean	handlePreModuleStop(@NonNull ModuleWrapper moduleWrapper)	Called when a module is about to get stopped.
void	handlePreModuleUnload(@NonNull ModuleWrapper moduleWrapper)	Called when a module is about to get unloaded.
protected Object[]	moduleArguments(@NonNull ModuleConfiguration configuration)	Creates a new object array with these properties of the module: group name version

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

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

eventManager

protected final EventManager eventManager

moduleProvider

protected final ModuleProvider moduleProvider

serviceRegistry

protected final ServiceRegistry serviceRegistry

Constructor Details

DefaultModuleProviderHandler

@Inject
protected DefaultModuleProviderHandler(@NonNull
 @NonNull EventManager eventManager,
 @NonNull
 @NonNull ModuleProvider moduleProvider,
 @NonNull
 @NonNull ServiceRegistry serviceRegistry)

Method Details

handlePreModuleLoad

public boolean handlePreModuleLoad(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module is about to get loaded.

Specified by:

handlePreModuleLoad in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module wrapper which will be loaded.

Returns:

if the module is allowed to load.

handlePostModuleLoad

public void handlePostModuleLoad(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module was loaded.

Specified by:

handlePostModuleLoad in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which was loaded.

handlePreModuleStart

public boolean handlePreModuleStart(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module is about to get started.

Specified by:

handlePreModuleStart in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which will be started.

Returns:

if the module is allowed to start.

handlePostModuleStart

public void handlePostModuleStart(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module was started.

Specified by:

handlePostModuleStart in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which was started.

handlePreModuleReload

public boolean handlePreModuleReload(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module is about to get reloaded.

Specified by:

handlePreModuleReload in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which will be reloaded.

Returns:

if the module is allowed to be reloaded.

handlePostModuleReload

public void handlePostModuleReload(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module was reloaded.

Specified by:

handlePostModuleReload in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which was reloaded.

handlePreModuleStop

public boolean handlePreModuleStop(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module is about to get stopped.

Specified by:

handlePreModuleStop in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which will be stopped.

Returns:

if the module is allowed to stop.

handlePostModuleStop

public void handlePostModuleStop(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module was stopped.

Specified by:

handlePostModuleStop in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which was stopped.

handlePreModuleUnload

public void handlePreModuleUnload(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module is about to get unloaded.

Specified by:

handlePreModuleUnload in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which will be unloaded.

handlePostModuleUnload

public void handlePostModuleUnload(@NonNull
 @NonNull ModuleWrapper moduleWrapper)

Called when a module was unloaded.

Specified by:

handlePostModuleUnload in interface ModuleProviderHandler

Parameters:

moduleWrapper - the module which was unloaded.

handlePreInstallDependency

public void handlePreInstallDependency(@NonNull
 @NonNull ModuleConfiguration configuration,
 @NonNull
 @NonNull ModuleDependency dependency)

Called when a dependency for a module is about to get loaded.

Specified by:

handlePreInstallDependency in interface ModuleProviderHandler

Parameters:

configuration - the configuration of the module in which the dependency is declared.

dependency - the dependency which will be loaded.

handlePostInstallDependency

public void handlePostInstallDependency(@NonNull
 @NonNull ModuleConfiguration configuration,
 @NonNull
 @NonNull ModuleDependency dependency)

Called when a dependency for a module was loaded.

Specified by:

handlePostInstallDependency in interface ModuleProviderHandler

Parameters:

configuration - the configuration of the module in which the dependency is declared.

dependency - the dependency which was loaded.

callEvent

@NonNull
protected <T extends Event> T callEvent(@NonNull
 T event)

Shortcut for calling an event using EventManager.callEvent(Event)

Type Parameters:

T - the method parameter of the event

Parameters:

event - the event to call.

Returns:

the same given event instance.

Throws:

NullPointerException - if event is null.

moduleArguments

protected Object[] moduleArguments(@NonNull
 @NonNull ModuleConfiguration configuration)

Creates a new object array with these properties of the module:

1. group
2. name
3. version

Parameters:

configuration - the module configuration to obtain the information from.

Returns:

an object array containing the group, name and version of the module.

Throws:

NullPointerException - if configuration is null.