com.atlassian.jira.cluster

Class DefaultClusterManager

java.lang.Object

com.atlassian.jira.cluster.DefaultClusterManager

All Implemented Interfaces:

ClusterInfo, ClusterManager, Startable

public class DefaultClusterManager
extends Object
implements ClusterManager, Startable

Manages the cluster - addition of nodes, removal, etc

Since:

v6.1

Field Summary

Fields inherited from interface com.atlassian.jira.cluster.ClusterManager

ALL_NODES, ANY_NODE

Constructor Summary

Constructors

Constructor and Description
DefaultClusterManager(ClusterNodes clusterNodes, com.atlassian.event.api.EventPublisher eventPublisher, ClusterLicenseCheck licenseCheck, MessageHandlerService messageHandlerService, NodeCutOffManager nodeCutOffManager, JiraProperties jiraProperties)

Method Summary

Modifier and Type	Method and Description
void	checkIndex() Forces an index check to see if it is current (or can be rebuilt from current) - if the index is too out of date search for it in shared home export/indexsnapshots directory.
List<Node>	findActiveAndNotAliveNodes()
Collection<Node>	findLiveNodes() Returns a snapshot of the live nodes.
List<Node>	findOfflineNodes()
Set<Node>	getAllNodes() Returns all the nodes in the cluster.
String	getNodeId() Provides the node ID for this particular cluster node.
boolean	isActive() Returns true if this node is active.
boolean	isClustered() If there is a cluster.properties that appears to be valid
boolean	isClusterLicensed() Returns whether or not JIRA is licensed for clustered configurations.
boolean	isNodeActive(@NotNull String nodeId)
boolean	isNodeAlive(@NotNull String nodeId)
boolean	isNodeOffline(@NotNull String nodeId)
boolean	isNodePresent(@NotNull String nodeId)
List<String>	moveNodesToOfflineIfOlderThan(@NotNull java.time.Duration retentionPeriod) Update nodes's state to Node.NodeState.OFFLINE if current node's state is Node.NodeState.ACTIVE and Not Alive for specified retention period
void	moveToOffline(@NotNull String nodeId) Update nodes's state to Node.NodeState.OFFLINE if current state is Node.NodeState.ACTIVE and Not Alive
void	onIndexesRestoredEvent(IndexesRestoredEvent ev)
void	refreshLiveNodes() Merges the information from the heartbeat table and the clusternode table to give accurate information of which nodes are alive.
void	removeIfOffline(@NotNull String nodeId) Remove node from cluster if node is Node.NodeState.OFFLINE
List<String>	removeOfflineNodesIfOlderThan(@NotNull java.time.Duration retentionPeriod) Remove node from cluster if node is in Node.NodeState.OFFLINE state for specified retention period
void	requestCurrentIndexFromNode(String destinationNode) We send a message to the node we wish a copy from.
void	start() This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClusterManager

public DefaultClusterManager(ClusterNodes clusterNodes,
                             com.atlassian.event.api.EventPublisher eventPublisher,
                             ClusterLicenseCheck licenseCheck,
                             MessageHandlerService messageHandlerService,
                             NodeCutOffManager nodeCutOffManager,
                             JiraProperties jiraProperties)

Method Detail

start

public void start()

Description copied from interface: Startable

This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:

start in interface Startable

getNodeId

@Nullable
public String getNodeId()

Description copied from interface: ClusterInfo

Provides the node ID for this particular cluster node.

Specified by:

getNodeId in interface ClusterInfo

Returns:

node id - null if the server is not in a cluster

isClustered

public boolean isClustered()

If there is a cluster.properties that appears to be valid

Specified by:

isClustered in interface ClusterInfo

Returns:

true if clustered

getAllNodes

public Set<Node> getAllNodes()

Description copied from interface: ClusterManager

Returns all the nodes in the cluster. If not clustered this will return an empty set.

Specified by:

getAllNodes in interface ClusterManager

Returns:

a collection of Nodes in a cluster

isActive

public boolean isActive()

Returns true if this node is active.

Specified by:

isActive in interface ClusterManager

Returns:

true if this node is active.

checkIndex

public void checkIndex()

Forces an index check to see if it is current (or can be rebuilt from current) - if the index is too out of date search for it in shared home export/indexsnapshots directory. If it is not available in export/indexsnapshots request it from any other node. Searching for snapshot in export/indexsnapshots can be disabled by setting system property com.atlassian.jira.startup.pick.indexsnapshot.from.shared to false.

Specified by:

checkIndex in interface ClusterManager

requestCurrentIndexFromNode

public void requestCurrentIndexFromNode(String destinationNode)

Description copied from interface: ClusterManager

We send a message to the node we wish a copy from.

Specified by:

requestCurrentIndexFromNode in interface ClusterManager

Parameters:

destinationNode - Node to send the message to get an Index Copy from.

findLiveNodes

public Collection<Node> findLiveNodes()

Description copied from interface: ClusterManager

Returns a snapshot of the live nodes. This collection is refreshed in every heartbeat of the server. Or you can force it calling refreshLiveNodes()

Specified by:

findLiveNodes in interface ClusterManager

Returns:

the list of nodes that are alive.

refreshLiveNodes

public void refreshLiveNodes()

Description copied from interface: ClusterManager

Merges the information from the heartbeat table and the clusternode table to give accurate information of which nodes are alive.

Specified by:

refreshLiveNodes in interface ClusterManager

onIndexesRestoredEvent

@EventListener
public void onIndexesRestoredEvent(IndexesRestoredEvent ev)

isClusterLicensed

public boolean isClusterLicensed()

Description copied from interface: ClusterManager

Returns whether or not JIRA is licensed for clustered configurations.

Specified by:

isClusterLicensed in interface ClusterManager

Returns:

whether or not JIRA is licensed for clustered configurations.

removeIfOffline

public void removeIfOffline(@NotNull
                            @NotNull String nodeId)
                     throws ClusterStateException

Description copied from interface: ClusterManager

Remove node from cluster if node is Node.NodeState.OFFLINE

Specified by:

removeIfOffline in interface ClusterManager

Throws:

ClusterStateException - if node is not offline

removeOfflineNodesIfOlderThan

public List<String> removeOfflineNodesIfOlderThan(@NotNull
                                                  @NotNull java.time.Duration retentionPeriod)

Description copied from interface: ClusterManager

Remove node from cluster if node is in Node.NodeState.OFFLINE state for specified retention period

Specified by:

removeOfflineNodesIfOlderThan in interface ClusterManager

moveToOffline

public void moveToOffline(@NotNull
                          @NotNull String nodeId)
                   throws ClusterStateException

Description copied from interface: ClusterManager

Update nodes's state to Node.NodeState.OFFLINE if current state is Node.NodeState.ACTIVE and Not Alive

Specified by:

moveToOffline in interface ClusterManager

Throws:

ClusterStateException - if node is alive

moveNodesToOfflineIfOlderThan

public List<String> moveNodesToOfflineIfOlderThan(@NotNull
                                                  @NotNull java.time.Duration retentionPeriod)

Description copied from interface: ClusterManager

Update nodes's state to Node.NodeState.OFFLINE if current node's state is Node.NodeState.ACTIVE and Not Alive for specified retention period

Specified by:

moveNodesToOfflineIfOlderThan in interface ClusterManager

Returns:

List of nodes that was moved to Node.NodeState.OFFLINE state

isNodeAlive

public boolean isNodeAlive(@NotNull
                           @NotNull String nodeId)

Specified by:

isNodeAlive in interface ClusterManager

Returns:

true if node is alive otherwise return false

isNodePresent

public boolean isNodePresent(@NotNull
                             @NotNull String nodeId)

Specified by:

isNodePresent in interface ClusterManager

Returns:

true if node is present in cluster otherwise return false

isNodeOffline

public boolean isNodeOffline(@NotNull
                             @NotNull String nodeId)

Specified by:

isNodeOffline in interface ClusterManager

Returns:

true if node is Node.NodeState.OFFLINE otherwise return false

isNodeActive

public boolean isNodeActive(@NotNull
                            @NotNull String nodeId)

Specified by:

isNodeActive in interface ClusterManager

Returns:

true if node is Node.NodeState.ACTIVE otherwise return false

findActiveAndNotAliveNodes

public List<Node> findActiveAndNotAliveNodes()

Specified by:

findActiveAndNotAliveNodes in interface ClusterManager

Returns:

list of nodes that are Node.NodeState.ACTIVE and not alive ClusterManager.isNodeAlive(java.lang.String)

findOfflineNodes

public List<Node> findOfflineNodes()

Specified by:

findOfflineNodes in interface ClusterManager

Returns:

list of nodes that are Node.NodeState.OFFLINE