info.magnolia.module

Class ModuleLifecycleContextImpl

java.lang.Object

info.magnolia.module.ModuleLifecycleContextImpl

All Implemented Interfaces:

ModuleLifecycleContext

public class ModuleLifecycleContextImpl
extends Object
implements ModuleLifecycleContext

This default implementation of ModuleLifecycleContext allows the ModuleManager to set the current "phase" of installation; other ModuleLifecycleContext clients have read-only access to the phase.

Field Summary

Fields inherited from interface info.magnolia.module.ModuleLifecycleContext

PHASE_MODULE_RESTART, PHASE_SYSTEM_SHUTDOWN, PHASE_SYSTEM_STARTUP

Constructor Summary

Constructors

Constructor and Description
ModuleLifecycleContextImpl()

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	setCurrentModuleDefinition(ModuleDefinition currentModuleDefinition)
void	setPhase(int phase)
void	start(Collection<Content> moduleNodes)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleLifecycleContextImpl

public ModuleLifecycleContextImpl()

Method Detail

registerModuleObservingComponent

public void registerModuleObservingComponent(String nodeName,
                                    ObservedManager component)

Description copied from interface: ModuleLifecycleContext

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

Specified by:

registerModuleObservingComponent in interface ModuleLifecycleContext

start

public void start(Collection<Content> moduleNodes)

Parameters:

moduleNodes - a Collection<Content> of module nodes.

getCurrentModuleDefinition

public ModuleDefinition getCurrentModuleDefinition()

Description copied from interface: ModuleLifecycleContext

Gets the current module definition.

Specified by:

getCurrentModuleDefinition in interface ModuleLifecycleContext

setCurrentModuleDefinition

public void setCurrentModuleDefinition(ModuleDefinition currentModuleDefinition)

getPhase

public int getPhase()

Description copied from interface: ModuleLifecycleContext

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

Specified by:

getPhase in interface ModuleLifecycleContext

setPhase

public void setPhase(int phase)