org.apache.ambari.server.state

Interface ServiceComponentHost

All Known Implementing Classes:

ServiceComponentHostImpl

public interface ServiceComponentHost

Method Summary

Modifier and Type	Method and Description
boolean	canBeRemoved()
ServiceComponentHostResponse	convertToResponse(Map<String,DesiredConfig> desiredConfigs) Builds a ServiceComponentHostResponse.
ServiceComponentHostResponse	convertToResponseStatusOnly(Map<String,DesiredConfig> desiredConfigs, boolean collectStaleConfigsStatus)
void	debugDump(StringBuilder sb)
void	delete(DeleteHostComponentStatusMetaData deleteMetaData)
Map<String,HostConfig>	getActualConfigs() Gets the actual config tags, if known.
long	getClusterId() Get the Cluster that this object maps to
String	getClusterName() Get the Cluster that this object maps to
HostComponentAdminState	getComponentAdminState()
StackId	getDesiredStackId() Convenience method to get the desired stack id from the service component
State	getDesiredState()
HostComponentDesiredStateEntity	getDesiredStateEntity()
Host	getHost() Get the Host this object maps to
String	getHostName() Get the Host this object maps to
HostState	getHostState()
MaintenanceState	getMaintenanceState()
List<Map<String,String>>	getProcesses()
String	getPublicHostName() Get the public host name this object maps to
ServiceComponent	getServiceComponent() Gets the service component.
String	getServiceComponentName() Get the ServiceComponent this object maps to
String	getServiceName() Get the Service this object maps to
State	getState()
UpgradeState	getUpgradeState()
String	getVersion() Gets the version of the component.
void	handleEvent(ServiceComponentHostEvent event) Send a ServiceComponentHostState event to the StateMachine
boolean	isClientComponent()
boolean	isRecoveryEnabled() Get whether recovery is enabled for this component or not.
boolean	isRestartRequired()
boolean	isRestartRequired(HostComponentDesiredStateEntity hostComponentDesiredStateEntity)
HostVersionEntity	recalculateHostVersionState() Updates an existing HostVersionEntity for the desired repository of this component, or create one if it doesn't exist.
void	setComponentAdminState(HostComponentAdminState attribute)
void	setDesiredState(State state)
void	setMaintenanceState(MaintenanceState state)
void	setProcesses(List<Map<String,String>> procs)
void	setRestartRequired(boolean restartRequired)
boolean	setRestartRequiredWithoutEventPublishing(boolean restartRequired) Set restartRequired flag for appropriate HostComponentDesiredStateEntity
void	setState(State state)
void	setUpgradeState(UpgradeState upgradeState)
void	setVersion(String version) Sets the version of the component from the stack.

Method Detail

getClusterId

long getClusterId()

Get the Cluster that this object maps to

getClusterName

String getClusterName()

Get the Cluster that this object maps to

getServiceName

String getServiceName()

Get the Service this object maps to

Returns:

Name of the Service

isClientComponent

boolean isClientComponent()

getServiceComponentName

String getServiceComponentName()

Get the ServiceComponent this object maps to

Returns:

Name of the ServiceComponent

getHostName

String getHostName()

Get the Host this object maps to

Returns:

Host's hostname

getPublicHostName

String getPublicHostName()

Get the public host name this object maps to

Returns:

Host's public hostname

getHost

Host getHost()

Get the Host this object maps to

Returns:

Host Object

isRecoveryEnabled

boolean isRecoveryEnabled()

Get whether recovery is enabled for this component or not.

Returns:

True or false.

handleEvent

void handleEvent(ServiceComponentHostEvent event)
          throws InvalidStateTransitionException

Send a ServiceComponentHostState event to the StateMachine

Parameters:

event - Event to handle

Throws:

InvalidStateTransitionException

getDesiredState

State getDesiredState()

setDesiredState

void setDesiredState(State state)

getState

State getState()

setState

void setState(State state)

getVersion

String getVersion()

Gets the version of the component.

Returns:

component version

setVersion

void setVersion(String version)
         throws org.apache.ambari.server.AmbariException

Sets the version of the component from the stack.

Parameters:

version - component version (e.g. 2.2.0.0-2041)

Throws:

org.apache.ambari.server.AmbariException

setUpgradeState

void setUpgradeState(UpgradeState upgradeState)

Parameters:

upgradeState - the upgrade state

getUpgradeState

UpgradeState getUpgradeState()

Returns:

the upgrade state. Valid values: NONE - means that component is installed and good to go, no upgrade in progress IN_PROGRESS - means that component is being upgraded COMPLETE - means that component has reported a correct new version during upgrade FAILED - means that failed and component did not get upgraded VERSION_MISMATCH - means that component reported unexpected version

getComponentAdminState

HostComponentAdminState getComponentAdminState()

setComponentAdminState

void setComponentAdminState(HostComponentAdminState attribute)

convertToResponse

ServiceComponentHostResponse convertToResponse(Map<String,DesiredConfig> desiredConfigs)

Builds a ServiceComponentHostResponse.

Parameters:

desiredConfigs - the desired configurations for the cluster. Obtaining these can be expensive and since this method operates on SCH's, it could be called 10,000's of times when generating cluster/host responses. Therefore, the caller should build these once and pass them in. If null, then this method will retrieve them at runtime, incurring a performance penality.

Returns:

convertToResponseStatusOnly

ServiceComponentHostResponse convertToResponseStatusOnly(Map<String,DesiredConfig> desiredConfigs,
                                                         boolean collectStaleConfigsStatus)

debugDump

void debugDump(StringBuilder sb)

canBeRemoved

boolean canBeRemoved()

delete

void delete(DeleteHostComponentStatusMetaData deleteMetaData)

getActualConfigs

Map<String,HostConfig> getActualConfigs()

Gets the actual config tags, if known.

Returns:

the actual config map

getHostState

HostState getHostState()

setMaintenanceState

void setMaintenanceState(MaintenanceState state)

Parameters:

state - the maintenance state

getMaintenanceState

MaintenanceState getMaintenanceState()

Returns:

the maintenance state

setProcesses

void setProcesses(List<Map<String,String>> procs)

Parameters:

procs - a list containing a map describing each process

getProcesses

List<Map<String,String>> getProcesses()

Returns:

the list of maps describing each process

isRestartRequired

boolean isRestartRequired()

Returns:

whether restart required

isRestartRequired

boolean isRestartRequired(HostComponentDesiredStateEntity hostComponentDesiredStateEntity)

setRestartRequired

void setRestartRequired(boolean restartRequired)

Parameters:

restartRequired - the restartRequired flag

setRestartRequiredWithoutEventPublishing

boolean setRestartRequiredWithoutEventPublishing(boolean restartRequired)

Set restartRequired flag for appropriate HostComponentDesiredStateEntity

Parameters:

restartRequired - the restartRequired flag.

Returns:

true when restartRequired flag was changed.

getDesiredStateEntity

HostComponentDesiredStateEntity getDesiredStateEntity()

getServiceComponent

ServiceComponent getServiceComponent()

Gets the service component.

Returns:

the service component (never null).

recalculateHostVersionState

HostVersionEntity recalculateHostVersionState()
                                       throws org.apache.ambari.server.AmbariException

Updates an existing HostVersionEntity for the desired repository of this component, or create one if it doesn't exist.

Returns:

Returns either the newly created or the updated Host Version Entity.

Throws:

org.apache.ambari.server.AmbariException

getDesiredStackId

StackId getDesiredStackId()

Convenience method to get the desired stack id from the service component

Returns:

the desired stack id