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.java;
  22
  23 import java.lang.reflect.Method;
  24
  25 import org.onap.policy.apex.context.ContextException;
  26 import org.onap.policy.apex.core.engine.event.EnEvent;
  27 import org.onap.policy.apex.core.engine.executor.TaskSelectExecutor;
  28 import org.onap.policy.apex.core.engine.executor.context.TaskSelectionExecutionContext;
  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 JavaTaskSelectExecutor is the task selection executor for task selection logic written in Java.
  36  *
  37  * @author Liam Fallon (liam.fallon@ericsson.com)
  38  */
  39 public class JavaTaskSelectExecutor extends TaskSelectExecutor {
  40     // Logger for this class
  41     private static final XLogger LOGGER = XLoggerFactory.getXLogger(JavaTaskSelectExecutor.class);
  42
  43     // The Java Task Selection executor class
  44     private Object taskSelectionLogicObject = null;
  45
  46     /**
  47      * Prepares the task 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         // Get the class for task selection
  57         try {
  58             // Create the task logic object from the byte code of the class
  59             taskSelectionLogicObject = Class.forName(getSubject().getTaskSelectionLogic().getLogic()).newInstance();
  60         } catch (final Exception e) {
  61             LOGGER.error("instantiation error on Java class" + taskSelectionLogicObject, e);
  62             throw new StateMachineException("instantiation error on Java class" + taskSelectionLogicObject, e);
  63         }
  64     }
  65
  66     /**
  67      * Executes the executor for the task in a sequential manner.
  68      *
  69      * @param executionId the execution ID 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 EnEvent incomingEvent)
  77             throws StateMachineException, ContextException {
  78         // Do execution pre work
  79         executePre(executionId, incomingEvent);
  80
  81         // Check and execute the Java logic
  82         boolean returnValue = false;
  83         try {
  84             // Find and call the method with the signature "public boolean getTask(final TaskSelectionExecutionContext
  85             // executor)" to invoke the task selection
  86             // logic in the Java class
  87             final Method method = taskSelectionLogicObject.getClass().getDeclaredMethod("getTask", (Class[])
  88                     new Class[] { TaskSelectionExecutionContext.class });
  89             returnValue = (boolean) method.invoke(taskSelectionLogicObject, getExecutionContext());
  90         } catch (final Exception e) {
  91             LOGGER.error(
  92                     "execute: task selection logic failed to run for state  \"" + getSubject().getKey().getId() + "\"",
  93                     e);
  94             throw new StateMachineException(
  95                     "task selection logic failed to run for state  \"" + getSubject().getKey().getId() + "\"", e);
  96         }
  97
  98         // Do the execution post work
  99         executePost(returnValue);
 100
 101         // Send back the return event
 102         if (returnValue) {
 103             return getOutgoing();
 104         } else {
 105             return null;
 106         }
 107     }
 108
 109     /**
 110      * Cleans up the task after processing.
 111      *
 112      * @throws StateMachineException thrown when a state machine execution error occurs
 113      */
 114     @Override
 115     public void cleanUp() throws StateMachineException {
 116         LOGGER.debug("cleanUp:" + getSubject().getKey().getId() + ","
 117                 + getSubject().getTaskSelectionLogic().getLogicFlavour() + ","
 118                 + getSubject().getTaskSelectionLogic().getLogic());
 119     }
 120 }