plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/main/java/org/onap/policy/apex/plugins/event/carrier/websocket/ApexWebSocketProducer.java

   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.carrier.websocket;
  22
  23 import java.util.EnumMap;
  24 import java.util.Map;
  25 import java.util.Properties;
  26
  27 import org.onap.policy.apex.core.infrastructure.messaging.MessagingException;
  28 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessageClient;
  29 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessageListener;
  30 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessageServer;
  31 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessager;
  32 import org.onap.policy.apex.service.engine.event.ApexEventException;
  33 import org.onap.policy.apex.service.engine.event.ApexEventProducer;
  34 import org.onap.policy.apex.service.engine.event.PeeredReference;
  35 import org.onap.policy.apex.service.engine.event.SynchronousEventCache;
  36 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  37 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 /**
  42  * Concrete implementation of an Apex event producer that sends events using a web socket.
  43  *
  44  * @author Liam Fallon (liam.fallon@ericsson.com)
  45  */
  46 public class ApexWebSocketProducer implements ApexEventProducer, WsStringMessageListener {
  47     // Get a reference to the logger
  48     private static final Logger LOGGER = LoggerFactory.getLogger(ApexWebSocketProducer.class);
  49
  50     // The web socket messager, may be WS a server or a client
  51     private WsStringMessager wsStringMessager;
  52
  53     // The name for this producer
  54     private String name = null;
  55
  56     // The peer references for this event handler
  57     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
  58
  59     @Override
  60     public void init(final String producerName, final EventHandlerParameters producerParameters)
  61             throws ApexEventException {
  62         this.name = producerName;
  63
  64         // Check and get the web socket Properties
  65         if (!(producerParameters.getCarrierTechnologyParameters() instanceof WebSocketCarrierTechnologyParameters)) {
  66             String message =
  67                     "specified producer properties for " + this.name + "are not applicable to a web socket producer";
  68             LOGGER.warn(message);
  69             throw new ApexEventException("specified producer properties are not applicable to a web socket producer");
  70         }
  71         // The Web Socket properties
  72         WebSocketCarrierTechnologyParameters webSocketProducerProperties =
  73                 (WebSocketCarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
  74
  75         // Check if this is a server or a client Web Socket
  76         if (webSocketProducerProperties.isWsClient()) {
  77             // Create a WS client
  78             wsStringMessager = new WsStringMessageClient(webSocketProducerProperties.getHost(),
  79                     webSocketProducerProperties.getPort());
  80         } else {
  81             wsStringMessager = new WsStringMessageServer(webSocketProducerProperties.getPort());
  82         }
  83
  84         // Start reception of event strings on the web socket
  85         try {
  86             wsStringMessager.start(this);
  87         } catch (final MessagingException e) {
  88             String message = "could not start web socket producer (" + this.name + ")";
  89             LOGGER.warn(message, e);
  90         }
  91     }
  92
  93     /*
  94      * (non-Javadoc)
  95      *
  96      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName()
  97      */
  98     @Override
  99     public String getName() {
 100         return name;
 101     }
 102
 103     /*
 104      * (non-Javadoc)
 105      *
 106      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getPeeredReference(org.onap.policy.apex.service.
 107      * parameters. eventhandler.EventHandlerPeeredMode)
 108      */
 109     @Override
 110     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 111         return peerReferenceMap.get(peeredMode);
 112     }
 113
 114     /*
 115      * (non-Javadoc)
 116      *
 117      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#setPeeredReference(org.onap.policy.apex.service.
 118      * parameters. eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference)
 119      */
 120     @Override
 121     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 122         peerReferenceMap.put(peeredMode, peeredReference);
 123     }
 124
 125     /*
 126      * (non-Javadoc)
 127      *
 128      * @see org.onap.policy.apex.apps.uservice.producer.ApexEventProducer#sendEvent(long, java.lang.String,
 129      * java.lang.Object)
 130      */
 131     @Override
 132     public void sendEvent(final long executionId, final Properties executionProperties, final String eventName,
 133             final Object event) {
 134         // Check if this is a synchronized event, if so we have received a reply
 135         final SynchronousEventCache synchronousEventCache =
 136                 (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
 137         if (synchronousEventCache != null) {
 138             synchronousEventCache.removeCachedEventToApexIfExists(executionId);
 139         }
 140
 141         wsStringMessager.sendString((String) event);
 142     }
 143
 144     /*
 145      * (non-Javadoc)
 146      *
 147      * @see org.onap.policy.apex.apps.uservice.producer.ApexEventProducer#stop()
 148      */
 149     @Override
 150     public void stop() {
 151         if (wsStringMessager != null) {
 152             wsStringMessager.stop();
 153         }
 154     }
 155
 156     /*
 157      * (non-Javadoc)
 158      *
 159      * @see
 160      * org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WSStringMessageListener#receiveString(java.
 161      * lang. String)
 162      */
 163     @Override
 164     public void receiveString(final String messageString) {
 165         String message = "received message \"" + messageString + "\" on web socket producer (" + this.name
 166                 + ") , no messages should be received on a web socket producer";
 167         LOGGER.warn(message);
 168     }
 169 }