Package com.atlassian.jira.gadgets.system

Class StatsResource

java.lang.Object

com.atlassian.jira.gadgets.system.AbstractResource

com.atlassian.jira.gadgets.system.SearchQueryBackedResource

com.atlassian.jira.gadgets.system.StatsResource

@Path("/stats")
@Produces("application/json")
public class StatsResource
extends SearchQueryBackedResource

REST endpoint for statistics gadgets Project/Filter Stats and 2D Stats.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatsResource.Results
static class	StatsResource.StatsRow

Field Summary

Fields inherited from class com.atlassian.jira.gadgets.system.SearchQueryBackedResource

chartUtils, permissionManager, QUERY_STRING, searchService

Constructor Summary

Constructors

Constructor

Description

StatsResource(ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, SearchService searchService, SearchRequestService searchRequestService, PermissionManager permissionManager, StatisticTypesProvider statisticTypesProvider, ProjectManager projectManager, VelocityRequestContextFactory velocityRequestContextFactory, FieldValueToDisplayTransformer<StatsMarkup> fieldValueToDisplayTransformer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getData(String queryString, String statType, boolean includeResolvedIssues, String sortDirection, String sortBy)	Return a Response containing a Results bean for the given query.
protected com.atlassian.jira.gadgets.system.StatsSearchUrlBuilder	getHeadingUrlBuilder()
protected StatisticAccessorBean	getStatisticsAcessorBean(SearchRequest searchRequest)
void	setGenerator(FilterStatisticsValuesGenerator generator)
javax.ws.rs.core.Response	validate(String queryString, String statType)	Check that the queryString referes to a valid search criteria and that the statType refers to a known statistic type.

Methods inherited from class com.atlassian.jira.gadgets.system.SearchQueryBackedResource

getFilterTitle, getFilterUrl, getSearchRequestAndValidate, validateSize

Methods inherited from class com.atlassian.jira.gadgets.system.AbstractResource

createErrorResponse, createIndexingUnavailableResponse, createValidationResponse

Methods inherited from class java.lang.Object

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

Constructor Details

StatsResource

@Inject
public StatsResource(ChartUtils chartUtils,
 JiraAuthenticationContext authenticationContext,
 SearchService searchService,
 SearchRequestService searchRequestService,
 PermissionManager permissionManager,
 StatisticTypesProvider statisticTypesProvider,
 ProjectManager projectManager,
 VelocityRequestContextFactory velocityRequestContextFactory,
 FieldValueToDisplayTransformer<StatsMarkup> fieldValueToDisplayTransformer)

Method Details

validate

@GET
@Path("validate")
public javax.ws.rs.core.Response validate(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("statType")
 String statType)

Check that the queryString referes to a valid search criteria and that the statType refers to a known statistic type.

setGenerator

public void setGenerator(FilterStatisticsValuesGenerator generator)

getData

@GET
@Path("generate")
public javax.ws.rs.core.Response getData(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("statType") @DefaultValue("assignees")
 String statType,
 @QueryParam("includeResolvedIssues") @DefaultValue("false")
 boolean includeResolvedIssues,
 @QueryParam("sortDirection") @DefaultValue("asc")
 String sortDirection,
 @QueryParam("sortBy") @DefaultValue("natural")
 String sortBy)

Return a Response containing a Results bean for the given query.

getStatisticsAcessorBean

protected StatisticAccessorBean getStatisticsAcessorBean(SearchRequest searchRequest)

getHeadingUrlBuilder

protected com.atlassian.jira.gadgets.system.StatsSearchUrlBuilder getHeadingUrlBuilder()