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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 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  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.actor.appc;
  22
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26 import java.util.concurrent.CompletableFuture;
  27 import org.onap.policy.appc.CommonHeader;
  28 import org.onap.policy.appc.Request;
  29 import org.onap.policy.appc.Response;
  30 import org.onap.policy.appc.ResponseCode;
  31 import org.onap.policy.common.utils.coder.Coder;
  32 import org.onap.policy.common.utils.coder.CoderException;
  33 import org.onap.policy.common.utils.coder.StandardCoder;
  34 import org.onap.policy.common.utils.coder.StandardCoderInstantAsMillis;
  35 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  36 import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
  37 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation;
  38 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
  39 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  40 import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * Superclass for APPC Operations.
  46  */
  47 public abstract class AppcOperation extends BidirectionalTopicOperation<Request, Response> {
  48     private static final Logger logger = LoggerFactory.getLogger(AppcOperation.class);
  49     private static final StandardCoder coder = new StandardCoderInstantAsMillis();
  50     public static final String VNF_ID_KEY = "generic-vnf.vnf-id";
  51
  52     /**
  53      * Keys used to match the response with the request listener. The sub request ID is a
  54      * UUID, so it can be used to uniquely identify the response.
  55      * <p/>
  56      * Note: if these change, then {@link #getExpectedKeyValues(int, Request)} must be
  57      * updated accordingly.
  58      */
  59     public static final List<SelectorKey> SELECTOR_KEYS = List.of(new SelectorKey("CommonHeader", "SubRequestID"));
  60
  61     /**
  62      * Constructs the object.
  63      *
  64      * @param params operation parameters
  65      * @param config configuration for this operation
  66      * @param propertyNames names of properties required by this operation
  67      */
  68     public AppcOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config,
  69                     List<String> propertyNames) {
  70         super(params, config, Response.class, propertyNames);
  71     }
  72
  73     /**
  74      * Starts the GUARD.
  75      */
  76     @Override
  77     protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
  78         return startGuardAsync();
  79     }
  80
  81     /**
  82      * Makes a request, given the target VNF. This is a support function for
  83      * {@link #makeRequest(int)}.
  84      *
  85      * @param attempt attempt number
  86      * @param targetVnf target VNF
  87      * @return a new request
  88      */
  89     protected Request makeRequest(int attempt, String targetVnf) {
  90         Request request = new Request();
  91         request.setCommonHeader(new CommonHeader());
  92         request.getCommonHeader().setRequestId(params.getRequestId());
  93         request.getCommonHeader().setSubRequestId(getSubRequestId());
  94
  95         request.setAction(getName());
  96
  97         // convert payload strings to objects
  98         if (params.getPayload() == null) {
  99             logger.info("{}: no payload specified for {}", getFullName(), params.getRequestId());
 100         } else {
 101             convertPayload(params.getPayload(), request.getPayload());
 102         }
 103
 104         // add/replace specific values
 105         request.getPayload().put(VNF_ID_KEY, targetVnf);
 106
 107         return request;
 108     }
 109
 110     /**
 111      * Converts a payload. The original value is assumed to be a JSON string, which is
 112      * decoded into an object.
 113      *
 114      * @param source source from which to get the values
 115      * @param target where to place the decoded values
 116      */
 117     private static void convertPayload(Map<String, Object> source, Map<String, Object> target) {
 118         for (Entry<String, Object> ent : source.entrySet()) {
 119             Object value = ent.getValue();
 120             if (value == null) {
 121                 target.put(ent.getKey(), null);
 122                 continue;
 123             }
 124
 125             try {
 126                 target.put(ent.getKey(), coder.decode(value.toString(), Object.class));
 127
 128             } catch (CoderException e) {
 129                 logger.warn("cannot decode JSON value {}: {}", ent.getKey(), ent.getValue(), e);
 130             }
 131         }
 132     }
 133
 134     /**
 135      * Note: these values must match {@link #SELECTOR_KEYS}.
 136      */
 137     @Override
 138     protected List<String> getExpectedKeyValues(int attempt, Request request) {
 139         return List.of(getSubRequestId());
 140     }
 141
 142     @Override
 143     protected Status detmStatus(String rawResponse, Response response) {
 144         if (response.getStatus() == null) {
 145             // no status - this must be a request, not a response - just ignore it
 146             logger.info("{}: ignoring request message for {}", getFullName(), params.getRequestId());
 147             return Status.STILL_WAITING;
 148         }
 149
 150         ResponseCode code = ResponseCode.toResponseCode(response.getStatus().getCode());
 151         if (code == null) {
 152             throw new IllegalArgumentException(
 153                             "unknown APPC-C response status code: " + response.getStatus().getCode());
 154         }
 155
 156         switch (code) {
 157             case SUCCESS:
 158                 return Status.SUCCESS;
 159             case FAILURE:
 160                 return Status.FAILURE;
 161             case ERROR:
 162             case REJECT:
 163                 throw new IllegalArgumentException("APP-C request was not accepted, code=" + code);
 164             case ACCEPT:
 165             default:
 166                 // awaiting a "final" response
 167                 return Status.STILL_WAITING;
 168         }
 169     }
 170
 171     /**
 172      * Sets the message to the status description, if available.
 173      */
 174     @Override
 175     public OperationOutcome setOutcome(OperationOutcome outcome, OperationResult result, Response response) {
 176         outcome.setResponse(response);
 177
 178         if (response.getStatus() == null || response.getStatus().getDescription() == null) {
 179             return setOutcome(outcome, result);
 180         }
 181
 182         outcome.setResult(result);
 183         outcome.setMessage(response.getStatus().getDescription());
 184         return outcome;
 185     }
 186
 187     @Override
 188     protected Coder getCoder() {
 189         return coder;
 190     }
 191 }