plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsObjectEventConverter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019 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.plugins.event.protocol.jms;
  23
  24 import java.lang.reflect.Method;
  25 import java.util.ArrayList;
  26 import java.util.List;
  27
  28 import org.onap.policy.apex.service.engine.event.ApexEvent;
  29 import org.onap.policy.apex.service.engine.event.ApexEventException;
  30 import org.onap.policy.apex.service.engine.event.ApexEventProtocolConverter;
  31 import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
  32 import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters;
  33 import org.slf4j.ext.XLogger;
  34 import org.slf4j.ext.XLoggerFactory;
  35
  36 /**
  37  * The Class Apex2JMSObjectEventConverter converts {@link ApexEvent} instances into string instances of object message
  38  * events for JMS.
  39  *
  40  * @author Liam Fallon (liam.fallon@ericsson.com)
  41  */
  42 public final class Apex2JmsObjectEventConverter implements ApexEventProtocolConverter {
  43     private static final XLogger LOGGER = XLoggerFactory.getXLogger(Apex2JmsObjectEventConverter.class);
  44
  45     // JMS event protocol parameters on the consumer (JMS->Apex) sides
  46     private JmsObjectEventProtocolParameters eventProtocolParameters = null;
  47
  48     /**
  49      * Constructor to create the Apex to JMS Object converter.
  50      *
  51      * @throws ApexEventException the apex event exception
  52      */
  53     public Apex2JmsObjectEventConverter() throws ApexEventException {
  54         // Nothing specific to initiate for this plugin
  55     }
  56
  57     @Override
  58     public void init(final EventProtocolParameters parameters) {
  59         // Check if properties have been set for JMS object event conversion as a consumer. They may not be set because
  60         // JMS may not be in use
  61         // on both sides of Apex
  62         if (!(parameters instanceof JmsObjectEventProtocolParameters)) {
  63             final String errormessage = "specified Event Protocol Parameters properties of type \""
  64                             + parameters.getClass().getName() + "\" are not applicable to a "
  65                             + Apex2JmsObjectEventConverter.class.getName() + " converter";
  66             LOGGER.error(errormessage);
  67         } else {
  68             this.eventProtocolParameters = (JmsObjectEventProtocolParameters) parameters;
  69         }
  70
  71     }
  72
  73     /**
  74      * {@inheritDoc}.
  75      */
  76     @Override
  77     public List<ApexEvent> toApexEvent(final String eventName, final Object eventObject) throws ApexEventException {
  78         // Look for a "getObject()" method on the incoming object, if there is no such method, then we cannot fetch the
  79         // object from JMS
  80         Method getObjectMethod;
  81         try {
  82             getObjectMethod = eventObject.getClass().getMethod("getObject", (Class<?>[]) null);
  83         } catch (Exception e) {
  84             final String errorMessage = "message \"" + eventObject
  85                             + "\" received from JMS does not have a \"getObject()\" method";
  86             LOGGER.warn(errorMessage, e);
  87             throw new ApexEventRuntimeException(errorMessage);
  88         }
  89
  90         Object jmsIncomingObject;
  91         try {
  92             jmsIncomingObject = getObjectMethod.invoke(eventObject, (Object[]) null);
  93         } catch (final Exception e) {
  94             final String errorMessage = "object contained in message \"" + eventObject
  95                             + "\" received from JMS could not be retrieved as a Java object";
  96             LOGGER.debug(errorMessage, e);
  97             throw new ApexEventRuntimeException(errorMessage, e);
  98         }
  99
 100         // Check that the consumer parameters for JMS->Apex messaging have been set
 101         if (eventProtocolParameters == null) {
 102             final String errorMessage = "consumer parameters for JMS events consumed by "
 103                             + "Apex are not set in the Apex configuration for this engine";
 104             LOGGER.debug(errorMessage);
 105             throw new ApexEventRuntimeException(errorMessage);
 106         }
 107
 108         // Create the Apex event
 109         // @formatter:off
 110         final ApexEvent apexEvent = new ApexEvent(
 111                         jmsIncomingObject.getClass().getSimpleName() + eventProtocolParameters.getIncomingEventSuffix(),
 112                         eventProtocolParameters.getIncomingEventVersion(),
 113                         jmsIncomingObject.toString().getClass().getPackage().getName(),
 114                         eventProtocolParameters.getIncomingEventSource(),
 115                         eventProtocolParameters.getIncomingEventTarget());
 116         // @formatter:on
 117
 118         // Set the data on the apex event as the incoming object
 119         apexEvent.put(jmsIncomingObject.getClass().getSimpleName(), jmsIncomingObject);
 120
 121         // Return the event in a single element
 122         final ArrayList<ApexEvent> eventList = new ArrayList<>();
 123         eventList.add(apexEvent);
 124         return eventList;
 125     }
 126
 127     /**
 128      * {@inheritDoc}.
 129      */
 130     @Override
 131     public Object fromApexEvent(final ApexEvent apexEvent) throws ApexEventException {
 132         // Check the Apex event
 133         if (apexEvent == null) {
 134             LOGGER.warn("event processing failed, Apex event is null");
 135             throw new ApexEventException("event processing failed, Apex event is null");
 136         }
 137
 138         // Check that the Apex event has a single parameter
 139         if (apexEvent.size() != 1) {
 140             final String errorMessage = "event processing failed, "
 141                             + "Apex event must have one and only one parameter for JMS Object handling";
 142             LOGGER.warn(errorMessage);
 143             throw new ApexEventException(errorMessage);
 144         }
 145
 146         // Return the single object from the Apex event message
 147         return apexEvent.values().iterator().next();
 148     }
 149 }