2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
6 * Modifications Copyright (C) 2021, 2024 Nordix Foundation.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.policy.xacml.pdp.application.monitoring;
26 import com.att.research.xacml.api.Response;
27 import java.util.Arrays;
28 import java.util.List;
30 import java.util.Map.Entry;
31 import org.apache.commons.lang3.tuple.Pair;
32 import org.onap.policy.models.decisions.concepts.DecisionRequest;
33 import org.onap.policy.models.decisions.concepts.DecisionResponse;
34 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
35 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
36 import org.onap.policy.pdp.xacml.application.common.std.StdCombinedPolicyResultsTranslator;
37 import org.onap.policy.pdp.xacml.application.common.std.StdXacmlApplicationServiceProvider;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
42 * This is the engine class that manages the instance of the XACML PDP engine.
44 * <p>It is responsible for initializing it and shutting it down properly in a thread-safe manner.
47 * @author pameladragosh
50 public class MonitoringPdpApplication extends StdXacmlApplicationServiceProvider {
51 private static final Logger LOGGER = LoggerFactory.getLogger(MonitoringPdpApplication.class);
53 public static final String ONAP_MONITORING_BASE_POLICY_TYPE = "onap.Monitoring";
54 public static final String ONAP_MONITORING_DERIVED_POLICY_TYPE = "onap.policies.monitoring.";
56 public static final String VERSION_100 = "1.0.0";
58 private final StdCombinedPolicyResultsTranslator translator = new StdCombinedPolicyResultsTranslator();
63 public MonitoringPdpApplication() {
66 applicationName = "monitoring";
67 actions = List.of("configure");
69 // By default, this supports just Monitoring policy types
71 supportedPolicyTypes.add(new ToscaConceptIdentifier(ONAP_MONITORING_BASE_POLICY_TYPE, VERSION_100));
75 public boolean canSupportPolicyType(ToscaConceptIdentifier policyTypeId) {
77 // For Monitoring, we will attempt to support all versions
78 // of the policy type. Since we are only packaging a decision
79 // back with a JSON payload of the property contents.
81 return policyTypeId.getName().startsWith(ONAP_MONITORING_DERIVED_POLICY_TYPE);
85 public Pair<DecisionResponse, Response> makeDecision(DecisionRequest request,
86 Map<String, String[]> requestQueryParams) {
90 Pair<DecisionResponse, Response> decisionPair = super.makeDecision(request, requestQueryParams);
91 var decisionResponse = decisionPair.getKey();
93 // Abbreviate results if needed
95 if (checkAbbreviateResults(requestQueryParams) && decisionResponse.getPolicies() != null) {
96 LOGGER.info("Abbreviating decision results {}", decisionResponse);
97 for (Entry<String, Object> entry : decisionResponse.getPolicies().entrySet()) {
99 // DecisionResponse policies will always be a map
101 @SuppressWarnings("unchecked")
102 Map<String, Object> policy = (Map<String, Object>) entry.getValue();
103 policy.remove("type_version");
104 policy.remove("properties");
105 policy.remove("name");
106 policy.remove("version");
113 protected ToscaPolicyTranslator getTranslator(String type) {
118 * Checks the query parameters to determine whether the decision results should be abbreviated.
120 * @param queryParams - http request query parameters
122 protected boolean checkAbbreviateResults(Map<String, String[]> queryParams) {
123 if (queryParams != null && !queryParams.isEmpty()) {
124 // Check if query params contains "abbrev" flag
125 if (queryParams.containsKey("abbrev")) {
126 return Arrays.asList(queryParams.get("abbrev")).contains("true");
128 LOGGER.info("Unsupported query param for Monitoring application: {}", queryParams);
132 LOGGER.info("Query parameters empty");