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