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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.pdpx.main.rest;
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;
31 import java.util.ServiceLoader;
32 import java.util.stream.Collectors;
35 import org.onap.policy.models.decisions.concepts.DecisionRequest;
36 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
37 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
38 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
39 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
40 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
44 public class XacmlPdpApplicationManager {
45 private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpApplicationManager.class);
49 private static XacmlPdpApplicationManager current;
51 private ServiceLoader<XacmlApplicationServiceProvider> applicationLoader;
52 private Map<String, XacmlApplicationServiceProvider> providerActionMap = new HashMap<>();
53 private List<ToscaPolicyTypeIdentifier> toscaPolicyTypeIdents = new ArrayList<>();
54 private Map<ToscaPolicy, XacmlApplicationServiceProvider> mapLoadedPolicies = new HashMap<>();
58 * One time to initialize the applications upon startup.
60 public XacmlPdpApplicationManager(Path applicationPath) {
61 if (LOGGER.isInfoEnabled()) {
62 LOGGER.info("Initialization applications {}", applicationPath.toAbsolutePath());
67 applicationLoader = ServiceLoader.load(XacmlApplicationServiceProvider.class);
69 // Iterate through the applications for actions and supported policy types
71 for (XacmlApplicationServiceProvider application : applicationLoader) {
72 if (LOGGER.isInfoEnabled()) {
73 LOGGER.info("Application {} supports {}", application.applicationName(),
74 application.supportedPolicyTypes());
77 // We are not going to make this available unless the application can
80 boolean applicationInitialized = false;
82 // Have it initialize at a path
85 initializeApplicationPath(applicationPath, application);
89 applicationInitialized = true;
90 } catch (XacmlApplicationException e) {
91 LOGGER.error("Failed to initialize path for {}", application.applicationName(), e);
93 if (applicationInitialized) {
95 // Iterate through the actions and save in the providerActionMap
97 for (String action : application.actionDecisionsSupported()) {
99 // Save the actions that it supports
101 providerActionMap.put(action, application);
104 // Add all the supported policy types
106 toscaPolicyTypeIdents.addAll(application.supportedPolicyTypes());
110 // we have initialized
112 LOGGER.info("Finished applications initialization {}", providerActionMap);
116 public XacmlApplicationServiceProvider findApplication(DecisionRequest request) {
117 return providerActionMap.get(request.getAction());
123 * @return the map containing ToscaPolicies
125 public Map<ToscaPolicy, XacmlApplicationServiceProvider> getToscaPolicies() {
126 return mapLoadedPolicies;
130 * getToscaPolicyIdentifiers.
132 * @return list of ToscaPolicyIdentifier
134 public List<ToscaPolicyIdentifier> getToscaPolicyIdentifiers() {
136 // converting map to return List of ToscaPolicyIdentiers
138 return mapLoadedPolicies.keySet().stream().map(ToscaPolicy::getIdentifier).collect(Collectors.toList());
141 public List<ToscaPolicyTypeIdentifier> getToscaPolicyTypeIdents() {
142 return toscaPolicyTypeIdents;
146 * Finds the appropriate application and removes the policy.
148 * @param policy Incoming policy
150 public void removeUndeployedPolicy(ToscaPolicy policy) {
152 for (XacmlApplicationServiceProvider application : applicationLoader) {
154 if (application.unloadPolicy(policy)) {
155 if (LOGGER.isInfoEnabled()) {
156 LOGGER.info("Unloaded ToscaPolicy {} from application {}", policy.getMetadata(),
157 application.applicationName());
159 if (mapLoadedPolicies.remove(policy) == null) {
160 LOGGER.error("Failed to remove unloaded policy {} from map size {}", policy.getMetadata(),
161 mapLoadedPolicies.size());
164 } catch (XacmlApplicationException e) {
165 LOGGER.error("Failed to undeploy the Tosca Policy", e);
171 * Finds the appropriate application and loads the policy.
173 * @param policy Incoming policy
175 public void loadDeployedPolicy(ToscaPolicy policy) {
177 for (XacmlApplicationServiceProvider application : applicationLoader) {
180 // There should be only one application per policytype. We can
181 // put more logic surrounding enforcement of that later. For now,
182 // just use the first one found.
184 if (application.canSupportPolicyType(policy.getTypeIdentifier())) {
185 if (application.loadPolicy(policy)) {
186 if (LOGGER.isInfoEnabled()) {
187 LOGGER.info("Loaded ToscaPolicy {} into application {}", policy.getMetadata(),
188 application.applicationName());
190 mapLoadedPolicies.put(policy, application);
194 } catch (XacmlApplicationException e) {
195 LOGGER.error("Failed to load the Tosca Policy", e);
201 * Returns the current count of policy types supported. This could be misleading a bit
202 * as some applications can support wildcard of policy types. Eg. onap.Monitoring.* as
203 * well as individual types/versions. Nevertheless useful for debugging and testing.
205 * @return Total count added from all applications
207 public long getPolicyTypeCount() {
209 for (XacmlApplicationServiceProvider application : applicationLoader) {
210 types += application.supportedPolicyTypes().size();
215 private void initializeApplicationPath(Path basePath, XacmlApplicationServiceProvider application)
216 throws XacmlApplicationException {
218 // Making an assumption that all application names are unique, and
219 // they can result in a valid directory being created.
221 Path path = Paths.get(basePath.toAbsolutePath().toString(), application.applicationName());
222 if (LOGGER.isInfoEnabled()) {
223 LOGGER.info("initializeApplicationPath {} at this path {}", application.applicationName(), path);
226 // Create that the directory if it does not exist. Ideally
227 // this is only for testing, but could be used for production
228 // Probably better to have the docker container and/or helm
229 // scripts setup the local directory.
231 if (! path.toFile().exists()) {
234 // Try to create the directory
236 Files.createDirectory(path);
237 } catch (IOException e) {
238 LOGGER.error("Failed to create application directory {}", path.toAbsolutePath().toString(), e);
242 // Have the application initialize
244 application.initialize(path);