plugins/plugins-executor/plugins-executor-javascript/src/main/java/org/onap/policy/apex/plugins/executor/javascript/JavascriptTaskSelectExecutor.java

   1 /*-
   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
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.plugins.executor.javascript;
  23
  24 import java.util.Properties;
  25
  26 import org.onap.policy.apex.context.ContextException;
  27 import org.onap.policy.apex.core.engine.event.EnEvent;
  28 import org.onap.policy.apex.core.engine.executor.TaskSelectExecutor;
  29 import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
  30 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  31 import org.slf4j.ext.XLogger;
  32 import org.slf4j.ext.XLoggerFactory;
  33
  34 /**
  35  * The Class JavascriptTaskSelectExecutor is the task selection executor for task selection logic written in Javascript
  36  * It is unlikely that this is thread safe.
  37  *
  38  * @author Liam Fallon (liam.fallon@ericsson.com)
  39  */
  40 public class JavascriptTaskSelectExecutor extends TaskSelectExecutor {
  41     // Logger for this class
  42     private static final XLogger LOGGER = XLoggerFactory.getXLogger(JavascriptTaskSelectExecutor.class);
  43
  44     private JavascriptExecutor javascriptExecutor;
  45
  46     /**
  47      * Prepares the task selection logic for processing.
  48      *
  49      * @throws StateMachineException thrown when a state machine execution error occurs
  50      */
  51     @Override
  52     public void prepare() throws StateMachineException {
  53         // Call generic prepare logic
  54         super.prepare();
  55
  56         // Create the executor
  57         if (javascriptExecutor == null) {
  58             javascriptExecutor = new JavascriptExecutor(getSubject().getKey());
  59         }
  60
  61         // Initialize and cleanup the executor to check the Javascript code
  62         javascriptExecutor.init(getSubject().getTaskSelectionLogic().getLogic());
  63     }
  64
  65     /**
  66      * Executes the executor for the task in a sequential manner.
  67      *
  68      * @param executionId the execution ID for the current APEX policy execution
  69      * @param executionProperties properties for the current APEX policy execution
  70      * @param incomingEvent the incoming event
  71      * @return The outgoing event
  72      * @throws StateMachineException on an execution error
  73      * @throws ContextException on context errors
  74      */
  75     @Override
  76     public AxArtifactKey execute(final long executionId, final Properties executionProperties,
  77         final EnEvent incomingEvent) throws StateMachineException, ContextException {
  78         // Do execution pre work
  79         executePre(executionId, executionProperties, incomingEvent);
  80
  81         // Execute the Javascript executor
  82         boolean result = javascriptExecutor.execute(getExecutionContext());
  83
  84         // Execute the Javascript
  85         executePost(result);
  86
  87         return getOutgoing();
  88     }
  89
  90     /**
  91      * Cleans up the task after processing.
  92      *
  93      * @throws StateMachineException thrown when a state machine execution error occurs
  94      */
  95     @Override
  96     public void cleanUp() throws StateMachineException {
  97         LOGGER.debug(
  98             "cleanUp:" + getSubject().getKey().getId() + "," + getSubject().getTaskSelectionLogic().getLogicFlavour()
  99                 + "," + getSubject().getTaskSelectionLogic().getLogic());
 100
 101         javascriptExecutor.cleanUp();
 102     }
 103 }