summaryrefslogtreecommitdiffstats
path: root/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/EngineParameters.java
diff options
context:
space:
mode:
Diffstat (limited to 'core/core-engine/src/main/java/org/onap/policy/apex/core/engine/EngineParameters.java')
-rw-r--r--core/core-engine/src/main/java/org/onap/policy/apex/core/engine/EngineParameters.java95
1 files changed, 95 insertions, 0 deletions
diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/EngineParameters.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/EngineParameters.java
new file mode 100644
index 000000000..ff616979d
--- /dev/null
+++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/EngineParameters.java
@@ -0,0 +1,95 @@
+/*-
+ * ============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.core.engine;
+
+import java.util.Map;
+import java.util.TreeMap;
+
+import org.onap.policy.apex.context.parameters.ContextParameters;
+import org.onap.policy.apex.model.basicmodel.service.AbstractParameters;
+import org.onap.policy.apex.model.basicmodel.service.ParameterService;
+
+/**
+ * This class holds the parameters for a single Apex engine. This parameter class holds parameters for context schemas
+ * and context albums for the engine and a map of the logic flavour executors defined for the engine and the parameters
+ * for each of those executors.
+ * <p>
+ * The context parameters for the engine are held in a {@link ContextParameters} instance. This instance holds the
+ * parameters for context schema handling that will be used by the engine as well as the context album distribution,
+ * locking, and persistence parameters.
+ * <p>
+ * In Apex, an engine can be configured to use many logic flavours. The executors for each logic flavour are identified
+ * by their name. Each logic flavour executor must have an instance of {@link ExecutorParameters} defined for it, which
+ * specifies the executor plugins to use for that logic flavour executor and specific parameters for those executor
+ * plugins.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+public class EngineParameters extends AbstractParameters {
+ private ContextParameters contextParameters = new ContextParameters();
+
+ // A map of parameters for executors of various logic types
+ private Map<String, ExecutorParameters> executorParameterMap = new TreeMap<String, ExecutorParameters>();
+
+ /**
+ * Constructor to create an engine parameters instance and register the instance with the parameter service.
+ */
+ public EngineParameters() {
+ super(EngineParameters.class.getCanonicalName());
+ ParameterService.registerParameters(EngineParameters.class, this);
+ }
+
+ /**
+ * Gets the parameters for context schema and album handling.
+ *
+ * @return the parameters for context schema and album handling
+ */
+ public ContextParameters getContextParameters() {
+ return contextParameters;
+ }
+
+ /**
+ * Sets the parameters for context schema and album handling.
+ *
+ * @param contextParameters the parameters for context schema and album handling
+ */
+ public void setContextParameters(final ContextParameters contextParameters) {
+ this.contextParameters = contextParameters;
+ }
+
+ /**
+ * Gets the executor parameter map of the engine.
+ *
+ * @return the executor parameter map of the engine
+ */
+ public Map<String, ExecutorParameters> getExecutorParameterMap() {
+ return executorParameterMap;
+ }
+
+ /**
+ * Sets the executor parameter map of the engine.
+ *
+ * @param executorParameterMap the executor parameter map of the engine
+ */
+ public void setExecutorParameterMap(final Map<String, ExecutorParameters> executorParameterMap) {
+ this.executorParameterMap = executorParameterMap;
+ }
+}