models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingParams.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 lombok.Data;
  24 import lombok.EqualsAndHashCode;
  25 import lombok.experimental.SuperBuilder;
  26 import org.onap.policy.common.parameters.annotations.Min;
  27 import org.onap.policy.common.parameters.annotations.NotBlank;
  28 import org.onap.policy.common.parameters.annotations.NotNull;
  29 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams;
  30
  31 /**
  32  * Parameters used by Operators that, after issuing an HTTP request, must poll the target
  33  * server to determine the request completion status.
  34  */
  35 @NotNull
  36 @NotBlank
  37 @Data
  38 @EqualsAndHashCode(callSuper = true)
  39 @SuperBuilder(toBuilder = true)
  40 public class HttpPollingParams extends HttpParams {
  41
  42     /**
  43      * Path to use when polling for request completion.
  44      */
  45     private String pollPath;
  46
  47     /**
  48      * Maximum number of times to poll to retrieve the response.
  49      */
  50     @Min(0)
  51     private int maxPolls;
  52
  53     /**
  54      * Time, in seconds, to wait between polling.
  55      */
  56     @Min(1)
  57     private int pollWaitSec;
  58 }