org.atmosphere.cpr.AtmosphereInitializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atmosphere-runtime Show documentation
There is a newer version: 3.0.5.slf4jvaadin1
/*
 * Copyright 2015 Async-IO.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.atmosphere.cpr;

import org.atmosphere.container.JSR356AsyncSupport;
import org.atmosphere.util.IOUtils;
import org.atmosphere.util.Utils;

import javax.servlet.ServletContainerInitializer;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;
import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.annotation.HandlesTypes;
import javax.servlet.http.HttpServletRequest;

import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static org.atmosphere.cpr.ApplicationConfig.PROPERTY_SESSION_SUPPORT;

/**
 * Initializer for the AtmosphereFramework per servlet instance, 
 * this initializer is called during web-application startup lifecycle (since Servlet 3.0).
 * If you need to disable automatic initialization add the following configuration to your web.xml.
 * e.g.
 *  * <init-param>
 * <param-name>org.atmosphere.cpr.AtmosphereInitializer.disabled</param-name>
 * <param-value>true</param-value>
 * </init-param>
 * 
 */

@HandlesTypes({})
public class AtmosphereInitializer implements ServletContainerInitializer {
    private static final String DISABLE_SWITCH_KEY="org.atmosphere.cpr.AtmosphereInitializer.disabled";

    @Override
    public void onStartup(Set> classes, final ServletContext c) throws ServletException {
        c.log("Initializing AtmosphereFramework");
        for (Map.Entry reg : c.getServletRegistrations().entrySet()) {
            String disableSwitchValue = reg.getValue().getInitParameter(DISABLE_SWITCH_KEY);
            // check if AtmosphereInitializer is disabled via web.xml see: https://github.com/Atmosphere/atmosphere/issues/1695
            if (Boolean.parseBoolean(disableSwitchValue)){
            	c.log("container managed initialization disabled for servlet: "+reg.getValue().getName());
            	continue;
            } 
        	
			if (c.getAttribute(reg.getKey()) == null && IOUtils.isAtmosphere(reg.getValue().getClassName()))  {

                final AtmosphereFramework framework = new AtmosphereFramework(false, true);
                // Hack to make jsr356 works. Pretty ugly.
                DefaultAsyncSupportResolver resolver = new DefaultAsyncSupportResolver(framework.getAtmosphereConfig());
                List> l = resolver.detectWebSocketPresent(false, true);

                // Don't use WebLogic Native WebSocket support if JSR356 is available
                int size = c.getServerInfo().contains("WebLogic") ? 1 : 0;

                if (l.size() == size && resolver.testClassExists(DefaultAsyncSupportResolver.JSR356_WEBSOCKET)) {
                    framework.setAsyncSupport(new JSR356AsyncSupport(new AtmosphereConfig(framework) {
                        public ServletContext getServletContext() {
                            return c;
                        }

                        public String getInitParameter(String name) {
                            return c.getInitParameter(name);
                        }

                        public Enumeration getInitParameterNames() {
                            return c.getInitParameterNames();
                        }
                    }));
                }

                try {
                    c.addListener(new ServletRequestListener() {
                        @Override
                        public void requestDestroyed(ServletRequestEvent sre) {
                        }

                        @Override
                        public void requestInitialized(ServletRequestEvent sre) {
                            HttpServletRequest r = HttpServletRequest.class.cast(sre.getServletRequest());
                            if (framework.getAtmosphereConfig().isSupportSession() && Utils.webSocketEnabled(r)) {
                                r.getSession(true);
                            }
                        }
                    });
                } catch (Throwable t) {
                	c.log("AtmosphereFramework : Unable to install WebSocket Session Creator", t);
                }

                try {
                    String s = c.getInitParameter(PROPERTY_SESSION_SUPPORT);
                    if (s != null) {
                        boolean sessionSupport = Boolean.valueOf(s);
                        if (sessionSupport && c.getMajorVersion() > 2) {
                            c.addListener(SessionSupport.class);
                            c.log("AtmosphereFramework : Installed "+SessionSupport.class);
                        }
                    }
                } catch (Throwable t) {
                	c.log("AtmosphereFramework : SessionSupport error. Make sure you also define {} as a listener in web.xml, see https://github.com/Atmosphere/atmosphere/wiki/Enabling-HttpSession-Support", t);
                }

                c.setAttribute(reg.getKey(), framework);
            }
        }
    }
}