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