org.apache.ambari.server.state

Interface Host

All Superinterfaces:

Comparable

All Known Implementing Classes:

HostImpl

public interface Host
extends Comparable

Method Summary

Modifier and Type	Method and Description
boolean	addDesiredConfig(long clusterId, boolean selected, String user, Config config) Adds a desired configuration to the host instance.
void	calculateHostStatus(Long clusterId)
HostResponse	convertToResponse()
AgentVersion	getAgentVersion() Version of the Ambari Agent running on the host
AgentVersion	getAgentVersion(HostStateEntity hostStateEntity) Gets version of the ambari agent running on the host.
List<HostVersionEntity>	getAllHostVersions() Get all of the HostVersionEntity objects for the host.
long	getAvailableMemBytes() Get the Amount of available memory for the Host.
int	getCpuCount()
Integer	getCurrentPingPort()
Map<String,DesiredConfig>	getDesiredConfigs(long clusterId) Gets all the selected configurations for the host.
Map<String,HostConfig>	getDesiredHostConfigs(Cluster cluster, Map<String,DesiredConfig> clusterDesiredConfigs) Get the desired configurations for the host including overrides
List<DiskInfo>	getDisksInfo() Get information on disks available on the host.
HostHealthStatus	getHealthStatus()
HostHealthStatus	getHealthStatus(HostStateEntity hostStateEntity) Gets the health status from host attributes
Map<String,String>	getHostAttributes() Get additional host attributes For example, public/hostname/IP for AWS
Map<String,String>	getHostAttributes(HostEntity hostEntity) Gets host attributes from host entity
HostEntity	getHostEntity()
Long	getHostId()
String	getHostName()
String	getIPv4() IPv4 assigned to the Host
String	getIPv6() IPv6 assigned to the Host
AgentEnv	getLastAgentEnv() Gets the latest agent environment that arrived in a heartbeat.
long	getLastAgentStartTime() Time the Ambari Agent was started.
long	getLastHeartbeatTime() Last time the Ambari Server received a heartbeat from the Host ( Unix timestamp )
long	getLastRegistrationTime() Last time the host registered with the Ambari Server ( Unix timestamp )
MaintenanceState	getMaintenanceState(long clusterId)
String	getOsArch() Get the OS Architecture.
String	getOsFamily() Get the os Family: redhat6: for centos6, rhel6, oraclelinux6 ..
String	getOsFamily(Map<String,String> hostAttributes) Gets the os family from host attributes
String	getOSFamilyFromHostAttributes(Map<String,String> hostAttributes)
String	getOsInfo() Get the General OS information.
String	getOsType() Get the OS Type: RHEL6/CentOS6/...
int	getPhCpuCount()
String	getPrefix() Get the prefix path of all logs
String	getPublicHostName() Sets the public-facing host name.
String	getRackInfo()
RecoveryReport	getRecoveryReport() Get detailed recovery report for the host
HostState	getState() Get Current Host State
String	getStatus() Get Current Host Status
long	getTimeInState() Get time spent in the current state i.e.
long	getTotalMemBytes() Get the Amount of physical memory for the Host.
void	handleEvent(HostEvent event) Send an event to the Host's StateMachine
boolean	hasComponentsAdvertisingVersions(StackId stackId) Gets whether this host has components which advertise their version.
void	importHostInfo(HostInfo hostInfo)
boolean	isRepositoryVersionCorrect(RepositoryVersionEntity repositoryVersion) Gets whether all host components whose desired repository version matches the repository version specified have reported the correct version and are no longer upgrading.
void	setAgentVersion(AgentVersion agentVersion)
void	setAvailableMemBytes(long availableMemBytes) Set the Amount of available memory for the Host.
void	setCpuCount(int cpuCount)
void	setCurrentPingPort(Integer currentPingPort)
void	setDisksInfo(List<DiskInfo> disksInfo)
void	setHealthStatus(HostHealthStatus healthStatus)
void	setHostAttributes(Map<String,String> hostAttributes)
void	setIPv4(String ip)
void	setIPv6(String ip)
void	setLastAgentEnv(AgentEnv env) Sets the latest agent environment that arrived in a heartbeat.
void	setLastAgentStartTime(long lastAgentStartTime)
void	setLastHeartbeatTime(long lastHeartbeatTime)
void	setLastRegistrationTime(long lastRegistrationTime)
void	setMaintenanceState(long clusterId, MaintenanceState state) Sets the maintenance state for the host.
void	setOsArch(String osArch)
void	setOsInfo(String osInfo)
void	setOsType(String osType)
void	setPhCpuCount(int phCpuCount)
void	setPrefix(String prefix) Set the prefix path of all logs of the host
void	setPublicHostName(String hostName) Gets the public-facing host name.
void	setRackInfo(String rackInfo)
void	setRecoveryReport(RecoveryReport recoveryReport) Set detailed recovery report for the host
void	setState(HostState state) Set the State of the Host
void	setStateMachineState(HostState state) Set state of host's state machine.
void	setStatus(String status) Set the Status of the Host
void	setTimeInState(long timeInState)
void	setTotalMemBytes(long totalMemBytes) Set the Amount of physical memory for the Host.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getHostEntity

HostEntity getHostEntity()

getHostName

String getHostName()

Returns:

the hostName

getHostId

Long getHostId()

Returns:

host id

getCurrentPingPort

Integer getCurrentPingPort()

Returns:

the currentPingPort

setCurrentPingPort

void setCurrentPingPort(Integer currentPingPort)

Parameters:

currentPingPort - the currentPingPort to set

setPublicHostName

void setPublicHostName(String hostName)

Gets the public-facing host name.

getPublicHostName

String getPublicHostName()

Sets the public-facing host name.

getIPv4

String getIPv4()

IPv4 assigned to the Host

Returns:

the ip or null if no IPv4 interface

setIPv4

void setIPv4(String ip)

Parameters:

ip - the ip to set

getIPv6

String getIPv6()

IPv6 assigned to the Host

Returns:

the ip or null if no IPv6 interface

setIPv6

void setIPv6(String ip)

Parameters:

ip - the ip to set

getCpuCount

int getCpuCount()

Returns:

the cpuCount

setCpuCount

void setCpuCount(int cpuCount)

Parameters:

cpuCount - the cpuCount to set

getPhCpuCount

int getPhCpuCount()

Returns:

the physical cpu cores

setPhCpuCount

void setPhCpuCount(int phCpuCount)

Parameters:

phCpuCount - the physical cpu cores to set

getTotalMemBytes

long getTotalMemBytes()

Get the Amount of physical memory for the Host.

Returns:

the totalMemBytes

setTotalMemBytes

void setTotalMemBytes(long totalMemBytes)

Set the Amount of physical memory for the Host.

Parameters:

totalMemBytes - the totalMemBytes to set

getAvailableMemBytes

long getAvailableMemBytes()

Get the Amount of available memory for the Host. In most cases, available should be same as total unless the agent on the host is configured to not use all available memory

Returns:

the availableMemBytes

setAvailableMemBytes

void setAvailableMemBytes(long availableMemBytes)

Set the Amount of available memory for the Host.

Parameters:

availableMemBytes - the availableMemBytes to set

getOsArch

String getOsArch()

Get the OS Architecture. i386, x86_64, etc.

Returns:

the osArch

setOsArch

void setOsArch(String osArch)

Parameters:

osArch - the osArch to set

getOsInfo

String getOsInfo()

Get the General OS information. uname -a, /etc/*-release dump

Returns:

the osInfo

setOsInfo

void setOsInfo(String osInfo)

Parameters:

osInfo - the osInfo to set

getOsType

String getOsType()

Get the OS Type: RHEL6/CentOS6/... Defined and match-able OS type

Returns:

the osType

getOsFamily

String getOsFamily()

Get the os Family: redhat6: for centos6, rhel6, oraclelinux6 .. ubuntu12 : for ubuntu12 suse11: for sles11, suse11 .. suse12: for suse12, sles12 ..

Returns:

the osFamily

getOsFamily

String getOsFamily(Map<String,String> hostAttributes)

Gets the os family from host attributes

Parameters:

hostAttributes - host attributes

Returns:

the os family for host

getOSFamilyFromHostAttributes

String getOSFamilyFromHostAttributes(Map<String,String> hostAttributes)

setOsType

void setOsType(String osType)

Parameters:

osType - the osType to set

getDisksInfo

List<DiskInfo> getDisksInfo()

Get information on disks available on the host.

Returns:

the disksInfo

setDisksInfo

void setDisksInfo(List<DiskInfo> disksInfo)

Parameters:

disksInfo - the disksInfo to set

getHealthStatus

HostHealthStatus getHealthStatus()

Returns:

the healthStatus

getHealthStatus

HostHealthStatus getHealthStatus(HostStateEntity hostStateEntity)

Gets the health status from host attributes

Parameters:

hostStateEntity - host attributes

Returns:

the health status

getRecoveryReport

RecoveryReport getRecoveryReport()

Get detailed recovery report for the host

Returns:

setRecoveryReport

void setRecoveryReport(RecoveryReport recoveryReport)

Set detailed recovery report for the host

setHealthStatus

void setHealthStatus(HostHealthStatus healthStatus)

Parameters:

healthStatus - the healthStatus to set

getHostAttributes

Map<String,String> getHostAttributes()

Get additional host attributes For example, public/hostname/IP for AWS

Returns:

the hostAttributes

getHostAttributes

Map<String,String> getHostAttributes(HostEntity hostEntity)

Gets host attributes from host entity

Parameters:

hostEntity - host entity

Returns:

the host attributes

setHostAttributes

void setHostAttributes(Map<String,String> hostAttributes)

Parameters:

hostAttributes - the hostAttributes to set

getRackInfo

String getRackInfo()

Returns:

the rackInfo

setRackInfo

void setRackInfo(String rackInfo)

Parameters:

rackInfo - the rackInfo to set

getLastRegistrationTime

long getLastRegistrationTime()

Last time the host registered with the Ambari Server ( Unix timestamp )

Returns:

the lastRegistrationTime

setLastRegistrationTime

void setLastRegistrationTime(long lastRegistrationTime)

Parameters:

lastRegistrationTime - the lastRegistrationTime to set

getLastAgentStartTime

long getLastAgentStartTime()

Time the Ambari Agent was started. ( Unix timestamp )

Returns:

the lastOnAgentStartRegistrationTime

setLastAgentStartTime

void setLastAgentStartTime(long lastAgentStartTime)

Parameters:

lastAgentStartTime - the lastAgentStartTime to set

getLastHeartbeatTime

long getLastHeartbeatTime()

Last time the Ambari Server received a heartbeat from the Host ( Unix timestamp )

Returns:

the lastHeartbeatTime

setLastHeartbeatTime

void setLastHeartbeatTime(long lastHeartbeatTime)

Parameters:

lastHeartbeatTime - the lastHeartbeatTime to set

setLastAgentEnv

void setLastAgentEnv(AgentEnv env)

Sets the latest agent environment that arrived in a heartbeat.

getLastAgentEnv

AgentEnv getLastAgentEnv()

Gets the latest agent environment that arrived in a heartbeat.

getAgentVersion

AgentVersion getAgentVersion()

Version of the Ambari Agent running on the host

Returns:

the agentVersion

getAgentVersion

AgentVersion getAgentVersion(HostStateEntity hostStateEntity)

Gets version of the ambari agent running on the host.

Parameters:

hostStateEntity - host state entity

Returns:

the agentVersion

setAgentVersion

void setAgentVersion(AgentVersion agentVersion)

Parameters:

agentVersion - the agentVersion to set

getState

HostState getState()

Get Current Host State

Returns:

HostState

setState

void setState(HostState state)

Set the State of the Host

Parameters:

state - Host State

setStateMachineState

void setStateMachineState(HostState state)

Set state of host's state machine.

Parameters:

state -

getPrefix

String getPrefix()

Get the prefix path of all logs

Returns:

prefix

setPrefix

void setPrefix(String prefix)

Set the prefix path of all logs of the host

Parameters:

prefix - the prefix path to set

handleEvent

void handleEvent(HostEvent event)
          throws InvalidStateTransitionException

Send an event to the Host's StateMachine

Parameters:

event - HostEvent

Throws:

InvalidStateTransitionException

getTimeInState

long getTimeInState()

Get time spent in the current state i.e. the time since last state change.

Returns:

Time spent in current state.

setTimeInState

void setTimeInState(long timeInState)

Parameters:

timeInState - the timeInState to set

getStatus

String getStatus()

Get Current Host Status

Returns:

String

setStatus

void setStatus(String status)

Set the Status of the Host

Parameters:

status - Host Status

convertToResponse

HostResponse convertToResponse()

importHostInfo

void importHostInfo(HostInfo hostInfo)

addDesiredConfig

boolean addDesiredConfig(long clusterId,
                         boolean selected,
                         String user,
                         Config config)

Adds a desired configuration to the host instance.

Parameters:

clusterId - the cluster id that the config applies to

selected - true if the configuration is selected. Applies only to remove the override, otherwise this value should always be true.

user - the user making the change for audit purposes

config - the configuration object

Returns:

true if the config was added, or false if the config is already set as the current

getDesiredConfigs

Map<String,DesiredConfig> getDesiredConfigs(long clusterId)

Gets all the selected configurations for the host. return a map of type-to-DesiredConfig instances.

getDesiredHostConfigs

Map<String,HostConfig> getDesiredHostConfigs(Cluster cluster,
                                             Map<String,DesiredConfig> clusterDesiredConfigs)
                                      throws org.apache.ambari.server.AmbariException

Get the desired configurations for the host including overrides

Parameters:

cluster -

clusterDesiredConfigs - the desired configurations for the cluster. Obtaining these can be expensive and since this method operates on hosts, it could be called 1,000's of times when generating 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:

Throws:

org.apache.ambari.server.AmbariException

setMaintenanceState

void setMaintenanceState(long clusterId,
                         MaintenanceState state)

Sets the maintenance state for the host.

Parameters:

clusterId - the cluster id

state - the state

getMaintenanceState

MaintenanceState getMaintenanceState(long clusterId)

Parameters:

clusterId - the cluster id

Returns:

the maintenance state

getAllHostVersions

List<HostVersionEntity> getAllHostVersions()

Get all of the HostVersionEntity objects for the host.

Returns:

hasComponentsAdvertisingVersions

boolean hasComponentsAdvertisingVersions(StackId stackId)
                                  throws org.apache.ambari.server.AmbariException

Gets whether this host has components which advertise their version.

Parameters:

stackId - the version of the stack to use when checking version advertise-ability.

Returns:

true if at least 1 component on this host advertises its version.

Throws:

org.apache.ambari.server.AmbariException - if there is a problem retrieving the component from the stack.

See Also:

ComponentInfo.isVersionAdvertised()

calculateHostStatus

void calculateHostStatus(Long clusterId)
                  throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

isRepositoryVersionCorrect

boolean isRepositoryVersionCorrect(RepositoryVersionEntity repositoryVersion)
                            throws org.apache.ambari.server.AmbariException

Gets whether all host components whose desired repository version matches the repository version specified have reported the correct version and are no longer upgrading.

Parameters:

repositoryVersion - the repository version to check for (not null).

Returns:

true if all components on this host have checked in with the correct version if their desired repository matches the one specified.

Throws:

org.apache.ambari.server.AmbariException