Summary: Methods | [Expand All]
@ExperimentalApi public interface

NodeStateService

com.atlassian.jira.cluster.NodeStateService
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

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

Summary

Public Methods
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.

Public Methods

public 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

public 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

public boolean isActive ()

Indicates whether the current node is active within the cluster.

Returns
  • true if not clustered