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  *  Modifications Copyright (C) 2020 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.plugins.event.carrier.websocket;
  23
  24 import java.util.Properties;
  25
  26 import org.onap.policy.apex.core.infrastructure.messaging.MessagingException;
  27 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessageClient;
  28 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessageListener;
  29 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessageServer;
  30 import org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WsStringMessager;
  31 import org.onap.policy.apex.service.engine.event.ApexEventException;
  32 import org.onap.policy.apex.service.engine.event.ApexPluginsEventProducer;
  33 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * Concrete implementation of an Apex event producer that sends events using a web socket.
  39  *
  40  * @author Liam Fallon (liam.fallon@ericsson.com)
  41  */
  42 public class ApexWebSocketProducer extends ApexPluginsEventProducer implements WsStringMessageListener {
  43     // Get a reference to the logger
  44     private static final Logger LOGGER = LoggerFactory.getLogger(ApexWebSocketProducer.class);
  45
  46     // The web socket messager, may be WS a server or a client
  47     private WsStringMessager wsStringMessager;
  48
  49     @Override
  50     public void init(final String producerName, final EventHandlerParameters producerParameters)
  51             throws ApexEventException {
  52         this.name = producerName;
  53
  54         // Check and get the web socket Properties
  55         if (!(producerParameters.getCarrierTechnologyParameters() instanceof WebSocketCarrierTechnologyParameters)) {
  56             String message =
  57                     "specified producer properties for " + this.name + "are not applicable to a web socket producer";
  58             LOGGER.warn(message);
  59             throw new ApexEventException("specified producer properties are not applicable to a web socket producer");
  60         }
  61         // The Web Socket properties
  62         WebSocketCarrierTechnologyParameters webSocketProducerProperties =
  63                 (WebSocketCarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
  64
  65         // Check if this is a server or a client Web Socket
  66         if (webSocketProducerProperties.isWsClient()) {
  67             // Create a WS client
  68             wsStringMessager = new WsStringMessageClient(webSocketProducerProperties.getHost(),
  69                     webSocketProducerProperties.getPort());
  70         } else {
  71             wsStringMessager = new WsStringMessageServer(webSocketProducerProperties.getPort());
  72         }
  73
  74         // Start reception of event strings on the web socket
  75         try {
  76             wsStringMessager.start(this);
  77         } catch (final MessagingException e) {
  78             String message = "could not start web socket producer (" + this.name + ")";
  79             LOGGER.warn(message, e);
  80         }
  81     }
  82
  83     /**
  84      * {@inheritDoc}.
  85      */
  86     @Override
  87     public void sendEvent(final long executionId, final Properties executionProperties, final String eventName,
  88             final Object event) {
  89         super.sendEvent(executionId, executionProperties, eventName, event);
  90
  91         wsStringMessager.sendString((String) event);
  92     }
  93
  94     /**
  95      * {@inheritDoc}.
  96      */
  97     @Override
  98     public void stop() {
  99         if (wsStringMessager != null) {
 100             wsStringMessager.stop();
 101         }
 102     }
 103
 104     /**
 105      * {@inheritDoc}.
 106      */
 107     @Override
 108     public void receiveString(final String messageString) {
 109         String message = "received message \"" + messageString + "\" on web socket producer (" + this.name
 110                 + ") , no messages should be received on a web socket producer";
 111         LOGGER.warn(message);
 112     }
 113 }