artifactbroker/main/src/main/java/org/onap/policy/distribution/main/parameters/DistributionParameterGroup.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.distribution.main.parameters;
  22
  23 import java.util.LinkedHashMap;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26
  27 import org.onap.policy.common.parameters.GroupValidationResult;
  28 import org.onap.policy.common.parameters.ParameterGroup;
  29 import org.onap.policy.common.parameters.ValidationStatus;
  30 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
  31
  32 /**
  33  * Class to hold all parameters needed for Distribution component.
  34  *
  35  * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
  36  */
  37 public class DistributionParameterGroup implements ParameterGroup {
  38     // @formatter:off
  39     private String name;
  40     private RestServerParameters restServerParameters;
  41     // @formatter:on
  42
  43     /**
  44      * Create the distribution parameter group.
  45      *
  46      * @param name the parameter group name
  47      */
  48     public DistributionParameterGroup(final String name, final RestServerParameters restServerParameters) {
  49         this.name = name;
  50         this.restServerParameters = restServerParameters;
  51     }
  52
  53     /**
  54      * Return the name of this parameter group instance.
  55      *
  56      * @return name the parameter group name
  57      */
  58     @Override
  59     public String getName() {
  60         return name;
  61     }
  62
  63     /**
  64      * Set the name of this parameter group instance.
  65      *
  66      * @param name the parameter group name
  67      */
  68     @Override
  69     public void setName(final String name) {
  70         this.name = name;
  71     }
  72
  73     /**
  74      * Return the restServerParameters of this parameter group instance.
  75      *
  76      * @return the restServerParameters
  77      */
  78     public RestServerParameters getRestServerParameters() {
  79         return restServerParameters;
  80     }
  81
  82     /**
  83      * Validate the parameter group.
  84      *
  85      * @return the result of the validation
  86      */
  87     @Override
  88     public GroupValidationResult validate() {
  89         final GroupValidationResult validationResult = new GroupValidationResult(this);
  90         if (!ParameterValidationUtils.validateStringParameter(name)) {
  91             validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
  92         }
  93         if (restServerParameters == null) {
  94             validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
  95                 "must have restServerParameters to configure distribution rest server");
  96         } else {
  97             validationResult.setResult("restServerParameters", restServerParameters.validate());
  98         }
  99         return validationResult;
 100     }
 101
 102 }