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
  14 import java.util.List;
  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.WebContextBuilder;
  25 import org.opendaylight.aaa.web.WebContextSecurer;
  26 import org.opendaylight.aaa.web.WebServer;
  27 import org.opendaylight.aaa.web.servlet.ServletSupport;
  28 import org.opendaylight.restconf.nb.rfc8040.DataStreamApplication;
  29 import org.opendaylight.restconf.nb.rfc8040.RestconfApplication;
  30 import org.opendaylight.restconf.nb.rfc8040.RootFoundApplication;
  31 import org.opendaylight.restconf.nb.rfc8040.streams.WebSocketInitializer;
  32 import org.opendaylight.yangtools.concepts.Registration;
  33
  34 /**
  35  * Initializes the rfc8040 web app endpoint.
  36  *
  37  * @author Thomas Pantelis
  38  */
  39 @Singleton
  40 public class WebInitializer {
  41     private final Registration registration;
  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         WebContextBuilder webContextBuilder = WebContext.builder()
  50             .contextPath("/")
  51             .supportsSessions(false)
  52             .addServlet(ServletDetails.builder()
  53                 .addUrlPattern("/" + BASE_URI_PATTERN + "/*")
  54                 .servlet(servletSupport.createHttpServletBuilder(webApp).build())
  55                 .asyncSupported(true)
  56                 .build())
  57             .addServlet(ServletDetails.builder()
  58                 .addUrlPattern("/" + BASE_URI_PATTERN + "/notif/*")
  59                 .servlet(servletSupport.createHttpServletBuilder(webAppNotif).build())
  60                 .name("notificationServlet")
  61                 .asyncSupported(true)
  62                 .build())
  63             .addServlet(ServletDetails.builder()
  64                 .addAllUrlPatterns(List.of(
  65                     "/" + BASE_URI_PATTERN + "/" + DATA_SUBSCRIPTION + "/*",
  66                     "/" + BASE_URI_PATTERN + "/" + NOTIFICATION_STREAM + "/*"))
  67                 .servlet(webSocketServlet)
  68                 .build())
  69             .addServlet(ServletDetails.builder()
  70                 .addUrlPattern("/.well-known/*")
  71                 .servlet(servletSupport.createHttpServletBuilder(new RootFoundApplication(BASE_URI_PATTERN)).build())
  72                 .name("Rootfound")
  73                 .build())
  74
  75             // Allows user to add javax.servlet.Filter(s) in front of REST services
  76             .addFilter(FilterDetails.builder()
  77                 .addUrlPattern("/*")
  78                 .filter(new CustomFilterAdapter(customFilterAdapterConfig))
  79                 .asyncSupported(true)
  80                 .build());
  81
  82         webContextSecurer.requireAuthentication(webContextBuilder, true, "/" + BASE_URI_PATTERN + "/*");
  83
  84         registration = webServer.registerWebContext(webContextBuilder.build());
  85     }
  86
  87     @PreDestroy
  88     public void close() {
  89         if (registration != null) {
  90             registration.close();
  91         }
  92     }
  93 }