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