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
  37  * object message 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
  51      *         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().getCanonicalName() + "\" 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      * (non-Javadoc)
  75      *
  76      * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object)
  77      */
  78     @Override
  79     public List<ApexEvent> toApexEvent(final String eventName, final Object eventObject) throws ApexEventException {
  80         // Look for a "getObject()" method on the incoming object, if there is no such method, then we cannot fetch the
  81         // object from JMS
  82         Method getObjectMethod;
  83         try {
  84             getObjectMethod = eventObject.getClass().getMethod("getObject", (Class<?>[]) null);
  85         } catch (Exception e) {
  86             final String errorMessage = "message \"" + eventObject
  87                             + "\" received from JMS does not have a \"getObject()\" method";
  88             LOGGER.warn(errorMessage);
  89             throw new ApexEventRuntimeException(errorMessage);
  90         }
  91
  92         Object jmsIncomingObject;
  93         try {
  94             jmsIncomingObject = getObjectMethod.invoke(eventObject, (Object[]) null);
  95         } catch (final Exception e) {
  96             final String errorMessage = "object contained in message \"" + eventObject
  97                             + "\" received from JMS could not be retrieved as a Java object";
  98             LOGGER.debug(errorMessage, e);
  99             throw new ApexEventRuntimeException(errorMessage, e);
 100         }
 101
 102         // Check that the consumer parameters for JMS->Apex messaging have been set
 103         if (eventProtocolParameters == null) {
 104             final String errorMessage = "consumer parameters for JMS events consumed by 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         // @formattter: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(org.onap.policy.apex.service.engine.event.ApexEvent)
 132      */
 133     @Override
 134     public Object fromApexEvent(final ApexEvent apexEvent) throws ApexEventException {
 135         // Check the Apex event
 136         if (apexEvent == null) {
 137             LOGGER.warn("event processing failed, Apex event is null");
 138             throw new ApexEventException("event processing failed, Apex event is null");
 139         }
 140
 141         // Check that the Apex event has a single parameter
 142         if (apexEvent.size() != 1) {
 143             final String errorMessage = "event processing failed, Apex event must have one and only one parameter for JMS Object handling";
 144             LOGGER.warn(errorMessage);
 145             throw new ApexEventException(errorMessage);
 146         }
 147
 148         // Return the single object from the Apex event message
 149         return apexEvent.values().iterator().next();
 150     }
 151 }