com.atlassian.jira.plugins.ha.rest

Class NodeStateResource

java.lang.Object

com.atlassian.jira.plugins.ha.rest.NodeStateResource

public class NodeStateResource
extends Object

The web resource for the current node's state within the Jira cluster.

Since:

6.1

Constructor Summary

Constructors

Constructor and Description
NodeStateResource(JiraAuthenticationContext authenticationContext, NodeStateService nodeStateService)

Method Summary

Modifier and Type	Method and Description
boolean	getState() Gets the state of this Jira node.
javax.ws.rs.core.Response	setState(boolean active) Sets the state of this Jira node.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeStateResource

public NodeStateResource(JiraAuthenticationContext authenticationContext,
                         NodeStateService nodeStateService)

Method Detail

getState

public boolean getState()

Gets the state of this Jira node. request.representation.mediaType application/json request.representation.doc A flag indicating whether this Jira instance should be active. request.representation.example true response.representation.400.doc Returned if the specified base URL is not valid.

Returns:

the desired state of this instance

setState

public javax.ws.rs.core.Response setState(boolean active)

Sets the state of this Jira node. request.representation.mediaType application/json request.representation.doc A flag indicating whether this Jira instance should be active. request.representation.example true response.representation.400.doc Returned if the specified base URL is not valid.

Parameters:

active - the desired state of this instance

Returns:

ok if state successfully set, else contains error collection