org.apache.ambari.server.state

Interface ServiceComponent

All Known Implementing Classes:

ServiceComponentImpl

public interface ServiceComponent

Method Summary

Modifier and Type	Method and Description
void	addServiceComponentHost(ServiceComponentHost hostComponent)
ServiceComponentHost	addServiceComponentHost(String hostName)
void	addServiceComponentHosts(Map<String,ServiceComponentHost> hostComponents)
boolean	canBeRemoved()
ServiceComponentResponse	convertToResponse()
void	debugDump(StringBuilder sb)
void	delete(DeleteHostComponentStatusMetaData deleteMetaData)
void	deleteAllServiceComponentHosts(DeleteHostComponentStatusMetaData deleteMetaData)
void	deleteServiceComponentHosts(String hostname, DeleteHostComponentStatusMetaData deleteMetaData)
long	getClusterId()
String	getClusterName()
RepositoryVersionEntity	getDesiredRepositoryVersion() Gets the desired repository for this service component.
StackId	getDesiredStackId()
State	getDesiredState()
String	getDesiredVersion()
String	getDisplayName()
String	getName()
RepositoryVersionState	getRepositoryState()
ServiceComponentHost	getServiceComponentHost(String hostname)
Map<String,ServiceComponentHost>	getServiceComponentHosts()
Set<String>	getServiceComponentsHosts()
String	getServiceName()
boolean	isClientComponent()
boolean	isMasterComponent()
boolean	isRecoveryEnabled() Get a true or false value specifying if auto start was enabled for this component.
boolean	isVersionAdvertised()
void	setDesiredRepositoryVersion(RepositoryVersionEntity repositoryVersionEntity)
void	setDesiredState(State state)
void	setRecoveryEnabled(boolean recoveryEnabled) Set a true or false value specifying if this component is to be enabled for auto start or not.
void	updateComponentInfo() Refresh Component info due to current stack
void	updateRepositoryState(String reportedVersion) This method computes the state of the repository that's associated with the desired version.

Method Detail

getName

String getName()

isRecoveryEnabled

boolean isRecoveryEnabled()

Get a true or false value specifying if auto start was enabled for this component.

Returns:

true or false

setRecoveryEnabled

void setRecoveryEnabled(boolean recoveryEnabled)

Set a true or false value specifying if this component is to be enabled for auto start or not.

Parameters:

recoveryEnabled - - true or false

getServiceName

String getServiceName()

getDisplayName

String getDisplayName()

getClusterId

long getClusterId()

getClusterName

String getClusterName()

getDesiredState

State getDesiredState()

setDesiredState

void setDesiredState(State state)

getDesiredRepositoryVersion

RepositoryVersionEntity getDesiredRepositoryVersion()

Gets the desired repository for this service component.

Returns:

getDesiredStackId

StackId getDesiredStackId()

getDesiredVersion

String getDesiredVersion()

setDesiredRepositoryVersion

void setDesiredRepositoryVersion(RepositoryVersionEntity repositoryVersionEntity)

updateComponentInfo

void updateComponentInfo()
                  throws org.apache.ambari.server.AmbariException

Refresh Component info due to current stack

Throws:

org.apache.ambari.server.AmbariException

getServiceComponentHosts

Map<String,ServiceComponentHost> getServiceComponentHosts()

getServiceComponentsHosts

Set<String> getServiceComponentsHosts()

getServiceComponentHost

ServiceComponentHost getServiceComponentHost(String hostname)
                                      throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

addServiceComponentHosts

void addServiceComponentHosts(Map<String,ServiceComponentHost> hostComponents)
                       throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

addServiceComponentHost

void addServiceComponentHost(ServiceComponentHost hostComponent)
                      throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

convertToResponse

ServiceComponentResponse convertToResponse()

debugDump

void debugDump(StringBuilder sb)

isClientComponent

boolean isClientComponent()

isMasterComponent

boolean isMasterComponent()

isVersionAdvertised

boolean isVersionAdvertised()

canBeRemoved

boolean canBeRemoved()

deleteAllServiceComponentHosts

void deleteAllServiceComponentHosts(DeleteHostComponentStatusMetaData deleteMetaData)
                             throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

deleteServiceComponentHosts

void deleteServiceComponentHosts(String hostname,
                                 DeleteHostComponentStatusMetaData deleteMetaData)
                          throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

addServiceComponentHost

ServiceComponentHost addServiceComponentHost(String hostName)
                                      throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

delete

void delete(DeleteHostComponentStatusMetaData deleteMetaData)

updateRepositoryState

void updateRepositoryState(String reportedVersion)
                    throws org.apache.ambari.server.AmbariException

This method computes the state of the repository that's associated with the desired version. It is used, for example, when a host component reports its version and the state can be in flux.

Parameters:

reportedVersion -

Throws:

org.apache.ambari.server.AmbariException

getRepositoryState

RepositoryVersionState getRepositoryState()

Returns:

the repository state for the desired version