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