artifactbroker/main/src/main/java/org/onap/policy/distribution/main/parameters/DistributionParameterGroup.java

   1 /*-
   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
   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.distribution.main.parameters;
  22
  23 import java.util.LinkedHashMap;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26
  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;
  33
  34 /**
  35  * Class to hold all parameters needed for Distribution component.
  36  *
  37  * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
  38  */
  39 public class DistributionParameterGroup implements ParameterGroup {
  40     // @formatter:off
  41     private String name;
  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<>();
  48     // @formatter:on
  49
  50     /**
  51      * Create the distribution parameter group.
  52      *
  53      * @param name the parameter group name
  54      */
  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) {
  59         this.name = name;
  60         this.restServerParameters = restServerParameters;
  61         this.receptionHandlerParameters = receptionHandlerParameters;
  62         this.receptionHandlerConfigurationParameters = receptionHandlerConfigurationParameters;
  63         this.artifactForwarderConfigurationParameters = artifactForwarderConfigurationParameters;
  64     }
  65
  66     /**
  67      * Return the name of this parameter group instance.
  68      *
  69      * @return name the parameter group name
  70      */
  71     @Override
  72     public String getName() {
  73         return name;
  74     }
  75
  76     /**
  77      * Set the name of this parameter group instance.
  78      *
  79      * @param name the parameter group name
  80      */
  81     @Override
  82     public void setName(final String name) {
  83         this.name = name;
  84     }
  85
  86     /**
  87      * Return the receptionHandlerParameters of this parameter group instance.
  88      *
  89      * @return the receptionHandlerParameters
  90      */
  91     public Map<String, ReceptionHandlerParameters> getReceptionHandlerParameters() {
  92         return receptionHandlerParameters;
  93     }
  94
  95     /**
  96      * Return the restServerParameters of this parameter group instance.
  97      *
  98      * @return the restServerParameters
  99      */
 100     public RestServerParameters getRestServerParameters() {
 101         return restServerParameters;
 102     }
 103
 104     /**
 105      * Gets the reception handler configuration parameter map.
 106      *
 107      * @return the reception handler configuration parameter map
 108      */
 109     public Map<String, ReceptionHandlerConfigurationParameterGroup> getReceptionHandlerConfigurationParameters() {
 110         return receptionHandlerConfigurationParameters;
 111     }
 112
 113     /**
 114      * Sets the reception handler configuration parameter map.
 115      *
 116      * @param receptionHandlerConfigurationParameters the reception handler configuration parameters
 117      */
 118     public void setReceptionHandlerConfigurationParameters(
 119         final Map<String, ReceptionHandlerConfigurationParameterGroup> receptionHandlerConfigurationParameters) {
 120         this.receptionHandlerConfigurationParameters = receptionHandlerConfigurationParameters;
 121     }
 122
 123     /**
 124      * Gets the policy forwarder configuration parameter map.
 125      *
 126      * @return the policy forwarder configuration parameter map
 127      */
 128     public Map<String, ArtifactForwarderConfigurationParameterGroup> getArtifactForwarderConfigurationParameters() {
 129         return artifactForwarderConfigurationParameters;
 130     }
 131
 132     /**
 133      * Sets the policy forwarder configuration parameter map.
 134      *
 135      * @param artifactForwarderConfigurationParameters the policy forwarder configuration parameters
 136      */
 137     public void setArtifactForwarderConfigurationParameters(
 138         final Map<String, ArtifactForwarderConfigurationParameterGroup> artifactForwarderConfigurationParameters) {
 139         this.artifactForwarderConfigurationParameters = artifactForwarderConfigurationParameters;
 140     }
 141
 142     /**
 143      * Validate the parameter group.
 144      *
 145      * @return the result of the validation
 146      */
 147     @Override
 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");
 152         }
 153         if (restServerParameters == null) {
 154             validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
 155                 "must have restServerParameters to configure distribution rest server");
 156         } else {
 157             validationResult.setResult("restServerParameters", restServerParameters.validate());
 158         }
 159         validateReceptionHandlers(validationResult);
 160         validateForwarderConfigurations(validationResult);
 161         return validationResult;
 162     }
 163
 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");
 168         } else {
 169             for (final Entry<String, ReceptionHandlerParameters> nestedGroupEntry : receptionHandlerParameters
 170                 .entrySet()) {
 171                 validationResult.setResult("receptionHandlerParameters", nestedGroupEntry.getKey(),
 172                     nestedGroupEntry.getValue().validate());
 173             }
 174         }
 175     }
 176
 177     private void validateForwarderConfigurations(final GroupValidationResult validationResult) {
 178         // @formatter:off
 179         for (final Entry<String, ArtifactForwarderConfigurationParameterGroup> configurationParameters :
 180             artifactForwarderConfigurationParameters.entrySet()) {
 181             validationResult.setResult("artifactForwarderConfigurationParameters", configurationParameters.getKey(),
 182                 configurationParameters.getValue().validate());
 183         }
 184         // @formatter:on
 185     }
 186
 187 }