org.apache.ambari.server.stack

Interface StackDefinitionModule<T,I>

All Known Implementing Classes:

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

public interface StackDefinitionModule<T,I>

Stack Definition Module. Represents a module within a stack definition tree. For each stack version specified in a stack definition a tree will exist with a stack module being the root node. Each module may have a parent as well as child modules. Each module has an associated "info" object which contains the underlying state that is being wrapped by the module.

Method Summary

Modifier and Type	Method and Description
void	finalizeModule() Lifecycle even which is called when the associated stack has been fully resolved.
String	getId() Obtain the id of the module.
I	getModuleInfo() Obtain the associated module information.
ModuleState	getModuleState() Module state.
boolean	isDeleted() Determine whether the module has been marked for deletion.
boolean	isValid()
void	resolve(T parent, Map<String,StackModule> allStacks, Map<String,ServiceModule> commonServices, Map<String,ExtensionModule> extensions) Resolve the module state with the specified parent.
void	setValid(boolean valid)

Method Detail

resolve

void resolve(T parent,
             Map<String,StackModule> allStacks,
             Map<String,ServiceModule> commonServices,
             Map<String,ExtensionModule> extensions)
      throws org.apache.ambari.server.AmbariException

Resolve the module state with the specified parent.

Parameters:

parent - the parent that this module will be merged with

allStacks - collection of all stack modules in the tree

commonServices - collection of all common service modules in the tree

extensions - collection of all extension modules in the tree

Throws:

org.apache.ambari.server.AmbariException - if resolution fails

getModuleInfo

I getModuleInfo()

Obtain the associated module information.

Returns:

associated module information

isDeleted

boolean isDeleted()

Determine whether the module has been marked for deletion.

Returns:

true if the module is marked for deletion; otherwise false

getId

String getId()

Obtain the id of the module.

Returns:

module id

finalizeModule

void finalizeModule()

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

getModuleState

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.

Returns:

the module state

isValid

boolean isValid()

Returns:

valid module flag

setValid

void setValid(boolean valid)

Parameters:

valid - set validity flag