Replace non-Javadoc comments with inheritDocs

[policy/apex-pdp.git] / plugins / plugins-event / plugins-event-carrier / plugins-event-carrier-jms / src / main / java / org / onap / policy / apex / plugins / event / carrier / jms / ApexJmsProducer.java

diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsProducer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsProducer.java
index 7277a7d..4bd7be5 100644 (file)
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsProducer.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsProducer.java
@@ -23,6 +23,7 @@ package org.onap.policy.apex.plugins.event.carrier.jms;
 import java.io.Serializable;
 import java.util.EnumMap;
 import java.util.Map;
+import java.util.Properties;
 
 import javax.jms.Connection;
 import javax.jms.ConnectionFactory;
@@ -74,21 +75,18 @@ public class ApexJmsProducer implements ApexEventProducer {
     // The peer references for this event handler
     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#init(java.lang.String,
-     * org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void init(final String producerName, final EventHandlerParameters producerParameters)
-                    throws ApexEventException {
+            throws ApexEventException {
         this.name = producerName;
 
         // Check and get the JMS Properties
         if (!(producerParameters.getCarrierTechnologyParameters() instanceof JmsCarrierTechnologyParameters)) {
-            final String errorMessage = "specified producer properties are not applicable to a JMS producer ("
-                            + this.name + ")";
+            final String errorMessage =
+                    "specified producer properties are not applicable to a JMS producer (" + this.name + ")";
             LOGGER.warn(errorMessage);
             throw new ApexEventException(errorMessage);
         }
@@ -103,13 +101,14 @@ public class ApexJmsProducer implements ApexEventProducer {
 
             // Check if we actually got a connection factory
             if (connectionFactory == null) {
-                throw new NullPointerException("JMS context lookup of \"" + jmsProducerProperties.getConnectionFactory()
+                throw new IllegalArgumentException(
+                        "JMS context lookup of \"" + jmsProducerProperties.getConnectionFactory()
                                 + "\" returned null for producer (" + this.name + ")");
             }
         } catch (final Exception e) {
             final String errorMessage = "lookup of JMS connection factory  \""
-                            + jmsProducerProperties.getConnectionFactory() + "\" failed for JMS producer properties \""
-                            + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
+                    + jmsProducerProperties.getConnectionFactory() + "\" failed for JMS producer properties \""
+                    + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
             LOGGER.warn(errorMessage, e);
             throw new ApexEventException(errorMessage, e);
         }
@@ -121,13 +120,13 @@ public class ApexJmsProducer implements ApexEventProducer {
 
             // Check if we actually got a topic
             if (jmsOutgoingTopic == null) {
-                throw new NullPointerException("JMS context lookup of \"" + jmsProducerProperties.getProducerTopic()
-                                + "\" returned null for producer (" + this.name + ")");
+                throw new IllegalArgumentException("JMS context lookup of \"" + jmsProducerProperties.getProducerTopic()
+                        + "\" returned null for producer (" + this.name + ")");
             }
         } catch (final Exception e) {
             final String errorMessage = "lookup of JMS topic  \"" + jmsProducerProperties.getProducerTopic()
-                            + "\" failed for JMS producer properties \""
-                            + jmsProducerProperties.getJmsProducerProperties() + FOR_PRODUCER_TAG + this.name + ")";
+                    + "\" failed for JMS producer properties \"" + jmsProducerProperties.getJmsProducerProperties()
+                    + FOR_PRODUCER_TAG + this.name + ")";
             LOGGER.warn(errorMessage, e);
             throw new ApexEventException(errorMessage, e);
         }
@@ -135,11 +134,11 @@ public class ApexJmsProducer implements ApexEventProducer {
         // Create and start a connection to the JMS server
         try {
             connection = connectionFactory.createConnection(jmsProducerProperties.getSecurityPrincipal(),
-                            jmsProducerProperties.getSecurityCredentials());
+                    jmsProducerProperties.getSecurityCredentials());
             connection.start();
         } catch (final Exception e) {
             final String errorMessage = "connection to JMS server failed for JMS properties \""
-                            + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
+                    + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
             LOGGER.warn(errorMessage, e);
             throw new ApexEventException(errorMessage, e);
         }
@@ -149,7 +148,7 @@ public class ApexJmsProducer implements ApexEventProducer {
             jmsSession = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
         } catch (final Exception e) {
             final String errorMessage = "creation of session to JMS server failed for JMS properties \""
-                            + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
+                    + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
             LOGGER.warn(errorMessage, e);
             throw new ApexEventException(errorMessage, e);
         }
@@ -158,57 +157,47 @@ public class ApexJmsProducer implements ApexEventProducer {
         try {
             messageProducer = jmsSession.createProducer(jmsOutgoingTopic);
         } catch (final Exception e) {
-            final String errorMessage = "creation of producer for sending events "
-                            + "to JMS server failed for JMS properties \""
+            final String errorMessage =
+                    "creation of producer for sending events " + "to JMS server failed for JMS properties \""
                             + jmsProducerProperties.getJmsConsumerProperties() + "\"";
             LOGGER.warn(errorMessage, e);
             throw new ApexEventException(errorMessage, e);
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String getName() {
         return name;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getPeeredReference(org.onap.policy.apex.service.
-     * parameters. eventhandler.EventHandlerPeeredMode)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
         return peerReferenceMap.get(peeredMode);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#setPeeredReference(org.onap.policy.apex.service.
-     * parameters. eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
         peerReferenceMap.put(peeredMode, peeredReference);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#sendEvent(long, java.lang.String,
-     * java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
-    public void sendEvent(final long executionId, final String eventname, final Object eventObject) {
+    public void sendEvent(final long executionId, final Properties executionProperties, final String eventname,
+            final Object eventObject) {
         // Check if this is a synchronized event, if so we have received a reply
-        final SynchronousEventCache synchronousEventCache = (SynchronousEventCache) peerReferenceMap
-                        .get(EventHandlerPeeredMode.SYNCHRONOUS);
+        final SynchronousEventCache synchronousEventCache =
+                (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
         if (synchronousEventCache != null) {
             synchronousEventCache.removeCachedEventToApexIfExists(executionId);
         }
@@ -216,8 +205,7 @@ public class ApexJmsProducer implements ApexEventProducer {
         // Check if the object to be sent is serializable
         if (!Serializable.class.isAssignableFrom(eventObject.getClass())) {
             final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG + this.name
-                            + ", object of type \"" + eventObject.getClass().getCanonicalName()
-                            + "\" is not serializable";
+                    + ", object of type \"" + eventObject.getClass().getCanonicalName() + "\" is not serializable";
             LOGGER.warn(errorMessage);
             throw new ApexEventRuntimeException(errorMessage);
         }
@@ -231,9 +219,9 @@ public class ApexJmsProducer implements ApexEventProducer {
             try {
                 jmsMessage = jmsSession.createObjectMessage((Serializable) eventObject);
             } catch (final Exception e) {
-                final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG
-                                + this.name + ", could not create JMS Object Message for object \"" + eventObject;
-                LOGGER.warn(errorMessage);
+                final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG + this.name
+                        + ", could not create JMS Object Message for object \"" + eventObject;
+                LOGGER.warn(errorMessage, e);
                 throw new ApexEventRuntimeException(errorMessage);
             }
         } else {
@@ -241,9 +229,9 @@ public class ApexJmsProducer implements ApexEventProducer {
             try {
                 jmsMessage = jmsSession.createTextMessage(eventObject.toString());
             } catch (final Exception e) {
-                final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG
-                                + this.name + ", could not create JMS Text Message for object \"" + eventObject;
-                LOGGER.warn(errorMessage);
+                final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG + this.name
+                        + ", could not create JMS Text Message for object \"" + eventObject;
+                LOGGER.warn(errorMessage, e);
                 throw new ApexEventRuntimeException(errorMessage);
             }
         }
@@ -252,16 +240,14 @@ public class ApexJmsProducer implements ApexEventProducer {
             messageProducer.send(jmsMessage);
         } catch (final Exception e) {
             final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG + this.name
-                            + ", send failed for object \"" + eventObject;
-            LOGGER.warn(errorMessage);
+                    + ", send failed for object \"" + eventObject;
+            LOGGER.warn(errorMessage, e);
             throw new ApexEventRuntimeException(errorMessage);
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.apps.uservice.producer.ApexEventProducer#stop()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void stop() {