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;
24 import org.onap.policy.common.endpoints.parameters.RestServerParameters;
25 import org.onap.policy.common.parameters.GroupValidationResult;
26 import org.onap.policy.common.parameters.ParameterGroup;
27 import org.onap.policy.common.parameters.ValidationStatus;
28 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
29 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
32 * Class to hold all parameters needed for Api component.
35 public class ApiParameterGroup implements ParameterGroup {
38 private RestServerParameters restServerParameters;
39 private PolicyModelsProviderParameters databaseProviderParameters;
40 private List<String> preloadPolicyTypes;
43 * Create the api parameter group.
45 * @param name the parameter group name
46 * @param restServerParameters the parameters for instantiating API rest server
47 * @param databaseProviderParameters the parameters for instantiating database provider
48 * @param preloadPolicyTypes the list of preloaded policy types
50 public ApiParameterGroup(final String name, final RestServerParameters restServerParameters,
51 final PolicyModelsProviderParameters databaseProviderParameters, final List<String> preloadPolicyTypes) {
53 this.restServerParameters = restServerParameters;
54 this.databaseProviderParameters = databaseProviderParameters;
55 this.preloadPolicyTypes = preloadPolicyTypes;
59 * Return the name of this parameter group instance.
61 * @return name the parameter group name
64 public String getName() {
69 * Set the name of this parameter group instance.
71 * @param name the parameter group name
74 public void setName(String name) {
79 * Return the restServerParameters of this parameter group instance.
81 * @return the restServerParameters
83 public RestServerParameters getRestServerParameters() {
84 return restServerParameters;
88 * Return the databaseProviderParameters of this parameter group instance.
90 * @return the databaseProviderParameters
92 public PolicyModelsProviderParameters getDatabaseProviderParameters() {
93 return databaseProviderParameters;
97 * Return the preloadPolicyTypes of this parameter group instance.
99 * @return the preloadPolicyTypes
101 public List<String> getPreloadPolicyTypes() {
102 return preloadPolicyTypes;
106 * Validate the parameter group.
108 * @return the result of the validation
111 public GroupValidationResult validate() {
112 final GroupValidationResult validationResult = new GroupValidationResult(this);
113 if (!ParameterValidationUtils.validateStringParameter(name)) {
114 validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
116 if (restServerParameters == null) {
117 validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
118 "must have restServerParameters to configure api rest server");
120 validationResult.setResult("restServerParameters", restServerParameters.validate());
122 if (databaseProviderParameters == null) {
123 validationResult.setResult("databaseProviderParameters", ValidationStatus.INVALID,
124 "must have databaseProviderParameters to configure api rest server");
126 validationResult.setResult("databaseProviderParameters", databaseProviderParameters.validate());
128 return validationResult;