com.atlassian.jira.cluster.lock

Class NullJiraClusterNodeHeartBeatDao

java.lang.Object

com.atlassian.jira.cluster.lock.NullJiraClusterNodeHeartBeatDao

All Implemented Interfaces:

ClusterNodeHeartBeatDao, TimedClusterNodeHeartBeatDao

public class NullJiraClusterNodeHeartBeatDao
extends Object
implements TimedClusterNodeHeartBeatDao

Created this class to avoid problems of dependencies in non-clustered environments

Constructor Summary

Constructors

Constructor and Description
NullJiraClusterNodeHeartBeatDao()

Method Summary

Modifier and Type	Method and Description
Collection<String>	findNodesWithHeartbeatsAfter(long time)
Map<String,Long>	getActiveNodesDatabaseTimeOffsets(long databaseActiveTime) Returns each active cluster node's clock offset from the database clock.
Long	getLastHeartbeatTime(String nodeId) Returns the last time a heartbeat was sent by the given node.
String	getNodeId() Returns the globally unique Identifier for this cluster node.
void	writeHeartBeat(long time) Writes a heartbeat for this node at the given time.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullJiraClusterNodeHeartBeatDao

public NullJiraClusterNodeHeartBeatDao()

Method Detail

getNodeId

@Nonnull
public String getNodeId()

Description copied from interface: ClusterNodeHeartBeatDao

Returns the globally unique Identifier for this cluster node.

Specified by:

getNodeId in interface ClusterNodeHeartBeatDao

Returns:

the globally unique Identifier for this cluster node.

writeHeartBeat

public void writeHeartBeat(long time)

Description copied from interface: ClusterNodeHeartBeatDao

Writes a heartbeat for this node at the given time. Caller will pass the time to stamp; in production this would normally be System.currentTimeMillis().

Specified by:

writeHeartBeat in interface ClusterNodeHeartBeatDao

Parameters:

time - the time in millis to write as the heartbeat.

getLastHeartbeatTime

@Nullable
public Long getLastHeartbeatTime(@Nonnull
                                           String nodeId)

Description copied from interface: ClusterNodeHeartBeatDao

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

A null value indicates no heartbeats have been sent by this node.

Specified by:

getLastHeartbeatTime in interface ClusterNodeHeartBeatDao

Parameters:

nodeId - the node

Returns:

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

findNodesWithHeartbeatsAfter

@Nonnull
public Collection<String> findNodesWithHeartbeatsAfter(long time)

Specified by:

findNodesWithHeartbeatsAfter in interface ClusterNodeHeartBeatDao

getActiveNodesDatabaseTimeOffsets

@Nonnull
public Map<String,Long> getActiveNodesDatabaseTimeOffsets(long databaseActiveTime)

Description copied from interface: TimedClusterNodeHeartBeatDao

Returns each active cluster node's clock offset from the database clock.

The returned map maps node IDs to their clock offset times in milliseconds. A clock offset time is the number of milliseconds difference between that node's system clock and the clock of the database. These values can be used to determine how synchronized the node's clocks are.

It is possible that a node's time offset value is returned as null if they have not registered a heartbeat yet after they have started up or if they are upgrading their version and have not written a database time value in the database yet.

Specified by:

getActiveNodesDatabaseTimeOffsets in interface TimedClusterNodeHeartBeatDao

Parameters:

databaseActiveTime - the minimum database time a node should have in the system to regard it as active. Nodes that registered their heartbeat with an associated database time less than this value will not be returned.

Returns:

a map mapping node IDs to offset times in milliseconds.