restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/JaxRsNorthbound.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 com.google.common.annotations.Beta;
  11 import javax.servlet.ServletException;
  12 import org.opendaylight.aaa.filterchain.configuration.CustomFilterAdapterConfiguration;
  13 import org.opendaylight.aaa.filterchain.filters.CustomFilterAdapter;
  14 import org.opendaylight.aaa.web.FilterDetails;
  15 import org.opendaylight.aaa.web.ServletDetails;
  16 import org.opendaylight.aaa.web.WebContext;
  17 import org.opendaylight.aaa.web.WebContextSecurer;
  18 import org.opendaylight.aaa.web.WebServer;
  19 import org.opendaylight.aaa.web.servlet.ServletSupport;
  20 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  21 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  22 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindProvider;
  23 import org.opendaylight.restconf.nb.rfc8040.rests.services.impl.MdsalRestconfServer;
  24 import org.opendaylight.restconf.nb.rfc8040.streams.RestconfStreamServletFactory;
  25 import org.opendaylight.yangtools.concepts.Registration;
  26 import org.osgi.service.component.annotations.Activate;
  27 import org.osgi.service.component.annotations.Component;
  28 import org.osgi.service.component.annotations.Deactivate;
  29 import org.osgi.service.component.annotations.Reference;
  30
  31 /**
  32  * Main entrypoint into RFC8040 northbound. Take care of wiring up all applications activating them through JAX-RS.
  33  */
  34 @Beta
  35 @Component(service = { })
  36 public final class JaxRsNorthbound implements AutoCloseable {
  37     private final Registration discoveryReg;
  38     private final Registration restconfReg;
  39
  40     @Activate
  41     public JaxRsNorthbound(@Reference final WebServer webServer, @Reference final WebContextSecurer webContextSecurer,
  42             @Reference final ServletSupport servletSupport,
  43             @Reference final CustomFilterAdapterConfiguration filterAdapterConfiguration,
  44             @Reference final DOMMountPointService mountPointService, @Reference final DOMSchemaService schemaService,
  45             @Reference final DatabindProvider databindProvider, @Reference final MdsalRestconfServer server,
  46             @Reference final RestconfStreamServletFactory servletFactory) throws ServletException {
  47         final var restconfBuilder = WebContext.builder()
  48             .name("RFC8040 RESTCONF")
  49             .contextPath("/" + URLConstants.BASE_PATH)
  50             .supportsSessions(false)
  51             .addServlet(ServletDetails.builder()
  52                 .addUrlPattern("/*")
  53                 .servlet(servletSupport.createHttpServletBuilder(
  54                     new RestconfApplication(databindProvider, server, mountPointService, schemaService))
  55                     .build())
  56                 .asyncSupported(true)
  57                 .build())
  58             .addServlet(ServletDetails.builder()
  59                 .addUrlPattern("/" + URLConstants.STREAMS_SUBPATH + "/*")
  60                 .servlet(servletFactory.newStreamServlet())
  61                 .name("notificationServlet")
  62                 .asyncSupported(true)
  63                 .build())
  64
  65             // Allows user to add javax.servlet.Filter(s) in front of REST services
  66             .addFilter(FilterDetails.builder()
  67                 .addUrlPattern("/*")
  68                 .filter(new CustomFilterAdapter(filterAdapterConfiguration))
  69                 .asyncSupported(true)
  70                 .build());
  71
  72         webContextSecurer.requireAuthentication(restconfBuilder, true, "/*");
  73
  74         restconfReg = webServer.registerWebContext(restconfBuilder.build());
  75
  76         final var discoveryBuilder = WebContext.builder()
  77             .name("RFC6415 Web Host Metadata")
  78             .contextPath("/.well-known")
  79             .supportsSessions(false)
  80             .addServlet(ServletDetails.builder()
  81                 .addUrlPattern("/*")
  82                 .servlet(servletSupport.createHttpServletBuilder(new RootFoundApplication(URLConstants.BASE_PATH))
  83                     .build())
  84                 .name("Rootfound")
  85                 .build());
  86
  87         webContextSecurer.requireAuthentication(discoveryBuilder, true, "/*");
  88
  89         discoveryReg = webServer.registerWebContext(discoveryBuilder.build());
  90     }
  91
  92     @Deactivate
  93     @Override
  94     public void close() {
  95         discoveryReg.close();
  96         restconfReg.close();
  97     }
  98 }