* ============LICENSE_START=======================================================
* Copyright (C) 2019-2021 Nordix Foundation.
* Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
+ * Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
import io.swagger.annotations.ExtensionProperty;
import io.swagger.annotations.ResponseHeader;
import java.time.Instant;
+import java.util.List;
import java.util.Map;
import java.util.UUID;
-import javax.ws.rs.GET;
-import javax.ws.rs.HeaderParam;
-import javax.ws.rs.Path;
-import javax.ws.rs.PathParam;
-import javax.ws.rs.QueryParam;
-import javax.ws.rs.core.Response;
+import lombok.RequiredArgsConstructor;
import org.onap.policy.models.base.PfModelException;
-import org.onap.policy.models.base.PfModelRuntimeException;
+import org.onap.policy.models.pdp.concepts.PdpStatistics;
import org.onap.policy.models.pdp.persistence.provider.PdpFilterParameters;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
/**
* Class to provide REST endpoints for PAP component statistics.
*
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
+@RestController
+@RequestMapping(path = "/policy/pap/v1")
+@RequiredArgsConstructor
public class StatisticsRestControllerV1 extends PapRestControllerV1 {
- private static final Logger LOGGER = LoggerFactory.getLogger(StatisticsRestControllerV1.class);
- private static final String GET_STATISTICS_ERR_MSG = "get pdpStatistics failed";
+ private final StatisticsRestProvider provider;
/**
* get statistics of PAP.
*
* @return a response
*/
- @GET
- @Path("statistics")
+ @GetMapping("statistics")
@ApiOperation(value = "Fetch current statistics",
notes = "Returns current statistics of the Policy Administration component",
response = StatisticsReport.class, authorizations = @Authorization(value = AUTHORIZATION_TYPE))
@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)})
- public Response statistics(
- @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId) {
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
- .entity(new StatisticsRestProvider().fetchCurrentStatistics())
- .build();
+ public ResponseEntity<StatisticsReport> statistics(
+ @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
+ required = false,
+ value = REQUEST_ID_NAME) final UUID requestId) {
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
+ .body(provider.fetchCurrentStatistics());
}
/**
*
*
* @return a response
+ * @throws PfModelException the exception
*/
- @GET
- @Path("pdps/statistics")
+ @GetMapping("pdps/statistics")
@ApiOperation(value = "Fetch statistics for all PDP Groups and subgroups in the system",
notes = "Returns for all PDP Groups and subgroups statistics of the Policy Administration component",
response = Map.class, tags = {"PDP Statistics"},
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
})
- public Response pdpStatistics(
- @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId,
- @ApiParam(value = "Record Count", required = false) @QueryParam("recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp",
- required = false) @QueryParam("startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp",
- required = false) @QueryParam("endTime") final Long endTime) {
- try {
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
- .entity(new StatisticsRestProvider().fetchDatabaseStatistics(PdpFilterParameters.builder()
- .recordNum(recordCount)
- .startTime(convertEpochtoInstant(startTime))
- .endTime(convertEpochtoInstant(endTime))
- .build()))
- .build();
- } catch (final PfModelException | PfModelRuntimeException exp) {
- LOGGER.info(GET_STATISTICS_ERR_MSG, exp);
- return addLoggingHeaders(
- addVersionControlHeaders(Response.status(exp.getErrorResponse().getResponseCode())), requestId)
- .build();
- }
+ public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpStatistics(
+ @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
+ required = false,
+ value = REQUEST_ID_NAME) final UUID requestId,
+ @ApiParam(value = "Record Count") @RequestParam(
+ defaultValue = "10", required = false,
+ value = "recordCount") final int recordCount,
+ @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "startTime") final Long startTime,
+ @ApiParam(value = "End time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "endTime") final Long endTime) throws PfModelException {
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
+ .body(provider.fetchDatabaseStatistics(PdpFilterParameters.builder().recordNum(recordCount)
+ .startTime(convertEpochtoInstant(startTime)).endTime(convertEpochtoInstant(endTime)).build()));
}
/**
*
* @param groupName name of the PDP group
* @return a response
+ * @throws PfModelException the exception
*/
- @GET
- @Path("pdps/statistics/{group}")
+ @GetMapping("pdps/statistics/{group}")
@ApiOperation(value = "Fetch current statistics for given PDP Group",
notes = "Returns statistics for given PDP Group of the Policy Administration component",
response = Map.class, tags = {"PDP Statistics"},
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
})
- public Response pdpGroupStatistics(
- @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId,
- @ApiParam(value = "PDP Group Name", required = true) @PathParam("group") final String groupName,
- @ApiParam(value = "Record Count", required = false) @QueryParam("recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp",
- required = false) @QueryParam("startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp",
- required = false) @QueryParam("endTime") final Long endTime) {
- try {
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
- .entity(new StatisticsRestProvider().fetchDatabaseStatistics(PdpFilterParameters.builder()
- .group(groupName)
- .recordNum(recordCount)
- .startTime(convertEpochtoInstant(startTime))
- .endTime(convertEpochtoInstant(endTime))
- .build()))
- .build();
- } catch (final PfModelException | PfModelRuntimeException exp) {
- LOGGER.info(GET_STATISTICS_ERR_MSG, exp);
- return addLoggingHeaders(
- addVersionControlHeaders(Response.status(exp.getErrorResponse().getResponseCode())), requestId)
- .build();
- }
+ public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpGroupStatistics(
+ @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
+ required = false,
+ value = REQUEST_ID_NAME) final UUID requestId,
+ @ApiParam(value = "PDP Group Name") @PathVariable("group") final String groupName,
+ @ApiParam(value = "Record Count") @RequestParam(
+ defaultValue = "10", required = false,
+ value = "recordCount") final int recordCount,
+ @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "startTime") final Long startTime,
+ @ApiParam(value = "End time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "endTime") final Long endTime) throws PfModelException {
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
+ .body(provider.fetchDatabaseStatistics(PdpFilterParameters.builder().group(groupName).recordNum(recordCount)
+ .startTime(convertEpochtoInstant(startTime)).endTime(convertEpochtoInstant(endTime)).build()));
}
/**
* @param groupName name of the PDP group
* @param subType type of the sub PDP group
* @return a response
+ * @throws PfModelException the exception
*/
- @GET
- @Path("pdps/statistics/{group}/{type}")
+ @GetMapping("pdps/statistics/{group}/{type}")
@ApiOperation(value = "Fetch statistics for the specified subgroup",
notes = "Returns statistics for the specified subgroup of the Policy Administration component",
response = Map.class, tags = {"PDP Statistics"},
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
})
- public Response pdpSubGroupStatistics(
- @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId,
- @ApiParam(value = "PDP Group Name", required = true) @PathParam("group") final String groupName,
- @ApiParam(value = "PDP SubGroup type", required = true) @PathParam("type") final String subType,
- @ApiParam(value = "Record Count", required = false) @QueryParam("recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp",
- required = false) @QueryParam("startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp",
- required = false) @QueryParam("endTime") final Long endTime) {
- try {
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
- .entity(new StatisticsRestProvider().fetchDatabaseStatistics(PdpFilterParameters.builder()
- .group(groupName)
- .subGroup(subType)
- .recordNum(recordCount)
- .startTime(convertEpochtoInstant(startTime))
- .endTime(convertEpochtoInstant(endTime))
- .build()))
- .build();
- } catch (final PfModelException | PfModelRuntimeException exp) {
- LOGGER.info(GET_STATISTICS_ERR_MSG, exp);
- return addLoggingHeaders(
- addVersionControlHeaders(Response.status(exp.getErrorResponse().getResponseCode())), requestId)
- .build();
- }
+ public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpSubGroupStatistics(
+ @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
+ required = false,
+ value = REQUEST_ID_NAME) final UUID requestId,
+ @ApiParam(value = "PDP Group Name") @PathVariable("group") final String groupName,
+ @ApiParam(value = "PDP SubGroup type") @PathVariable("type") final String subType,
+ @ApiParam(value = "Record Count") @RequestParam(
+ defaultValue = "10", required = false,
+ value = "recordCount") final int recordCount,
+ @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "startTime") final Long startTime,
+ @ApiParam(value = "End time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "endTime") final Long endTime) throws PfModelException {
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
+ .body(provider.fetchDatabaseStatistics(
+ PdpFilterParameters.builder().group(groupName).subGroup(subType).recordNum(recordCount)
+ .startTime(convertEpochtoInstant(startTime)).endTime(convertEpochtoInstant(endTime)).build()));
}
/**
* @param pdpName the name of the PDP
* @param recordCount the count of the query response, optional, default return all statistics stored
* @return a response
+ * @throws PfModelException the exception
*/
- @GET
- @Path("pdps/statistics/{group}/{type}/{pdp}")
+ @GetMapping("pdps/statistics/{group}/{type}/{pdp}")
@ApiOperation(value = "Fetch statistics for the specified pdp",
notes = "Returns statistics for the specified pdp of the Policy Administration component",
response = Map.class,
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
})
- public Response pdpInstanceStatistics(
- @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId,
- @ApiParam(value = "PDP Group Name", required = true) @PathParam("group") final String groupName,
- @ApiParam(value = "PDP SubGroup type", required = true) @PathParam("type") final String subType,
- @ApiParam(value = "PDP Instance name", required = true) @PathParam("pdp") final String pdpName,
- @ApiParam(value = "Record Count", required = false) @QueryParam("recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp",
- required = false) @QueryParam("startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp",
- required = false) @QueryParam("endTime") final Long endTime) {
- try {
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
- .entity(new StatisticsRestProvider().fetchDatabaseStatistics(
- PdpFilterParameters.builder()
- .group(groupName)
- .subGroup(subType)
- .name(pdpName)
- .recordNum(recordCount)
- .startTime(convertEpochtoInstant(startTime))
- .endTime(convertEpochtoInstant(endTime))
- .build()))
- .build();
- } catch (final PfModelException | PfModelRuntimeException exp) {
- LOGGER.info(GET_STATISTICS_ERR_MSG, exp);
- return addLoggingHeaders(
- addVersionControlHeaders(Response.status(exp.getErrorResponse().getResponseCode())), requestId)
- .build();
- }
+ public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpInstanceStatistics(
+ @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
+ required = false,
+ value = REQUEST_ID_NAME) final UUID requestId,
+ @ApiParam(value = "PDP Group Name") @PathVariable("group") final String groupName,
+ @ApiParam(value = "PDP SubGroup type") @PathVariable("type") final String subType,
+ @ApiParam(value = "PDP Instance name") @PathVariable("pdp") final String pdpName,
+ @ApiParam(value = "Record Count") @RequestParam(
+ defaultValue = "10", required = false,
+ value = "recordCount") final int recordCount,
+ @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "startTime") final Long startTime,
+ @ApiParam(value = "End time in epoch timestamp") @RequestParam(
+ required = false,
+ value = "endTime") final Long endTime) throws PfModelException {
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
+ .body(provider.fetchDatabaseStatistics(
+ PdpFilterParameters.builder().group(groupName).subGroup(subType).name(pdpName).recordNum(recordCount)
+ .startTime(convertEpochtoInstant(startTime)).endTime(convertEpochtoInstant(endTime)).build()));
}
private Instant convertEpochtoInstant(Long epochSecond) {
Code Review / policy / pap.git / blobdiff