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

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  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 static java.util.Objects.requireNonNull;
  11
  12 import java.util.Map;
  13 import java.util.Set;
  14 import javax.servlet.http.HttpServlet;
  15 import javax.ws.rs.core.Application;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.aaa.web.servlet.ServletSupport;
  18 import org.opendaylight.restconf.server.spi.RestconfStream;
  19 import org.osgi.service.component.annotations.Activate;
  20 import org.osgi.service.component.annotations.Component;
  21 import org.osgi.service.component.annotations.Deactivate;
  22 import org.osgi.service.component.annotations.Reference;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Auxiliary interface for instantiating JAX-RS streams.
  28  *
  29  * @deprecated This componet exists only to support SSE/Websocket delivery. It will be removed when support for
  30  *             WebSockets is removed.
  31  */
  32 @Component(factory = DefaultRestconfStreamServletFactory.FACTORY_NAME, service = RestconfStreamServletFactory.class)
  33 @Deprecated(since = "7.0.0", forRemoval = true)
  34 public final class DefaultRestconfStreamServletFactory implements RestconfStreamServletFactory, AutoCloseable {
  35     private static final Logger LOG = LoggerFactory.getLogger(DefaultRestconfStreamServletFactory.class);
  36
  37     public static final String FACTORY_NAME =
  38         "org.opendaylight.restconf.nb.rfc8040.streams.RestconfStreamServletFactory";
  39
  40     private static final String PROP_STREAM_REGISTRY = ".streamRegistry";
  41     private static final String PROP_NAME_PREFIX = ".namePrefix";
  42     private static final String PROP_CORE_POOL_SIZE = ".corePoolSize";
  43     private static final String PROP_USE_WEBSOCKETS = ".useWebsockets";
  44     private static final String PROP_STREAMS_CONFIGURATION = ".streamsConfiguration";
  45     private static final String PROP_RESTCONF = ".restconf";
  46
  47     private final @NonNull String restconf;
  48     private final RestconfStream.Registry streamRegistry;
  49     private final ServletSupport servletSupport;
  50
  51     private final DefaultPingExecutor pingExecutor;
  52     private final StreamsConfiguration streamsConfiguration;
  53     private final boolean useWebsockets;
  54
  55     public DefaultRestconfStreamServletFactory(final ServletSupport servletSupport, final String restconf,
  56             final RestconfStream.Registry streamRegistry, final StreamsConfiguration streamsConfiguration,
  57             final String namePrefix, final int corePoolSize, final boolean useWebsockets) {
  58         this.servletSupport = requireNonNull(servletSupport);
  59         this.restconf = requireNonNull(restconf);
  60         if (restconf.endsWith("/")) {
  61             throw new IllegalArgumentException("{+restconf} value ends with /");
  62         }
  63         this.streamRegistry = requireNonNull(streamRegistry);
  64         this.streamsConfiguration = requireNonNull(streamsConfiguration);
  65         pingExecutor = new DefaultPingExecutor(namePrefix, corePoolSize);
  66         this.useWebsockets = useWebsockets;
  67         if (useWebsockets) {
  68             LOG.warn("""
  69                 RESTCONF event streams use WebSockets instead of Server-Sent Events. This option is will be removed in
  70                 the next major release.""");
  71         }
  72     }
  73
  74     @Activate
  75     public DefaultRestconfStreamServletFactory(@Reference final ServletSupport servletSupport,
  76             final Map<String, ?> props) {
  77         this(servletSupport, (String) props.get(PROP_RESTCONF),
  78             (RestconfStream.Registry) props.get(PROP_STREAM_REGISTRY),
  79             (StreamsConfiguration) props.get(PROP_STREAMS_CONFIGURATION),
  80             (String) props.get(PROP_NAME_PREFIX), (int) requireNonNull(props.get(PROP_CORE_POOL_SIZE)),
  81             (boolean) requireNonNull(props.get(PROP_USE_WEBSOCKETS)));
  82     }
  83
  84     @Override
  85     public String restconf() {
  86         return restconf;
  87     }
  88
  89     @Override
  90     public HttpServlet newStreamServlet() {
  91         return useWebsockets ? new WebSocketInitializer(restconf, streamRegistry, pingExecutor, streamsConfiguration)
  92             : servletSupport.createHttpServletBuilder(
  93                 new Application() {
  94                     @Override
  95                     public Set<Object> getSingletons() {
  96                         return Set.of(new SSEStreamService(streamRegistry, pingExecutor, streamsConfiguration));
  97                     }
  98                 }).build();
  99     }
 100
 101     @Override
 102     @Deactivate
 103     public void close() {
 104         pingExecutor.close();
 105     }
 106
 107     public static Map<String, ?> props(final String restconf, final RestconfStream.Registry streamRegistry,
 108             final boolean useSSE, final StreamsConfiguration streamsConfiguration, final String namePrefix,
 109             final int corePoolSize) {
 110         return Map.of(
 111             PROP_RESTCONF, restconf,
 112             PROP_STREAM_REGISTRY, streamRegistry,
 113             PROP_USE_WEBSOCKETS, !useSSE,
 114             PROP_STREAMS_CONFIGURATION, streamsConfiguration,
 115             PROP_NAME_PREFIX, namePrefix,
 116             PROP_CORE_POOL_SIZE, corePoolSize);
 117     }
 118 }