package org.onap.policy.pdpx.main.rest;
+import java.io.IOException;
+import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.ServiceLoader;
+import java.util.stream.Collectors;
+import lombok.Getter;
+import lombok.Setter;
import org.onap.policy.models.decisions.concepts.DecisionRequest;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
+import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class XacmlPdpApplicationManager {
private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpApplicationManager.class);
- private static boolean needsInit = true;
- private static ServiceLoader<XacmlApplicationServiceProvider> applicationLoader;
- private static Map<String, XacmlApplicationServiceProvider> providerActionMap = new HashMap<>();
- private static List<ToscaPolicyTypeIdentifier> toscaPolicyTypeIdents = new ArrayList<>();
+ @Getter
+ @Setter
+ private static XacmlPdpApplicationManager current;
+
+ private ServiceLoader<XacmlApplicationServiceProvider> applicationLoader;
+ private Map<String, XacmlApplicationServiceProvider> providerActionMap = new HashMap<>();
+ private List<ToscaPolicyTypeIdentifier> toscaPolicyTypeIdents = new ArrayList<>();
+ private Map<ToscaPolicy, XacmlApplicationServiceProvider> mapLoadedPolicies = new HashMap<>();
- private XacmlPdpApplicationManager() {
- super();
- }
/**
* One time to initialize the applications upon startup.
*/
- public static void initializeApplications(Path applicationPath) {
- //
- // If we have already done this
- //
- if (! needsInit) {
- LOGGER.error("Already initialized the applications");
- return;
+ public XacmlPdpApplicationManager(Path applicationPath) {
+ if (LOGGER.isInfoEnabled()) {
+ LOGGER.info("Initialization applications {}", applicationPath.toAbsolutePath());
}
//
// Load service
//
applicationLoader = ServiceLoader.load(XacmlApplicationServiceProvider.class);
-
//
- // Iterate through them the applications for actions and supported policy types
+ // Iterate through the applications for actions and supported policy types
//
for (XacmlApplicationServiceProvider application : applicationLoader) {
-
- LOGGER.info("Application {} supports {}", application.applicationName(),
+ if (LOGGER.isInfoEnabled()) {
+ LOGGER.info("Application {} supports {}", application.applicationName(),
application.supportedPolicyTypes());
-
+ }
//
- // Iterate through the actions and save in the providerActionMap
+ // We are not going to make this available unless the application can
+ // install correctly.
//
- int pathCount = 1;
- for (String action : application.actionDecisionsSupported()) {
+ boolean applicationInitialized = false;
+ //
+ // Have it initialize at a path
+ //
+ try {
+ initializeApplicationPath(applicationPath, application);
//
- // Save the actions that it supports
+ // We are initialized
//
- providerActionMap.put(action, application);
+ applicationInitialized = true;
+ } catch (XacmlApplicationException e) {
+ LOGGER.error("Failed to initialize path for {}", application.applicationName(), e);
+ }
+ if (applicationInitialized) {
//
- // Create a unique path for the application to store its data
- // May need to scan this name to remove unsafe characters etc.
- // But for debugging purposes, its good to use the application name
+ // Iterate through the actions and save in the providerActionMap
//
- Path path = Paths.get(applicationPath.toAbsolutePath().toString(),
- application.applicationName(), Integer.toString(pathCount++));
+ for (String action : application.actionDecisionsSupported()) {
+ //
+ // Save the actions that it supports
+ //
+ providerActionMap.put(action, application);
+ }
//
- // Have the application initialize
+ // Add all the supported policy types
//
- application.initialize(path);
- }
-
- // Get string list of supportedPolicyTypes
- List<String> supportedPolicyTypes = application.supportedPolicyTypes();
-
- // Iterate through the supportedPolicyTypes to set the toscaPolicyTypeIdents
- for (String name : supportedPolicyTypes) {
- ToscaPolicyTypeIdentifier ident = new ToscaPolicyTypeIdentifier(name, "1.0.0");
- toscaPolicyTypeIdents.add(ident);
+ toscaPolicyTypeIdents.addAll(application.supportedPolicyTypes());
}
}
//
// we have initialized
//
- needsInit = false;
+ LOGGER.info("Finished applications initialization {}", providerActionMap);
+
}
- public static XacmlApplicationServiceProvider findApplication(DecisionRequest request) {
+ public XacmlApplicationServiceProvider findApplication(DecisionRequest request) {
return providerActionMap.get(request.getAction());
}
- public static List<ToscaPolicyTypeIdentifier> getToscaPolicyTypeIdents() {
+ /**
+ * getToscaPolicies.
+ *
+ * @return the map containing ToscaPolicies
+ */
+ public Map<ToscaPolicy, XacmlApplicationServiceProvider> getToscaPolicies() {
+ return mapLoadedPolicies;
+ }
+
+ /**
+ * getToscaPolicyIdentifiers.
+ *
+ * @return list of ToscaPolicyIdentifier
+ */
+ public List<ToscaPolicyIdentifier> getToscaPolicyIdentifiers() {
+ //
+ // converting map to return List of ToscaPolicyIdentiers
+ //
+ return mapLoadedPolicies.keySet().stream().map(ToscaPolicy::getIdentifier).collect(Collectors.toList());
+ }
+
+ public List<ToscaPolicyTypeIdentifier> getToscaPolicyTypeIdents() {
return toscaPolicyTypeIdents;
}
+ /**
+ * Finds the appropriate application and removes the policy.
+ *
+ * @param policy Incoming policy
+ */
+ public void removeUndeployedPolicy(ToscaPolicy policy) {
+
+ for (XacmlApplicationServiceProvider application : applicationLoader) {
+ try {
+ if (application.unloadPolicy(policy)) {
+ if (LOGGER.isInfoEnabled()) {
+ LOGGER.info("Unloaded ToscaPolicy {} from application {}", policy.getMetadata(),
+ application.applicationName());
+ }
+ if (mapLoadedPolicies.remove(policy) == null) {
+ LOGGER.error("Failed to remove unloaded policy {} from map size {}", policy.getMetadata(),
+ mapLoadedPolicies.size());
+ }
+ }
+ } catch (XacmlApplicationException e) {
+ LOGGER.error("Failed to undeploy the Tosca Policy", e);
+ }
+ }
+ }
+
+ /**
+ * Finds the appropriate application and loads the policy.
+ *
+ * @param policy Incoming policy
+ */
+ public void loadDeployedPolicy(ToscaPolicy policy) {
+
+ for (XacmlApplicationServiceProvider application : applicationLoader) {
+ try {
+ //
+ // There should be only one application per policytype. We can
+ // put more logic surrounding enforcement of that later. For now,
+ // just use the first one found.
+ //
+ if (application.canSupportPolicyType(policy.getTypeIdentifier())) {
+ if (application.loadPolicy(policy)) {
+ if (LOGGER.isInfoEnabled()) {
+ LOGGER.info("Loaded ToscaPolicy {} into application {}", policy.getMetadata(),
+ application.applicationName());
+ }
+ mapLoadedPolicies.put(policy, application);
+ }
+ return;
+ }
+ } catch (XacmlApplicationException e) {
+ LOGGER.error("Failed to load the Tosca Policy", e);
+ }
+ }
+ }
+
/**
* Returns the current count of policy types supported. This could be misleading a bit
* as some applications can support wildcard of policy types. Eg. onap.Monitoring.* as
*
* @return Total count added from all applications
*/
- public static long getPolicyTypeCount() {
+ public long getPolicyTypeCount() {
long types = 0;
for (XacmlApplicationServiceProvider application : applicationLoader) {
types += application.supportedPolicyTypes().size();
return types;
}
+ private void initializeApplicationPath(Path basePath, XacmlApplicationServiceProvider application)
+ throws XacmlApplicationException {
+ //
+ // Making an assumption that all application names are unique, and
+ // they can result in a valid directory being created.
+ //
+ Path path = Paths.get(basePath.toAbsolutePath().toString(), application.applicationName());
+ if (LOGGER.isInfoEnabled()) {
+ LOGGER.info("initializeApplicationPath {} at this path {}", application.applicationName(), path);
+ }
+ //
+ // Create that the directory if it does not exist. Ideally
+ // this is only for testing, but could be used for production
+ // Probably better to have the docker container and/or helm
+ // scripts setup the local directory.
+ //
+ if (! path.toFile().exists()) {
+ try {
+ //
+ // Try to create the directory
+ //
+ Files.createDirectory(path);
+ } catch (IOException e) {
+ LOGGER.error("Failed to create application directory {}", path.toAbsolutePath().toString(), e);
+ }
+ }
+ //
+ // Have the application initialize
+ //
+ application.initialize(path);
+ }
}