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