org.apache.ambari.server.stack

Class ConfigurationModule

java.lang.Object

org.apache.ambari.server.stack.BaseModule<ConfigurationModule,ConfigurationInfo>

org.apache.ambari.server.stack.ConfigurationModule

All Implemented Interfaces:

StackDefinitionModule<ConfigurationModule,ConfigurationInfo>, Validable

public class ConfigurationModule
extends BaseModule<ConfigurationModule,ConfigurationInfo>
implements Validable

Configuration module which provides functionality related to parsing and fully resolving a configuration from the stack definition. Each instance is specific to a configuration type.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	valid validity flag

Fields inherited from class org.apache.ambari.server.stack.BaseModule

moduleState

Constructor Summary

Constructors

Constructor and Description
ConfigurationModule(String configType, ConfigurationInfo info) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addError(String error)
void	addErrors(Collection<String> errors)
String	getConfigType() Obtain the configuration type.
Collection<String>	getErrors()
String	getId() Obtain the id of the module.
ConfigurationInfo	getModuleInfo() Obtain the associated module information.
boolean	isDeleted() Determine whether the module has been marked for deletion.
boolean	isValid()
void	resolve(ConfigurationModule parent, Map<String,StackModule> allStacks, Map<String,ServiceModule> commonServices, Map<String,ExtensionModule> extensions) Resolve the module state with the specified parent.
void	setDeleted(boolean isDeleted) Set the deleted flag.
void	setValid(boolean valid)

Methods inherited from class org.apache.ambari.server.stack.BaseModule

finalizeChildModules, finalizeModule, getModuleState, mergeChildModules

Methods inherited from class java.lang.Object

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

Field Detail

valid

protected boolean valid

validity flag

Constructor Detail

ConfigurationModule

public ConfigurationModule(String configType,
                           ConfigurationInfo info)

Constructor.

Parameters:

configType - configuration type

info - configuration info

Method Detail

addError

public void addError(String error)

Specified by:

addError in interface Validable

getErrors

public Collection<String> getErrors()

Specified by:

getErrors in interface Validable

resolve

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

Description copied from interface: StackDefinitionModule

Resolve the module state with the specified parent.

Specified by:

resolve in interface StackDefinitionModule<ConfigurationModule,ConfigurationInfo>

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

public ConfigurationInfo getModuleInfo()

Description copied from interface: StackDefinitionModule

Obtain the associated module information.

Specified by:

getModuleInfo in interface StackDefinitionModule<ConfigurationModule,ConfigurationInfo>

Returns:

associated module information

isDeleted

public boolean isDeleted()

Description copied from interface: StackDefinitionModule

Determine whether the module has been marked for deletion.

Specified by:

isDeleted in interface StackDefinitionModule<ConfigurationModule,ConfigurationInfo>

Returns:

true if the module is marked for deletion; otherwise false

getId

public String getId()

Description copied from interface: StackDefinitionModule

Obtain the id of the module.

Specified by:

getId in interface StackDefinitionModule<ConfigurationModule,ConfigurationInfo>

Returns:

module id

getConfigType

public String getConfigType()

Obtain the configuration type.

Returns:

configuration type

setDeleted

public void setDeleted(boolean isDeleted)

Set the deleted flag.

Parameters:

isDeleted - whether the configuration has been marked for deletion

isValid

public boolean isValid()

Specified by:

isValid in interface StackDefinitionModule<ConfigurationModule,ConfigurationInfo>

Specified by:

isValid in interface Validable

Returns:

valid xml flag

setValid

public void setValid(boolean valid)

Specified by:

setValid in interface StackDefinitionModule<ConfigurationModule,ConfigurationInfo>

Specified by:

setValid in interface Validable

Parameters:

valid - set validity flag

addErrors

public void addErrors(Collection<String> errors)

Specified by:

addErrors in interface Validable