org.apache.ambari.server.stack

Class ServiceModule

java.lang.Object

org.apache.ambari.server.stack.BaseModule<ServiceModule,ServiceInfo>

org.apache.ambari.server.stack.ServiceModule

All Implemented Interfaces:

StackDefinitionModule<ServiceModule,ServiceInfo>, Validable

public class ServiceModule
extends BaseModule<ServiceModule,ServiceInfo>
implements Validable

Service module which provides all functionality related to parsing and fully resolving services from the stack definition.

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
ServiceModule(StackContext stackContext, ServiceInfo serviceInfo, ServiceDirectory serviceDirectory) Constructor.
ServiceModule(StackContext stackContext, ServiceInfo serviceInfo, ServiceDirectory serviceDirectory, boolean isCommonService) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addError(String error)
void	addErrors(Collection<String> errors)
void	finalizeModule() Lifecycle even which is called when the associated stack has been fully resolved.
Collection<String>	getErrors()
String	getId() Obtain the id of the module.
ServiceInfo	getModuleInfo() Obtain the associated module information.
ServiceDirectory	getServiceDirectory()
boolean	hasConfigs() Whether the service is a special case where it does not include any config types
boolean	isDeleted() Determine whether the module has been marked for deletion.
boolean	isValid()
void	resolve(ServiceModule parentModule, Map<String,StackModule> allStacks, Map<String,ServiceModule> commonServices, Map<String,ExtensionModule> extensions) Resolve the module state with the specified parent.
void	resolveCommonService(Map<String,StackModule> allStacks, Map<String,ServiceModule> commonServices, Map<String,ExtensionModule> extensions) Resolve common service
void	resolveExplicit(ServiceModule parentModule, Map<String,StackModule> allStacks, Map<String,ServiceModule> commonServices, Map<String,ExtensionModule> extensions)
void	resolveInternal(ServiceModule parentModule, Map<String,StackModule> allStacks, Map<String,ServiceModule> commonServices, Map<String,ExtensionModule> extensions, boolean resolveExplicit)
void	setValid(boolean valid)
String	toString()

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

finalizeChildModules, getModuleState, mergeChildModules

Methods inherited from class java.lang.Object

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

Field Detail

valid

protected boolean valid

validity flag

Constructor Detail

ServiceModule

public ServiceModule(StackContext stackContext,
                     ServiceInfo serviceInfo,
                     ServiceDirectory serviceDirectory)

Constructor.

Parameters:

stackContext - stack context which provides module access to external functionality

serviceInfo - associated service info

serviceDirectory - used for all IO interaction with service directory in stack definition

ServiceModule

public ServiceModule(StackContext stackContext,
                     ServiceInfo serviceInfo,
                     ServiceDirectory serviceDirectory,
                     boolean isCommonService)

Constructor.

Parameters:

stackContext - stack context which provides module access to external functionality

serviceInfo - associated service info

serviceDirectory - used for all IO interaction with service directory in stack definition

isCommonService - flag to mark a service as a common service

Method Detail

getModuleInfo

public ServiceInfo getModuleInfo()

Description copied from interface: StackDefinitionModule

Obtain the associated module information.

Specified by:

getModuleInfo in interface StackDefinitionModule<ServiceModule,ServiceInfo>

Returns:

associated module information

resolve

public void resolve(ServiceModule parentModule,
                    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<ServiceModule,ServiceInfo>

Parameters:

parentModule - 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

resolveExplicit

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

Throws:

org.apache.ambari.server.AmbariException

resolveInternal

public void resolveInternal(ServiceModule parentModule,
                            Map<String,StackModule> allStacks,
                            Map<String,ServiceModule> commonServices,
                            Map<String,ExtensionModule> extensions,
                            boolean resolveExplicit)
                     throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

resolveCommonService

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

Resolve common service

Parameters:

allStacks - all stack modules

commonServices - common service modules

Throws:

org.apache.ambari.server.AmbariException

isDeleted

public boolean isDeleted()

Description copied from interface: StackDefinitionModule

Determine whether the module has been marked for deletion.

Specified by:

isDeleted in interface StackDefinitionModule<ServiceModule,ServiceInfo>

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<ServiceModule,ServiceInfo>

Returns:

module id

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<ServiceModule,ServiceInfo>

Overrides:

finalizeModule in class BaseModule<ServiceModule,ServiceInfo>

isValid

public boolean isValid()

Specified by:

isValid in interface StackDefinitionModule<ServiceModule,ServiceInfo>

Specified by:

isValid in interface Validable

Returns:

valid xml flag

setValid

public void setValid(boolean valid)

Specified by:

setValid in interface StackDefinitionModule<ServiceModule,ServiceInfo>

Specified by:

setValid in interface Validable

Parameters:

valid - set validity flag

addError

public void addError(String error)

Specified by:

addError in interface Validable

getErrors

public Collection<String> getErrors()

Specified by:

getErrors in interface Validable

getServiceDirectory

public ServiceDirectory getServiceDirectory()

Returns:

The service's directory

addErrors

public void addErrors(Collection<String> errors)

Specified by:

addErrors in interface Validable

hasConfigs

public boolean hasConfigs()

Whether the service is a special case where it does not include any config types

toString

public String toString()

Overrides:

toString in class Object