GAEListener.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.capedwarf.appidentity;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletRequest;
import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

import com.google.appengine.api.LifecycleManager;
import com.google.appengine.api.log.LogServiceFactory;
import com.google.appengine.api.modules.ModulesServiceFactory;
import org.jboss.capedwarf.common.apiproxy.CapedwarfDelegate;
import org.jboss.capedwarf.common.config.CapedwarfEnvironment;
import org.jboss.capedwarf.common.security.PrincipalInfo;
import org.jboss.capedwarf.cron.CronService;
import org.jboss.capedwarf.log.ExposedLogService;
import org.jboss.capedwarf.shared.components.AppIdFactory;
import org.jboss.capedwarf.shared.components.SimpleAppIdFactory;
import org.jboss.capedwarf.shared.config.AppEngineWebXml;
import org.jboss.capedwarf.shared.config.ApplicationConfiguration;
import org.jboss.capedwarf.shared.config.ConfigurationAware;

/**
 * Env setup is done in AS' CapedwarfSetupAction.
 *
 * @author <a href="mailto:marko.luksa@gmail.com">Marko Luksa</a>
 * @author <a href="mailto:ales.justin@jboss.org">Ales Justin</a>
 */
public class GAEListener extends ConfigurationAware implements ServletContextListener, ServletRequestListener {
    private volatile ExposedLogService logService;
    private AppIdFactory appIdFactory;

    private CronService cronService;

    // Invoked from CapedwarfSetupAction -- do not change signatures; reflection usage!

    public static void setup() {
        setupInternal(applicationConfigurationTL.get());
    }

    public static boolean isSetup() {
        return CapedwarfEnvironment.hasThreadLocalInstance();
    }

    public static void teardown() {
        try {
            final CapedwarfEnvironment env = CapedwarfEnvironment.getThreadLocalInstance();
            try {
                env.checkGlobalTimeLimit();
            } finally {
                CapedwarfEnvironment.clearThreadLocalInstance();
            }
        } finally {
            AppIdFactory.resetCurrentFactory();
        }
    }

    protected static void setupInternal(ApplicationConfiguration applicationConfiguration) {
        AppEngineWebXml appEngineWebXml = applicationConfiguration.getAppEngineWebXml();
        AppIdFactory.setCurrentFactory(new SimpleAppIdFactory(appEngineWebXml.getApplication(), appEngineWebXml.getModule()));

        CapedwarfEnvironment environment = CapedwarfEnvironment.createThreadLocalInstance();
        environment.setApplicationConfiguration(applicationConfiguration);
    }

    // Servlet / Request event handling

    public void contextInitialized(ServletContextEvent sce) {
        initialize();

        final String appId = applicationConfiguration.getAppEngineWebXml().getApplication();
        final String module = applicationConfiguration.getAppEngineWebXml().getModule();

        final ServletContext servletContext = sce.getServletContext();
        servletContext.setAttribute("org.jboss.capedwarf.appId", appId);
        servletContext.setAttribute("org.jboss.capedwarf.module", module);

        appIdFactory = new SimpleAppIdFactory(appId, module);
        cronService = CronService.create(applicationConfiguration);
    }

    public void contextDestroyed(ServletContextEvent sce) {
        final ServletContext servletContext = sce.getServletContext();

        try {
            cronService.destroy();
        } finally {
            String deadlineParameter = servletContext.getInitParameter("lifecycle-manager-deadline");
            long deadline = Long.parseLong((deadlineParameter != null) ? deadlineParameter : "0");
            LifecycleManager.getInstance().beginShutdown(deadline);
        }
    }

    public void requestInitialized(ServletRequestEvent sre) {
        AppIdFactory.setCurrentFactory(appIdFactory);

        long requestStartMillis = System.currentTimeMillis();

        final ServletRequest req = sre.getServletRequest();
        if (req instanceof HttpServletRequest) {
            initJBossEnvironment((HttpServletRequest) req);
        }

        CapedwarfDelegate.INSTANCE.addRequest(req);

        getLogService().requestStarted(req, requestStartMillis);
    }

    public void requestDestroyed(ServletRequestEvent sre) {
        try {
            final ServletRequest req = sre.getServletRequest();
            try {
                CapedwarfHttpServletResponseWrapper response = (CapedwarfHttpServletResponseWrapper) req.getAttribute(CapedwarfHttpServletResponseWrapper.class.getName());
                if (response != null) {
                    getLogService().requestFinished(req, response.getStatus(), response.getContentLength());
                } else {
                    // TODO -- looks like some error before GAEFilter kicked in.
                }
            } finally {
                CapedwarfDelegate.INSTANCE.removeRequest();
            }
        } finally {
            AppIdFactory.resetCurrentFactory();
        }
    }

    private void initJBossEnvironment(HttpServletRequest request) {
        CapedwarfEnvironment environment = CapedwarfEnvironment.getThreadLocalInstance();
        initServerData(environment);
        initRequestData(environment, request);
        initUserData(environment, request);
        environment.initialized();
    }

    private void initServerData(CapedwarfEnvironment environment) {
        environment.getAttributes().put(CapedwarfEnvironment.INSTANCE_ID, ModulesServiceFactory.getModulesService().getCurrentInstanceId());
    }

    private void initRequestData(CapedwarfEnvironment environment, HttpServletRequest request) {
        environment.setBaseApplicationUrl(request.getScheme(), request.getServerName(), request.getServerPort(), request.getContextPath());
    }

    private void initUserData(CapedwarfEnvironment environment, HttpServletRequest request) {
        HttpSession session = request.getSession();
        // our fake request doesn't create session
        if (session != null) {
            PrincipalInfo principal = (PrincipalInfo) session.getAttribute(CapedwarfHttpServletRequestWrapper.USER_PRINCIPAL_SESSION_ATTRIBUTE_KEY);
            if (principal != null) {
                environment.setUserId(principal.getUserId());
                environment.setEmail(principal.getName());
                environment.setAuthDomain(principal.getAuthDomain());
                environment.setAdmin(principal.isAdmin());
            }
        }
    }

    private ExposedLogService getLogService() {
        if (logService == null) {
            logService = (ExposedLogService) LogServiceFactory.getLogService();
        }
        return logService;
    }
}