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;
24 import org.onap.policy.apex.services.onappf.ApexStarterCommandLineArguments;
25 import org.onap.policy.apex.services.onappf.exception.ApexStarterException;
26 import org.onap.policy.common.parameters.GroupValidationResult;
27 import org.onap.policy.common.utils.coder.Coder;
28 import org.onap.policy.common.utils.coder.CoderException;
29 import org.onap.policy.common.utils.coder.StandardCoder;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
34 * This class handles reading, parsing and validating of apex starter parameters from JSON files.
36 * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
38 public class ApexStarterParameterHandler {
40 private static final Logger LOGGER = LoggerFactory.getLogger(ApexStarterParameterHandler.class);
41 private static final Coder CODER = new StandardCoder();
44 * Read the parameters from the parameter file.
46 * @param arguments the arguments passed to apex starter
47 * @return the parameters read from the configuration file
48 * @throws ApexStarterException on parameter exceptions
50 public ApexStarterParameterGroup getParameters(final ApexStarterCommandLineArguments arguments)
51 throws ApexStarterException {
52 ApexStarterParameterGroup apexStarterParameterGroup = null;
54 // Read the parameters
56 // Read the parameters from JSON
57 final File file = new File(arguments.getFullConfigurationFilePath());
58 apexStarterParameterGroup = CODER.decode(file, ApexStarterParameterGroup.class);
59 } catch (final CoderException e) {
60 final String errorMessage = "error reading parameters from \"" + arguments.getConfigurationFilePath()
61 + "\"\n" + "(" + e.getClass().getSimpleName() + "):" + e.getMessage();
62 throw new ApexStarterException(errorMessage, e);
65 // The JSON processing returns null if there is an empty file
66 if (apexStarterParameterGroup == null) {
67 final String errorMessage = "no parameters found in \"" + arguments.getConfigurationFilePath() + "\"";
68 LOGGER.error(errorMessage);
69 throw new ApexStarterException(errorMessage);
72 // validate the parameters
73 final GroupValidationResult validationResult = apexStarterParameterGroup.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 ApexStarterException(returnMessage);
83 return apexStarterParameterGroup;