restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/OSGiNorthbound.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;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.Map;
  13 import org.opendaylight.restconf.nb.rfc8040.streams.DefaultPingExecutor;
  14 import org.opendaylight.restconf.nb.rfc8040.streams.DefaultRestconfStreamServletFactory;
  15 import org.opendaylight.restconf.nb.rfc8040.streams.StreamsConfiguration;
  16 import org.opendaylight.restconf.server.mdsal.MdsalRestconfStreamRegistry;
  17 import org.osgi.framework.FrameworkUtil;
  18 import org.osgi.service.component.ComponentFactory;
  19 import org.osgi.service.component.ComponentInstance;
  20 import org.osgi.service.component.annotations.Activate;
  21 import org.osgi.service.component.annotations.Component;
  22 import org.osgi.service.component.annotations.Deactivate;
  23 import org.osgi.service.component.annotations.Modified;
  24 import org.osgi.service.component.annotations.Reference;
  25 import org.osgi.service.metatype.annotations.AttributeDefinition;
  26 import org.osgi.service.metatype.annotations.Designate;
  27 import org.osgi.service.metatype.annotations.ObjectClassDefinition;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 /**
  32  * Component managing global RESTCONF northbound configuration.
  33  */
  34 @Component(service = { }, configurationPid = "org.opendaylight.restconf.nb.rfc8040")
  35 @Designate(ocd = OSGiNorthbound.Configuration.class)
  36 public final class OSGiNorthbound {
  37     @ObjectClassDefinition
  38     public @interface Configuration {
  39         @AttributeDefinition(min = "0", max = "" + StreamsConfiguration.MAXIMUM_FRAGMENT_LENGTH_LIMIT)
  40         int maximum$_$fragment$_$length() default 0;
  41         @AttributeDefinition(min = "0")
  42         int heartbeat$_$interval() default 10000;
  43         @AttributeDefinition(min = "1")
  44         int idle$_$timeout() default 30000;
  45         @AttributeDefinition(min = "1")
  46         String ping$_$executor$_$name$_$prefix() default DefaultPingExecutor.DEFAULT_NAME_PREFIX;
  47         // FIXME: this is a misnomer: it specifies the core pool size, i.e. minimum thread count, the maximum is set to
  48         //        Integer.MAX_VALUE, which is not what we want
  49         @AttributeDefinition(min = "0")
  50         int max$_$thread$_$count() default DefaultPingExecutor.DEFAULT_CORE_POOL_SIZE;
  51         @Deprecated(since = "7.0.0", forRemoval = true)
  52         @AttributeDefinition
  53         boolean use$_$sse() default true;
  54         @AttributeDefinition(name = "{+restconf}", description = """
  55             The value of RFC8040 {+restconf} URI template, pointing to the root resource. Must not end with '/'.""")
  56         String restconf() default "rests";
  57     }
  58
  59     private static final Logger LOG = LoggerFactory.getLogger(OSGiNorthbound.class);
  60
  61     private final ComponentFactory<MdsalRestconfStreamRegistry> registryFactory;
  62     private final ComponentFactory<DefaultRestconfStreamServletFactory> servletFactoryFactory;
  63
  64     private ComponentInstance<MdsalRestconfStreamRegistry> registry;
  65     @Deprecated(since = "7.0.0", forRemoval = true)
  66     private boolean useSSE;
  67
  68     private ComponentInstance<DefaultRestconfStreamServletFactory> servletFactory;
  69     private Map<String, ?> servletProps;
  70
  71     @Activate
  72     public OSGiNorthbound(
  73             @Reference(target = "(component.factory=" + DefaultRestconfStreamServletFactory.FACTORY_NAME + ")")
  74             final ComponentFactory<DefaultRestconfStreamServletFactory> servletFactoryFactory,
  75             @Reference(target = "(component.factory=" + MdsalRestconfStreamRegistry.FACTORY_NAME + ")")
  76             final ComponentFactory<MdsalRestconfStreamRegistry> registryFactory, final Configuration configuration) {
  77         this.registryFactory = requireNonNull(registryFactory);
  78         this.servletFactoryFactory = requireNonNull(servletFactoryFactory);
  79
  80         useSSE = configuration.use$_$sse();
  81         registry = registryFactory.newInstance(FrameworkUtil.asDictionary(MdsalRestconfStreamRegistry.props(useSSE)));
  82
  83         servletProps = DefaultRestconfStreamServletFactory.props(configuration.restconf(), registry.getInstance(),
  84             useSSE,
  85             new StreamsConfiguration(configuration.maximum$_$fragment$_$length(),
  86                 configuration.idle$_$timeout(), configuration.heartbeat$_$interval()),
  87             configuration.ping$_$executor$_$name$_$prefix(), configuration.max$_$thread$_$count());
  88         servletFactory = servletFactoryFactory.newInstance(FrameworkUtil.asDictionary(servletProps));
  89
  90         LOG.info("Global RESTCONF northbound pools started");
  91     }
  92
  93     @Modified
  94     void modified(final Configuration configuration) {
  95         final var newUseSSE = configuration.use$_$sse();
  96         if (newUseSSE != useSSE) {
  97             useSSE = newUseSSE;
  98             registry.dispose();
  99             registry = registryFactory.newInstance(FrameworkUtil.asDictionary(
 100                 MdsalRestconfStreamRegistry.props(useSSE)));
 101             LOG.debug("ListenersBroker restarted with {}", newUseSSE ? "SSE" : "Websockets");
 102         }
 103
 104         final var newServletProps = DefaultRestconfStreamServletFactory.props(configuration.restconf(),
 105             registry.getInstance(), useSSE,
 106             new StreamsConfiguration(configuration.maximum$_$fragment$_$length(),
 107                 configuration.idle$_$timeout(), configuration.heartbeat$_$interval()),
 108             configuration.ping$_$executor$_$name$_$prefix(), configuration.max$_$thread$_$count());
 109         if (!newServletProps.equals(servletProps)) {
 110             servletProps = newServletProps;
 111             servletFactory.dispose();
 112             servletFactory = servletFactoryFactory.newInstance(FrameworkUtil.asDictionary(servletProps));
 113             LOG.debug("RestconfStreamServletFactory restarted with {}", servletProps);
 114         }
 115
 116         LOG.debug("Applied {}", configuration);
 117     }
 118
 119     @Deactivate
 120     void deactivate() {
 121         servletFactory.dispose();
 122         servletFactory = null;
 123         registry.dispose();
 124         registry = null;
 125         LOG.info("Global RESTCONF northbound pools stopped");
 126     }
 127 }