main/src/main/java/org/onap/policy/pdpx/main/rest/XacmlPdpApplicationManager.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   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.pdpx.main.rest;
  22
  23 import java.io.IOException;
  24 import java.nio.file.Files;
  25 import java.nio.file.Path;
  26 import java.nio.file.Paths;
  27 import java.util.ArrayList;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.ServiceLoader;
  32 import java.util.stream.Collectors;
  33 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  34 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  35 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
  36 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  37 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
  38 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 public class XacmlPdpApplicationManager {
  43     private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpApplicationManager.class);
  44
  45     private static boolean needsInit = true;
  46     private static ServiceLoader<XacmlApplicationServiceProvider> applicationLoader;
  47     private static Map<String, XacmlApplicationServiceProvider> providerActionMap = new HashMap<>();
  48     private static List<ToscaPolicyTypeIdentifier> toscaPolicyTypeIdents = new ArrayList<>();
  49     private static Map<ToscaPolicy, XacmlApplicationServiceProvider> mapLoadedPolicies = new HashMap<>();
  50
  51
  52     private XacmlPdpApplicationManager() {
  53         super();
  54     }
  55
  56     /**
  57      * One time to initialize the applications upon startup.
  58      */
  59     public static void initializeApplications(Path applicationPath) {
  60         if (LOGGER.isInfoEnabled()) {
  61             LOGGER.info("Initialization applications {}", applicationPath.toAbsolutePath());
  62         }
  63         //
  64         // If we have already done this
  65         //
  66         if (! needsInit) {
  67             LOGGER.warn("Already initialized the applications {}", providerActionMap);
  68             //
  69             // I had to remove this because the JUnits kept failing - although I probably can
  70             // add it back. The main() is hanging around during JUnits and initialization will
  71             // fail.
  72             //
  73             // return
  74         }
  75         //
  76         // Load service
  77         //
  78         applicationLoader = ServiceLoader.load(XacmlApplicationServiceProvider.class);
  79         //
  80         // Iterate through the applications for actions and supported policy types
  81         //
  82         for (XacmlApplicationServiceProvider application : applicationLoader) {
  83             if (LOGGER.isInfoEnabled()) {
  84                 LOGGER.info("Application {} supports {}", application.applicationName(),
  85                     application.supportedPolicyTypes());
  86             }
  87             //
  88             // We are not going to make this available unless the application can
  89             // install correctly.
  90             //
  91             boolean applicationInitialized = false;
  92             //
  93             // Have it initialize at a path
  94             //
  95             try {
  96                 initializeApplicationPath(applicationPath, application);
  97                 //
  98                 // We are initialized
  99                 //
 100                 applicationInitialized = true;
 101             } catch (XacmlApplicationException e) {
 102                 LOGGER.error("Failed to initialize path for {}", application.applicationName(), e);
 103             }
 104             if (applicationInitialized) {
 105                 //
 106                 // Iterate through the actions and save in the providerActionMap
 107                 //
 108                 for (String action : application.actionDecisionsSupported()) {
 109                     //
 110                     // Save the actions that it supports
 111                     //
 112                     providerActionMap.put(action, application);
 113                 }
 114                 //
 115                 // Add all the supported policy types
 116                 //
 117                 toscaPolicyTypeIdents.addAll(application.supportedPolicyTypes());
 118             }
 119         }
 120         //
 121         // we have initialized
 122         //
 123         needsInit = false;
 124         LOGGER.info("Finished applications initialization {}", providerActionMap);
 125
 126     }
 127
 128     public static XacmlApplicationServiceProvider findApplication(DecisionRequest request) {
 129         return providerActionMap.get(request.getAction());
 130     }
 131
 132     /**
 133      * getToscaPolicies.
 134      *
 135      * @return the map containing ToscaPolicies
 136      */
 137     public static Map<ToscaPolicy, XacmlApplicationServiceProvider> getToscaPolicies() {
 138         return mapLoadedPolicies;
 139     }
 140
 141     /**
 142      * getToscaPolicyIdentifiers.
 143      *
 144      * @return list of ToscaPolicyIdentifier
 145      */
 146     public static List<ToscaPolicyIdentifier> getToscaPolicyIdentifiers() {
 147         //
 148         // converting map to return List of ToscaPolicyIdentiers
 149         //
 150         return mapLoadedPolicies.keySet().stream().map(ToscaPolicy::getIdentifier).collect(Collectors.toList());
 151     }
 152
 153     public static List<ToscaPolicyTypeIdentifier> getToscaPolicyTypeIdents() {
 154         return toscaPolicyTypeIdents;
 155     }
 156
 157     /**
 158      * Finds the appropriate application and removes the policy.
 159      *
 160      * @param policy Incoming policy
 161      */
 162     public static void removeUndeployedPolicy(ToscaPolicy policy) {
 163
 164         for (XacmlApplicationServiceProvider application : applicationLoader) {
 165             try {
 166                 if (application.unloadPolicy(policy)) {
 167                     if (LOGGER.isInfoEnabled()) {
 168                         LOGGER.info("Unloaded ToscaPolicy {} from application {}", policy.getMetadata(),
 169                             application.applicationName());
 170                     }
 171                     if (mapLoadedPolicies.remove(policy) == null) {
 172                         LOGGER.error("Failed to remove unloaded policy {} from map size {}", policy.getMetadata(),
 173                                 mapLoadedPolicies.size());
 174                     }
 175                 }
 176             } catch (XacmlApplicationException e) {
 177                 LOGGER.error("Failed to undeploy the Tosca Policy", e);
 178             }
 179         }
 180     }
 181
 182     /**
 183      * Finds the appropriate application and loads the policy.
 184      *
 185      * @param policy Incoming policy
 186      */
 187     public static void loadDeployedPolicy(ToscaPolicy policy) {
 188
 189         for (XacmlApplicationServiceProvider application : applicationLoader) {
 190             try {
 191                 //
 192                 // There should be only one application per policytype. We can
 193                 // put more logic surrounding enforcement of that later. For now,
 194                 // just use the first one found.
 195                 //
 196                 if (application.canSupportPolicyType(policy.getTypeIdentifier())) {
 197                     if (application.loadPolicy(policy)) {
 198                         if (LOGGER.isInfoEnabled()) {
 199                             LOGGER.info("Loaded ToscaPolicy {} into application {}", policy.getMetadata(),
 200                                 application.applicationName());
 201                         }
 202                         mapLoadedPolicies.put(policy, application);
 203                     }
 204                     return;
 205                 }
 206             } catch (XacmlApplicationException e) {
 207                 LOGGER.error("Failed to load the Tosca Policy", e);
 208             }
 209         }
 210     }
 211
 212     /**
 213      * Returns the current count of policy types supported. This could be misleading a bit
 214      * as some applications can support wildcard of policy types. Eg. onap.Monitoring.* as
 215      * well as individual types/versions. Nevertheless useful for debugging and testing.
 216      *
 217      * @return Total count added from all applications
 218      */
 219     public static long getPolicyTypeCount() {
 220         long types = 0;
 221         for (XacmlApplicationServiceProvider application : applicationLoader) {
 222             types += application.supportedPolicyTypes().size();
 223         }
 224         return types;
 225     }
 226
 227     private static void initializeApplicationPath(Path basePath, XacmlApplicationServiceProvider application)
 228             throws XacmlApplicationException {
 229         //
 230         // Making an assumption that all application names are unique, and
 231         // they can result in a valid directory being created.
 232         //
 233         Path path = Paths.get(basePath.toAbsolutePath().toString(), application.applicationName());
 234         if (LOGGER.isInfoEnabled()) {
 235             LOGGER.info("initializeApplicationPath {} at this path {}", application.applicationName(), path);
 236         }
 237         //
 238         // Create that the directory if it does not exist. Ideally
 239         // this is only for testing, but could be used for production
 240         // Probably better to have the docker container and/or helm
 241         // scripts setup the local directory.
 242         //
 243         if (! path.toFile().exists()) {
 244             try {
 245                 //
 246                 // Try to create the directory
 247                 //
 248                 Files.createDirectory(path);
 249             } catch (IOException e) {
 250                 LOGGER.error("Failed to create application directory {}", path.toAbsolutePath().toString(), e);
 251             }
 252         }
 253         //
 254         // Have the application initialize
 255         //
 256         application.initialize(path);
 257     }
 258
 259 }