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 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.Request;
  26 import com.att.research.xacml.api.Response;
  27 import java.util.ArrayList;
  28 import java.util.Arrays;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Map.Entry;
  32 import org.apache.commons.lang3.tuple.Pair;
  33 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  34 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  35 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  36 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
  37 import org.onap.policy.pdp.xacml.application.common.std.StdCombinedPolicyResultsTranslator;
  38 import org.onap.policy.pdp.xacml.application.common.std.StdXacmlApplicationServiceProvider;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * This is the engine class that manages the instance of the XACML PDP engine.
  44  *
  45  * <p>It is responsible for initializing it and shutting it down properly in a thread-safe manner.
  46  *
  47  *
  48  * @author pameladragosh
  49  *
  50  */
  51 public class MonitoringPdpApplication extends StdXacmlApplicationServiceProvider {
  52     private static final Logger LOGGER = LoggerFactory.getLogger(MonitoringPdpApplication.class);
  53
  54     private static final String ONAP_MONITORING_BASE_POLICY_TYPE = "onap.Monitoring";
  55     private static final String ONAP_MONITORING_CDAP = "onap.policies.monitoring.cdap.tca.hi.lo.app";
  56     private static final String ONAP_MONITORING_APPSERVER =
  57             "onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server";
  58     private static final String ONAP_MONITORING_SONHANDLER = "onap.policies.monitoring.docker.sonhandler.app";
  59     private static final String ONAP_MONITORING_DERIVED_POLICY_TYPE = "onap.policies.monitoring";
  60     private static final String VERSION_100 = "1.0.0";
  61
  62     private StdCombinedPolicyResultsTranslator translator = new StdCombinedPolicyResultsTranslator();
  63     private List<ToscaPolicyTypeIdentifier> supportedPolicyTypes = new ArrayList<>();
  64
  65     /**
  66      * Constructor.
  67      */
  68     public MonitoringPdpApplication() {
  69         //
  70         // By default this supports just Monitoring policy types
  71         //
  72         supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(ONAP_MONITORING_BASE_POLICY_TYPE, VERSION_100));
  73         supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(ONAP_MONITORING_CDAP, VERSION_100));
  74         supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(ONAP_MONITORING_APPSERVER, VERSION_100));
  75         supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(ONAP_MONITORING_SONHANDLER, VERSION_100));
  76     }
  77
  78     @Override
  79     public String applicationName() {
  80         return "monitoring";
  81     }
  82
  83     @Override
  84     public List<String> actionDecisionsSupported() {
  85         return Arrays.asList("configure");
  86     }
  87
  88     @Override
  89     public synchronized List<ToscaPolicyTypeIdentifier> supportedPolicyTypes() {
  90         return supportedPolicyTypes;
  91     }
  92
  93     @Override
  94     public boolean canSupportPolicyType(ToscaPolicyTypeIdentifier policyTypeId) {
  95         //
  96         // For Monitoring, we will attempt to support all versions
  97         // of the policy type. Since we are only packaging a decision
  98         // back with a JSON payload of the property contents.
  99         //
 100         return (policyTypeId.getName().equals(ONAP_MONITORING_BASE_POLICY_TYPE)
 101                 || policyTypeId.getName().equals(ONAP_MONITORING_CDAP)
 102                 || policyTypeId.getName().equals(ONAP_MONITORING_APPSERVER)
 103                 || policyTypeId.getName().equals(ONAP_MONITORING_SONHANDLER)
 104                 || policyTypeId.getName().startsWith(ONAP_MONITORING_DERIVED_POLICY_TYPE));
 105     }
 106
 107     @Override
 108     public Pair<DecisionResponse, Response> makeDecision(DecisionRequest request,
 109             Map<String, String[]> requestQueryParams) {
 110         //
 111         // Convert to a XacmlRequest
 112         //
 113         Request xacmlRequest = this.getTranslator().convertRequest(request);
 114         //
 115         // Now get a decision
 116         //
 117         Response xacmlResponse = this.xacmlDecision(xacmlRequest);
 118         //
 119         // Convert to a DecisionResponse
 120         //
 121         DecisionResponse decisionResponse = this.getTranslator().convertResponse(xacmlResponse);
 122         //
 123         // Abbreviate results if needed
 124         //
 125         if (checkAbbreviateResults(requestQueryParams) && decisionResponse.getPolicies() != null
 126                 && !decisionResponse.getPolicies().isEmpty()) {
 127             LOGGER.info("Abbreviating decision results {}", decisionResponse);
 128             for (Entry<String, Object> entry : decisionResponse.getPolicies().entrySet()) {
 129                 if (entry.getValue() instanceof Map) {
 130                     @SuppressWarnings("unchecked")
 131                     Map<String, Object> policy = (Map<String, Object>) entry.getValue();
 132                     policy.remove("properties");
 133                     policy.remove("name");
 134                     policy.remove("version");
 135                 }
 136             }
 137         }
 138         return Pair.of(decisionResponse, xacmlResponse);
 139     }
 140
 141     @Override
 142     protected ToscaPolicyTranslator getTranslator(String type) {
 143         return translator;
 144     }
 145
 146     /**
 147      * Checks the query parameters to determine whether the decision results should be abbreviated.
 148      *
 149      * @param queryParams - http request query parameters
 150      */
 151     private boolean checkAbbreviateResults(Map<String, String[]> queryParams) {
 152         if (queryParams != null && !queryParams.isEmpty()) {
 153             // Check if query params contains "abbrev" flag
 154             if (queryParams.containsKey("abbrev")) {
 155                 return Arrays.asList(queryParams.get("abbrev")).contains("true");
 156             } else {
 157                 LOGGER.info("Unsupported query param for Monitoring application: {}", queryParams);
 158                 return false;
 159             }
 160         }
 161         LOGGER.info("Query parameters empty");
 162         return false;
 163     }
 164 }