Package com.atlassian.jira.rest.v2.cluster

Class ClusterResource

java.lang.Object

com.atlassian.jira.rest.v2.cluster.ClusterResource

@Produces("application/json")
@Path("cluster")
public final class ClusterResource
extends Object

It gives possibility to manage old node in cluster.

Since:

v8.1

Field Summary

Fields

Modifier and Type	Field	Description
static final int	METHOD_NOT_ALLOWED

Constructor Summary

Constructors

Constructor	Description
ClusterResource(ClusterManager clusterManager, JiraAuthenticationContext jiraAuthenticationContext, GlobalPermissionManager globalPermissionManager, I18nHelper i18n, com.atlassian.event.api.EventPublisher eventPublisher, IndexingFeatures indexingFeatures)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	changeNodeStateToOffline(String nodeId)	Change the node's state to offline if the node is reporting as active, but is not alive.
jakarta.ws.rs.core.Response	deleteNode(String nodeId)	Delete the node from the cluster if state of node is OFFLINE.
jakarta.ws.rs.core.Response	getAllNodes()
jakarta.ws.rs.core.Response	requestCurrentIndexFromNode(String nodeId)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

METHOD_NOT_ALLOWED

public static final int METHOD_NOT_ALLOWED

See Also:

• Constant Field Values

Constructor Details

ClusterResource

@Inject
public ClusterResource(ClusterManager clusterManager,
 JiraAuthenticationContext jiraAuthenticationContext,
 GlobalPermissionManager globalPermissionManager,
 I18nHelper i18n,
 com.atlassian.event.api.EventPublisher eventPublisher,
 IndexingFeatures indexingFeatures)

Method Details

getAllNodes

@Path("/nodes")
@GET
public jakarta.ws.rs.core.Response getAllNodes()

Returns:

All nodes in cluster.

Since:

v8.1

deleteNode

@Path("node/{nodeId}")
@DELETE
public jakarta.ws.rs.core.Response deleteNode(@PathParam("nodeId")
 String nodeId)

Delete the node from the cluster if state of node is OFFLINE.

Since:

v8.1

requestCurrentIndexFromNode

@Path("index-snapshot/{nodeId}")
@PUT
@Deprecated(since="10.4",
            forRemoval=true)
public jakarta.ws.rs.core.Response requestCurrentIndexFromNode(@PathParam("nodeId")
 String nodeId)

Deprecated, for removal: This API element is subject to removal in a future version.

request current index from node (the request is processed asynchronously)

Since:

v8.14

changeNodeStateToOffline

@Path("node/{nodeId}/offline")
@PUT
public jakarta.ws.rs.core.Response changeNodeStateToOffline(@PathParam("nodeId")
 String nodeId)

Change the node's state to offline if the node is reporting as active, but is not alive. Don't use this method as an equivalent of running ./stop-jira.sh. This method doesn't shut down a node, but only changes its state, so that other nodes don't communicate with it.

Since:

v8.1