Package com.atlassian.greenhopper.web.configuration

Class LexoRankResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.configuration.LexoRankResource

@Path("lexorank")
@Produces("application/json")
@Consumes("application/json")
public class LexoRankResource
extends AbstractResource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LexoRankResource.LexoRankBalanceResponse
static class	LexoRankResource.LexoRankBalanceStatus
static class	LexoRankResource.LexoRankSuspendRequest

Field Summary

Fields inherited from class com.atlassian.greenhopper.web.AbstractResource

authenticationContext, log

Constructor Summary

Constructors

Constructor	Description
LexoRankResource(PermissionService permissionService, LexoRankStatisticsAgent lexoRankStatisticsAgent, LexoRankDao lexoRankDao, LexoRankCustomFieldService lexoRankCustomFieldService, LexoRankManager lexoRankManager, LexoRankIntegrityCheckerImpl lexoRankIntegrityChecker, LexoRankHelper lexoRankHelper, LexoRankSuspendManager lexoRankSuspendManager)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	balance(long fieldId)
jakarta.ws.rs.core.Response	balanceStatus()
jakarta.ws.rs.core.Response	getDuplicates()	Reports the duplicate ranks of all rank custom fields
jakarta.ws.rs.core.Response	healDuplicates()	Heals up any duplicate ranks detected for all rank fields
jakarta.ws.rs.core.Response	integrityReport()
jakarta.ws.rs.core.Response	report()
jakarta.ws.rs.core.Response	suspendBalancing(LexoRankResource.LexoRankSuspendRequest lexoRankSuspendRequest)	Update the state of LexoRank rebalancing (either enable it to continue running, or manually prevent it from running).

Methods inherited from class com.atlassian.greenhopper.web.AbstractResource

check, checkResult, createNoContentResponse, createOkResponse, createOkResponse, getUser, isGadgetRequest, nullSafe, response, responseWithoutAccessCheck

Methods inherited from class java.lang.Object

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

Constructor Details

LexoRankResource

@Inject
public LexoRankResource(PermissionService permissionService,
 LexoRankStatisticsAgent lexoRankStatisticsAgent,
 LexoRankDao lexoRankDao,
 LexoRankCustomFieldService lexoRankCustomFieldService,
 LexoRankManager lexoRankManager,
 LexoRankIntegrityCheckerImpl lexoRankIntegrityChecker,
 LexoRankHelper lexoRankHelper,
 LexoRankSuspendManager lexoRankSuspendManager)

Method Details

balanceStatus

@GET
@Path("/balance")
public jakarta.ws.rs.core.Response balanceStatus()

balance

@POST
@Path("/balance")
public jakarta.ws.rs.core.Response balance(@DefaultValue("0") @QueryParam("fieldId")
 long fieldId)

suspendBalancing

@PUT
@Path("/balance")
public jakarta.ws.rs.core.Response suspendBalancing(LexoRankResource.LexoRankSuspendRequest lexoRankSuspendRequest)

Update the state of LexoRank rebalancing (either enable it to continue running, or manually prevent it from running).

Note that once you have suspended balancing through this resource, it will not continue again until a subsequent request has been made to enable it. Suspended balancing may result in users being unable to rank issues on the backlog or on boards. We only recommend using this resource when you are sure of the implications, and preferably only with the guidance of an Atlassian Support Engineer.

Parameters:

lexoRankSuspendRequest - An object containing the rebalance update parameters. This should contain a single boolean value, suspendBalancing, indicating whether or not LexoRank balancing should be suspended. When true, any in-progress rebalancing will be aborted, and subsequent rebalances will not be scheduled. When false, rebalancing will be scheduled at some point in the future, defined by the current distribution of ranks in the system.

report

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

getDuplicates

@GET
@Path("/duplicates")
public jakarta.ws.rs.core.Response getDuplicates()

Reports the duplicate ranks of all rank custom fields

healDuplicates

@PUT
@Path("/duplicates")
public jakarta.ws.rs.core.Response healDuplicates()

Heals up any duplicate ranks detected for all rank fields

integrityReport

@GET
@Path("/integrity")
public jakarta.ws.rs.core.Response integrityReport()