2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2020 Nordix Foundation.
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.apex.services.onappf.parameters;
25 import org.onap.policy.apex.services.onappf.ApexStarterCommandLineArguments;
26 import org.onap.policy.apex.services.onappf.exception.ApexStarterException;
27 import org.onap.policy.common.parameters.GroupValidationResult;
28 import org.onap.policy.common.utils.coder.Coder;
29 import org.onap.policy.common.utils.coder.CoderException;
30 import org.onap.policy.common.utils.coder.StandardCoder;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
35 * This class handles reading, parsing and validating of apex starter parameters from JSON files.
37 * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
39 public class ApexStarterParameterHandler {
41 private static final Logger LOGGER = LoggerFactory.getLogger(ApexStarterParameterHandler.class);
42 private static final Coder CODER = new StandardCoder();
45 * Read the parameters from the parameter file.
47 * @param arguments the arguments passed to apex starter
48 * @return the parameters read from the configuration file
49 * @throws ApexStarterException on parameter exceptions
51 public ApexStarterParameterGroup getParameters(final ApexStarterCommandLineArguments arguments)
52 throws ApexStarterException {
53 ApexStarterParameterGroup apexStarterParameterGroup = null;
55 // Read the parameters
57 // Read the parameters from JSON
58 final File file = new File(arguments.getFullConfigurationFilePath());
59 apexStarterParameterGroup = CODER.decode(file, ApexStarterParameterGroup.class);
60 } catch (final CoderException e) {
61 final String errorMessage = "error reading parameters from \"" + arguments.getConfigurationFilePath()
62 + "\"\n" + "(" + e.getClass().getSimpleName() + "):" + e.getMessage();
63 throw new ApexStarterException(errorMessage, e);
66 // The JSON processing returns null if there is an empty file
67 if (apexStarterParameterGroup == null) {
68 final String errorMessage = "no parameters found in \"" + arguments.getConfigurationFilePath() + "\"";
69 LOGGER.error(errorMessage);
70 throw new ApexStarterException(errorMessage);
73 // validate the parameters
74 final GroupValidationResult validationResult = apexStarterParameterGroup.validate();
75 if (!validationResult.isValid()) {
76 String returnMessage =
77 "validation error(s) on parameters from \"" + arguments.getConfigurationFilePath() + "\"\n";
78 returnMessage += validationResult.getResult();
80 LOGGER.error(returnMessage);
81 throw new ApexStarterException(returnMessage);
84 return apexStarterParameterGroup;