info.magnolia.module
Interface ModuleLifecycleContext

All Known Implementing Classes:

ModuleLifecycleContextImpl

public interface ModuleLifecycleContext

This interface currently provides a hook allowing modules to register ObserverManager instances, which can observer other modules' nodes. In the future, it might provide other callback methods relevant to the lifecycle management of a module.

Version:

$Revision: $ ($Author: $)

Author:

gjoseph

Field Summary

static int	PHASE_MODULE_RESTART A module is restarted.
static int	PHASE_SYSTEM_SHUTDOWN The system is shutting down.
static int	PHASE_SYSTEM_STARTUP System is starting up.

Method Summary

ModuleDefinition	getCurrentModuleDefinition() Gets the current module definition.
int	getPhase() Returns the phase the lifecycle is in.
void	registerModuleObservingComponent(String nodeName, ObservedManager component) Registers a component which will observe other modules' config node with the given nodeName.

Field Detail

PHASE_SYSTEM_STARTUP

static final int PHASE_SYSTEM_STARTUP

System is starting up.

See Also:

Constant Field Values

PHASE_MODULE_RESTART

static final int PHASE_MODULE_RESTART

A module is restarted. This is triggered through observation (change in the config node).

See Also:

Constant Field Values

PHASE_SYSTEM_SHUTDOWN

static final int PHASE_SYSTEM_SHUTDOWN

The system is shutting down.

See Also:

Constant Field Values

Method Detail

getCurrentModuleDefinition

ModuleDefinition getCurrentModuleDefinition()

Gets the current module definition.

getPhase

int getPhase()

Returns the phase the lifecycle is in. This is one of the phase constants.

registerModuleObservingComponent

void registerModuleObservingComponent(String nodeName,
                                      ObservedManager component)

Registers a component which will observe other modules' config node with the given nodeName.