com.atlassian.jira.cluster

Interface NodeStateManager

All Known Implementing Classes:

DefaultNodeStateManager

public interface NodeStateManager

Manage the state of nodes in the HA Cluster.

Since:

v6.1

Method Summary

Modifier and Type	Method and Description
void	activate() Activate the node.
void	deactivate() Deactivate the node.
Set<Node>	getAllNodes() Deprecated. since 7.0.6 Use ClusterNodes.all() instead.
Node	getNode() Deprecated. since 7.0.6 Use ClusterNodes.current() instead.
Node	getNodeWithRefresh() Deprecated. since 7.0.6 Use ClusterNodes.reset() followed by ClusterNodes.current() instead.
void	quiesce()
void	restart()
void	shutdownNode() Shutdowns the node in the db.

Method Detail

getNode

@Deprecated
Node getNode()

Deprecated. since 7.0.6 Use ClusterNodes.current() instead.

Returns the current JIRA node.

Returns:

a non-null instance; call Node.isClustered() to see if it's part of a cluster

getNodeWithRefresh

@Deprecated
Node getNodeWithRefresh()

Deprecated. since 7.0.6 Use ClusterNodes.reset() followed by ClusterNodes.current() instead.

Returns the current JIRA node, first refreshing its state from the database.

Returns:

a non-null instance; call Node.isClustered() to see if it's part of a cluster

getAllNodes

@Deprecated
Set<Node> getAllNodes()

Deprecated. since 7.0.6 Use ClusterNodes.all() instead.

Returns all the known nodes JIRA node. If not clustered this will return an empty set.

Returns:

a collection of Nodes in a cluster

activate

void activate()
       throws ClusterStateException

Activate the node. This method will block until the node becomes active.

Throws:

ClusterStateException - when we can't become active as requested

deactivate

void deactivate()
         throws NotClusteredException

Deactivate the node. This method will block until the node becomes inactive (passive).

Throws:

NotClusteredException - if the instance is not clustered

quiesce

void quiesce()
      throws NotClusteredException

Throws:

NotClusteredException

restart

void restart()

shutdownNode

void shutdownNode()

Shutdowns the node in the db. The state of the node should be OFFLINE This will prevent the health checks to show abnormal behaviour in the cluster