restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/web/Bierman02WebRegistrarImpl.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.netconf.sal.restconf.web;
   9
  10 import javax.servlet.ServletException;
  11 import javax.ws.rs.core.Application;
  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.WebContextBuilder;
  18 import org.opendaylight.aaa.web.WebContextRegistration;
  19 import org.opendaylight.aaa.web.WebContextSecurer;
  20 import org.opendaylight.aaa.web.WebServer;
  21 import org.opendaylight.aaa.web.servlet.ServletSupport;
  22
  23 /**
  24  * Implementation of Bierman02WebRegistrar.
  25  *
  26  * @author Thomas Pantelis
  27  */
  28 public class Bierman02WebRegistrarImpl implements Bierman02WebRegistrar {
  29
  30     private WebContextRegistration registraton;
  31     private final WebServer webServer;
  32     private final WebContextSecurer webContextSecurer;
  33     private final ServletSupport servletSupport;
  34     private final Application webApp;
  35     private final CustomFilterAdapterConfiguration customFilterAdapterConfig;
  36
  37     public Bierman02WebRegistrarImpl(WebServer webServer,  WebContextSecurer webContextSecurer,
  38             ServletSupport servletSupport, Application webApp,
  39             CustomFilterAdapterConfiguration customFilterAdapterConfig) {
  40         this.webServer = webServer;
  41         this.webContextSecurer = webContextSecurer;
  42         this.servletSupport = servletSupport;
  43         this.webApp = webApp;
  44         this.customFilterAdapterConfig = customFilterAdapterConfig;
  45     }
  46
  47     public void close() {
  48         if (registraton != null) {
  49             registraton.close();
  50         }
  51     }
  52
  53     @Override
  54     public void registerWithAuthentication() {
  55         register(true);
  56     }
  57
  58     @Override
  59     public void registerWithoutAuthentication() {
  60         register(false);
  61     }
  62
  63     private void register(boolean authenticate) {
  64         WebContextBuilder webContextBuilder = WebContext.builder().contextPath("restconf").supportsSessions(true)
  65                 .addServlet(ServletDetails.builder().servlet(servletSupport.createHttpServletBuilder(webApp).build())
  66                     .addUrlPattern("/*").build())
  67
  68                 // Allows user to add javax.servlet.Filter(s) in front of REST services
  69                 .addFilter(FilterDetails.builder().filter(new CustomFilterAdapter(customFilterAdapterConfig))
  70                     .addUrlPattern("/*").build())
  71
  72                 .addFilter(FilterDetails.builder().filter(new org.eclipse.jetty.servlets.GzipFilter())
  73                     .putInitParam("mimeTypes",
  74                         "application/xml,application/yang.data+xml,xml,application/json,application/yang.data+json")
  75                     .addUrlPattern("/*").build());
  76
  77         if (authenticate) {
  78             webContextSecurer.requireAuthentication(webContextBuilder, "/*");
  79         }
  80
  81         try {
  82             registraton = webServer.registerWebContext(webContextBuilder.build());
  83         } catch (ServletException e) {
  84             throw new RuntimeException("Failed to register the web context", e);
  85         }
  86     }
  87 }