src/java/de/uapcore/lightpit/ModuleManager.java

Sun, 26 Nov 2017 18:09:23 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 26 Nov 2017 18:09:23 +0100
changeset 6
da61a1646eba
child 7
598670d5b0b8
permissions
-rw-r--r--

adds module manager

universe@6 1 /*
universe@6 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@6 3 *
universe@6 4 * Copyright 2017 Mike Becker. All rights reserved.
universe@6 5 *
universe@6 6 * Redistribution and use in source and binary forms, with or without
universe@6 7 * modification, are permitted provided that the following conditions are met:
universe@6 8 *
universe@6 9 * 1. Redistributions of source code must retain the above copyright
universe@6 10 * notice, this list of conditions and the following disclaimer.
universe@6 11 *
universe@6 12 * 2. Redistributions in binary form must reproduce the above copyright
universe@6 13 * notice, this list of conditions and the following disclaimer in the
universe@6 14 * documentation and/or other materials provided with the distribution.
universe@6 15 *
universe@6 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@6 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@6 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@6 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@6 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@6 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@6 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@6 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@6 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@6 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@6 26 * POSSIBILITY OF SUCH DAMAGE.
universe@6 27 *
universe@6 28 */
universe@6 29 package de.uapcore.lightpit;
universe@6 30
universe@6 31 import java.util.logging.Level;
universe@6 32 import java.util.logging.Logger;
universe@6 33 import javax.servlet.ServletContext;
universe@6 34 import javax.servlet.ServletContextEvent;
universe@6 35 import javax.servlet.ServletContextListener;
universe@6 36 import javax.servlet.ServletRegistration;
universe@6 37 import javax.servlet.annotation.WebListener;
universe@6 38
universe@6 39 /**
universe@6 40 * Scans registered servlets for LightPIT modules.
universe@6 41 */
universe@6 42 @WebListener
universe@6 43 public class ModuleManager implements ServletContextListener {
universe@6 44
universe@6 45 private static final Logger LOG = Logger.getLogger(ModuleManager.class.getName());
universe@6 46
universe@6 47 /**
universe@6 48 * The attribute name in the servlet context under which an instance of this class can be found.
universe@6 49 */
universe@6 50 public static final String SC_ATTR_NAME = ModuleManager.class.getName();
universe@6 51
universe@6 52 private ServletContext sc;
universe@6 53
universe@6 54 @Override
universe@6 55 public void contextInitialized(ServletContextEvent sce) {
universe@6 56 sc = sce.getServletContext();
universe@6 57 reloadAll();
universe@6 58 sc.setAttribute(SC_ATTR_NAME, this);
universe@6 59 LOG.info("Module manager injected into ServletContext.");
universe@6 60 }
universe@6 61
universe@6 62 @Override
universe@6 63 public void contextDestroyed(ServletContextEvent sce) {
universe@6 64 assert sc != null && sc.equals(sce.getServletContext());
universe@6 65 sc.removeAttribute(SC_ATTR_NAME);
universe@6 66 unloadAll();
universe@6 67 }
universe@6 68
universe@6 69 private boolean isRegisteredAsModule(ServletRegistration sr) {
universe@6 70 try {
universe@6 71 final Class scclass = Class.forName(sr.getClassName());
universe@6 72 return scclass.isAnnotationPresent(LightPITModule.class);
universe@6 73 } catch (ClassNotFoundException ex) {
universe@6 74 LOG.log(Level.SEVERE,
universe@6 75 "Servlet registration refers to a class which cannot be found by the class loader: {0}",
universe@6 76 sr.getClassName());
universe@6 77 return false;
universe@6 78 }
universe@6 79 }
universe@6 80
universe@6 81 private void handleServletRegistration(String name, ServletRegistration sr) {
universe@6 82 if (isRegisteredAsModule(sr)) {
universe@6 83 LOG.log(Level.CONFIG, "Module detected: {0}", name);
universe@6 84 } else {
universe@6 85 LOG.log(Level.FINE, "Servlet {0} is no module, skipping.", name);
universe@6 86 }
universe@6 87 }
universe@6 88
universe@6 89 /**
universe@6 90 * Scans for modules and reloads them all.
universe@6 91 */
universe@6 92 public void reloadAll() {
universe@6 93 sc.getServletRegistrations().forEach(this::handleServletRegistration);
universe@6 94 LOG.info("Modules loaded.");
universe@6 95 }
universe@6 96
universe@6 97 /**
universe@6 98 * Unloads all found modules.
universe@6 99 */
universe@6 100 public void unloadAll() {
universe@6 101 LOG.info("All modules unloaded.");
universe@6 102 }
universe@6 103 }

mercurial