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