com.atlassian.jira.cluster

Interface NodeStateService

All Known Implementing Classes:

DefaultNodeStateService

@ExperimentalApi
public interface NodeStateService

A service relating to the state of nodes within a JIRA cluster.

Since:

6.1

Method Summary

Modifier and Type	Method and Description
ServiceResult	activate(ApplicationUser user) Activate the current node, provided the user has the necessary permissions.
ServiceResult	deactivate(ApplicationUser user) Deactivate the node.
boolean	isActive() Indicates whether the current node is active within the cluster.

Method Detail

activate

ServiceResult activate(ApplicationUser user)

Activate the current node, provided the user has the necessary permissions.

This method will block until the node becomes active.

Parameters:

user - the user performing the activation (required)

Returns:

a non-null result

deactivate

ServiceResult deactivate(ApplicationUser user)

Deactivate the node.

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

Parameters:

user - the user performing the deactivation (required)

Returns:

a non-null result

isActive

boolean isActive()

Indicates whether the current node is active within the cluster.

Returns:

true if not clustered