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

void	activate() Activate the node.
void	deactivate() Deactivate the node.
Set<Node>	getAllNodes() Returns all the known nodes JIRA node.
Node	getNode() Returns the current JIRA node.
Node	getNodeWithRefresh() Returns the current JIRA node, first refreshing its state from the database.
void	quiesce()
void	restart()

Method Detail

getNode

Node getNode()

Returns the current JIRA node.

Returns:

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

getNodeWithRefresh

Node getNodeWithRefresh()

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

Set<Node> getAllNodes()

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()