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

ClusterInfo

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

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Provides basic information about whether or not JIRA is clustered, the identification of the current node, and so on.

Summary

Public Methods
@Nullable String getNodeId()
Provides the node ID for this particular cluster node.
boolean isClustered()
Returns whether or not this is JIRA instance is configured as a node in a JIRA Data Center cluster.

Public Methods

@Nullable public String getNodeId ()

Provides the node ID for this particular cluster node.

Returns
  • the current node's unique identifier, or null if this is not a clustered environment (isClustered() will return false).

public boolean isClustered ()

Returns whether or not this is JIRA instance is configured as a node in a JIRA Data Center cluster.

Returns
  • true if this is a clustered JIRA instance; false if this JIRA instance is not part of a JIRA Data Center cluster.