models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingConfig.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.actorserviceprovider.parameters;
  22
  23 import java.util.concurrent.Executor;
  24 import lombok.Getter;
  25 import org.onap.policy.common.endpoints.http.client.HttpClient;
  26 import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
  27
  28 /**
  29  * Configuration for HTTP Operators that, after issuing a request, must poll the target
  30  * server to determine the request completion status.
  31  */
  32 @Getter
  33 public class HttpPollingConfig extends HttpConfig {
  34
  35     /**
  36      * Path to use when polling for request completion. A trailing "/" is added, if it is
  37      * missing.
  38      */
  39     private String pollPath;
  40
  41     /**
  42      * Maximum number of times to poll to retrieve the response.
  43      */
  44     private int maxPolls;
  45
  46     /**
  47      * Time, in seconds, to wait between polling.
  48      */
  49     private int pollWaitSec;
  50
  51
  52     /**
  53      * Constructs the object.
  54      *
  55      * @param blockingExecutor executor to be used for tasks that may perform blocking I/O
  56      * @param params operator parameters
  57      * @param clientFactory factory from which to obtain the {@link HttpClient}
  58      */
  59     public HttpPollingConfig(Executor blockingExecutor, HttpPollingParams params, HttpClientFactory clientFactory) {
  60         super(blockingExecutor, params, clientFactory);
  61
  62         this.pollPath = params.getPollPath() + (params.getPollPath().endsWith("/") ? "" : "/");
  63         this.maxPolls = params.getMaxPolls();
  64         this.pollWaitSec = params.getPollWaitSec();
  65     }
  66 }