applications/guard/src/main/java/org/onap/policy/xacml/pdp/application/guard/GuardPdpApplication.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 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.guard;
  24
  25 import java.util.ArrayList;
  26 import java.util.Arrays;
  27 import java.util.List;
  28
  29 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  30 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
  31 import org.onap.policy.pdp.xacml.application.common.std.StdXacmlApplicationServiceProvider;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 /**
  36  * This class implements the onap.policies.controlloop.Guard policy implementations.
  37  *
  38  * @author pameladragosh
  39  *
  40  */
  41 public class GuardPdpApplication extends StdXacmlApplicationServiceProvider {
  42     private static final Logger LOGGER = LoggerFactory.getLogger(GuardPdpApplication.class);
  43     private static final String STRING_VERSION100 = "1.0.0";
  44     private List<ToscaPolicyTypeIdentifier> supportedPolicyTypes = new ArrayList<>();
  45     private GuardTranslator guardTranslator = new GuardTranslator();
  46     private CoordinationGuardTranslator coordinationTranslator = new CoordinationGuardTranslator();
  47
  48     /**
  49      * Constructor.
  50      *
  51      */
  52     public GuardPdpApplication() {
  53         this.supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(
  54                 GuardTranslator.POLICYTYPE_FREQUENCY,
  55                 STRING_VERSION100));
  56         this.supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(
  57                 GuardTranslator.POLICYTYPE_MINMAX,
  58                 STRING_VERSION100));
  59         this.supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(
  60                 GuardTranslator.POLICYTYPE_BLACKLIST,
  61                 STRING_VERSION100));
  62         this.supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(
  63                 "onap.policies.controlloop.guard.coordination.FirstBlocksSecond",
  64                 STRING_VERSION100));
  65     }
  66
  67     @Override
  68     public String applicationName() {
  69         return "guard";
  70     }
  71
  72     @Override
  73     public List<String> actionDecisionsSupported() {
  74         return Arrays.asList("guard");
  75     }
  76
  77     @Override
  78     public List<ToscaPolicyTypeIdentifier> supportedPolicyTypes() {
  79         return supportedPolicyTypes;
  80     }
  81
  82     @Override
  83     public boolean canSupportPolicyType(ToscaPolicyTypeIdentifier policyTypeId) {
  84         //
  85         // For the time being, restrict this if the version isn't known.
  86         // Could be too difficult to support changing of versions dynamically.
  87         //
  88         for (ToscaPolicyTypeIdentifier supported : this.supportedPolicyTypes) {
  89             if (policyTypeId.equals(supported)) {
  90                 return true;
  91             }
  92         }
  93         return false;
  94     }
  95
  96     @Override
  97     protected ToscaPolicyTranslator getTranslator(String type) {
  98         LOGGER.debug("Policy type {}", type);
  99         if ( type.contains("coordination") ) {
 100             LOGGER.debug("returning coordinationTranslator");
 101             return coordinationTranslator;
 102         } else {
 103             LOGGER.debug("returning guardTranslator");
 104             return guardTranslator;
 105         }
 106     }
 107
 108 }