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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.api.main.parameters;
23 import java.util.List;
26 import org.onap.policy.common.endpoints.parameters.RestServerParameters;
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 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
34 * Class to hold all parameters needed for Api component.
38 public class ApiParameterGroup implements ParameterGroup {
42 private final RestServerParameters restServerParameters;
43 private final PolicyModelsProviderParameters databaseProviderParameters;
44 private final List<String> preloadPolicyTypes;
45 private final List<String> preloadPolicies;
48 * Create the api parameter group.
50 * @param name the parameter group name
51 * @param restServerParameters the parameters for instantiating API rest server
52 * @param databaseProviderParameters the parameters for instantiating database provider
53 * @param preloadPolicyTypes the list of preloaded policy types
54 * @param preloadPolicies the list of preloaded policies
56 public ApiParameterGroup(final String name, final RestServerParameters restServerParameters,
57 final PolicyModelsProviderParameters databaseProviderParameters, final List<String> preloadPolicyTypes,
58 final List<String> preloadPolicies) {
60 this.restServerParameters = restServerParameters;
61 this.databaseProviderParameters = databaseProviderParameters;
62 this.preloadPolicyTypes = preloadPolicyTypes;
63 this.preloadPolicies = preloadPolicies;
67 * Validate the parameter group.
69 * @return the result of the validation
72 public GroupValidationResult validate() {
73 final GroupValidationResult validationResult = new GroupValidationResult(this);
74 if (!ParameterValidationUtils.validateStringParameter(name)) {
75 validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
77 if (restServerParameters == null) {
78 validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
79 "must have restServerParameters to configure api rest server");
81 validationResult.setResult("restServerParameters", restServerParameters.validate());
83 if (databaseProviderParameters == null) {
84 validationResult.setResult("databaseProviderParameters", ValidationStatus.INVALID,
85 "must have databaseProviderParameters to configure api rest server");
87 validationResult.setResult("databaseProviderParameters", databaseProviderParameters.validate());
89 return validationResult;