models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpParams.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.Builder;
  24 import lombok.Data;
  25 import org.onap.policy.common.parameters.BeanValidator;
  26 import org.onap.policy.common.parameters.ValidationResult;
  27 import org.onap.policy.common.parameters.annotations.Min;
  28 import org.onap.policy.common.parameters.annotations.NotBlank;
  29 import org.onap.policy.common.parameters.annotations.NotNull;
  30
  31 /**
  32  * Parameters used by Operators that connect to a server via HTTP.
  33  */
  34 @NotNull
  35 @NotBlank
  36 @Data
  37 @Builder(toBuilder = true)
  38 public class HttpParams {
  39
  40     /**
  41      * Name of the HttpClient, as found in the HttpClientFactory.
  42      */
  43     private String clientName;
  44
  45     /**
  46      * URI path.
  47      */
  48     private String path;
  49
  50     /**
  51      * Amount of time, in seconds to wait for the HTTP request to complete, where zero
  52      * indicates that it should wait forever. The default is zero.
  53      */
  54     @Min(0)
  55     @Builder.Default
  56     private int timeoutSec = 0;
  57
  58
  59     /**
  60      * Validates the parameters.
  61      *
  62      * @param resultName name of the result
  63      *
  64      * @return the validation result
  65      */
  66     public ValidationResult validate(String resultName) {
  67         return new BeanValidator().validateTop(resultName, this);
  68     }
  69 }