aboutsummaryrefslogtreecommitdiffstats
path: root/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/ExecutorParameters.java
blob: 7bff07d9a6e8a93b77db25cef64cae9825be33a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. 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 org.onap.policy.common.parameters.ParameterGroupImpl;

/**
 * This class provides the executors for a logic flavour. Plugin classes for execution of task
 * logic, task selection logic, and state finalizer logic for the logic flavour must be specified.
 *
 * <p>Specializations of this class may provide extra parameters for their specific logic flavour
 * executors.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class ExecutorParameters extends ParameterGroupImpl {
    // Executor Plugin classes for executors
    private String taskExecutorPluginClass;
    private String taskSelectionExecutorPluginClass;
    private String stateFinalizerExecutorPluginClass;

    /**
     * Constructor to create an executor parameters instance and register the instance with the
     * parameter service.
     */
    public ExecutorParameters() {
        super(EngineParameterConstants.EXECUTOR_GROUP_NAME);
    }

    /**
     * Gets the task executor plugin class for the executor.
     *
     * @return the task executor plugin class for the executor
     */
    public String getTaskExecutorPluginClass() {
        return taskExecutorPluginClass;
    }

    /**
     * Sets the task executor plugin class for the executor.
     *
     * @param taskExecutorPluginClass the task executor plugin class for the executor
     */
    public void setTaskExecutorPluginClass(final String taskExecutorPluginClass) {
        this.taskExecutorPluginClass = taskExecutorPluginClass;
    }

    /**
     * Gets the task selection executor plugin class for the executor.
     *
     * @return the task selection executor plugin class for the executor
     */
    public String getTaskSelectionExecutorPluginClass() {
        return taskSelectionExecutorPluginClass;
    }

    /**
     * Sets the task selection executor plugin class for the executor.
     *
     * @param taskSelectionExecutorPluginClass the task selection executor plugin class for the
     *        executor
     */
    public void setTaskSelectionExecutorPluginClass(final String taskSelectionExecutorPluginClass) {
        this.taskSelectionExecutorPluginClass = taskSelectionExecutorPluginClass;
    }

    /**
     * Gets the state finalizer executor plugin class for the executor.
     *
     * @return the state finalizer executor plugin class for the executor
     */
    public String getStateFinalizerExecutorPluginClass() {
        return stateFinalizerExecutorPluginClass;
    }

    /**
     * Sets the state finalizer executor plugin class for the executor.
     *
     * @param stateFinalizerExecutorPluginClass the state finalizer executor plugin class for the
     *        executor
     */
    public void setStateFinalizerExecutorPluginClass(final String stateFinalizerExecutorPluginClass) {
        this.stateFinalizerExecutorPluginClass = stateFinalizerExecutorPluginClass;
    }

    @Override
    public String toString() {
        return "ExecutorParameters [name=" + getName() + ", taskExecutorPluginClass=" + taskExecutorPluginClass
                        + ", taskSelectionExecutorPluginClass=" + taskSelectionExecutorPluginClass
                        + ", stateFinalizerExecutorPluginClass=" + stateFinalizerExecutorPluginClass + "]";
    }
}