com.atlassian.bamboo.beehive

Class BambooClusterNodeHeartbeatServiceImpl

java.lang.Object

com.atlassian.bamboo.beehive.BambooClusterNodeHeartbeatServiceImpl

All Implemented Interfaces:

BambooClusterNodeHeartbeatService

public class BambooClusterNodeHeartbeatServiceImpl
extends Object
implements BambooClusterNodeHeartbeatService

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_TIME_WITHOUT_LOCK_MINUTES

Constructor Summary

Constructors

Constructor and Description
BambooClusterNodeHeartbeatServiceImpl(@NotNull ClusterNodeHeartbeatBootstrapDao clusterNodeHeartBeatDao, @NotNull ClusterLockBootstrapDao clusterLockBootstrapDao, @NotNull BambooLicenseManager bambooLicenseManager)

Method Summary

Modifier and Type	Method and Description
@NotNull Collection<String>	findLiveNodes() Returns all nodes that have sent a heartbeat within the default threshold time.
@NotNull Collection<String>	findLiveNodes(long threshold) Returns all nodes that have sent a heartbeat within the given threshold.
Long	getLastHeartbeatTime(@NotNull String nodeId) Returns the last time a heartbeat was sent by the given node.
@NotNull String	getNodeId() Returns the node ID for this node.
@NotNull List<BambooNodeStatus>	getNodeStatuses() Get status of all nodes if DC license applied otherwise empty list.
boolean	isCurrentNodePrimaryBuffered()
boolean	isNodeHeartbeatStarted()
boolean	isNodeLive(@NotNull String nodeId) Checks whether the given cluster node is considered "live".
protected com.atlassian.scheduler.JobRunner	newHeartbeatJobRunner()
void	setCurrentNodePrimary(boolean primary) Set current node's primary flag.
void	startNodeHeartbeat() Starts registering heartbeats for the current node.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TIME_WITHOUT_LOCK_MINUTES

public static final int MAX_TIME_WITHOUT_LOCK_MINUTES

Constructor Detail

BambooClusterNodeHeartbeatServiceImpl

@Inject
public BambooClusterNodeHeartbeatServiceImpl(@NotNull
                                                     @NotNull ClusterNodeHeartbeatBootstrapDao clusterNodeHeartBeatDao,
                                                     @NotNull
                                                     @NotNull ClusterLockBootstrapDao clusterLockBootstrapDao,
                                                     @NotNull
                                                     @NotNull BambooLicenseManager bambooLicenseManager)
                                              throws com.atlassian.scheduler.SchedulerServiceException

Throws:

com.atlassian.scheduler.SchedulerServiceException

Method Detail

startNodeHeartbeat

public void startNodeHeartbeat()
                        throws Exception

Description copied from interface: BambooClusterNodeHeartbeatService

Starts registering heartbeats for the current node.

Specified by:

startNodeHeartbeat in interface BambooClusterNodeHeartbeatService

Throws:

Exception

getNodeId

@NotNull
public @NotNull String getNodeId()

Description copied from interface: BambooClusterNodeHeartbeatService

Returns the node ID for this node.

Specified by:

getNodeId in interface BambooClusterNodeHeartbeatService

Returns:

the node ID for this node.

isNodeLive

public boolean isNodeLive(@NotNull
                          @NotNull String nodeId)

Description copied from interface: BambooClusterNodeHeartbeatService

Checks whether the given cluster node is considered "live".

Each live node will be writing a heartbeat on a set schedule (eg once a minute). A node is considered live if it has written a heartbeat within a reasonable tolerance level (eg 5 minutes).

The tolerance level needs to be large enough to avoid certain expected slow-downs in the system including GC pauses, or just general slowness in the JVM / scheduler / network / database of the remote node.

Specified by:

isNodeLive in interface BambooClusterNodeHeartbeatService

Parameters:

nodeId - the cluster node to check

Returns:

true iff the given cluster node is still "live".

getLastHeartbeatTime

public Long getLastHeartbeatTime(@NotNull
                                 @NotNull String nodeId)

Description copied from interface: BambooClusterNodeHeartbeatService

Returns the last time a heartbeat was sent by the given node.

A null value indicates no heartbeats have ever been sent by the given node.

Specified by:

getLastHeartbeatTime in interface BambooClusterNodeHeartbeatService

Parameters:

nodeId - the node

Returns:

the last time a heartbeat was sent by the given node.

findLiveNodes

@NotNull
public @NotNull Collection<String> findLiveNodes()

Description copied from interface: BambooClusterNodeHeartbeatService

Returns all nodes that have sent a heartbeat within the default threshold time.

Specified by:

findLiveNodes in interface BambooClusterNodeHeartbeatService

Returns:

all nodes that have sent a heartbeat within the default threshold time.

See Also:

BambooClusterNodeHeartbeatService.findLiveNodes(long)

findLiveNodes

@NotNull
public @NotNull Collection<String> findLiveNodes(long threshold)

Description copied from interface: BambooClusterNodeHeartbeatService

Returns all nodes that have sent a heartbeat within the given threshold.

Specified by:

findLiveNodes in interface BambooClusterNodeHeartbeatService

Parameters:

threshold - the threshold in milliseconds

Returns:

all nodes that have sent a heartbeat within the given threshold.

See Also:

BambooClusterNodeHeartbeatService.findLiveNodes()

isNodeHeartbeatStarted

public boolean isNodeHeartbeatStarted()

Specified by:

isNodeHeartbeatStarted in interface BambooClusterNodeHeartbeatService

Returns:

true if node heartbeat has been started for the current node

setCurrentNodePrimary

public void setCurrentNodePrimary(boolean primary)

Description copied from interface: BambooClusterNodeHeartbeatService

Set current node's primary flag.

Specified by:

setCurrentNodePrimary in interface BambooClusterNodeHeartbeatService

isCurrentNodePrimaryBuffered

public boolean isCurrentNodePrimaryBuffered()

Specified by:

isCurrentNodePrimaryBuffered in interface BambooClusterNodeHeartbeatService

Returns:

true if current node has been recently (i.e. within timeout) successfully marked as alive.

getNodeStatuses

@NotNull
public @NotNull List<BambooNodeStatus> getNodeStatuses()

Description copied from interface: BambooClusterNodeHeartbeatService

Get status of all nodes if DC license applied otherwise empty list.

Specified by:

getNodeStatuses in interface BambooClusterNodeHeartbeatService

newHeartbeatJobRunner

protected com.atlassian.scheduler.JobRunner newHeartbeatJobRunner()