main/src/main/java/org/onap/policy/pap/main/parameters/PapParameterGroup.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   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.pap.main.parameters;
  22
  23 import org.onap.policy.common.parameters.GroupValidationResult;
  24 import org.onap.policy.common.parameters.ParameterGroup;
  25 import org.onap.policy.common.parameters.ValidationStatus;
  26 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
  27
  28 /**
  29  * Class to hold all parameters needed for pap component.
  30  *
  31  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  32  */
  33 public class PapParameterGroup implements ParameterGroup {
  34     private String name;
  35     private RestServerParameters restServerParameters;
  36
  37     /**
  38      * Create the pap parameter group.
  39      *
  40      * @param name the parameter group name
  41      * @param restServerParameters the rest server parameters
  42      */
  43     public PapParameterGroup(final String name, final RestServerParameters restServerParameters) {
  44         this.name = name;
  45         this.restServerParameters = restServerParameters;
  46     }
  47
  48     /**
  49      * Return the name of this parameter group instance.
  50      *
  51      * @return name the parameter group name
  52      */
  53     @Override
  54     public String getName() {
  55         return name;
  56     }
  57
  58     /**
  59      * Set the name of this parameter group instance.
  60      *
  61      * @param name the parameter group name
  62      */
  63     @Override
  64     public void setName(final String name) {
  65         this.name = name;
  66     }
  67
  68     /**
  69      * Return the restServerParameters of this parameter group instance.
  70      *
  71      * @return the restServerParameters
  72      */
  73     public RestServerParameters getRestServerParameters() {
  74         return restServerParameters;
  75     }
  76
  77     /**
  78      * Validate the parameter group.
  79      *
  80      * @return the result of the validation
  81      */
  82     @Override
  83     public GroupValidationResult validate() {
  84         final GroupValidationResult validationResult = new GroupValidationResult(this);
  85         if (!ParameterValidationUtils.validateStringParameter(name)) {
  86             validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
  87         }
  88         if (restServerParameters == null) {
  89             validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
  90                     "must have restServerParameters to configure pap rest server");
  91         } else {
  92             validationResult.setResult("restServerParameters", restServerParameters.validate());
  93         }
  94         return validationResult;
  95     }
  96 }