restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/streams/WebSocketInitializer.java

   1 /*
   2  * Copyright © 2019 FRINX s.r.o. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.nb.rfc8040.streams;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  12 import java.util.concurrent.ScheduledExecutorService;
  13 import javax.inject.Inject;
  14 import javax.inject.Singleton;
  15 import javax.servlet.http.HttpServletResponse;
  16 import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
  17 import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
  18 import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
  19 import org.eclipse.jetty.websocket.servlet.WebSocketServlet;
  20 import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory;
  21 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
  22 import org.opendaylight.restconf.nb.rfc8040.streams.listeners.ListenersBroker;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Web-socket servlet listening on ws or wss schemas for created data-change-event or notification streams.
  28  */
  29 @Singleton
  30 public final class WebSocketInitializer extends WebSocketServlet {
  31     private static final long serialVersionUID = 1L;
  32
  33     @SuppressFBWarnings(value = "SE_BAD_FIELD",
  34         justification = "Servlet/WebSocket bridge, we need this service for heartbeats")
  35     private final ScheduledExecutorService executorService;
  36     private final int maximumFragmentLength;
  37     private final int heartbeatInterval;
  38     private final int idleTimeoutMillis;
  39
  40     /**
  41      * Creation of the web-socket initializer.
  42      *
  43      * @param scheduledThreadPool    ODL thread pool used for fetching of scheduled executors.
  44      * @param configuration          Web-socket configuration holder.
  45      */
  46     @Inject
  47     public WebSocketInitializer(final ScheduledThreadPool scheduledThreadPool,
  48             final StreamsConfiguration configuration) {
  49         executorService = scheduledThreadPool.getExecutor();
  50         maximumFragmentLength = configuration.maximumFragmentLength();
  51         heartbeatInterval = configuration.heartbeatInterval();
  52         idleTimeoutMillis = configuration.idleTimeout();
  53     }
  54
  55     /**
  56      * Configuration of the web-socket factory - idle timeout and specified factory object.
  57      *
  58      * @param factory Configurable web-socket factory.
  59      */
  60     @Override
  61     public void configure(final WebSocketServletFactory factory) {
  62         factory.getPolicy().setIdleTimeout(idleTimeoutMillis);
  63         factory.setCreator(new WebSocketFactory(executorService, maximumFragmentLength, heartbeatInterval));
  64     }
  65
  66     /**
  67      * Factory that is used for creation of new web-sockets based on HTTP/HTTPS upgrade request.
  68      */
  69     @VisibleForTesting
  70     static final class WebSocketFactory implements WebSocketCreator {
  71         private static final Logger LOG = LoggerFactory.getLogger(WebSocketFactory.class);
  72
  73         private final ScheduledExecutorService executorService;
  74         // FIXME: inject this reference
  75         private final ListenersBroker listenersBroker = ListenersBroker.getInstance();
  76         private final int maximumFragmentLength;
  77         private final int heartbeatInterval;
  78
  79         /**
  80          * Creation of the web-socket factory.
  81          *
  82          * @param executorService       Executor for creation of threads for controlling of web-socket sessions.
  83          * @param maximumFragmentLength Maximum web-socket fragment length in number of Unicode code units (characters)
  84          *                              (exceeded message length leads to fragmentation of messages).
  85          * @param heartbeatInterval     Interval in milliseconds between sending of ping control frames.
  86          */
  87         WebSocketFactory(final ScheduledExecutorService executorService, final int maximumFragmentLength,
  88                 final int heartbeatInterval) {
  89             this.executorService = executorService;
  90             this.maximumFragmentLength = maximumFragmentLength;
  91             this.heartbeatInterval = heartbeatInterval;
  92         }
  93
  94         /**
  95          * Creation of the new web-socket based on input HTTP/HTTPS upgrade request. Web-socket is created only if the
  96          * data listener for input URI can be found (results in status code 101); otherwise status code 404 is set
  97          * in upgrade response.
  98          *
  99          * @param servletUpgradeRequest  Upgrade request.
 100          * @param servletUpgradeResponse Upgrade response.
 101          * @return Created web-socket instance or {@code null} if the web-socket cannot be created.
 102          */
 103         @Override
 104         public Object createWebSocket(final ServletUpgradeRequest servletUpgradeRequest,
 105                 final ServletUpgradeResponse servletUpgradeResponse) {
 106             final var streamName = ListenersBroker.createStreamNameFromUri(
 107                 servletUpgradeRequest.getRequestURI().getRawPath());
 108
 109             final var listener = listenersBroker.listenerFor(streamName);
 110             if (listener == null) {
 111                 LOG.debug("Listener for stream with name {} was not found.", streamName);
 112                 servletUpgradeResponse.setSuccess(false);
 113                 servletUpgradeResponse.setStatusCode(HttpServletResponse.SC_NOT_FOUND);
 114                 return null;
 115             }
 116
 117             LOG.debug("Listener for stream with name {} has been found, web-socket session handler will be created",
 118                 streamName);
 119             servletUpgradeResponse.setSuccess(true);
 120             servletUpgradeResponse.setStatusCode(HttpServletResponse.SC_SWITCHING_PROTOCOLS);
 121             // note: every web-socket manages PING process individually because this approach scales better than
 122             //       sending of PING frames at once over all web-socket sessions
 123             return new WebSocketSessionHandler(executorService, listener, maximumFragmentLength, heartbeatInterval);
 124         }
 125     }
 126 }