org.apache.ambari.server.stack

Class BaseModule<T,I>

java.lang.Object

org.apache.ambari.server.stack.BaseModule<T,I>

All Implemented Interfaces:

StackDefinitionModule<T,I>

Direct Known Subclasses:

ComponentModule, ConfigurationModule, ExtensionModule, QuickLinksConfigurationModule, ServiceModule, StackModule, ThemeModule

public abstract class BaseModule<T,I>
extends Object
implements StackDefinitionModule<T,I>

Abstract base service definition module. Provides functionality that is common across multiple modules.

Field Summary

Fields

Modifier and Type	Field and Description
protected ModuleState	moduleState Module visitation state

Constructor Summary

Constructors

Constructor and Description
BaseModule()

Method Summary

Modifier and Type	Method and Description
protected void	finalizeChildModules(Collection<? extends StackDefinitionModule> modules) Finalize a modules child components.
void	finalizeModule() Lifecycle even which is called when the associated stack has been fully resolved.
ModuleState	getModuleState() Module state.
protected <T extends StackDefinitionModule<T,?>> Collection<T>	mergeChildModules(Map<String,StackModule> allStacks, Map<String,ServiceModule> commonServices, Map<String,ExtensionModule> extensions, Map<String,T> modules, Map<String,T> parentModules) Merges child modules with the corresponding parent modules.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.stack.StackDefinitionModule

getId, getModuleInfo, isDeleted, isValid, resolve, setValid

Field Detail

moduleState

protected ModuleState moduleState

Module visitation state

Constructor Detail

BaseModule

public BaseModule()

Method Detail

getModuleState

public ModuleState getModuleState()

Module state. Initial state is INIT. When resolve is called state is set to VISITED. When resolve completes, state is set to RESOLVED.

Specified by:

getModuleState in interface StackDefinitionModule<T,I>

Returns:

the module's state

mergeChildModules

protected <T extends StackDefinitionModule<T,?>> Collection<T> mergeChildModules(Map<String,StackModule> allStacks,
                                                                                 Map<String,ServiceModule> commonServices,
                                                                                 Map<String,ExtensionModule> extensions,
                                                                                 Map<String,T> modules,
                                                                                 Map<String,T> parentModules)
                                                                          throws org.apache.ambari.server.AmbariException

Merges child modules with the corresponding parent modules.

Parameters:

allStacks - collection of all stack module in stack definition

commonServices - collection of all common service module in stack definition

modules - child modules of this module that are to be merged

parentModules - parent modules which the modules are to be merged with

Returns:

collection of the merged modules

Throws:

org.apache.ambari.server.AmbariException

finalizeChildModules

protected void finalizeChildModules(Collection<? extends StackDefinitionModule> modules)

Finalize a modules child components. Any child module marked as deleted will be removed from this module after finalizing the child.

Parameters:

modules - child modules to finalize

finalizeModule

public void finalizeModule()

Description copied from interface: StackDefinitionModule

Lifecycle even which is called when the associated stack has been fully resolved.

Specified by:

finalizeModule in interface StackDefinitionModule<T,I>