plugins/plugins-executor/plugins-executor-mvel/src/main/java/org/onap/policy/apex/plugins/executor/mvel/MvelTaskSelectExecutor.java

   1 /*-
   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
   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.mvel;
  23
  24 import static org.onap.policy.common.utils.validation.Assertions.argumentNotNull;
  25
  26 import java.io.Serializable;
  27 import java.util.HashMap;
  28 import java.util.Properties;
  29 import org.mvel2.MVEL;
  30 import org.onap.policy.apex.context.ContextException;
  31 import org.onap.policy.apex.core.engine.event.EnEvent;
  32 import org.onap.policy.apex.core.engine.executor.TaskSelectExecutor;
  33 import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
  34 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  35 import org.slf4j.ext.XLogger;
  36 import org.slf4j.ext.XLoggerFactory;
  37
  38 /**
  39  * The Class MvelTaskSelectExecutor is the task selection executor for task selection logic written in MVEL.
  40  *
  41  * @author Liam Fallon (liam.fallon@ericsson.com)
  42  */
  43 public class MvelTaskSelectExecutor extends TaskSelectExecutor {
  44     // Logger for this class
  45     private static final XLogger LOGGER = XLoggerFactory.getXLogger(MvelTaskSelectExecutor.class);
  46
  47     // The MVEL code
  48     private Serializable compiled = null;
  49
  50     /**
  51      * Prepares the task for processing.
  52      *
  53      * @throws StateMachineException thrown when a state machine execution error occurs
  54      */
  55     @Override
  56     public void prepare() throws StateMachineException {
  57         // Call generic prepare logic
  58         super.prepare();
  59
  60         // Compile the MVEL code
  61         try {
  62             compiled = MVEL.compileExpression(getSubject().getTaskSelectionLogic().getLogic());
  63         } catch (final Exception e) {
  64             LOGGER.warn("failed to compile MVEL code for state " + getSubject().getKey().getId(), e);
  65             throw new StateMachineException("failed to compile MVEL code for state " + getSubject().getKey().getId(),
  66                     e);
  67         }
  68     }
  69
  70     /**
  71      * Executes the executor for the task in a sequential manner.
  72      *
  73      * @param executionId the execution ID for the current APEX policy execution
  74      * @param executionProperties properties for the current APEX policy execution
  75      * @param incomingEvent the incoming event
  76      * @return The outgoing event
  77      * @throws StateMachineException on an execution error
  78      * @throws ContextException on context errors
  79      */
  80     @Override
  81     public AxArtifactKey execute(final long executionId, final Properties executionProperties,
  82             final EnEvent incomingEvent) throws StateMachineException, ContextException {
  83         // Do execution pre work
  84         executePre(executionId, executionProperties, incomingEvent);
  85
  86         // Check and execute the MVEL logic
  87         argumentNotNull(compiled, "MVEL task not compiled.");
  88
  89         boolean returnValue = false;
  90         try {
  91             // Execute the MVEL code
  92             returnValue =
  93                     (boolean) MVEL.executeExpression(compiled, getExecutionContext(), new HashMap<String, Object>());
  94         } catch (final Exception e) {
  95             LOGGER.warn("failed to execute MVEL code for state " + getSubject().getKey().getId(), e);
  96             throw new StateMachineException("failed to execute MVEL code for state " + getSubject().getKey().getId(),
  97                     e);
  98         }
  99
 100         // Do the execution post work
 101         executePost(returnValue);
 102
 103         // Send back the return event
 104         return getOutgoing();
 105     }
 106
 107     /**
 108      * Cleans up the task after processing.
 109      *
 110      * @throws StateMachineException thrown when a state machine execution error occurs
 111      */
 112     @Override
 113     public void cleanUp() throws StateMachineException {
 114         LOGGER.debug("cleanUp:" + getSubject().getKey().getId() + ","
 115                 + getSubject().getTaskSelectionLogic().getLogicFlavour() + ","
 116                 + getSubject().getTaskSelectionLogic().getLogic());
 117     }
 118 }