gerrit.onap Code Review - policy/xacml-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.xacml.pdp.application.monitoring;
  24
  25 import com.att.research.xacml.api.Response;
  26 import java.util.ArrayList;
  27 import java.util.Arrays;
  28 import java.util.List;
  29 import java.util.Map;
  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.ToscaPolicyTypeIdentifier;
  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;
  40
  41 /**
  42  * This is the engine class that manages the instance of the XACML PDP engine.
  43  *
  44  * <p>It is responsible for initializing it and shutting it down properly in a thread-safe manner.
  45  *
  46  *
  47  * @author pameladragosh
  48  *
  49  */
  50 public class MonitoringPdpApplication extends StdXacmlApplicationServiceProvider {
  51     private static final Logger LOGGER = LoggerFactory.getLogger(MonitoringPdpApplication.class);
  52
  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.";
  55
  56     public static final String VERSION_100 = "1.0.0";
  57
  58     private StdCombinedPolicyResultsTranslator translator = new StdCombinedPolicyResultsTranslator();
  59     private List<ToscaPolicyTypeIdentifier> supportedPolicyTypes = new ArrayList<>();
  60
  61     /**
  62      * Constructor.
  63      */
  64     public MonitoringPdpApplication() {
  65         //
  66         // By default this supports just Monitoring policy types
  67         //
  68         supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(ONAP_MONITORING_BASE_POLICY_TYPE, VERSION_100));
  69     }
  70
  71     @Override
  72     public String applicationName() {
  73         return "monitoring";
  74     }
  75
  76     @Override
  77     public List<String> actionDecisionsSupported() {
  78         return Arrays.asList("configure");
  79     }
  80
  81     @Override
  82     public synchronized List<ToscaPolicyTypeIdentifier> supportedPolicyTypes() {
  83         return supportedPolicyTypes;
  84     }
  85
  86     @Override
  87     public boolean canSupportPolicyType(ToscaPolicyTypeIdentifier policyTypeId) {
  88         //
  89         // For Monitoring, we will attempt to support all versions
  90         // of the policy type. Since we are only packaging a decision
  91         // back with a JSON payload of the property contents.
  92         //
  93         return policyTypeId.getName().startsWith(ONAP_MONITORING_DERIVED_POLICY_TYPE);
  94     }
  95
  96     @Override
  97     public Pair<DecisionResponse, Response> makeDecision(DecisionRequest request,
  98             Map<String, String[]> requestQueryParams) {
  99         //
 100         // Make the decision
 101         //
 102         Pair<DecisionResponse, Response> decisionPair = super.makeDecision(request, requestQueryParams);
 103         DecisionResponse decisionResponse = decisionPair.getKey();
 104         //
 105         // Abbreviate results if needed
 106         //
 107         if (checkAbbreviateResults(requestQueryParams) && decisionResponse.getPolicies() != null) {
 108             LOGGER.info("Abbreviating decision results {}", decisionResponse);
 109             for (Entry<String, Object> entry : decisionResponse.getPolicies().entrySet()) {
 110                 //
 111                 // DecisionResponse policies will always be a map
 112                 //
 113                 @SuppressWarnings("unchecked")
 114                 Map<String, Object> policy = (Map<String, Object>) entry.getValue();
 115                 policy.remove("type_version");
 116                 policy.remove("properties");
 117                 policy.remove("name");
 118                 policy.remove("version");
 119             }
 120         }
 121         return decisionPair;
 122     }
 123
 124     @Override
 125     protected ToscaPolicyTranslator getTranslator(String type) {
 126         return translator;
 127     }
 128
 129     /**
 130      * Checks the query parameters to determine whether the decision results should be abbreviated.
 131      *
 132      * @param queryParams - http request query parameters
 133      */
 134     private boolean checkAbbreviateResults(Map<String, String[]> queryParams) {
 135         if (queryParams != null && !queryParams.isEmpty()) {
 136             // Check if query params contains "abbrev" flag
 137             if (queryParams.containsKey("abbrev")) {
 138                 return Arrays.asList(queryParams.get("abbrev")).contains("true");
 139             } else {
 140                 LOGGER.info("Unsupported query param for Monitoring application: {}", queryParams);
 141                 return false;
 142             }
 143         }
 144         LOGGER.info("Query parameters empty");
 145         return false;
 146     }
 147 }