core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/context/TaskSelectionExecutionContext.java

   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.context;
  22
  23 import java.util.ArrayList;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.TreeMap;
  27
  28 import org.onap.policy.apex.context.ContextAlbum;
  29 import org.onap.policy.apex.context.ContextRuntimeException;
  30 import org.onap.policy.apex.core.engine.context.ApexInternalContext;
  31 import org.onap.policy.apex.core.engine.event.EnEvent;
  32 import org.onap.policy.apex.core.engine.executor.Executor;
  33 import org.onap.policy.apex.core.engine.executor.TaskSelectExecutor;
  34 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  35 import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
  36 import org.onap.policy.apex.model.policymodel.concepts.AxState;
  37 import org.slf4j.ext.XLogger;
  38 import org.slf4j.ext.XLoggerFactory;
  39
  40 /**
  41  * Container class for the execution context for Task Selection logic executions in a task being
  42  * executed in an Apex engine. The task must have easy access to the state definition, the incoming
  43  * and outgoing event contexts, as well as the policy, global, and external context.
  44  *
  45  * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
  46  */
  47 public class TaskSelectionExecutionContext {
  48     // Logger for task execution
  49     private static final XLogger EXECUTION_LOGGER =
  50             XLoggerFactory.getXLogger("org.onap.policy.apex.executionlogging.TaskSelectionExecutionLogging");
  51
  52     // CHECKSTYLE:OFF: checkstyle:VisibilityModifier Logic has access to these field
  53
  54     /** A constant <code>boolean true</code> value available for reuse e.g., for the return value */
  55     public final Boolean TRUE = true;
  56
  57     /**
  58      * A constant <code>boolean false</code> value available for reuse e.g., for the return value
  59      */
  60     public final Boolean FALSE = false;
  61
  62     /** A facade to the full state definition for the task selection logic being executed. */
  63     public final AxStateFacade subject;
  64
  65     /** the execution ID for the current APEX policy execution instance. */
  66     public final Long executionID;
  67
  68     /**
  69      * The incoming fields from the trigger event for the state. The task selection logic can access
  70      * these fields to decide what task to select for the state.
  71      */
  72     public final Map<String, Object> inFields;
  73
  74     /**
  75      * The task that the task selection logic has selected for a state. The task selection logic
  76      * sets this field in its logic prior to executing and the Apex engine executes this task as the
  77      * task for this state.
  78      */
  79     public final AxArtifactKey selectedTask;
  80
  81     /**
  82      * Logger for task selection execution, task selection logic can use this field to access and
  83      * log to Apex logging.
  84      */
  85     public final XLogger logger = EXECUTION_LOGGER;
  86
  87     // CHECKSTYLE:ON: checkstyle:VisibilityModifier
  88
  89     // All available context albums
  90     private final Map<String, ContextAlbum> context;
  91
  92     // A message specified in the logic
  93     private String message;
  94
  95     /**
  96      * Instantiates a new task selection execution context.
  97      *
  98      * @param taskSelectExecutor the task selection executor that requires context
  99      * @param executionID the execution identifier
 100      * @param axState the state definition that is the subject of execution
 101      * @param incomingEvent the incoming event for the state
 102      * @param outgoingKey the outgoing key for the task to execute in this state
 103      * @param internalContext the execution context of the Apex engine in which the task is being
 104      *        executed
 105      */
 106     public TaskSelectionExecutionContext(final TaskSelectExecutor taskSelectExecutor, final long executionID,
 107             final AxState axState, final EnEvent incomingEvent, final AxArtifactKey outgoingKey,
 108             final ApexInternalContext internalContext) {
 109         // The subject is the state definition
 110         subject = new AxStateFacade(axState);
 111
 112         // Execution ID is the current policy execution instance
 113         this.executionID = executionID;
 114
 115         // The events
 116         inFields = incomingEvent;
 117         selectedTask = outgoingKey;
 118
 119         // Set up the context albums for this task
 120         // Set up the context albums for this task
 121         context = new TreeMap<>();
 122         for (final AxArtifactKey mapKey : subject.state.getContextAlbumReferences()) {
 123             context.put(mapKey.getName(), internalContext.getContextAlbums().get(mapKey));
 124         }
 125
 126         // Get the artifact stack of the users of the policy
 127         final List<AxConcept> usedArtifactStack = new ArrayList<>();
 128         for (Executor<?, ?, ?, ?> parent = taskSelectExecutor.getParent(); parent != null; parent =
 129                 parent.getParent()) {
 130             // Add each parent to the top of the stack
 131             usedArtifactStack.add(0, parent.getKey());
 132         }
 133
 134         // Add the events to the artifact stack
 135         usedArtifactStack.add(incomingEvent.getKey());
 136
 137         // Change the stack to an array
 138         final AxConcept[] usedArtifactStackArray = usedArtifactStack.toArray(new AxConcept[usedArtifactStack.size()]);
 139
 140         // Set the user of the context
 141         // Set the user of the context
 142         for (final ContextAlbum contextAlbum : context.values()) {
 143             contextAlbum.setUserArtifactStack(usedArtifactStackArray);
 144         }
 145         incomingEvent.setUserArtifactStack(usedArtifactStackArray);
 146     }
 147
 148     /**
 149      * Return a context album if it exists in the context definition of this state.
 150      *
 151      * @param contextAlbumName The context album name
 152      * @return The context albumxxxxxx
 153      * @throws ContextRuntimeException if the context album does not exist on the state for this
 154      *         executor
 155      */
 156     public ContextAlbum getContextAlbum(final String contextAlbumName) throws ContextRuntimeException {
 157         // Find the context album
 158         final ContextAlbum foundContextAlbum = context.get(contextAlbumName);
 159
 160         // Check if the context album exists
 161         if (foundContextAlbum != null) {
 162             return foundContextAlbum;
 163         } else {
 164             throw new ContextRuntimeException("cannot find definition of context album \"" + contextAlbumName
 165                     + "\" on state \"" + subject.getId() + "\"");
 166         }
 167     }
 168
 169     /**
 170      * Gets the user message.
 171      *
 172      * @return the user message
 173      */
 174     public String getMessage() {
 175         return message;
 176     }
 177
 178     /**
 179      * Sets the user message.
 180      *
 181      * @param message the message
 182      */
 183     public void setMessage(final String message) {
 184         this.message = message;
 185     }
 186 }