models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcActor.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2017-2020 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.actor.appc;
  23
  24 import com.google.common.collect.ImmutableList;
  25 import com.google.common.collect.ImmutableMap;
  26 import java.util.Collections;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Map.Entry;
  30 import org.onap.policy.appc.CommonHeader;
  31 import org.onap.policy.appc.Request;
  32 import org.onap.policy.common.utils.coder.CoderException;
  33 import org.onap.policy.common.utils.coder.StandardCoder;
  34 import org.onap.policy.controlloop.ControlLoopOperation;
  35 import org.onap.policy.controlloop.VirtualControlLoopEvent;
  36 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicActor;
  37 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator;
  38 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicActorParams;
  39 import org.onap.policy.controlloop.policy.Policy;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43
  44 public class AppcActor extends BidirectionalTopicActor<BidirectionalTopicActorParams> {
  45     public static final String NAME = "APPC";
  46
  47     private static final Logger logger = LoggerFactory.getLogger(AppcActor.class);
  48
  49     // TODO old code: remove lines down to **HERE**
  50
  51     private static final StandardCoder coder = new StandardCoder();
  52
  53     // Strings for targets
  54     private static final String TARGET_VM = "VM";
  55     private static final String TARGET_VNF = "VNF";
  56
  57     // Strings for recipes
  58     private static final String RECIPE_RESTART = "Restart";
  59     private static final String RECIPE_REBUILD = "Rebuild";
  60     private static final String RECIPE_MIGRATE = "Migrate";
  61     private static final String RECIPE_MODIFY = "ModifyConfig";
  62
  63     private static final ImmutableList<String> recipes =
  64                     ImmutableList.of(RECIPE_RESTART, RECIPE_REBUILD, RECIPE_MIGRATE, RECIPE_MODIFY);
  65     private static final ImmutableMap<String, List<String>> targets = new ImmutableMap.Builder<String, List<String>>()
  66                     .put(RECIPE_RESTART, ImmutableList.of(TARGET_VM)).put(RECIPE_REBUILD, ImmutableList.of(TARGET_VM))
  67                     .put(RECIPE_MIGRATE, ImmutableList.of(TARGET_VM)).put(RECIPE_MODIFY, ImmutableList.of(TARGET_VNF))
  68                     .build();
  69     private static final ImmutableMap<String, List<String>> payloads = new ImmutableMap.Builder<String, List<String>>()
  70                     .put(RECIPE_MODIFY, ImmutableList.of("generic-vnf.vnf-id")).build();
  71
  72     // **HERE**
  73
  74     /**
  75      * Constructs the object.
  76      */
  77     public AppcActor() {
  78         super(NAME, BidirectionalTopicActorParams.class);
  79
  80         addOperator(new BidirectionalTopicOperator(NAME, ModifyConfigOperation.NAME, this, AppcOperation.SELECTOR_KEYS,
  81                         ModifyConfigOperation::new));
  82     }
  83
  84     // TODO old code: remove lines down to **HERE**
  85
  86     @Override
  87     public String actor() {
  88         return NAME;
  89     }
  90
  91     @Override
  92     public List<String> recipes() {
  93         return ImmutableList.copyOf(recipes);
  94     }
  95
  96     @Override
  97     public List<String> recipeTargets(String recipe) {
  98         return ImmutableList.copyOf(targets.getOrDefault(recipe, Collections.emptyList()));
  99     }
 100
 101     @Override
 102     public List<String> recipePayloads(String recipe) {
 103         return ImmutableList.copyOf(payloads.getOrDefault(recipe, Collections.emptyList()));
 104     }
 105
 106     /**
 107      * Constructs an APPC request conforming to the legacy API. The legacy API will be
 108      * deprecated in future releases as all legacy functionality is moved into the LCM
 109      * API.
 110      *
 111      * @param onset the event that is reporting the alert for policy to perform an action
 112      * @param operation the control loop operation specifying the actor, operation,
 113      *        target, etc.
 114      * @param policy the policy the was specified from the yaml generated by CLAMP or
 115      *        through the Policy GUI/API
 116      * @return an APPC request conforming to the legacy API
 117      */
 118     public static Request constructRequest(VirtualControlLoopEvent onset, ControlLoopOperation operation, Policy policy,
 119                     String targetVnf) {
 120         /*
 121          * Construct an APPC request
 122          */
 123         Request request = new Request();
 124         request.setCommonHeader(new CommonHeader());
 125         request.getCommonHeader().setRequestId(onset.getRequestId());
 126         request.getCommonHeader().setSubRequestId(operation.getSubRequestId());
 127         request.setAction(policy.getRecipe().substring(0, 1).toUpperCase() + policy.getRecipe().substring(1));
 128
 129         // convert policy payload strings to objects
 130         if (policy.getPayload() == null) {
 131             logger.info("no APPC payload specified for policy {}", policy.getName());
 132         } else {
 133             convertPayload(policy.getPayload(), request.getPayload());
 134         }
 135
 136         // add/replace specific values
 137         request.getPayload().put("generic-vnf.vnf-id", targetVnf);
 138
 139         /*
 140          * Return the request
 141          */
 142
 143         return request;
 144     }
 145
 146     /**
 147      * Converts a payload. The original value is assumed to be a JSON string, which is
 148      * decoded into an object.
 149      *
 150      * @param source source from which to get the values
 151      * @param target where to place the decoded values
 152      */
 153     private static void convertPayload(Map<String, String> source, Map<String, Object> target) {
 154         for (Entry<String, String> ent : source.entrySet()) {
 155             try {
 156                 target.put(ent.getKey(), coder.decode(ent.getValue(), Object.class));
 157
 158             } catch (CoderException e) {
 159                 logger.warn("cannot decode JSON value {}: {}", ent.getKey(), ent.getValue(), e);
 160             }
 161         }
 162     }
 163
 164     // **HERE**
 165 }