gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.plugins.executor.jython;
  22
  23 import java.util.Map;
  24
  25 import org.onap.policy.apex.context.ContextException;
  26 import org.onap.policy.apex.core.engine.executor.TaskExecutor;
  27 import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
  28 import org.python.core.Py;
  29 import org.python.core.PyCode;
  30 import org.python.core.PyException;
  31 import org.python.util.PythonInterpreter;
  32 import org.slf4j.ext.XLogger;
  33 import org.slf4j.ext.XLoggerFactory;
  34
  35 /**
  36  * The Class JythonTaskExecutor is the task executor for task logic written in Jython It is unlikely that this is thread
  37  * safe.
  38  *
  39  * @author Liam Fallon (liam.fallon@ericsson.com)
  40  */
  41 public class JythonTaskExecutor extends TaskExecutor {
  42     // Logger for this class
  43     private static final XLogger LOGGER = XLoggerFactory.getXLogger(JythonTaskExecutor.class);
  44
  45     // The Jython interpreter
  46     private final PythonInterpreter interpreter = new PythonInterpreter();
  47     private PyCode compiled = null;
  48
  49     /**
  50      * Prepares the task for processing.
  51      *
  52      * @throws StateMachineException thrown when a state machine execution error occurs
  53      */
  54     @Override
  55     public void prepare() throws StateMachineException {
  56         interpreter.setErr(System.err);
  57         interpreter.setOut(System.out);
  58
  59         // Call generic prepare logic
  60         super.prepare();
  61         try {
  62             synchronized (Py.class) {
  63                 compiled = Py.compile_flags(getSubject().getTaskLogic().getLogic(),
  64                         "<" + getSubject().getKey().toString() + ">", "exec", null);
  65             }
  66         } catch (final PyException e) {
  67             LOGGER.warn("failed to compile Jython code for task " + getSubject().getKey().getID(), e);
  68             throw new StateMachineException("failed to compile Jython code for task " + getSubject().getKey().getID(),
  69                     e);
  70         }
  71
  72     }
  73
  74     /**
  75      * Executes the executor for the task in a sequential manner.
  76      *
  77      * @param executionID the execution ID for the current APEX policy execution
  78      * @param incomingFields the incoming fields
  79      * @return The outgoing fields
  80      * @throws StateMachineException on an execution error
  81      * @throws ContextException on context errors
  82      */
  83     @Override
  84     public Map<String, Object> execute(final long executionID, final Map<String, Object> incomingFields)
  85             throws StateMachineException, ContextException {
  86
  87         boolean returnValue = false;
  88
  89         // Do execution pre work
  90         executePre(executionID, incomingFields);
  91
  92         try {
  93
  94             // Check and execute the Jython logic
  95             /* Precompiled Version */
  96             synchronized (Py.class) {
  97                 // Set up the Jython engine
  98                 interpreter.set("executor", getExecutionContext());
  99                 interpreter.exec(compiled);
 100                 try {
 101                     final Object ret = interpreter.get("returnValue", java.lang.Boolean.class);
 102                     if (ret == null) {
 103                         LOGGER.error("execute: task logic failed to set a return value for task  \""
 104                                 + getSubject().getKey().getID() + "\"");
 105                         throw new StateMachineException("execute: task logic failed to set a return value for task  \""
 106                                 + getSubject().getKey().getID() + "\"");
 107                     }
 108                     returnValue = (Boolean) ret;
 109                 } catch (NullPointerException | ClassCastException e) {
 110                     LOGGER.error("execute: task selection logic failed to set a correct return value for state  \""
 111                             + getSubject().getKey().getID() + "\"", e);
 112                     throw new StateMachineException(
 113                             "execute: task selection logic failed to set a return value for state  \""
 114                                     + getSubject().getKey().getID() + "\"",
 115                             e);
 116                 }
 117             }
 118             /* */
 119         } catch (final Exception e) {
 120             LOGGER.warn("failed to execute Jython code for task " + getSubject().getKey().getID(), e);
 121             throw new StateMachineException("failed to execute Jython code for task " + getSubject().getKey().getID(),
 122                     e);
 123         }
 124
 125         // Do the execution post work
 126         executePost(returnValue);
 127
 128         // Send back the return event
 129         if (returnValue) {
 130             return getOutgoing();
 131         } else {
 132             return null;
 133         }
 134     }
 135
 136     /**
 137      * Cleans up the task after processing.
 138      *
 139      * @throws StateMachineException thrown when a state machine execution error occurs
 140      */
 141     @Override
 142     public void cleanUp() throws StateMachineException {
 143         interpreter.cleanup();
 144         LOGGER.debug("cleanUp:" + getSubject().getKey().getID() + "," + getSubject().getTaskLogic().getLogicFlavour()
 145                 + "," + getSubject().getTaskLogic().getLogic());
 146     }
 147 }