org.diet4j.core

Class DefaultModuleActivator

java.lang.Object

org.diet4j.core.DefaultModuleActivator

All Implemented Interfaces:

ModuleActivator

public class DefaultModuleActivator
extends Object
implements ModuleActivator

This is the default implementation of ModuleActivator. If an activation class was provided for the Module, it looks for static methods 'moduleActivate' and 'moduleDeactivate' in this class. If they exist, they will be invoked when the Module is activated or deactivated. The methods must have the following signature:

 public static void moduleActivate(
         Module thisModule );

 public static void moduleDeactivate(
         Module thisModule );
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVATION_METHOD_NAME Name of the activation method in the ModuleInit class.
static String	DEACTIVATION_METHOD_NAME Name of the deactivation method in the ModuleInit class.
protected Module	theModule The Module that this ModuleActivator can activate.

Constructor Summary

Constructors

Constructor and Description
DefaultModuleActivator(Module mod) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	activate() Activate a Module.
void	deactivate() Deactivate a Module.
ModuleActivator	dependentModuleActivator(Module dependentModule) Obtain a ModuleActivator that is responsible for activating a dependent Module.
Module	getModule() Obtain the Module that this ModuleActivator can activate.

Methods inherited from class java.lang.Object

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

Field Detail

theModule

protected final Module theModule

The Module that this ModuleActivator can activate.

ACTIVATION_METHOD_NAME

public static final String ACTIVATION_METHOD_NAME

Name of the activation method in the ModuleInit class.

See Also:

Constant Field Values

DEACTIVATION_METHOD_NAME

public static final String DEACTIVATION_METHOD_NAME

Name of the deactivation method in the ModuleInit class.

See Also:

Constant Field Values

Constructor Detail

DefaultModuleActivator

public DefaultModuleActivator(Module mod)

Constructor.

Parameters:

mod - the Module to activate

Method Detail

getModule

public Module getModule()

Obtain the Module that this ModuleActivator can activate.

Specified by:

getModule in interface ModuleActivator

Returns:

the Module that this ModuleActivator can activate

activate

public Object activate()
                throws ModuleActivationException

Activate a Module.

Specified by:

activate in interface ModuleActivator

Returns:

a context object that is Module-specific, or null if none

Throws:

ModuleActivationException - throws if the Module could not be activated

deactivate

public void deactivate()
                throws ModuleDeactivationException

Deactivate a Module.

Specified by:

deactivate in interface ModuleActivator

Throws:

ModuleDeactivationException - throws if the Module could not be deactivated

dependentModuleActivator

public ModuleActivator dependentModuleActivator(Module dependentModule)

Obtain a ModuleActivator that is responsible for activating a dependent Module. This method exists in order to be able to override it.

Specified by:

dependentModuleActivator in interface ModuleActivator

Parameters:

dependentModule - the dependent Module to activate

Returns:

the ModuleActivator for the dependent Module