2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2018 Ericsson. 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.distribution.main.parameters;
23 import java.util.LinkedHashMap;
25 import java.util.Map.Entry;
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.distribution.reception.parameters.ReceptionHandlerConfigurationParameterGroup;
32 import org.onap.policy.distribution.reception.parameters.ReceptionHandlerParameters;
35 * Class to hold all parameters needed for Distribution component.
37 * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
39 public class DistributionParameterGroup implements ParameterGroup {
42 private RestServerParameters restServerParameters;
43 private Map<String, ReceptionHandlerParameters> receptionHandlerParameters;
44 private Map<String, ReceptionHandlerConfigurationParameterGroup> receptionHandlerConfigurationParameters
45 = new LinkedHashMap<>();
46 private Map<String, ArtifactForwarderConfigurationParameterGroup> artifactForwarderConfigurationParameters
47 = new LinkedHashMap<>();
51 * Create the distribution parameter group.
53 * @param name the parameter group name
55 public DistributionParameterGroup(final String name, final RestServerParameters restServerParameters,
56 final Map<String, ReceptionHandlerParameters> receptionHandlerParameters,
57 final Map<String, ReceptionHandlerConfigurationParameterGroup> receptionHandlerConfigurationParameters,
58 final Map<String, ArtifactForwarderConfigurationParameterGroup> artifactForwarderConfigurationParameters) {
60 this.restServerParameters = restServerParameters;
61 this.receptionHandlerParameters = receptionHandlerParameters;
62 this.receptionHandlerConfigurationParameters = receptionHandlerConfigurationParameters;
63 this.artifactForwarderConfigurationParameters = artifactForwarderConfigurationParameters;
67 * Return the name of this parameter group instance.
69 * @return name the parameter group name
72 public String getName() {
77 * Set the name of this parameter group instance.
79 * @param name the parameter group name
82 public void setName(final String name) {
87 * Return the receptionHandlerParameters of this parameter group instance.
89 * @return the receptionHandlerParameters
91 public Map<String, ReceptionHandlerParameters> getReceptionHandlerParameters() {
92 return receptionHandlerParameters;
96 * Return the restServerParameters of this parameter group instance.
98 * @return the restServerParameters
100 public RestServerParameters getRestServerParameters() {
101 return restServerParameters;
105 * Gets the reception handler configuration parameter map.
107 * @return the reception handler configuration parameter map
109 public Map<String, ReceptionHandlerConfigurationParameterGroup> getReceptionHandlerConfigurationParameters() {
110 return receptionHandlerConfigurationParameters;
114 * Sets the reception handler configuration parameter map.
116 * @param receptionHandlerConfigurationParameters the reception handler configuration parameters
118 public void setReceptionHandlerConfigurationParameters(
119 final Map<String, ReceptionHandlerConfigurationParameterGroup> receptionHandlerConfigurationParameters) {
120 this.receptionHandlerConfigurationParameters = receptionHandlerConfigurationParameters;
124 * Gets the policy forwarder configuration parameter map.
126 * @return the policy forwarder configuration parameter map
128 public Map<String, ArtifactForwarderConfigurationParameterGroup> getArtifactForwarderConfigurationParameters() {
129 return artifactForwarderConfigurationParameters;
133 * Sets the policy forwarder configuration parameter map.
135 * @param artifactForwarderConfigurationParameters the policy forwarder configuration parameters
137 public void setArtifactForwarderConfigurationParameters(
138 final Map<String, ArtifactForwarderConfigurationParameterGroup> artifactForwarderConfigurationParameters) {
139 this.artifactForwarderConfigurationParameters = artifactForwarderConfigurationParameters;
143 * Validate the parameter group.
145 * @return the result of the validation
148 public GroupValidationResult validate() {
149 final GroupValidationResult validationResult = new GroupValidationResult(this);
150 if (!ParameterValidationUtils.validateStringParameter(name)) {
151 validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
153 if (restServerParameters == null) {
154 validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
155 "must have restServerParameters to configure distribution rest server");
157 validationResult.setResult("restServerParameters", restServerParameters.validate());
159 validateReceptionHandlers(validationResult);
160 validateForwarderConfigurations(validationResult);
161 return validationResult;
164 private void validateReceptionHandlers(final GroupValidationResult validationResult) {
165 if (receptionHandlerParameters == null || receptionHandlerParameters.size() == 0) {
166 validationResult.setResult("receptionHandlerParameters", ValidationStatus.INVALID,
167 "must have at least one reception handler");
169 for (final Entry<String, ReceptionHandlerParameters> nestedGroupEntry : receptionHandlerParameters
171 validationResult.setResult("receptionHandlerParameters", nestedGroupEntry.getKey(),
172 nestedGroupEntry.getValue().validate());
177 private void validateForwarderConfigurations(final GroupValidationResult validationResult) {
179 for (final Entry<String, ArtifactForwarderConfigurationParameterGroup> configurationParameters :
180 artifactForwarderConfigurationParameters.entrySet()) {
181 validationResult.setResult("artifactForwarderConfigurationParameters", configurationParameters.getKey(),
182 configurationParameters.getValue().validate());