applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2021 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
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.xacml.pdp.application.monitoring;
  25
  26 import com.att.research.xacml.api.Response;
  27 import java.util.Arrays;
  28 import java.util.Map;
  29 import java.util.Map.Entry;
  30 import org.apache.commons.lang3.tuple.Pair;
  31 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  32 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  33 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  34 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
  35 import org.onap.policy.pdp.xacml.application.common.std.StdCombinedPolicyResultsTranslator;
  36 import org.onap.policy.pdp.xacml.application.common.std.StdXacmlApplicationServiceProvider;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 /**
  41  * This is the engine class that manages the instance of the XACML PDP engine.
  42  *
  43  * <p>It is responsible for initializing it and shutting it down properly in a thread-safe manner.
  44  *
  45  *
  46  * @author pameladragosh
  47  *
  48  */
  49 public class MonitoringPdpApplication extends StdXacmlApplicationServiceProvider {
  50     private static final Logger LOGGER = LoggerFactory.getLogger(MonitoringPdpApplication.class);
  51
  52     public static final String ONAP_MONITORING_BASE_POLICY_TYPE = "onap.Monitoring";
  53     public static final String ONAP_MONITORING_DERIVED_POLICY_TYPE = "onap.policies.monitoring.";
  54
  55     public static final String VERSION_100 = "1.0.0";
  56
  57     private StdCombinedPolicyResultsTranslator translator = new StdCombinedPolicyResultsTranslator();
  58
  59     /**
  60      * Constructor.
  61      */
  62     public MonitoringPdpApplication() {
  63         super();
  64
  65         applicationName = "monitoring";
  66         actions = Arrays.asList("configure");
  67         //
  68         // By default this supports just Monitoring policy types
  69         //
  70         supportedPolicyTypes.add(new ToscaConceptIdentifier(ONAP_MONITORING_BASE_POLICY_TYPE, VERSION_100));
  71     }
  72
  73     @Override
  74     public boolean canSupportPolicyType(ToscaConceptIdentifier policyTypeId) {
  75         //
  76         // For Monitoring, we will attempt to support all versions
  77         // of the policy type. Since we are only packaging a decision
  78         // back with a JSON payload of the property contents.
  79         //
  80         return policyTypeId.getName().startsWith(ONAP_MONITORING_DERIVED_POLICY_TYPE);
  81     }
  82
  83     @Override
  84     public Pair<DecisionResponse, Response> makeDecision(DecisionRequest request,
  85             Map<String, String[]> requestQueryParams) {
  86         //
  87         // Make the decision
  88         //
  89         Pair<DecisionResponse, Response> decisionPair = super.makeDecision(request, requestQueryParams);
  90         var decisionResponse = decisionPair.getKey();
  91         //
  92         // Abbreviate results if needed
  93         //
  94         if (checkAbbreviateResults(requestQueryParams) && decisionResponse.getPolicies() != null) {
  95             LOGGER.info("Abbreviating decision results {}", decisionResponse);
  96             for (Entry<String, Object> entry : decisionResponse.getPolicies().entrySet()) {
  97                 //
  98                 // DecisionResponse policies will always be a map
  99                 //
 100                 @SuppressWarnings("unchecked")
 101                 Map<String, Object> policy = (Map<String, Object>) entry.getValue();
 102                 policy.remove("type_version");
 103                 policy.remove("properties");
 104                 policy.remove("name");
 105                 policy.remove("version");
 106             }
 107         }
 108         return decisionPair;
 109     }
 110
 111     @Override
 112     protected ToscaPolicyTranslator getTranslator(String type) {
 113         return translator;
 114     }
 115
 116     /**
 117      * Checks the query parameters to determine whether the decision results should be abbreviated.
 118      *
 119      * @param queryParams - http request query parameters
 120      */
 121     protected boolean checkAbbreviateResults(Map<String, String[]> queryParams) {
 122         if (queryParams != null && !queryParams.isEmpty()) {
 123             // Check if query params contains "abbrev" flag
 124             if (queryParams.containsKey("abbrev")) {
 125                 return Arrays.asList(queryParams.get("abbrev")).contains("true");
 126             } else {
 127                 LOGGER.info("Unsupported query param for Monitoring application: {}", queryParams);
 128                 return false;
 129             }
 130         }
 131         LOGGER.info("Query parameters empty");
 132         return false;
 133     }
 134 }