core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/context/StateFinalizerExecutionContext.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.Set;
  29 import java.util.TreeMap;
  30 import lombok.Getter;
  31 import lombok.Setter;
  32 import org.onap.policy.apex.context.ContextAlbum;
  33 import org.onap.policy.apex.context.ContextRuntimeException;
  34 import org.onap.policy.apex.core.engine.context.ApexInternalContext;
  35 import org.onap.policy.apex.core.engine.executor.Executor;
  36 import org.onap.policy.apex.core.engine.executor.StateFinalizerExecutor;
  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 state finalizer logic executions in a state being executed in an Apex
  45  * engine. The state finalizer must have easy access to the state definition, the fields, as well as the policy, global,
  46  * and external context.
  47  *
  48  * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
  49  */
  50 @Getter
  51 public class StateFinalizerExecutionContext {
  52     /**
  53      * Logger for state finalizer execution, state finalizer logic can use this field to access and log to Apex logging.
  54      */
  55     private static final XLogger EXCEUTION_LOGGER =
  56             XLoggerFactory.getXLogger("org.onap.policy.apex.executionlogging.StateFinalizerExecutionLogging");
  57
  58     // CHECKSTYLE:OFF: checkstyle:VisibilityModifier Logic has access to these field
  59
  60     /** A facade to the full state definition for the state finalizer logic being executed. */
  61     public final AxStateFacade subject;
  62
  63     /** the execution ID for the current APEX policy execution instance. */
  64     public final Long executionId;
  65
  66     /**
  67      * The list of state outputs for this state finalizer. The purpose of a state finalizer is to select a state output
  68      * for a state from this list of state output names.
  69      */
  70     public final Set<String> stateOutputNames;
  71
  72     /**
  73      * The fields of this state finalizer. A state finalizer receives this list of fields from a task and may use these
  74      * fields to determine what state output to select. Once a state finalizer has selected a state output, it must
  75      * marshal these fields so that they match the fields required for the event defined in the state output.
  76      */
  77     public final Map<String, Object> fields;
  78
  79     /**
  80      * The state output that the state finalizer logic has selected for a state. The state finalizer logic sets this
  81      * field in its logic after executing and the Apex engine uses this state output for this state.
  82      */
  83     private String selectedStateOutputName;
  84
  85     /**
  86      * Logger for state finalizer execution, state finalizer logic can use this field to access and log to Apex logging.
  87      */
  88     public final XLogger logger = EXCEUTION_LOGGER;
  89
  90     // CHECKSTYLE:ON: checkstyle:visibilityModifier
  91
  92     // All available context albums
  93     private final Map<String, ContextAlbum> context;
  94
  95     // A message specified in the logic
  96     @Getter
  97     @Setter
  98     private String message;
  99
 100     // Execution properties for a policy execution
 101     @Getter
 102     private Properties executionProperties;
 103
 104     /**
 105      * Instantiates a new state finalizer execution context.
 106      *
 107      * @param stateFinalizerExecutor the state finalizer executor that requires context
 108      * @param executionId the execution ID for the current APEX policy execution instance
 109      * @param executionProperties the execution properties for task execution
 110      * @param axState the state definition that is the subject of execution
 111      * @param fields the fields to be manipulated by the state finalizer
 112      * @param stateOutputNames the state output names, one of which will be selected by the state finalizer
 113      * @param internalContext the execution context of the Apex engine in which the task is being executed
 114      */
 115     public StateFinalizerExecutionContext(final StateFinalizerExecutor stateFinalizerExecutor, final long executionId,
 116             final Properties executionProperties, final AxState axState, final Map<String, Object> fields,
 117             final Set<String> stateOutputNames, final ApexInternalContext internalContext) {
 118         subject = new AxStateFacade(axState);
 119
 120         // Execution ID is the current policy execution instance
 121         this.executionId = executionId;
 122         this.executionProperties = executionProperties;
 123
 124         this.fields = fields;
 125         this.stateOutputNames = stateOutputNames;
 126
 127         // Set up the context albums for this task
 128         context = new TreeMap<>();
 129         for (final AxArtifactKey mapKey : subject.state.getContextAlbumReferences()) {
 130             context.put(mapKey.getName(), internalContext.getContextAlbums().get(mapKey));
 131         }
 132
 133         // Get the artifact stack of the users of the policy
 134         final List<AxConcept> usedArtifactStack = new ArrayList<>();
 135         for (Executor<?, ?, ?, ?> parent = stateFinalizerExecutor.getParent(); parent != null; parent =
 136                 parent.getParent()) {
 137             // Add each parent to the top of the stack
 138             usedArtifactStack.add(0, parent.getKey());
 139         }
 140
 141         // Change the stack to an array
 142         final AxConcept[] usedArtifactStackArray = usedArtifactStack.toArray(new AxConcept[usedArtifactStack.size()]);
 143
 144         // Set the user of the context
 145         // Set the user of the context
 146         for (final ContextAlbum contextAlbum : context.values()) {
 147             contextAlbum.setUserArtifactStack(usedArtifactStackArray);
 148         }
 149     }
 150
 151     /**
 152      * Return a context album if it exists in the context definition of this state.
 153      *
 154      * @param contextAlbumName The context album name
 155      * @return The context album
 156      * @throws ContextRuntimeException if the context album does not exist on the state for this executor
 157      */
 158     public ContextAlbum getContextAlbum(final String contextAlbumName) {
 159         // Find the context album
 160         final ContextAlbum foundContextAlbum = context.get(contextAlbumName);
 161
 162         // Check if the context album exists
 163         if (foundContextAlbum != null) {
 164             return foundContextAlbum;
 165         } else {
 166             throw new ContextRuntimeException("cannot find definition of context album \"" + contextAlbumName
 167                     + "\" on state \"" + subject.getId() + "\"");
 168         }
 169     }
 170
 171     /**
 172      * Return the state output name selected by the state finalizer logic.
 173      *
 174      * @return the state output name
 175      */
 176     public String getSelectedStateOutputName() {
 177         return selectedStateOutputName;
 178     }
 179
 180     /**
 181      * Set the state output name selected by the state finalizer logic.
 182      *
 183      * @param selectedStateOutputName the state output name
 184      */
 185     public void setSelectedStateOutputName(final String selectedStateOutputName) {
 186         this.selectedStateOutputName = selectedStateOutputName;
 187     }
 188 }