models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/TopicPairParams.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 use a pair of Topics, one to publish requests and the
  33  * other to receive responses.
  34  */
  35 @NotNull
  36 @NotBlank
  37 @Data
  38 @Builder(toBuilder = true)
  39 public class TopicPairParams {
  40
  41     /**
  42      * Source topic end point, from which to read responses.
  43      */
  44     private String source;
  45
  46     /**
  47      * Name of the target topic end point to which requests should be published.
  48      */
  49     private String target;
  50
  51     /**
  52      * Amount of time, in seconds to wait for the response. The default is five minutes.
  53      */
  54     @Min(1)
  55     @Builder.Default
  56     private int timeoutSec = 300;
  57
  58     /**
  59      * Validates the parameters.
  60      *
  61      * @param resultName name of the result
  62      *
  63      * @return the validation result
  64      */
  65     public ValidationResult validate(String resultName) {
  66         return new BeanValidator().validateTop(resultName, this);
  67     }
  68 }