Run restconf using JaxRsEndpoint

Tobianas · Tobianas · commit 6816ac99495f · 2025-05-26T09:10:30.000+02:00
There is no need to create restconf manually anymore thanks to JaxRsEndpoint.
This patch relies on the previous JettyWebServerProvider patch since
JaxRsEndpoint requires JettyWebServer instead of regular server.

Now initialization order matters, and restconf has to be initialized
after lighty services.

JIRA: LIGHTY-329
Signed-off-by: tobias.pobocik &lt;tobias.pobocik@pantheon.tech&gt;
diff --git a/lighty-applications/lighty-rcgnmi-app-aggregator/lighty-rcgnmi-app-module/src/main/java/io/lighty/applications/rcgnmi/module/RcGnmiAppModule.java b/lighty-applications/lighty-rcgnmi-app-aggregator/lighty-rcgnmi-app-module/src/main/java/io/lighty/applications/rcgnmi/module/RcGnmiAppModule.java
@@ -82,13 +82,15 @@ public boolean initModules() {
 
             this.lightyRestconf = initRestconf(this.appModuleConfig.getRestconfConfig(),
                     this.lightyController.getServices());
+            lightyController.getServices().withJaxRsEndpoint(lightyRestconf.getJaxRsEndpoint());
             startAndWaitLightyModule(this.lightyRestconf);
 
             final AAAEncryptionService encryptionService = createEncryptionServiceWithErrorHandling();
             this.gnmiSouthboundModule = initGnmiModule(this.lightyController.getServices(),
                     this.gnmiExecutorService, this.appModuleConfig.getGnmiConfiguration(), encryptionService,
                     this.customReactor);
             startAndWaitLightyModule(this.gnmiSouthboundModule);
+            lightyRestconf.startServer();
 
         } catch (RcGnmiAppException e) {
             LOG.error("Unable to initialize and start RCgNMI lighty.io module!", e);
diff --git a/lighty-examples/lighty-community-aaa-restconf-app/src/main/java/io/lighty/kit/examples/community/aaa/restconf/Main.java b/lighty-examples/lighty-community-aaa-restconf-app/src/main/java/io/lighty/kit/examples/community/aaa/restconf/Main.java
@@ -107,21 +107,10 @@ private void startLighty(final ControllerConfiguration controllerConfiguration,
             throw new ModuleStartupException("Lighty.io Controller startup failed!");
         }
 
-        // 2. Initialize and start Restconf server
         final LightyJettyServerProvider jettyServerBuilder = new LightyJettyServerProvider(new InetSocketAddress(
                 restconfConfiguration.getInetAddress(), restconfConfiguration.getHttpPort()));
-        this.restconf = CommunityRestConfBuilder
-                .from(RestConfConfigUtils.getRestConfConfiguration(restconfConfiguration,
-                    this.lightyController.getServices()))
-                .withLightyServer(jettyServerBuilder)
-                .build();
-        final boolean restconfStartOk = this.restconf.start()
-                .get(modulesConfig.getModuleTimeoutSeconds(), TimeUnit.SECONDS);
-        if (!restconfStartOk) {
-            throw new ModuleStartupException("Community Restconf startup failed!");
-        }
 
-        // 3. Initialize and start Lighty AAA
+        // 2. Initialize and start Lighty AAA
         final DataBroker bindingDataBroker = this.lightyController.getServices().getBindingDataBroker();
         Security.addProvider(new BouncyCastleProvider());
         aaaConfiguration.setCertificateManager(
@@ -134,6 +123,21 @@ private void startLighty(final ControllerConfiguration controllerConfiguration,
             throw new ModuleStartupException("AAA module startup failed!");
         }
 
+        // 3. Initialize and start Restconf server
+        this.restconf = CommunityRestConfBuilder
+            .from(RestConfConfigUtils.getRestConfConfiguration(restconfConfiguration,
+                this.lightyController.getServices()))
+            .withLightyServer(jettyServerBuilder)
+            .withWebSecurer(aaaLighty.getWebContextSecurer())
+            .build();
+        final boolean restconfStartOk = this.restconf.start()
+            .get(modulesConfig.getModuleTimeoutSeconds(), TimeUnit.SECONDS);
+        if (!restconfStartOk) {
+            throw new ModuleStartupException("Community Restconf startup failed!");
+        }
+
+        // 4. Start Lighty jetty server
+        this.restconf.startServer();
     }
 
     private void closeLightyModule(final LightyModule module) {
diff --git a/lighty-modules/lighty-restconf-nb-community/src/main/java/io/lighty/modules/northbound/restconf/community/impl/CommunityRestConf.java b/lighty-modules/lighty-restconf-nb-community/src/main/java/io/lighty/modules/northbound/restconf/community/impl/CommunityRestConf.java
@@ -10,20 +10,11 @@
 import com.google.common.base.Stopwatch;
 import com.google.common.base.Throwables;
 import io.lighty.core.controller.api.AbstractLightyModule;
-import io.lighty.modules.northbound.restconf.community.impl.root.resource.discovery.RootFoundApplication;
 import io.lighty.modules.northbound.restconf.community.impl.util.RestConfConfigUtils;
+import io.lighty.server.LightyJettyServerProvider;
 import java.net.InetAddress;
 import java.net.InetSocketAddress;
-import java.util.Set;
-import io.lighty.server.LightyJettyServerProvider;
 import javax.servlet.ServletException;
-import javax.ws.rs.core.Application;
-import org.eclipse.jetty.server.Server;
-import org.eclipse.jetty.server.handler.ContextHandlerCollection;
-import org.eclipse.jetty.servlet.ServletContextHandler;
-import org.eclipse.jetty.servlet.ServletHolder;
-import org.glassfish.jersey.server.ResourceConfig;
-import org.glassfish.jersey.servlet.ServletContainer;
 import org.opendaylight.aaa.filterchain.configuration.impl.CustomFilterAdapterConfigurationImpl;
 import org.opendaylight.aaa.web.WebContext;
 import org.opendaylight.aaa.web.WebContextSecurer;
@@ -32,20 +23,14 @@
 import org.opendaylight.mdsal.dom.api.DOMActionService;
 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
-import org.opendaylight.mdsal.dom.api.DOMNotificationService;
 import org.opendaylight.mdsal.dom.api.DOMRpcService;
 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
-import org.opendaylight.restconf.api.query.PrettyPrintParam;
 import org.opendaylight.restconf.server.jaxrs.JaxRsEndpoint;
 import org.opendaylight.restconf.server.jaxrs.JaxRsEndpointConfiguration;
 import org.opendaylight.restconf.server.jaxrs.JaxRsLocationProvider;
-import org.opendaylight.restconf.server.jaxrs.JaxRsRestconf;
-import org.opendaylight.restconf.server.jaxrs.JsonJaxRsFormattableBodyWriter;
-import org.opendaylight.restconf.server.jaxrs.XmlJaxRsFormattableBodyWriter;
 import org.opendaylight.restconf.server.mdsal.MdsalDatabindProvider;
 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
 import org.opendaylight.restconf.server.mdsal.MdsalRestconfStreamRegistry;
-import org.opendaylight.restconf.server.spi.ErrorTagMapping;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -55,43 +40,41 @@ public class CommunityRestConf extends AbstractLightyModule {
 
     private final DOMDataBroker domDataBroker;
     private final DOMRpcService domRpcService;
-    private final DOMNotificationService domNotificationService;
     private final DOMMountPointService domMountPointService;
     private final DOMActionService domActionService;
     private final DOMSchemaService domSchemaService;
-    private final int httpPort;
     private final InetAddress inetAddress;
-    private final String restconfServletContextPath;
+    private final int httpPort;
     private JettyWebServer jettyServer;
     private LightyJettyServerProvider lightyServerBuilder;
     private JaxRsEndpoint jaxRsEndpoint;
+    private WebContextSecurer webContextSecurer;
 
     public CommunityRestConf(final DOMDataBroker domDataBroker, final DOMRpcService domRpcService,
-            final DOMActionService domActionService, final DOMNotificationService domNotificationService,
+            final DOMActionService domActionService,
             final DOMMountPointService domMountPointService,
-            final DOMSchemaService domSchemaService, final InetAddress inetAddress,
-            final int httpPort, final String restconfServletContextPath,
-            final LightyJettyServerProvider serverBuilder) {
+            final DOMSchemaService domSchemaService,
+            final InetAddress inetAddress,
+            final int httpPort,
+            final LightyJettyServerProvider serverBuilder,
+            final WebContextSecurer webContextSecurer) {
         this.domDataBroker = domDataBroker;
         this.domRpcService = domRpcService;
         this.domActionService = domActionService;
-        this.domNotificationService = domNotificationService;
         this.domMountPointService = domMountPointService;
         this.lightyServerBuilder = serverBuilder;
         this.domSchemaService = domSchemaService;
-        this.httpPort = httpPort;
         this.inetAddress = inetAddress;
-        this.restconfServletContextPath = restconfServletContextPath;
+        this.httpPort = httpPort;
+        this.webContextSecurer = (webContextSecurer == null) ? new LightyWebContextSecurer() : webContextSecurer;
     }
 
     public CommunityRestConf(final DOMDataBroker domDataBroker,
             final DOMRpcService domRpcService, final DOMActionService domActionService,
-            final DOMNotificationService domNotificationService, final DOMMountPointService domMountPointService,
-            final DOMSchemaService domSchemaService, final InetAddress inetAddress, final int httpPort,
-            final String restconfServletContextPath) {
-        this(domDataBroker, domRpcService, domActionService, domNotificationService,
-                domMountPointService, domSchemaService, inetAddress, httpPort,
-                restconfServletContextPath, null);
+            final DOMMountPointService domMountPointService, final DOMSchemaService domSchemaService,
+            final InetAddress inetAddress, final int httpPort, final WebContextSecurer webContextSecurer) {
+        this(domDataBroker, domRpcService, domActionService,
+                domMountPointService, domSchemaService, inetAddress, httpPort, null, webContextSecurer);
     }
 
     @Override
@@ -101,48 +84,24 @@ protected boolean initProcedure() throws ServletException {
 
         LOG.info("Starting RestconfApplication with configuration {}", streamsConfiguration);
 
-        if (lightyServerBuilder == null){
-            lightyServerBuilder = new LightyJettyServerProvider(new JettyWebServer());
+        if (lightyServerBuilder == null) {
+            lightyServerBuilder = new LightyJettyServerProvider(new InetSocketAddress(inetAddress, httpPort));
         }
 
         final MdsalDatabindProvider databindProvider = new MdsalDatabindProvider(domSchemaService);
-        final var server = new MdsalRestconfServer(databindProvider, domDataBroker, domRpcService, domActionService,
-            domMountPointService);
+        final var server = new MdsalRestconfServer(databindProvider, domDataBroker, domRpcService,
+            domActionService, domMountPointService);
 
         this.jettyServer = this.lightyServerBuilder.build();
-        this.jaxRsEndpoint = new JaxRsEndpoint(new JettyWebServer(httpPort), new LightyWebContextSecurer(),
-            new JerseyServletSupport(), new CustomFilterAdapterConfigurationImpl(), server,
+        this.jaxRsEndpoint = new JaxRsEndpoint(
+            jettyServer,
+            this.webContextSecurer,
+            new JerseyServletSupport(),
+            new CustomFilterAdapterConfigurationImpl(),
+            server,
             new MdsalRestconfStreamRegistry(new JaxRsLocationProvider(), domDataBroker),
-            JaxRsEndpoint.props(streamsConfiguration));
-
-        final ServletContainer servletContainer8040 = new ServletContainer(ResourceConfig
-            .forApplication(new Application() {
-                @Override
-                public Set<Object> getSingletons() {
-                    return Set.of(
-                        new JsonJaxRsFormattableBodyWriter(), new XmlJaxRsFormattableBodyWriter(),
-                        new JaxRsRestconf(server, new MdsalRestconfStreamRegistry(new JaxRsLocationProvider(),
-                            domDataBroker), jaxRsEndpoint, ErrorTagMapping.RFC8040, PrettyPrintParam.FALSE));
-                }
-            }));
-
-        final ServletHolder jaxrs = new ServletHolder(servletContainer8040);
-
-        LOG.info("RestConf init complete, starting Jetty");
-        LOG.info("http address:port {}:{}, url prefix: {}", this.inetAddress.toString(), this.httpPort,
-            this.restconfServletContextPath);
-        final InetSocketAddress inetSocketAddress = new InetSocketAddress(this.inetAddress, this.httpPort);
-        final ContextHandlerCollection contexts = new ContextHandlerCollection();
-        final ServletContextHandler mainHandler =
-            new ServletContextHandler(contexts, this.restconfServletContextPath, true, false);
-        mainHandler.addServlet(jaxrs, "/*");
-
-        final ServletContextHandler rrdHandler =
-            new ServletContextHandler(contexts, "/.well-known", true, false);
-        final RootFoundApplication rootDiscoveryApp = new RootFoundApplication(restconfServletContextPath);
-        rrdHandler.addServlet(new ServletHolder(new ServletContainer(ResourceConfig
-            .forApplication(rootDiscoveryApp))), "/*");
-
+            JaxRsEndpoint.props(streamsConfiguration)
+        );
 
         LOG.info("Lighty RestConf started in {}", stopwatch.stop());
         return true;
@@ -196,7 +155,7 @@ public static class LightyWebContextSecurer implements WebContextSecurer {
         @Override
         public void requireAuthentication(WebContext.Builder webContextBuilder,
             boolean asyncSupported, String... urlPatterns) {
-
+            //do nothing since shiro is not used
         }
 
         @Override
diff --git a/lighty-modules/lighty-restconf-nb-community/src/main/java/io/lighty/modules/northbound/restconf/community/impl/CommunityRestConfBuilder.java b/lighty-modules/lighty-restconf-nb-community/src/main/java/io/lighty/modules/northbound/restconf/community/impl/CommunityRestConfBuilder.java
@@ -9,6 +9,7 @@
 
 import io.lighty.modules.northbound.restconf.community.impl.config.RestConfConfiguration;
 import io.lighty.server.LightyJettyServerProvider;
+import org.opendaylight.aaa.web.WebContextSecurer;
 
 /**
  * Builder for {@link CommunityRestConf}.
@@ -17,6 +18,7 @@ public final class CommunityRestConfBuilder {
 
     private RestConfConfiguration restconfConfiguration = null;
     private LightyJettyServerProvider lightyServerBuilder = null;
+    private WebContextSecurer webContextSecurer;
 
 
     private CommunityRestConfBuilder(final RestConfConfiguration configuration) {
@@ -44,6 +46,17 @@ public CommunityRestConfBuilder withLightyServer(final LightyJettyServerProvider
         return this;
     }
 
+    /**
+     * Inject lighty web securer.
+     *
+     * @param webSecurer input web securer (can be null for no auth).
+     * @return instance of {@link CommunityRestConfBuilder}.
+     */
+    public CommunityRestConfBuilder withWebSecurer(final WebContextSecurer webSecurer) {
+        this.webContextSecurer = webSecurer;
+        return this;
+    }
+
     /**
      * Add ScheduledThreadPool.
      *
@@ -57,11 +70,9 @@ public CommunityRestConfBuilder withLightyServer(final LightyJettyServerProvider
      */
     public CommunityRestConf build() {
         return new CommunityRestConf(this.restconfConfiguration.getDomDataBroker(),
-            this.restconfConfiguration.getDomRpcService(),
-            this.restconfConfiguration.getDomActionService(), this.restconfConfiguration.getDomNotificationService(),
-            this.restconfConfiguration.getDomMountPointService(),
-            this.restconfConfiguration.getDomSchemaService(),
-            this.restconfConfiguration.getInetAddress(), this.restconfConfiguration.getHttpPort(),
-            this.restconfConfiguration.getRestconfServletContextPath(), this.lightyServerBuilder);
+            this.restconfConfiguration.getDomRpcService(), this.restconfConfiguration.getDomActionService(),
+            this.restconfConfiguration.getDomMountPointService(), this.restconfConfiguration.getDomSchemaService(),
+            this.restconfConfiguration.getInetAddress(),this.restconfConfiguration.getHttpPort(),
+            this.lightyServerBuilder, this.webContextSecurer);
     }
 }
