main/src/main/java/org/onap/policy/api/main/parameters/ApiParameterGroup.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Samsung Electronics Co., Ltd. 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.api.main.parameters;
  22
  23 import org.onap.policy.common.endpoints.parameters.RestServerParameters;
  24 import org.onap.policy.common.parameters.GroupValidationResult;
  25 import org.onap.policy.common.parameters.ParameterGroup;
  26 import org.onap.policy.common.parameters.ValidationStatus;
  27 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
  28 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  29
  30 /**
  31  * Class to hold all parameters needed for Api component.
  32  *
  33  */
  34 public class ApiParameterGroup implements ParameterGroup {
  35
  36     private String name;
  37     private RestServerParameters restServerParameters;
  38     private PolicyModelsProviderParameters databaseProviderParameters;
  39
  40     /**
  41      * Create the api parameter group.
  42      *
  43      * @param name the parameter group name
  44      */
  45     public ApiParameterGroup(final String name, final RestServerParameters restServerParameters,
  46             final PolicyModelsProviderParameters databaseProviderParameters) {
  47         this.name = name;
  48         this.restServerParameters = restServerParameters;
  49         this.databaseProviderParameters = databaseProviderParameters;
  50     }
  51
  52     /**
  53      * Return the name of this parameter group instance.
  54      *
  55      * @return name the parameter group name
  56      */
  57     @Override
  58     public String getName() {
  59         return name;
  60     }
  61
  62     /**
  63      * Set the name of this parameter group instance.
  64      *
  65      * @param name the parameter group name
  66      */
  67     @Override
  68     public void setName(String name) {
  69         this.name = name;
  70     }
  71
  72     /**
  73      * Return the restServerParameters of this parameter group instance.
  74      *
  75      * @return the restServerParameters
  76      */
  77     public RestServerParameters getRestServerParameters() {
  78         return restServerParameters;
  79     }
  80
  81     /**
  82      * Return the databaseProviderParameters of this parameter group instance.
  83      *
  84      * @return the databaseProviderParameters
  85      */
  86     public PolicyModelsProviderParameters getDatabaseProviderParameters() {
  87         return databaseProviderParameters;
  88     }
  89
  90     /**
  91      * Validate the parameter group.
  92      *
  93      * @return the result of the validation
  94      */
  95     @Override
  96     public GroupValidationResult validate() {
  97         final GroupValidationResult validationResult = new GroupValidationResult(this);
  98         if (!ParameterValidationUtils.validateStringParameter(name)) {
  99             validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
 100         }
 101         if (restServerParameters == null) {
 102             validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
 103                     "must have restServerParameters to configure api rest server");
 104         } else {
 105             validationResult.setResult("restServerParameters", restServerParameters.validate());
 106         }
 107         if (databaseProviderParameters == null) {
 108             validationResult.setResult("databaseProviderParameters", ValidationStatus.INVALID,
 109                     "must have databaseProviderParameters to configure api rest server");
 110         } else {
 111             validationResult.setResult("databaseProviderParameters", databaseProviderParameters.validate());
 112         }
 113         return validationResult;
 114     }
 115 }