Merge "Add Control Loop Coordination policy."
[policy/xacml-pdp.git] / 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 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
43     private static final Logger LOGGER = LoggerFactory.getLogger(GuardPdpApplication.class);
44     private static final String STRING_VERSION100 = "1.0.0";
45     private List<ToscaPolicyTypeIdentifier> supportedPolicyTypes = new ArrayList<>();
46     private LegacyGuardTranslator legacyTranslator = new LegacyGuardTranslator();
47     private CoordinationGuardTranslator coordinationTranslator = new CoordinationGuardTranslator();
48
49
50     /** Constructor.
51      *
52      */
53     public GuardPdpApplication() {
54         this.supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(
55                 "onap.policies.controlloop.guard.FrequencyLimiter",
56                 STRING_VERSION100));
57         this.supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(
58                 "onap.policies.controlloop.guard.MinMax",
59                 STRING_VERSION100));
60         this.supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(
61                 "onap.policies.controlloop.guard.coordination.FirstBlocksSecond",
62                 STRING_VERSION100));
63     }
64
65     @Override
66     public String applicationName() {
67         return "guard";
68     }
69
70     @Override
71     public List<String> actionDecisionsSupported() {
72         return Arrays.asList("guard");
73     }
74
75     @Override
76     public List<ToscaPolicyTypeIdentifier> supportedPolicyTypes() {
77         return supportedPolicyTypes;
78     }
79
80     @Override
81     public boolean canSupportPolicyType(ToscaPolicyTypeIdentifier policyTypeId) {
82         //
83         // For the time being, restrict this if the version isn't known.
84         // Could be too difficult to support changing of versions dynamically.
85         //
86         for (ToscaPolicyTypeIdentifier supported : this.supportedPolicyTypes) {
87             if (policyTypeId.equals(supported)) {
88                 return true;
89             }
90         }
91         return false;
92     }
93
94     @Override
95     protected ToscaPolicyTranslator getTranslator(String type) {
96         LOGGER.debug("Policy type {}", type);
97         if ( type.contains("coordination") ) {
98             LOGGER.debug("returning coordinationTranslator");
99             return coordinationTranslator;
100         } else {
101             LOGGER.debug("returning legacyTranslator");
102             return legacyTranslator;
103         }
104     }
105
106 }