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