2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2016-2018 Ericsson. All rights reserved.
4 * Modifications Copyright (C) 2019 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.jruby;
25 import java.util.Properties;
26 import org.jruby.embed.EmbedEvalUnit;
27 import org.jruby.embed.LocalContextScope;
28 import org.jruby.embed.LocalVariableBehavior;
29 import org.jruby.embed.ScriptingContainer;
30 import org.jruby.runtime.builtin.IRubyObject;
31 import org.onap.policy.apex.context.ContextException;
32 import org.onap.policy.apex.core.engine.executor.TaskExecutor;
33 import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
34 import org.slf4j.ext.XLogger;
35 import org.slf4j.ext.XLoggerFactory;
38 * The Class JrubyTaskExecutor is the task executor for task logic written in JRuby.
40 * @author Liam Fallon (liam.fallon@ericsson.com)
42 public class JrubyTaskExecutor extends TaskExecutor {
43 // Logger for this class
44 private static final XLogger LOGGER = XLoggerFactory.getXLogger(JrubyTaskExecutor.class);
47 private ScriptingContainer container = new ScriptingContainer(LocalContextScope.CONCURRENT,
48 LocalVariableBehavior.TRANSIENT, true);
49 private EmbedEvalUnit parsedjruby = null;
52 * Prepares the task for processing.
54 * @throws StateMachineException thrown when a state machine execution error occurs
57 public void prepare() throws StateMachineException {
58 // Call generic prepare logic
61 // Set up the JRuby engine
62 container = (container == null)
63 ? new ScriptingContainer(LocalContextScope.CONCURRENT, LocalVariableBehavior.TRANSIENT, true)
66 // Use the container.setError(System.err) and container.setOutput(System.out) method calls to redirect output
67 // and error to standard output and error for debugging
68 container.put("executor", getExecutionContext()); // needed for the compile
69 parsedjruby = container.parse(getSubject().getTaskLogic().getLogic());
73 * Executes the executor for the task in a sequential manner.
75 * @param executionId the execution ID for the current APEX policy execution
76 * @param executionProperties properties for the current APEX policy execution
77 * @param incomingFields the incoming fields
78 * @return The outgoing fields
79 * @throws StateMachineException on an execution error
80 * @throws ContextException on context errors
83 public Map<String, Object> execute(final long executionId, final Properties executionProperties,
84 final Map<String, Object> incomingFields) throws StateMachineException, ContextException {
85 // Do execution pre work
86 executePre(executionId, executionProperties, incomingFields);
88 // Check and execute the JRuby logic
89 container.put("executor", getExecutionContext());
91 /* Precompiled version */
92 boolean returnValue = false;
93 final IRubyObject ret = parsedjruby.run();
95 final Boolean retbool = ret.toJava(java.lang.Boolean.class);
96 if (retbool != null) {
101 // Do the execution post work
102 executePost(returnValue);
104 // Send back the return event
105 return getOutgoing();
109 * Cleans up the task after processing.
111 * @throws StateMachineException thrown when a state machine execution error occurs
114 public void cleanUp() throws StateMachineException {
115 LOGGER.debug("cleanUp:" + getSubject().getKey().getId() + "," + getSubject().getTaskLogic().getLogicFlavour()
116 + "," + getSubject().getTaskLogic().getLogic());
117 container.terminate();