services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/enevent/ApexEvent2EnEventConverter.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.service.engine.event.impl.enevent;
  22
  23 import java.util.ArrayList;
  24 import java.util.List;
  25
  26 import org.onap.policy.apex.core.engine.engine.ApexEngine;
  27 import org.onap.policy.apex.core.engine.event.EnEvent;
  28 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  29 import org.onap.policy.apex.model.basicmodel.service.ModelService;
  30 import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
  31 import org.onap.policy.apex.model.eventmodel.concepts.AxEvents;
  32 import org.onap.policy.apex.service.engine.event.ApexEvent;
  33 import org.onap.policy.apex.service.engine.event.ApexEventConverter;
  34 import org.onap.policy.apex.service.engine.event.ApexEventException;
  35 import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
  36 import org.slf4j.ext.XLogger;
  37 import org.slf4j.ext.XLoggerFactory;
  38
  39 /**
  40  * The Class ApexEvent2EnEventConverter converts externally facing {@link ApexEvent} instances to
  41  * and from instances of {@link EnEvent} that are used internally in the Apex engine core.
  42  *
  43  * @author Liam Fallon (liam.fallon@ericsson.com)
  44  */
  45 public final class ApexEvent2EnEventConverter implements ApexEventConverter {
  46     private static final XLogger LOGGER = XLoggerFactory.getXLogger(ApexEvent2EnEventConverter.class);
  47
  48     // The Apex engine with its event definitions
  49     private final ApexEngine apexEngine;
  50
  51     /**
  52      * Set up the event converter.
  53      *
  54      * @param apexEngine The engine to use to create events to be converted
  55      */
  56     public ApexEvent2EnEventConverter(final ApexEngine apexEngine) {
  57         this.apexEngine = apexEngine;
  58     }
  59
  60     /**
  61      * {@inheritDoc}.
  62      */
  63     @Override
  64     public List<ApexEvent> toApexEvent(final String eventName, final Object event) throws ApexException {
  65         // Check the Engine event
  66         if (event == null) {
  67             LOGGER.warn("event processing failed, engine event is null");
  68             throw new ApexEventException("event processing failed, engine event is null");
  69         }
  70
  71         // Cast the event to an Engine event event, if our conversion is correctly configured, this
  72         // cast should always work
  73         EnEvent enEvent = null;
  74         try {
  75             enEvent = (EnEvent) event;
  76         } catch (final Exception e) {
  77             final String errorMessage = "error transferring event \"" + event + "\" to the Apex engine";
  78             LOGGER.debug(errorMessage, e);
  79             throw new ApexEventRuntimeException(errorMessage, e);
  80         }
  81
  82         // Create the Apex event
  83         final AxEvent axEvent = enEvent.getAxEvent();
  84         final ApexEvent apexEvent = new ApexEvent(axEvent.getKey().getName(), axEvent.getKey().getVersion(),
  85                 axEvent.getNameSpace(), axEvent.getSource(), axEvent.getTarget());
  86
  87         apexEvent.setExecutionId(enEvent.getExecutionId());
  88         apexEvent.setExecutionProperties(enEvent.getExecutionProperties());
  89
  90         // Copy he exception message to the Apex event if it is set
  91         if (enEvent.getExceptionMessage() != null) {
  92             apexEvent.setExceptionMessage(enEvent.getExceptionMessage());
  93         }
  94
  95         // Set the data on the apex event
  96         apexEvent.putAll(enEvent);
  97
  98         // Return the event in a single element
  99         final ArrayList<ApexEvent> eventList = new ArrayList<>();
 100         eventList.add(apexEvent);
 101         return eventList;
 102     }
 103
 104     /**
 105      * {@inheritDoc}.
 106      */
 107     @Override
 108     public EnEvent fromApexEvent(final ApexEvent apexEvent) throws ApexException {
 109         // Check the Apex model
 110         if (apexEngine == null) {
 111             LOGGER.warn("event processing failed, apex engine is null");
 112             throw new ApexEventException("event processing failed, apex engine is null");
 113         }
 114
 115         // Get the event definition
 116         final AxEvent eventDefinition = ModelService.getModel(AxEvents.class).get(apexEvent.getName());
 117         if (eventDefinition == null) {
 118             LOGGER.warn("event processing failed, event \"" + apexEvent.getName() + "\" not found in apex model");
 119             throw new ApexEventException(
 120                     "event processing failed, event \"" + apexEvent.getName() + "\" not found in apex model");
 121         }
 122
 123         // Create the internal engine event
 124         final EnEvent enEvent = apexEngine.createEvent(eventDefinition.getKey());
 125
 126         // Set the data on the engine event
 127         enEvent.putAll(apexEvent);
 128
 129         enEvent.setExecutionId(apexEvent.getExecutionId());
 130         enEvent.setExecutionProperties(apexEvent.getExecutionProperties());
 131
 132         return enEvent;
 133     }
 134 }