restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/web/WebInitializer.java

   1 /*
   2  * Copyright (c) 2018 Inocybe Technologies 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.web;
   9
  10 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.DATA_SUBSCRIPTION;
  11 import static org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants.NOTIFICATION_STREAM;
  12 import static org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants.BASE_URI_PATTERN;
  13 import static org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants.NOTIF;
  14
  15 import javax.annotation.PreDestroy;
  16 import javax.inject.Inject;
  17 import javax.inject.Singleton;
  18 import javax.servlet.ServletException;
  19 import org.opendaylight.aaa.filterchain.configuration.CustomFilterAdapterConfiguration;
  20 import org.opendaylight.aaa.filterchain.filters.CustomFilterAdapter;
  21 import org.opendaylight.aaa.web.FilterDetails;
  22 import org.opendaylight.aaa.web.ServletDetails;
  23 import org.opendaylight.aaa.web.WebContext;
  24 import org.opendaylight.aaa.web.WebContextSecurer;
  25 import org.opendaylight.aaa.web.WebServer;
  26 import org.opendaylight.aaa.web.servlet.ServletSupport;
  27 import org.opendaylight.restconf.nb.rfc8040.DataStreamApplication;
  28 import org.opendaylight.restconf.nb.rfc8040.RestconfApplication;
  29 import org.opendaylight.restconf.nb.rfc8040.RootFoundApplication;
  30 import org.opendaylight.restconf.nb.rfc8040.streams.WebSocketInitializer;
  31 import org.opendaylight.yangtools.concepts.Registration;
  32
  33 /**
  34  * Initializes the rfc8040 web app endpoint.
  35  *
  36  * @author Thomas Pantelis
  37  */
  38 @Singleton
  39 public final class WebInitializer implements AutoCloseable {
  40     private final Registration discoveryReg;
  41     private final Registration restconfReg;
  42
  43     @Inject
  44     public WebInitializer(final WebServer webServer, final WebContextSecurer webContextSecurer,
  45             final ServletSupport servletSupport, final RestconfApplication webApp,
  46             final DataStreamApplication webAppNotif,
  47             final CustomFilterAdapterConfiguration customFilterAdapterConfig,
  48             final WebSocketInitializer webSocketServlet) throws ServletException {
  49         final var restconfBuilder = WebContext.builder()
  50             .name("RFC8040 RESTCONF")
  51             .contextPath("/" + BASE_URI_PATTERN)
  52             .supportsSessions(false)
  53             .addServlet(ServletDetails.builder()
  54                 .addUrlPattern("/*")
  55                 .servlet(servletSupport.createHttpServletBuilder(webApp).build())
  56                 .asyncSupported(true)
  57                 .build())
  58             .addServlet(ServletDetails.builder()
  59                 .addUrlPattern("/" + NOTIF + "/*")
  60                 .servlet(servletSupport.createHttpServletBuilder(webAppNotif).build())
  61                 .name("notificationServlet")
  62                 .asyncSupported(true)
  63                 .build())
  64             .addServlet(ServletDetails.builder()
  65                 .addUrlPattern("/" + DATA_SUBSCRIPTION + "/*")
  66                 .addUrlPattern("/" + NOTIFICATION_STREAM + "/*")
  67                 .servlet(webSocketServlet)
  68                 .build())
  69
  70             // Allows user to add javax.servlet.Filter(s) in front of REST services
  71             .addFilter(FilterDetails.builder()
  72                 .addUrlPattern("/*")
  73                 .filter(new CustomFilterAdapter(customFilterAdapterConfig))
  74                 .asyncSupported(true)
  75                 .build());
  76
  77         webContextSecurer.requireAuthentication(restconfBuilder, true, "/*");
  78
  79         restconfReg = webServer.registerWebContext(restconfBuilder.build());
  80
  81         final var discoveryBuilder = WebContext.builder()
  82             .name("RFC6415 Web Host Metadata")
  83             .contextPath("/.well-known")
  84             .supportsSessions(false)
  85             .addServlet(ServletDetails.builder()
  86                 .addUrlPattern("/*")
  87                 .servlet(servletSupport.createHttpServletBuilder(new RootFoundApplication(BASE_URI_PATTERN)).build())
  88                 .name("Rootfound")
  89                 .build());
  90
  91         webContextSecurer.requireAuthentication(discoveryBuilder, true, "/*");
  92
  93         discoveryReg = webServer.registerWebContext(discoveryBuilder.build());
  94     }
  95
  96     @PreDestroy
  97     @Override
  98     public void close() {
  99         discoveryReg.close();
 100         restconfReg.close();
 101     }
 102 }