Extract services manager into a top-level injectable manager

James Moger

2014-07-02 7d3a31514afbe88664081b4ea57cd7939de99014

 src/main/java/com/gitblit/servlet/GitblitContext.java

@@ -23,24 +23,25 @@
import java.io.OutputStream;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.servlet.ServletContext;
import javax.servlet.annotation.WebListener;
import javax.servlet.ServletContextEvent;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.gitblit.Constants;
import com.gitblit.FileSettings;
import com.gitblit.IStoredSettings;
import com.gitblit.Keys;
import com.gitblit.WebXmlSettings;
import com.gitblit.dagger.DaggerContext;
import com.gitblit.dagger.DaggerModule;
import com.gitblit.extensions.LifeCycleListener;
import com.gitblit.guice.CoreModule;
import com.gitblit.guice.WebModule;
import com.gitblit.manager.IAuthenticationManager;
import com.gitblit.manager.IFederationManager;
import com.gitblit.manager.IGitblit;
@@ -50,13 +51,15 @@
import com.gitblit.manager.IProjectManager;
import com.gitblit.manager.IRepositoryManager;
import com.gitblit.manager.IRuntimeManager;
import com.gitblit.manager.IServicesManager;
import com.gitblit.manager.IUserManager;
import com.gitblit.transport.ssh.IPublicKeyManager;
import com.gitblit.utils.ContainerUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.wicket.GitblitWicketFilter;

import dagger.ObjectGraph;
import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.servlet.GuiceServletContextListener;

/**
 * This class is the main entry point for the entire webapp.  It is a singleton
@@ -69,10 +72,11 @@
 * @author James Moger
 *
 */
@WebListener
public class GitblitContext extends DaggerContext {
public class GitblitContext extends GuiceServletContextListener {

   private static GitblitContext gitblit;

   protected final Logger logger = LoggerFactory.getLogger(getClass());

   private final List<IManager> managers = new ArrayList<IManager>();

@@ -115,23 +119,40 @@
      return null;
   }

   @Override
   protected Injector getInjector() {
      return Guice.createInjector(getModules());
   }

   /**
    * Returns Gitblit's Dagger injection modules.
    * Returns Gitblit's Guice injection modules.
    */
   protected AbstractModule [] getModules() {
      return new AbstractModule [] { new CoreModule(), new WebModule() };
   }

   /**
    * Configure Gitblit from the web.xml, if no configuration has already been
    * specified.
    *
    * @see ServletContextListener.contextInitialize(ServletContextEvent)
    */
   @Override
   protected Object [] getModules() {
      return new Object [] { new DaggerModule() };
   public final void contextInitialized(ServletContextEvent contextEvent) {
      super.contextInitialized(contextEvent);

      ServletContext context = contextEvent.getServletContext();
      startCore(context);
   }

   /**
    * Prepare runtime settings and start all manager instances.
    */
   @Override
   protected void beforeServletInjection(ServletContext context) {
      ObjectGraph injector = getInjector(context);
   protected void startCore(ServletContext context) {
      Injector injector = (Injector) context.getAttribute(Injector.class.getName());

      // create the runtime settings object
      IStoredSettings runtimeSettings = injector.get(IStoredSettings.class);
      IStoredSettings runtimeSettings = injector.getInstance(IStoredSettings.class);
      final File baseFolder;

      if (goSettings != null) {
@@ -161,7 +182,7 @@

      // Manually configure IRuntimeManager
      logManager(IRuntimeManager.class);
      IRuntimeManager runtime = injector.get(IRuntimeManager.class);
      IRuntimeManager runtime = injector.getInstance(IRuntimeManager.class);
      runtime.setBaseFolder(baseFolder);
      runtime.getStatus().isGO = goSettings != null;
      runtime.getStatus().servletContainer = context.getServerInfo();
@@ -180,6 +201,7 @@
      startManager(injector, IProjectManager.class);
      startManager(injector, IFederationManager.class);
      startManager(injector, IGitblit.class);
      startManager(injector, IServicesManager.class);

      // start the plugin manager last so that plugins can depend on
      // deterministic access to all other managers in their start() methods
@@ -189,7 +211,7 @@
      logger.info("All managers started.");
      logger.info("");

      IPluginManager pluginManager = injector.get(IPluginManager.class);
      IPluginManager pluginManager = injector.getInstance(IPluginManager.class);
      for (LifeCycleListener listener : pluginManager.getExtensions(LifeCycleListener.class)) {
         try {
            listener.onStartup();
@@ -211,12 +233,12 @@
      return null;
   }

   protected <X extends IManager> X loadManager(ObjectGraph injector, Class<X> clazz) {
      X x = injector.get(clazz);
   protected <X extends IManager> X loadManager(Injector injector, Class<X> clazz) {
      X x = injector.getInstance(clazz);
      return x;
   }

   protected <X extends IManager> X startManager(ObjectGraph injector, Class<X> clazz) {
   protected <X extends IManager> X startManager(Injector injector, Class<X> clazz) {
      X x = loadManager(injector, clazz);
      logManager(clazz);
      x.start();
@@ -229,46 +251,17 @@
      logger.info("----[{}]----", clazz.getName());
   }

   /**
    * Instantiate and inject all filters and servlets into the container using
    * the servlet 3 specification.
    */
   @Override
   protected void injectServlets(ServletContext context) {
      // access restricted servlets
      serve(context, Constants.R_PATH, GitServlet.class, GitFilter.class);
      serve(context, Constants.GIT_PATH, GitServlet.class, GitFilter.class);
      serve(context, Constants.RAW_PATH, RawServlet.class, RawFilter.class);
      serve(context, Constants.PAGES, PagesServlet.class, PagesFilter.class);
      serve(context, Constants.RPC_PATH, RpcServlet.class, RpcFilter.class);
      serve(context, Constants.ZIP_PATH, DownloadZipServlet.class, DownloadZipFilter.class);
      serve(context, Constants.SYNDICATION_PATH, SyndicationServlet.class, SyndicationFilter.class);

      // servlets
      serve(context, Constants.FEDERATION_PATH, FederationServlet.class);
      serve(context, Constants.SPARKLESHARE_INVITE_PATH, SparkleShareInviteServlet.class);
      serve(context, Constants.BRANCH_GRAPH_PATH, BranchGraphServlet.class);
      serve(context, Constants.PT_PATH, PtServlet.class);
      file(context, "/robots.txt", RobotsTxtServlet.class);
      file(context, "/logo.png", LogoServlet.class);

      // global filters
      filter(context, "/*", ProxyFilter.class, null);
      filter(context, "/*", EnforceAuthenticationFilter.class, null);

      // Wicket
      String toIgnore = StringUtils.flattenStrings(getRegisteredPaths(), ",");
      Map<String, String> params = new HashMap<String, String>();
      params.put(GitblitWicketFilter.FILTER_MAPPING_PARAM, "/*");
      params.put(GitblitWicketFilter.IGNORE_PATHS_PARAM, toIgnore);
      filter(context, "/*", GitblitWicketFilter.class, params);
   public final void contextDestroyed(ServletContextEvent contextEvent) {
      super.contextDestroyed(contextEvent);
      ServletContext context = contextEvent.getServletContext();
      destroyContext(context);
   }

   /**
    * Gitblit is being shutdown either because the servlet container is
    * shutting down or because the servlet container is re-deploying Gitblit.
    */
   @Override
   protected void destroyContext(ServletContext context) {
      logger.info("Gitblit context destroyed by servlet container.");