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.restconf.nb.jaxrs.JaxRsRestconf;
  23 import org.opendaylight.restconf.nb.jaxrs.JaxRsWebHostMetadata;
  24 import org.opendaylight.restconf.nb.jaxrs.JsonJaxRsFormattableBodyWriter;
  25 import org.opendaylight.restconf.nb.jaxrs.XmlJaxRsFormattableBodyWriter;
  26 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.JsonNormalizedNodeBodyWriter;
  27 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.XmlNormalizedNodeBodyWriter;
  28 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.errors.RestconfDocumentedExceptionMapper;
  29 import org.opendaylight.restconf.nb.rfc8040.streams.RestconfStreamServletFactory;
  30 import org.opendaylight.restconf.server.api.RestconfServer;
  31 import org.opendaylight.restconf.server.spi.DatabindProvider;
  32 import org.opendaylight.yangtools.concepts.Registration;
  33 import org.osgi.service.component.annotations.Activate;
  34 import org.osgi.service.component.annotations.Component;
  35 import org.osgi.service.component.annotations.Deactivate;
  36 import org.osgi.service.component.annotations.Reference;
  37
  38 /**
  39  * Main entrypoint into RFC8040 northbound. Take care of wiring up all applications activating them through JAX-RS.
  40  */
  41 @Beta
  42 @Component(service = { })
  43 public final class JaxRsNorthbound implements AutoCloseable {
  44     private final Registration discoveryReg;
  45     private final Registration restconfReg;
  46
  47     @Activate
  48     public JaxRsNorthbound(@Reference final WebServer webServer, @Reference final WebContextSecurer webContextSecurer,
  49             @Reference final ServletSupport servletSupport,
  50             @Reference final CustomFilterAdapterConfiguration filterAdapterConfiguration,
  51             @Reference final DatabindProvider databindProvider, @Reference final RestconfServer server,
  52             @Reference final RestconfStreamServletFactory servletFactory) throws ServletException {
  53         final var restconfBuilder = WebContext.builder()
  54             .name("RFC8040 RESTCONF")
  55             .contextPath("/" + servletFactory.restconf())
  56             .supportsSessions(false)
  57             .addServlet(ServletDetails.builder()
  58                 .addUrlPattern("/*")
  59                 .servlet(servletSupport.createHttpServletBuilder(
  60                     new Application() {
  61                         @Override
  62                         public Set<Class<?>> getClasses() {
  63                             return Set.of(JsonNormalizedNodeBodyWriter.class, XmlNormalizedNodeBodyWriter.class);
  64                         }
  65
  66                         @Override
  67                         public Set<Object> getSingletons() {
  68                             final var errorTagMapping = servletFactory.errorTagMapping();
  69
  70                             return Set.of(
  71                                 new JsonJaxRsFormattableBodyWriter(), new XmlJaxRsFormattableBodyWriter(),
  72                                 new RestconfDocumentedExceptionMapper(databindProvider, errorTagMapping),
  73                                 new JaxRsRestconf(server, errorTagMapping, servletFactory.prettyPrint()));
  74                         }
  75                     }).build())
  76                 .asyncSupported(true)
  77                 .build())
  78             .addServlet(ServletDetails.builder()
  79                 .addUrlPattern("/" + URLConstants.STREAMS_SUBPATH + "/*")
  80                 .servlet(servletFactory.newStreamServlet())
  81                 .name("notificationServlet")
  82                 .asyncSupported(true)
  83                 .build())
  84
  85             // Allows user to add javax.servlet.Filter(s) in front of REST services
  86             .addFilter(FilterDetails.builder()
  87                 .addUrlPattern("/*")
  88                 .filter(new CustomFilterAdapter(filterAdapterConfiguration))
  89                 .asyncSupported(true)
  90                 .build());
  91
  92         webContextSecurer.requireAuthentication(restconfBuilder, true, "/*");
  93
  94         restconfReg = webServer.registerWebContext(restconfBuilder.build());
  95
  96         final var discoveryBuilder = WebContext.builder()
  97             .name("RFC6415 Web Host Metadata")
  98             .contextPath("/.well-known")
  99             .supportsSessions(false)
 100             .addServlet(ServletDetails.builder()
 101                 .addUrlPattern("/*")
 102                 .servlet(servletSupport.createHttpServletBuilder(
 103                     new Application() {
 104                         @Override
 105                         public Set<Object> getSingletons() {
 106                             return Set.of(new JaxRsWebHostMetadata(servletFactory.restconf()));
 107                         }
 108                     }).build())
 109                 .name("Rootfound")
 110                 .build());
 111
 112         webContextSecurer.requireAuthentication(discoveryBuilder, true, "/*");
 113
 114         discoveryReg = webServer.registerWebContext(discoveryBuilder.build());
 115     }
 116
 117     @Deactivate
 118     @Override
 119     public void close() {
 120         discoveryReg.close();
 121         restconfReg.close();
 122     }
 123 }