gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation.
   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.clamp.controlloop.models.controlloop.concepts;
  22
  23 import java.util.Map;
  24 import javax.ws.rs.core.Response;
  25 import lombok.AccessLevel;
  26 import lombok.NoArgsConstructor;
  27 import org.onap.policy.common.utils.coder.Coder;
  28 import org.onap.policy.common.utils.coder.CoderException;
  29 import org.onap.policy.common.utils.coder.StandardCoder;
  30 import org.onap.policy.models.base.PfModelRuntimeException;
  31 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  32 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  33 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  34
  35 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  36 public final class ParticipantUtils {
  37
  38     private static final Coder CODER = new StandardCoder();
  39     private static final String CONTROL_LOOP_ELEMENT = "org.onap.policy.clamp.controlloop.ControlLoopElement";
  40
  41     /**
  42      * Finds participantType from a map of properties.
  43      *
  44      * @param properties Map of properties
  45      * @return participantType
  46      */
  47     public static ToscaConceptIdentifier findParticipantType(Map<String, Object> properties) {
  48         var objParticipantType = properties.get("participantType");
  49         if (objParticipantType != null) {
  50             try {
  51                 return CODER.decode(objParticipantType.toString(), ToscaConceptIdentifier.class);
  52             } catch (CoderException e) {
  53                 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, e.getMessage(), e);
  54             }
  55         }
  56         return null;
  57     }
  58
  59     /**
  60      * Get the First StartPhase
  61      * it depend of the state of the Control Loop
  62      * and also from the all startPhase defined into the ToscaServiceTemplate.
  63      * @param controlLoop the ControlLoop
  64      * @param toscaServiceTemplate the ToscaServiceTemplate
  65      * @return the First StartPhase
  66      */
  67     public static int getFirstStartPhase(ControlLoop controlLoop, ToscaServiceTemplate toscaServiceTemplate) {
  68         var minStartPhase = 1000;
  69         var maxStartPhase = 0;
  70         for (var element : controlLoop.getElements().values()) {
  71             ToscaNodeTemplate toscaNodeTemplate = toscaServiceTemplate.getToscaTopologyTemplate().getNodeTemplates()
  72                     .get(element.getDefinition().getName());
  73             int startPhase = ParticipantUtils.findStartPhase(toscaNodeTemplate.getProperties());
  74             minStartPhase = Math.min(minStartPhase, startPhase);
  75             maxStartPhase = Math.max(maxStartPhase, startPhase);
  76         }
  77
  78         return ControlLoopState.UNINITIALISED2PASSIVE.equals(controlLoop.getState())
  79                 || ControlLoopState.PASSIVE2RUNNING.equals(controlLoop.getState()) ? minStartPhase
  80                         : maxStartPhase;
  81     }
  82
  83     /**
  84      * Finds startPhase from a map of properties.
  85      *
  86      * @param properties Map of properties
  87      * @return startPhase
  88      */
  89     public static int findStartPhase(Map<String, Object> properties) {
  90         var objParticipantType = properties.get("startPhase");
  91         if (objParticipantType != null) {
  92             return Integer.valueOf(objParticipantType.toString());
  93         }
  94         return 0;
  95     }
  96
  97     /**
  98      * Checks If NodeTemplate Is ControlLoopElement.
  99      *
 100      * @param nodeTemplate the ToscaNodeTemplate
 101      * @param toscaServiceTemplate the ToscaServiceTemplate
 102      * @return true if NodeTemplate Is ControlLoopElement
 103      */
 104     public static boolean checkIfNodeTemplateIsControlLoopElement(ToscaNodeTemplate nodeTemplate,
 105             ToscaServiceTemplate toscaServiceTemplate) {
 106         if (nodeTemplate.getType().contains(CONTROL_LOOP_ELEMENT)) {
 107             return true;
 108         } else {
 109             var nodeType = toscaServiceTemplate.getNodeTypes().get(nodeTemplate.getType());
 110             if (nodeType != null) {
 111                 var derivedFrom = nodeType.getDerivedFrom();
 112                 if (derivedFrom != null) {
 113                     return derivedFrom.contains(CONTROL_LOOP_ELEMENT);
 114                 }
 115             }
 116         }
 117         return false;
 118     }
 119 }