* ============LICENSE_START=======================================================
* ONAP PAP
* ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2021-2023 Nordix Foundation.
+ * 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.
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Timer;
+import java.time.Duration;
+import java.time.Instant;
import java.util.UUID;
-import javax.ws.rs.DELETE;
-import javax.ws.rs.HeaderParam;
-import javax.ws.rs.Path;
-import javax.ws.rs.PathParam;
-import javax.ws.rs.core.Response;
-import javax.ws.rs.core.Response.Status;
-import org.apache.commons.lang3.tuple.Pair;
+import lombok.RequiredArgsConstructor;
+import org.onap.policy.common.utils.resources.PrometheusUtils;
+import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.base.PfModelRuntimeException;
import org.onap.policy.models.pap.concepts.PdpGroupDeleteResponse;
+import org.onap.policy.models.pap.concepts.PdpGroupDeployResponse;
+import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifierOptVersion;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RestController;
/**
* Class to provide REST end points for PAP component to delete a PDP group.
*/
-public class PdpGroupDeleteControllerV1 extends PapRestControllerV1 {
+@RestController
+@RequiredArgsConstructor
+public class PdpGroupDeleteControllerV1 extends PapRestControllerV1
+ implements PdpGroupDeleteControllerV1Api {
- private final PdpGroupDeleteProvider provider = new PdpGroupDeleteProvider();
+ private static final Logger logger = LoggerFactory.getLogger(PdpGroupDeleteControllerV1.class);
+
+ private final PdpGroupDeleteProvider provider;
+ private Timer undeploySuccessTimer;
+ private Timer undeployFailureTimer;
+
+
+ @Autowired
+ public PdpGroupDeleteControllerV1(PdpGroupDeleteProvider provider, MeterRegistry meterRegistry) {
+ this.provider = provider;
+ initMetrics(meterRegistry);
+ }
+
+ /**
+ * Initializes the metrics for delete operation.
+ *
+ * @param meterRegistry spring bean for MeterRegistry to add the new metric
+ */
+ public void initMetrics(MeterRegistry meterRegistry) {
+ String metricName = String.join(".", "pap", "policy", "deployments");
+ String description = "Timer for HTTP request to deploy/undeploy a policy";
+ undeploySuccessTimer = Timer.builder(metricName).description(description)
+ .tags(PrometheusUtils.OPERATION_METRIC_LABEL, PrometheusUtils.UNDEPLOY_OPERATION,
+ PrometheusUtils.STATUS_METRIC_LABEL, PdpPolicyStatus.State.SUCCESS.name())
+ .register(meterRegistry);
+ undeployFailureTimer = Timer.builder(metricName).description(description)
+ .tags(PrometheusUtils.OPERATION_METRIC_LABEL, PrometheusUtils.UNDEPLOY_OPERATION,
+ PrometheusUtils.STATUS_METRIC_LABEL, PdpPolicyStatus.State.FAILURE.name())
+ .register(meterRegistry);
+ }
/**
* Deletes a PDP group.
* @param groupName name of the PDP group to be deleted
* @return a response
*/
- // @formatter:off
- @DELETE
- @Path("pdps/groups/{name}")
- @ApiOperation(value = "Delete PDP Group",
- notes = "Deletes a PDP Group, returning optional error details",
- response = PdpGroupDeleteResponse.class,
- tags = {"Policy Administration (PAP) API"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {@Extension(name = EXTENSION_NAME,
- properties = {@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)})})
- @ApiResponses(value = {@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)})
- // @formatter:on
-
- public Response deleteGroup(@HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
- @ApiParam(value = "PDP Group Name", required = true) @PathParam("name") String groupName) {
-
- Pair<Status, PdpGroupDeleteResponse> pair = provider.delete(groupName, null);
+ @Override
+ public ResponseEntity<PdpGroupDeleteResponse> deleteGroup(String groupName, UUID requestId) {
+ return doOperation(requestId, () -> provider.deleteGroup(groupName));
+ }
- return addLoggingHeaders(addVersionControlHeaders(Response.status(pair.getLeft())), requestId)
- .entity(pair.getRight()).build();
+ /**
+ * Undeploys the latest version of a policy from the PDPs.
+ *
+ * @param requestId request ID used in ONAP logging
+ * @param policyName name of the PDP Policy to be deleted
+ * @return a response
+ */
+ @Override
+ public ResponseEntity<PdpGroupDeployResponse> deletePolicy(String policyName, UUID requestId) {
+ return doUndeployOperation(requestId,
+ () -> provider.undeploy(new ToscaConceptIdentifierOptVersion(policyName, null), getPrincipal()));
}
/**
- * Deletes a PDP group.
+ * Undeploys a specific version of a policy from the PDPs.
*
* @param requestId request ID used in ONAP logging
- * @param groupName name of the PDP group to be deleted
+ * @param policyName name of the PDP Policy to be deleted
* @param version version to be deleted
* @return a response
*/
- // @formatter:off
- @DELETE
- @Path("pdps/groups/{name}/versions/{version}")
- @ApiOperation(value = "Delete version of a PDP Group",
- notes = "Deletes a version of PDP Group, returning optional error details",
- response = PdpGroupDeleteResponse.class,
- tags = {"Policy Administration (PAP) API"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {@Extension(name = EXTENSION_NAME,
- properties = {@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)})})
- @ApiResponses(value = {@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)})
- // @formatter:on
+ @Override
+ public ResponseEntity<PdpGroupDeployResponse> deletePolicyVersion(
+ String policyName,
+ String version,
+ UUID requestId) {
+ return doUndeployOperation(requestId,
+ () -> provider.undeploy(new ToscaConceptIdentifierOptVersion(policyName, version), getPrincipal()));
+ }
+
+ /**
+ * Invokes an operation.
+ *
+ * @param requestId request ID
+ * @param runnable operation to invoke
+ * @return a {@link PdpGroupDeleteResponse} response entity
+ */
+ private ResponseEntity<PdpGroupDeleteResponse> doOperation(UUID requestId, RunnableWithPfEx runnable) {
+ try {
+ runnable.run();
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
+ .body(new PdpGroupDeleteResponse());
- public Response deleteGroupVersion(
- @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
- @ApiParam(value = "PDP Group Name", required = true) @PathParam("name") String groupName,
- @ApiParam(value = "PDP Group Version", required = true) @PathParam("version") String version) {
+ } catch (PfModelException | PfModelRuntimeException e) {
+ logger.warn("delete group failed", e);
+ var resp = new PdpGroupDeleteResponse();
+ resp.setErrorDetails(e.getErrorResponse().getErrorMessage());
+ return addLoggingHeaders(
+ addVersionControlHeaders(ResponseEntity.status(e.getErrorResponse().getResponseCode().getStatusCode())),
+ requestId).body(resp);
+ }
+ }
- Pair<Status, PdpGroupDeleteResponse> pair = provider.delete(groupName, version);
+ /**
+ * Invokes the undeployment operation.
+ *
+ * @param requestId request ID
+ * @param runnable operation to invoke
+ * @return a {@link PdpGroupDeployResponse} response entity
+ */
+ private ResponseEntity<PdpGroupDeployResponse> doUndeployOperation(UUID requestId, RunnableWithPfEx runnable) {
+ Instant start = Instant.now();
+ try {
+ runnable.run();
+ undeploySuccessTimer.record(Duration.between(start, Instant.now()));
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.accepted()), requestId)
+ .body(new PdpGroupDeployResponse(PdpGroupDeployControllerV1.DEPLOYMENT_RESPONSE_MSG,
+ PdpGroupDeployControllerV1.POLICY_STATUS_URI));
- return addLoggingHeaders(addVersionControlHeaders(Response.status(pair.getLeft())), requestId)
- .entity(pair.getRight()).build();
+ } catch (PfModelException | PfModelRuntimeException e) {
+ logger.warn("undeploy policy failed", e);
+ var resp = new PdpGroupDeployResponse();
+ resp.setErrorDetails(e.getErrorResponse().getErrorMessage());
+ undeployFailureTimer.record(Duration.between(start, Instant.now()));
+ return addLoggingHeaders(
+ addVersionControlHeaders(ResponseEntity.status(e.getErrorResponse().getResponseCode().getStatusCode())),
+ requestId).body(resp);
+ }
}
}
Code Review / policy / pap.git / blobdiff