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 javax.servlet.http.HttpServlet;
  14 import org.opendaylight.aaa.web.servlet.ServletSupport;
  15 import org.opendaylight.restconf.server.spi.RestconfStream;
  16 import org.osgi.service.component.annotations.Activate;
  17 import org.osgi.service.component.annotations.Component;
  18 import org.osgi.service.component.annotations.Deactivate;
  19 import org.osgi.service.component.annotations.Reference;
  20
  21 /**
  22  * Auxiliary interface for instantiating JAX-RS streams.
  23  */
  24 @Component(factory = DefaultRestconfStreamServletFactory.FACTORY_NAME, service = RestconfStreamServletFactory.class)
  25 public final class DefaultRestconfStreamServletFactory implements RestconfStreamServletFactory, AutoCloseable {
  26     public static final String FACTORY_NAME =
  27         "org.opendaylight.restconf.nb.rfc8040.streams.RestconfStreamServletFactory";
  28
  29     private static final String PROP_STREAM_REGISTRY = ".streamRegistry";
  30     private static final String PROP_NAME_PREFIX = ".namePrefix";
  31     private static final String PROP_CORE_POOL_SIZE = ".corePoolSize";
  32     private static final String PROP_USE_WEBSOCKETS = ".useWebsockets";
  33     private static final String PROP_STREAMS_CONFIGURATION = ".streamsConfiguration";
  34
  35     private final RestconfStream.Registry streamRegistry;
  36     private final ServletSupport servletSupport;
  37
  38     private final DefaultPingExecutor pingExecutor;
  39     private final StreamsConfiguration streamsConfiguration;
  40     private final boolean useWebsockets;
  41
  42     public DefaultRestconfStreamServletFactory(final ServletSupport servletSupport,
  43             final RestconfStream.Registry streamRegistry, final StreamsConfiguration streamsConfiguration,
  44             final String namePrefix, final int corePoolSize, final boolean useWebsockets) {
  45         this.servletSupport = requireNonNull(servletSupport);
  46         this.streamRegistry = requireNonNull(streamRegistry);
  47         this.streamsConfiguration = requireNonNull(streamsConfiguration);
  48         this.useWebsockets = useWebsockets;
  49         pingExecutor = new DefaultPingExecutor(namePrefix, corePoolSize);
  50     }
  51
  52     @Activate
  53     public DefaultRestconfStreamServletFactory(@Reference final ServletSupport servletSupport,
  54             final Map<String, ?> props) {
  55         this(servletSupport, (RestconfStream.Registry) props.get(PROP_STREAM_REGISTRY),
  56             (StreamsConfiguration) props.get(PROP_STREAMS_CONFIGURATION),
  57             (String) props.get(PROP_NAME_PREFIX), (int) requireNonNull(props.get(PROP_CORE_POOL_SIZE)),
  58             (boolean) requireNonNull(props.get(PROP_USE_WEBSOCKETS)));
  59     }
  60
  61     @Override
  62     public HttpServlet newStreamServlet() {
  63         return useWebsockets ? new WebSocketInitializer(streamRegistry, pingExecutor, streamsConfiguration)
  64             : servletSupport.createHttpServletBuilder(
  65                 new SSEApplication(streamRegistry, pingExecutor, streamsConfiguration))
  66             .build();
  67     }
  68
  69     @Override
  70     @Deactivate
  71     public void close() {
  72         pingExecutor.close();
  73     }
  74
  75     public static Map<String, ?> props(final RestconfStream.Registry streamRegistry, final boolean useSSE,
  76             final StreamsConfiguration streamsConfiguration, final String namePrefix, final int corePoolSize) {
  77         return Map.of(
  78             PROP_STREAM_REGISTRY, streamRegistry,
  79             PROP_USE_WEBSOCKETS, !useSSE,
  80             PROP_STREAMS_CONFIGURATION, streamsConfiguration,
  81             PROP_NAME_PREFIX, namePrefix,
  82             PROP_CORE_POOL_SIZE, corePoolSize);
  83     }
  84 }