aboutsummaryrefslogtreecommitdiffstats
path: root/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java
diff options
context:
space:
mode:
Diffstat (limited to 'services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java')
-rw-r--r--services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java100
1 files changed, 100 insertions, 0 deletions
diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java
new file mode 100644
index 000000000..79f10bdea
--- /dev/null
+++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java
@@ -0,0 +1,100 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.apex.service.parameters;
+
+import java.io.FileReader;
+
+import org.onap.policy.apex.core.engine.EngineParameters;
+import org.onap.policy.apex.service.engine.main.ApexCommandLineArguments;
+import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
+import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParametersJSONAdapter;
+import org.onap.policy.apex.service.parameters.engineservice.EngineServiceParametersJSONAdapter;
+import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters;
+import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParametersJSONAdapter;
+import org.slf4j.ext.XLogger;
+import org.slf4j.ext.XLoggerFactory;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
+/**
+ * This class handles reading, parsing and validating of Apex parameters from JSON files.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+public class ApexParameterHandler {
+ private static final XLogger LOGGER = XLoggerFactory.getXLogger(ApexParameterHandler.class);
+
+ /**
+ * Read the parameters from the parameter file.
+ *
+ * @param arguments the arguments passed to Apex
+ * @return the parameters read from the configuration file
+ * @throws ApexParameterException on parameter exceptions
+ */
+ public ApexParameters getParameters(final ApexCommandLineArguments arguments) throws ApexParameterException {
+ ApexParameters parameters = null;
+
+ // Read the parameters
+ try {
+ // Register the adapters for our carrier technologies and event protocols with GSON
+ // @formatter:off
+ final Gson gson = new GsonBuilder()
+ .registerTypeAdapter(EngineParameters .class, new EngineServiceParametersJSONAdapter())
+ .registerTypeAdapter(CarrierTechnologyParameters.class, new CarrierTechnologyParametersJSONAdapter())
+ .registerTypeAdapter(EventProtocolParameters .class, new EventProtocolParametersJSONAdapter())
+ .create();
+ // @formatter:on
+ parameters = gson.fromJson(new FileReader(arguments.getFullConfigurationFilePath()), ApexParameters.class);
+ } catch (final Exception e) {
+ final String errorMessage = "error reading parameters from \"" + arguments.getConfigurationFilePath()
+ + "\"\n" + "(" + e.getClass().getSimpleName() + "):" + e.getMessage();
+ LOGGER.error(errorMessage, e);
+ throw new ApexParameterException(errorMessage, e);
+ }
+
+ // The JSON processing returns null if there is an empty file
+ if (parameters == null) {
+ final String errorMessage = "no parameters found in \"" + arguments.getConfigurationFilePath() + "\"";
+ LOGGER.error(errorMessage);
+ throw new ApexParameterException(errorMessage);
+ }
+
+ // Check if we should override the model file parameter
+ final String modelFilePath = arguments.getModelFilePath();
+ if (modelFilePath != null && modelFilePath.replaceAll("\\s+", "").length() > 0) {
+ parameters.getEngineServiceParameters().setPolicyModelFileName(modelFilePath);
+ }
+
+ // validate the parameters
+ final String validationResult = parameters.validate();
+ if (!validationResult.isEmpty()) {
+ String returnMessage =
+ "validation error(s) on parameters from \"" + arguments.getConfigurationFilePath() + "\"\n";
+ returnMessage += validationResult;
+
+ LOGGER.error(returnMessage);
+ throw new ApexParameterException(returnMessage);
+ }
+
+ return parameters;
+ }
+}