applications/optimization/src/main/java/org/onap/policy/xacml/pdp/application/optimization/OptimizationPdpApplication.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.optimization;
  24
  25 import com.att.research.xacml.api.Request;
  26 import com.att.research.xacml.api.Response;
  27 import com.att.research.xacml.util.XACMLPolicyWriter;
  28 import com.google.common.collect.Lists;
  29
  30 import java.io.IOException;
  31 import java.nio.file.Path;
  32 import java.util.Arrays;
  33 import java.util.HashMap;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.Properties;
  37
  38 import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
  39
  40 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  41 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  42 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConversionException;
  43 import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
  44 import org.onap.policy.pdp.xacml.application.common.std.StdMatchableTranslator;
  45 import org.onap.policy.pdp.xacml.application.common.std.StdXacmlApplicationServiceProvider;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 public class OptimizationPdpApplication extends StdXacmlApplicationServiceProvider {
  50
  51     private static final Logger LOGGER = LoggerFactory.getLogger(OptimizationPdpApplication.class);
  52     private static final String STRING_VERSION100 = "1.0.0";
  53
  54     private StdMatchableTranslator translator = new StdMatchableTranslator();
  55     private Map<String, String> supportedPolicyTypes = new HashMap<>();
  56
  57     /**
  58      * Constructor.
  59      */
  60     public OptimizationPdpApplication() {
  61         this.supportedPolicyTypes.put("onap.policies.optimization.AffinityPolicy", STRING_VERSION100);
  62         this.supportedPolicyTypes.put("onap.policies.optimization.DistancePolicy", STRING_VERSION100);
  63         this.supportedPolicyTypes.put("onap.policies.optimization.HpaPolicy", STRING_VERSION100);
  64         this.supportedPolicyTypes.put("onap.policies.optimization.OptimizationPolicy", STRING_VERSION100);
  65         this.supportedPolicyTypes.put("onap.policies.optimization.PciPolicy", STRING_VERSION100);
  66         this.supportedPolicyTypes.put("onap.policies.optimization.QueryPolicy", STRING_VERSION100);
  67         this.supportedPolicyTypes.put("onap.policies.optimization.SubscriberPolicy", STRING_VERSION100);
  68         this.supportedPolicyTypes.put("onap.policies.optimization.Vim_fit", STRING_VERSION100);
  69         this.supportedPolicyTypes.put("onap.policies.optimization.VnfPolicy", STRING_VERSION100);
  70     }
  71
  72     @Override
  73     public String applicationName() {
  74         return "Optimization Application";
  75     }
  76
  77     @Override
  78     public List<String> actionDecisionsSupported() {
  79         return Arrays.asList("optimize");
  80     }
  81
  82     @Override
  83     public synchronized List<String> supportedPolicyTypes() {
  84         return Lists.newArrayList(supportedPolicyTypes.keySet());
  85     }
  86
  87     @Override
  88     public boolean canSupportPolicyType(String policyType, String policyTypeVersion) {
  89         //
  90         // For the time being, restrict this if the version isn't known.
  91         // Could be too difficult to support changing of versions dynamically.
  92         //
  93         if (! this.supportedPolicyTypes.containsKey(policyType)) {
  94             return false;
  95         }
  96         //
  97         // Must match version exactly
  98         //
  99         return this.supportedPolicyTypes.get(policyType).equals(policyTypeVersion);
 100     }
 101
 102     @Override
 103     public synchronized void loadPolicies(Map<String, Object> toscaPolicies) {
 104         try {
 105             //
 106             // Convert the policies first
 107             //
 108             List<PolicyType> listPolicies = translator.scanAndConvertPolicies(toscaPolicies);
 109             if (listPolicies.isEmpty()) {
 110                 throw new ToscaPolicyConversionException("Converted 0 policies");
 111             }
 112             //
 113             // Create a copy of the properties object
 114             //
 115             Properties newProperties = this.getProperties();
 116             //
 117             // Iterate through the policies
 118             //
 119             for (PolicyType newPolicy : listPolicies) {
 120                 //
 121                 // Construct the filename
 122                 //
 123                 Path refPath = XacmlPolicyUtils.constructUniquePolicyFilename(newPolicy, this.getDataPath());
 124                 //
 125                 // Write the policy to disk
 126                 // Maybe check for an error
 127                 //
 128                 XACMLPolicyWriter.writePolicyFile(refPath, newPolicy);
 129                 //
 130                 // Add root policy to properties object
 131                 //
 132                 XacmlPolicyUtils.addRootPolicy(newProperties, refPath);
 133             }
 134             //
 135             // Write the properties to disk
 136             //
 137             XacmlPolicyUtils.storeXacmlProperties(newProperties,
 138                     XacmlPolicyUtils.getPropertiesPath(this.getDataPath()));
 139             //
 140             // Reload the engine
 141             //
 142             this.createEngine(newProperties);
 143         } catch (IOException | ToscaPolicyConversionException e) {
 144             LOGGER.error("Failed to loadPolicies {}", e);
 145         }
 146     }
 147
 148     @Override
 149     public synchronized DecisionResponse makeDecision(DecisionRequest request) {
 150         //
 151         // Convert to a XacmlRequest
 152         //
 153         Request xacmlRequest = translator.convertRequest(request);
 154         //
 155         // Now get a decision
 156         //
 157         Response xacmlResponse = this.xacmlDecision(xacmlRequest);
 158         //
 159         // Convert to a DecisionResponse
 160         //
 161         return translator.convertResponse(xacmlResponse);
 162     }
 163
 164 }