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