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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.services.onappf.handler;
  22
  23 import com.google.gson.JsonObject;
  24 import java.io.IOException;
  25 import java.nio.charset.StandardCharsets;
  26 import java.nio.file.Files;
  27 import java.nio.file.Path;
  28 import java.util.ArrayList;
  29 import java.util.LinkedHashMap;
  30 import java.util.List;
  31 import java.util.Map;
  32 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  33 import org.onap.policy.apex.service.engine.main.ApexMain;
  34 import org.onap.policy.apex.services.onappf.exception.ApexStarterException;
  35 import org.onap.policy.common.utils.coder.CoderException;
  36 import org.onap.policy.common.utils.coder.StandardCoder;
  37 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  38 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * This class instantiates the Apex Engine based on instruction from PAP.
  44  *
  45  * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
  46  */
  47 public class ApexEngineHandler {
  48     private static final Logger LOGGER = LoggerFactory.getLogger(ApexEngineHandler.class);
  49
  50     private ApexMain apexMain;
  51
  52     /**
  53      * Constructs the object. Extracts the config and model files from each policy and instantiates the apex engine.
  54      *
  55      * @param policies the list of policies
  56      * @throws ApexStarterException if the apex engine instantiation failed using the policies passed
  57      */
  58     public ApexEngineHandler(List<ToscaPolicy> policies)  throws ApexStarterException {
  59         Map<ToscaPolicyIdentifier, String[]> policyArgsMap = createPolicyArgsMap(policies);
  60         LOGGER.debug("Starting apex engine.");
  61         try {
  62             apexMain = new ApexMain(policyArgsMap);
  63         } catch (ApexException e) {
  64             throw new ApexStarterException(e);
  65         }
  66     }
  67
  68     /**
  69      * Updates the Apex Engine with the policy model created from new list of policies.
  70      *
  71      * @param policies the list of policies
  72      * @throws ApexStarterException if the apex engine instantiation failed using the policies passed
  73      */
  74     public void updateApexEngine(List<ToscaPolicy> policies) throws ApexStarterException {
  75         if (null == apexMain || !apexMain.isAlive()) {
  76             throw new ApexStarterException("Apex Engine not initialized.");
  77         }
  78         Map<ToscaPolicyIdentifier, String[]> policyArgsMap = createPolicyArgsMap(policies);
  79         try {
  80             apexMain.updateModel(policyArgsMap);
  81         } catch (ApexException e) {
  82             throw new ApexStarterException(e);
  83         }
  84     }
  85
  86     private Map<ToscaPolicyIdentifier, String[]> createPolicyArgsMap(List<ToscaPolicy> policies)
  87         throws ApexStarterException {
  88         Map<ToscaPolicyIdentifier, String[]> policyArgsMap = new LinkedHashMap<>();
  89         for (ToscaPolicy policy : policies) {
  90             Object properties = policy.getProperties().get("content");
  91             final StandardCoder standardCoder = new StandardCoder();
  92             String policyModel;
  93             String apexConfig;
  94             try {
  95                 JsonObject body = standardCoder.decode(standardCoder.encode(properties), JsonObject.class);
  96                 final JsonObject engineServiceParameters = body.get("engineServiceParameters").getAsJsonObject();
  97                 policyModel = standardCoder.encode(engineServiceParameters.get("policy_type_impl"));
  98                 engineServiceParameters.remove("policy_type_impl");
  99                 apexConfig = standardCoder.encode(body);
 100             } catch (final CoderException e) {
 101                 throw new ApexStarterException(e);
 102             }
 103
 104             final String modelFilePath = createFile(policyModel, "modelFile");
 105
 106             final String apexConfigFilePath = createFile(apexConfig, "apexConfigFile");
 107             final String[] apexArgs = { "-c", apexConfigFilePath, "-m", modelFilePath };
 108             policyArgsMap.put(policy.getIdentifier(), apexArgs);
 109         }
 110         return policyArgsMap;
 111     }
 112
 113     /**
 114      * Method to create the policy model file.
 115      *
 116      * @param fileContent the content of the file
 117      * @param fileName the name of the file
 118      * @throws ApexStarterException if the file creation failed
 119      */
 120     private String createFile(final String fileContent, final String fileName) throws ApexStarterException {
 121         try {
 122             final Path path = Files.createTempFile(fileName, ".json");
 123             Files.write(path, fileContent.getBytes(StandardCharsets.UTF_8));
 124             return path.toAbsolutePath().toString();
 125         } catch (final IOException e) {
 126             final String errorMessage = "error creating  from the properties received in PdpUpdate.";
 127             LOGGER.error(errorMessage, e);
 128             throw new ApexStarterException(errorMessage, e);
 129         }
 130     }
 131
 132     /**
 133      * Method to check whether the apex engine is running or not.
 134      */
 135     public boolean isApexEngineRunning() {
 136         return null != apexMain && apexMain.isAlive();
 137     }
 138
 139     /**
 140      * Method that return the list of running policies in the apex engine.
 141      */
 142     public List<ToscaPolicyIdentifier> getRunningPolicies() {
 143         return new ArrayList<>(apexMain.getApexParametersMap().keySet());
 144     }
 145
 146     /**
 147      * Method to shut down the apex engine.
 148      */
 149     public void shutdown() throws ApexStarterException {
 150         try {
 151             LOGGER.debug("Shutting down apex engine.");
 152             apexMain.shutdown();
 153             apexMain = null;
 154         } catch (final ApexException e) {
 155             throw new ApexStarterException(e);
 156         }
 157     }
 158 }