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.util.ArrayList;
  24 import java.util.List;
  25
  26 import javax.jms.ObjectMessage;
  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
  38  * {@link javax.jms.ObjectMessage} message 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
  55     @Override
  56     public void init(final EventProtocolParameters parameters) {
  57         // Check if properties have been set for JMS object event conversion as a consumer. They may not be set because
  58         // JMS may not be in use
  59         // on both sides of Apex
  60         if (!(parameters instanceof JMSObjectEventProtocolParameters)) {
  61             final String errormessage = "specified Event Protocol Parameters properties of type \""
  62                     + parameters.getClass().getCanonicalName() + "\" are not applicable to a "
  63                     + Apex2JMSObjectEventConverter.class.getName() + " converter";
  64             LOGGER.error(errormessage);
  65         } else {
  66             this.eventProtocolParameters = (JMSObjectEventProtocolParameters) parameters;
  67         }
  68
  69     }
  70
  71     /*
  72      * (non-Javadoc)
  73      *
  74      * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object)
  75      */
  76     @Override
  77     public List<ApexEvent> toApexEvent(final String eventName, final Object eventObject) throws ApexEventException {
  78         // Check if this is an ObjectMessage from JMS
  79         if (!(eventObject instanceof ObjectMessage)) {
  80             final String errorMessage = "message \"" + eventObject + "\" received from JMS is not an instance of \""
  81                     + ObjectMessage.class.getCanonicalName() + "\"";
  82             LOGGER.warn(errorMessage);
  83             throw new ApexEventRuntimeException(errorMessage);
  84         }
  85
  86         // Get the object from the object message
  87         final ObjectMessage objectMessage = (ObjectMessage) eventObject;
  88         Object jmsIncomingObject;
  89         try {
  90             jmsIncomingObject = objectMessage.getObject();
  91         } catch (final Exception e) {
  92             final String errorMessage = "object contained in message \"" + eventObject
  93                     + "\" received from JMS could not be retrieved as a Java object";
  94             LOGGER.debug(errorMessage, e);
  95             throw new ApexEventRuntimeException(errorMessage, e);
  96         }
  97
  98         // Check that the consumer parameters for JMS->Apex messaging have been set
  99         if (eventProtocolParameters == null) {
 100             final String errorMessage =
 101                     "consumer parameters for JMS events consumed by Apex are not set in the Apex configuration for this engine";
 102             LOGGER.debug(errorMessage);
 103             throw new ApexEventRuntimeException(errorMessage);
 104         }
 105
 106         // Create the Apex event
 107         // @formatter:off
 108         final ApexEvent apexEvent = new ApexEvent(
 109                 jmsIncomingObject.getClass().getSimpleName() + eventProtocolParameters.getIncomingEventSuffix(),
 110                 eventProtocolParameters.getIncomingEventVersion(),
 111                 jmsIncomingObject.toString().getClass().getPackage().getName(),
 112                 eventProtocolParameters.getIncomingEventSource(),
 113                 eventProtocolParameters.getIncomingEventTarget());
 114         // @formattter:on
 115
 116         // Set the data on the apex event as the incoming object
 117         apexEvent.put(jmsIncomingObject.getClass().getSimpleName(), jmsIncomingObject);
 118
 119         // Return the event in a single element
 120         final ArrayList<ApexEvent> eventList = new ArrayList<ApexEvent>();
 121         eventList.add(apexEvent);
 122         return eventList;
 123     }
 124
 125     /*
 126      * (non-Javadoc)
 127      *
 128      * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#fromApexEvent(org.onap.policy.apex.service.engine.event.ApexEvent)
 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, 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 }