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.core.engine.executor;
  22
  23 import static org.onap.policy.apex.model.utilities.Assertions.argumentNotNull;
  24
  25 import java.util.Map;
  26
  27 import org.onap.policy.apex.context.ContextException;
  28 import org.onap.policy.apex.core.engine.ExecutorParameters;
  29 import org.onap.policy.apex.core.engine.context.ApexInternalContext;
  30 import org.onap.policy.apex.core.engine.executor.context.StateFinalizerExecutionContext;
  31 import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
  32 import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
  33 import org.onap.policy.apex.model.policymodel.concepts.AxState;
  34 import org.onap.policy.apex.model.policymodel.concepts.AxStateFinalizerLogic;
  35 import org.slf4j.ext.XLogger;
  36 import org.slf4j.ext.XLoggerFactory;
  37
  38 /**
  39  * This abstract class executes state finalizer logic in a state of an Apex policy and is
  40  * specialized by classes that implement execution of state finalizer logic.
  41  *
  42  * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
  43  * @author Liam Fallon (liam.fallon@ericsson.com)
  44  */
  45 public abstract class StateFinalizerExecutor
  46         implements Executor<Map<String, Object>, String, AxStateFinalizerLogic, ApexInternalContext> {
  47     // Logger for this class
  48     private static final XLogger LOGGER = XLoggerFactory.getXLogger(StateFinalizerExecutor.class);
  49
  50     // Hold the state and context definitions
  51     private Executor<?, ?, ?, ?> parent = null;
  52     private AxState axState = null;
  53     private AxStateFinalizerLogic finalizerLogic = null;
  54     private ApexInternalContext internalContext = null;
  55
  56     // Holds the incoming and outgoing fields
  57     private Map<String, Object> incomingFields = null;
  58
  59     // The next state finalizer executor
  60     private Executor<Map<String, Object>, String, AxStateFinalizerLogic, ApexInternalContext> nextExecutor = null;
  61
  62     // The execution context; contains the facades for events and context to be used by tasks
  63     // executed by this task
  64     // executor
  65     private StateFinalizerExecutionContext executionContext = null;
  66
  67     /**
  68      * Gets the execution internalContext.
  69      *
  70      * @return the execution context
  71      */
  72     protected StateFinalizerExecutionContext getExecutionContext() {
  73         return executionContext;
  74     }
  75
  76     /*
  77      * (non-Javadoc)
  78      *
  79      * @see org.onap.policy.apex.core.engine.executor.Executor#setContext(org.onap.policy.apex.core.
  80      * engine.executor.Executor, java.lang.Object, java.lang.Object)
  81      */
  82     @Override
  83     public void setContext(final Executor<?, ?, ?, ?> incomingParent,
  84             final AxStateFinalizerLogic incomingFinalizerLogic, final ApexInternalContext incomingInternalContext) {
  85         this.parent = incomingParent;
  86         axState = (AxState) parent.getSubject();
  87         this.finalizerLogic = incomingFinalizerLogic;
  88         this.internalContext = incomingInternalContext;
  89     }
  90
  91     /*
  92      * (non-Javadoc)
  93      *
  94      * @see org.onap.policy.apex.core.engine.executor.Executor#prepare()
  95      */
  96     @Override
  97     public void prepare() throws StateMachineException {
  98         LOGGER.debug("prepare:" + finalizerLogic.getID() + "," + finalizerLogic.getLogicFlavour() + ","
  99                 + finalizerLogic.getLogic());
 100         argumentNotNull(finalizerLogic.getLogic(), StateMachineException.class, "task logic cannot be null.");
 101     }
 102
 103     /*
 104      * (non-Javadoc)
 105      *
 106      * @see org.onap.policy.apex.core.engine.executor.Executor#execute(java.lang.long,
 107      * java.lang.Object)
 108      */
 109     @Override
 110     public String execute(final long executionID, final Map<String, Object> newIncomingFields)
 111             throws StateMachineException, ContextException {
 112         throw new StateMachineException(
 113                 "execute() not implemented on abstract StateFinalizerExecutionContext class, only on its subclasses");
 114     }
 115
 116     /*
 117      * (non-Javadoc)
 118      *
 119      * @see org.onap.policy.apex.core.engine.executor.Executor#executePre(java.lang.long,
 120      * java.lang.Object)
 121      */
 122     @Override
 123     public final void executePre(final long executionID, final Map<String, Object> newIncomingFields)
 124             throws StateMachineException, ContextException {
 125         LOGGER.debug("execute-pre:" + finalizerLogic.getLogicFlavour() + "," + getSubject().getID() + ","
 126                 + finalizerLogic.getLogic());
 127
 128         // Record the incoming fields
 129         this.incomingFields = newIncomingFields;
 130
 131         // Get state finalizer context object
 132         executionContext = new StateFinalizerExecutionContext(this, executionID, axState, getIncoming(),
 133                 axState.getStateOutputs().keySet(), getContext());
 134     }
 135
 136     /*
 137      * (non-Javadoc)
 138      *
 139      * @see org.onap.policy.apex.core.engine.executor.Executor#executePost(boolean)
 140      */
 141     @Override
 142     public final void executePost(final boolean returnValue) throws StateMachineException, ContextException {
 143         if (!returnValue) {
 144             String errorMessage = "execute-post: state finalizer logic execution failure on state \"" + axState.getID()
 145                     + "\" on finalizer logic " + finalizerLogic.getID();
 146             if (executionContext.getMessage() != null) {
 147                 errorMessage += ", user message: " + executionContext.getMessage();
 148             }
 149             LOGGER.warn(errorMessage);
 150             throw new StateMachineException(errorMessage);
 151         }
 152
 153         // Check a state output has been selected
 154         if (getOutgoing() == null) {
 155             LOGGER.warn("execute-post: state finalizer logic \"" + finalizerLogic.getID()
 156                     + "\" did not select an output state");
 157             throw new StateMachineException("execute-post: state finalizer logic \"" + finalizerLogic.getID()
 158                     + "\" did not select an output state");
 159         }
 160
 161         if (!axState.getStateOutputs().keySet().contains(getOutgoing())) {
 162             LOGGER.warn(
 163                     "execute-post: state finalizer logic \"" + finalizerLogic.getID() + "\" selected output state \""
 164                             + getOutgoing() + "\" that does not exsist on state \"" + axState.getID() + "\"");
 165             throw new StateMachineException(
 166                     "execute-post: state finalizer logic \"" + finalizerLogic.getID() + "\" selected output state \""
 167                             + getOutgoing() + "\" that does not exsist on state \"" + axState.getID() + "\"");
 168         }
 169
 170         LOGGER.debug("execute-post:" + finalizerLogic.getID() + ", returning  state output \"" + getOutgoing()
 171                 + " and fields " + incomingFields);
 172     }
 173
 174     /*
 175      * (non-Javadoc)
 176      *
 177      * @see org.onap.policy.apex.core.engine.executor.Executor#cleanUp()
 178      */
 179     @Override
 180     public void cleanUp() throws StateMachineException {
 181         throw new StateMachineException("cleanUp() not implemented on class");
 182     }
 183
 184     /*
 185      * (non-Javadoc)
 186      *
 187      * @see org.onap.policy.apex.core.engine.executor.Executor#getKey()
 188      */
 189     @Override
 190     public AxReferenceKey getKey() {
 191         return finalizerLogic.getKey();
 192     }
 193
 194     /*
 195      * (non-Javadoc)
 196      *
 197      * @see org.onap.policy.apex.core.engine.executor.Executor#getParent()
 198      */
 199     @Override
 200     public Executor<?, ?, ?, ?> getParent() {
 201         return parent;
 202     }
 203
 204     /*
 205      * (non-Javadoc)
 206      *
 207      * @see org.onap.policy.apex.core.engine.executor.Executor#getSubject()
 208      */
 209     @Override
 210     public AxStateFinalizerLogic getSubject() {
 211         return finalizerLogic;
 212     }
 213
 214     /*
 215      * (non-Javadoc)
 216      *
 217      * @see org.onap.policy.apex.core.engine.executor.Executor#getContext()
 218      */
 219     @Override
 220     public ApexInternalContext getContext() {
 221         return internalContext;
 222     }
 223
 224     /*
 225      * (non-Javadoc)
 226      *
 227      * @see org.onap.policy.apex.core.engine.executor.Executor#getIncoming()
 228      */
 229     @Override
 230     public Map<String, Object> getIncoming() {
 231         return incomingFields;
 232     }
 233
 234     /*
 235      * (non-Javadoc)
 236      *
 237      * @see org.onap.policy.apex.core.engine.executor.Executor#getOutgoing()
 238      */
 239     @Override
 240     public String getOutgoing() {
 241         return executionContext.getSelectedStateOutputName();
 242     }
 243
 244     /*
 245      * (non-Javadoc)
 246      *
 247      * @see
 248      * org.onap.policy.apex.core.engine.executor.Executor#setNext(org.onap.policy.apex.core.engine.
 249      * executor.Executor)
 250      */
 251     @Override
 252     public void setNext(final Executor<Map<String, Object>, String, AxStateFinalizerLogic, ApexInternalContext>
 253                         incomingNextExecutor) {
 254         this.nextExecutor = incomingNextExecutor;
 255     }
 256
 257     /*
 258      * (non-Javadoc)
 259      *
 260      * @see org.onap.policy.apex.core.engine.executor.Executor#getNext()
 261      */
 262     @Override
 263     public Executor<Map<String, Object>, String, AxStateFinalizerLogic, ApexInternalContext> getNext() {
 264         return nextExecutor;
 265     }
 266
 267     /*
 268      * (non-Javadoc)
 269      *
 270      * @see
 271      * org.onap.policy.apex.core.engine.executor.Executor#setParameters(org.onap.policy.apex.core.
 272      * engine. ExecutorParameters)
 273      */
 274     @Override
 275     public void setParameters(final ExecutorParameters parameters) {}
 276 }