gerrit.onap Code Review - policy/apex-pdp.git/blob

   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.plugins.event.protocol.jms;
  22
  23 import java.lang.reflect.Method;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26
  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().getCanonicalName() + "\" 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      * (non-Javadoc)
  74      *
  75      * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object)
  76      */
  77     @Override
  78     public List<ApexEvent> toApexEvent(final String eventName, final Object eventObject) throws ApexEventException {
  79         // Look for a "getObject()" method on the incoming object, if there is no such method, then we cannot fetch the
  80         // object from JMS
  81         Method getObjectMethod;
  82         try {
  83             getObjectMethod = eventObject.getClass().getMethod("getObject", (Class<?>[]) null);
  84         } catch (Exception e) {
  85             final String errorMessage = "message \"" + eventObject
  86                             + "\" received from JMS does not have a \"getObject()\" method";
  87             LOGGER.warn(errorMessage, e);
  88             throw new ApexEventRuntimeException(errorMessage);
  89         }
  90
  91         Object jmsIncomingObject;
  92         try {
  93             jmsIncomingObject = getObjectMethod.invoke(eventObject, (Object[]) null);
  94         } catch (final Exception e) {
  95             final String errorMessage = "object contained in message \"" + eventObject
  96                             + "\" received from JMS could not be retrieved as a Java object";
  97             LOGGER.debug(errorMessage, e);
  98             throw new ApexEventRuntimeException(errorMessage, e);
  99         }
 100
 101         // Check that the consumer parameters for JMS->Apex messaging have been set
 102         if (eventProtocolParameters == null) {
 103             final String errorMessage = "consumer parameters for JMS events consumed by "
 104                             + "Apex are not set in the Apex configuration for this engine";
 105             LOGGER.debug(errorMessage);
 106             throw new ApexEventRuntimeException(errorMessage);
 107         }
 108
 109         // Create the Apex event
 110         // @formatter:off
 111         final ApexEvent apexEvent = new ApexEvent(
 112                         jmsIncomingObject.getClass().getSimpleName() + eventProtocolParameters.getIncomingEventSuffix(),
 113                         eventProtocolParameters.getIncomingEventVersion(),
 114                         jmsIncomingObject.toString().getClass().getPackage().getName(),
 115                         eventProtocolParameters.getIncomingEventSource(),
 116                         eventProtocolParameters.getIncomingEventTarget());
 117         // @formatter:on
 118
 119         // Set the data on the apex event as the incoming object
 120         apexEvent.put(jmsIncomingObject.getClass().getSimpleName(), jmsIncomingObject);
 121
 122         // Return the event in a single element
 123         final ArrayList<ApexEvent> eventList = new ArrayList<>();
 124         eventList.add(apexEvent);
 125         return eventList;
 126     }
 127
 128     /*
 129      * (non-Javadoc)
 130      *
 131      * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#fromApexEvent
 132      * (org.onap.policy.apex.service.engine.event.ApexEvent)
 133      */
 134     @Override
 135     public Object fromApexEvent(final ApexEvent apexEvent) throws ApexEventException {
 136         // Check the Apex event
 137         if (apexEvent == null) {
 138             LOGGER.warn("event processing failed, Apex event is null");
 139             throw new ApexEventException("event processing failed, Apex event is null");
 140         }
 141
 142         // Check that the Apex event has a single parameter
 143         if (apexEvent.size() != 1) {
 144             final String errorMessage = "event processing failed, "
 145                             + "Apex event must have one and only one parameter for JMS Object handling";
 146             LOGGER.warn(errorMessage);
 147             throw new ApexEventException(errorMessage);
 148         }
 149
 150         // Return the single object from the Apex event message
 151         return apexEvent.values().iterator().next();
 152     }
 153 }