2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.sim.dmaap.parameters;
25 import org.onap.policy.common.parameters.GroupValidationResult;
26 import org.onap.policy.common.utils.coder.Coder;
27 import org.onap.policy.common.utils.coder.CoderException;
28 import org.onap.policy.common.utils.coder.StandardCoder;
29 import org.onap.policy.models.sim.dmaap.DmaapSimException;
30 import org.onap.policy.models.sim.dmaap.startstop.DmaapSimCommandLineArguments;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
35 * This class handles reading, parsing and validating of DMaaP simulator parameters from JSON files.
37 public class DmaapSimParameterHandler {
39 private static final Logger LOGGER = LoggerFactory.getLogger(DmaapSimParameterHandler.class);
41 private final Coder coder = new StandardCoder();
44 * Read the parameters from the parameter file.
46 * @param arguments the arguments passed to DMaaP simulator
47 * @return the parameters read from the configuration file
48 * @throws DmaapSimException on parameter exceptions
50 public DmaapSimParameterGroup getParameters(final DmaapSimCommandLineArguments arguments) throws DmaapSimException {
51 DmaapSimParameterGroup dmaapSimParameterGroup = null;
53 // Read the parameters
55 // Read the parameters from JSON
56 File file = new File(arguments.getFullConfigurationFilePath());
57 dmaapSimParameterGroup = coder.decode(file, DmaapSimParameterGroup.class);
58 } catch (final CoderException e) {
59 final String errorMessage = "error reading parameters from \"" + arguments.getConfigurationFilePath()
60 + "\"\n" + "(" + e.getClass().getSimpleName() + "):" + e.getMessage();
61 LOGGER.error(errorMessage);
62 throw new DmaapSimException(errorMessage, e);
65 // The JSON processing returns null if there is an empty file
66 if (dmaapSimParameterGroup == null) {
67 final String errorMessage = "no parameters found in \"" + arguments.getConfigurationFilePath() + "\"";
68 LOGGER.error(errorMessage);
69 throw new DmaapSimException(errorMessage);
72 // validate the parameters
73 final GroupValidationResult validationResult = dmaapSimParameterGroup.validate();
74 if (!validationResult.isValid()) {
75 String returnMessage =
76 "validation error(s) on parameters from \"" + arguments.getConfigurationFilePath() + "\"\n";
77 returnMessage += validationResult.getResult();
79 LOGGER.error(returnMessage);
80 throw new DmaapSimException(returnMessage);
83 return dmaapSimParameterGroup;