2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2016-2018 Ericsson. All rights reserved.
4 * Modifications Copyright (C) 2019-2020 Nordix Foundation.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.apex.plugins.executor.javascript;
25 import java.util.Properties;
27 import org.onap.policy.apex.context.ContextException;
28 import org.onap.policy.apex.core.engine.executor.TaskExecutor;
29 import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
30 import org.slf4j.ext.XLogger;
31 import org.slf4j.ext.XLoggerFactory;
34 * The Class JavascriptTaskExecutor is the task executor for task logic written in Javascript It is unlikely that this
37 * @author Liam Fallon (liam.fallon@ericsson.com)
39 public class JavascriptTaskExecutor extends TaskExecutor {
40 // Logger for this class
41 private static final XLogger LOGGER = XLoggerFactory.getXLogger(JavascriptTaskExecutor.class);
43 private JavascriptExecutor javascriptExecutor;
46 * Prepares the task for processing.
48 * @throws StateMachineException thrown when a state machine execution error occurs
51 public void prepare() throws StateMachineException {
52 // Call generic prepare logic
55 // Create the executor
56 if (javascriptExecutor == null) {
57 javascriptExecutor = new JavascriptExecutor(getSubject().getKey());
60 // Initialize and cleanup the executor to check the Javascript code
61 javascriptExecutor.init(getSubject().getTaskLogic().getLogic());
65 * Executes the executor for the task in a sequential manner.
67 * @param executionId the execution ID for the current APEX policy execution
68 * @param executionProperties properties for the current APEX policy execution
69 * @param incomingFields the incoming fields
70 * @return The outgoing fields
71 * @throws StateMachineException on an execution error
72 * @throws ContextException on context errors
75 public Map<String, Object> execute(final long executionId, final Properties executionProperties,
76 final Map<String, Object> incomingFields) throws StateMachineException, ContextException {
78 // Do execution pre work
79 executePre(executionId, executionProperties, incomingFields);
81 // Execute the Javascript executor
82 boolean result = javascriptExecutor.execute(getExecutionContext());
84 // Execute the Javascript
91 * Cleans up the task after processing.
93 * @throws StateMachineException thrown when a state machine execution error occurs
96 public void cleanUp() throws StateMachineException {
97 LOGGER.debug("cleanUp:" + getSubject().getKey().getId() + "," + getSubject().getTaskLogic().getLogicFlavour()
98 + "," + getSubject().getTaskLogic().getLogic());
100 if (javascriptExecutor != null) {
101 javascriptExecutor.cleanUp();
104 javascriptExecutor = null;