Package io.jans.configapi.rest.resource.auth

Class StatResource

java.lang.Object

io.jans.configapi.core.rest.BaseResource

io.jans.configapi.rest.resource.auth.ConfigBaseResource

io.jans.configapi.rest.resource.auth.StatResource

@Path("/stat")
public class StatResource
extends ConfigBaseResource

Constructor Summary

Constructors

Constructor	Description
StatResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getStatistics(String authorization, String month, String startMonth, String endMonth, String format)	Fetches basic server statistics for a specified month or month range.

Methods inherited from class io.jans.configapi.rest.resource.auth.ConfigBaseResource

getMaxCount

Methods inherited from class io.jans.configapi.core.rest.BaseResource

checkNotEmpty, checkNotEmpty, checkNotNull, checkNotNull, checkNotNull, checkResourceNotNull, createSearchRequest, findRootError, getBadRequestException, getBadRequestException, getBadRequestException, getHttpHeaders, getHttpRequest, getInternalServerException, getInternalServerException, getMissingAttributeError, getNotAcceptableException, getNotFoundError, getNotFoundError, getUriInfo, throwBadRequestException, throwBadRequestException, throwBadRequestException, throwInternalServerException, throwInternalServerException, throwInternalServerException, throwInternalServerException, throwMissingAttributeError, throwNotFoundException, throwNotFoundException

Methods inherited from class java.lang.Object

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

Constructor Details

StatResource

public StatResource()

Method Details

getStatistics

@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response getStatistics(@HeaderParam("Authorization")
 String authorization,
 @QueryParam("month")
 String month,
 @QueryParam("start_month")
 String startMonth,
 @QueryParam("end_month")
 String endMonth,
 @QueryParam("format")
 String format)

Fetches basic server statistics for a specified month or month range.

Parameters:

authorization - the Authorization header value used to authenticate the request

month - month for which the stat report is requested; required if both start_month and end_month are absent (format: YYYYMM)

startMonth - start month of the range for which the stat report is requested (format: YYYYMM)

endMonth - end month of the range for which the stat report is requested (format: YYYYMM)

format - report format; an empty value requests the default format

Returns:

the JSON value of the "response" field containing the requested statistics