com.atlassian.jira.cluster

Interface ClusterManager

All Superinterfaces:

ClusterInfo

All Known Implementing Classes:

DefaultClusterManager

public interface ClusterManager
extends ClusterInfo

Manages the cluster - addition of nodes, removal, etc

Since:

v6.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_NODES
static String	ANY_NODE

Method Summary

Modifier and Type	Method and Description
void	checkIndex()
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.
boolean	isActive()
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 id)
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	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 node) We send a message to the node we wish a copy from.

Methods inherited from interface com.atlassian.jira.cluster.ClusterInfo

getNodeId, isClustered

Field Detail

ALL_NODES

static final String ALL_NODES

See Also:

Constant Field Values

ANY_NODE

static final String ANY_NODE

See Also:

Constant Field Values

Method Detail

checkIndex

void checkIndex()

isActive

boolean isActive()

getAllNodes

Set<Node> getAllNodes()

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

Returns:

a collection of Nodes in a cluster

isClusterLicensed

boolean isClusterLicensed()

Returns whether or not JIRA is licensed for clustered configurations.

Returns:

whether or not JIRA is licensed for clustered configurations.

Since:

6.3

requestCurrentIndexFromNode

void requestCurrentIndexFromNode(String node)

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

Parameters:

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

findLiveNodes

Collection<Node> findLiveNodes()

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

Returns:

the list of nodes that are alive.

refreshLiveNodes

void refreshLiveNodes()

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

Since:

6.3.4

removeIfOffline

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

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

Throws:

ClusterStateException - if node is not offline

Since:

v8.1

removeOfflineNodesIfOlderThan

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

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

Since:

v8.10

moveToOffline

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

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

Throws:

ClusterStateException - if node is alive

Since:

v8.1

moveNodesToOfflineIfOlderThan

List<String> moveNodesToOfflineIfOlderThan(@NotNull
                                           @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

Returns:

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

Since:

v8.10

isNodeAlive

boolean isNodeAlive(@NotNull
                    @NotNull String nodeId)

Returns:

true if node is alive otherwise return false

Since:

v8.1

isNodePresent

boolean isNodePresent(@NotNull
                      @NotNull String id)

Returns:

true if node is present in cluster otherwise return false

Since:

v8.1

isNodeOffline

boolean isNodeOffline(@NotNull
                      @NotNull String nodeId)

Returns:

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

Since:

v8.1

isNodeActive

boolean isNodeActive(@NotNull
                     @NotNull String nodeId)

Returns:

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

Since:

v8.10

findActiveAndNotAliveNodes

List<Node> findActiveAndNotAliveNodes()

Returns:

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

Since:

v8.10

findOfflineNodes

List<Node> findOfflineNodes()

Returns:

list of nodes that are Node.NodeState.OFFLINE

Since:

v8.10