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

   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.guard;
  22
  23 import java.util.LinkedHashMap;
  24 import java.util.Map;
  25 import java.util.concurrent.Executor;
  26 import lombok.Getter;
  27 import org.onap.policy.common.endpoints.http.client.HttpClient;
  28 import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
  29 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
  30
  31 /**
  32  * Configuration for Guard Operators.
  33  */
  34 public class GuardConfig extends HttpConfig {
  35     private final Map<String, Object> defaultRequest = new LinkedHashMap<>();
  36
  37     /**
  38      * {@code True} if the associated guard operation is disabled.
  39      */
  40     @Getter
  41     private boolean disabled;
  42
  43     /**
  44      * Constructs the object.
  45      *
  46      * @param blockingExecutor executor to be used for tasks that may perform blocking I/O
  47      * @param params operator parameters
  48      * @param clientFactory factory from which to obtain the {@link HttpClient}
  49      */
  50     public GuardConfig(Executor blockingExecutor, GuardParams params, HttpClientFactory clientFactory) {
  51         super(blockingExecutor, params, clientFactory);
  52
  53         addProperty("ONAPComponent", params.getOnapComponent());
  54         addProperty("ONAPInstance", params.getOnapInstance());
  55         addProperty("ONAPName", params.getOnapName());
  56         addProperty("action", params.getAction());
  57
  58         this.disabled = params.isDisabled();
  59     }
  60
  61     /**
  62      * Adds a property to the default request, if the value is not {@code null}.
  63      *
  64      * @param key property key
  65      * @param value property value, or {@code null}
  66      */
  67     private void addProperty(String key, String value) {
  68         if (value != null) {
  69             defaultRequest.put(key, value);
  70         }
  71     }
  72
  73     /**
  74      * Creates a new request, with the default values.
  75      *
  76      * @return a new request map
  77      */
  78     public Map<String, Object> makeRequest() {
  79         return new LinkedHashMap<>(defaultRequest);
  80     }
  81 }