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