com.github.flowersinthesand.portal.atmosphere.AtmosphereModule Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2013 Donghwan Kim
 *
 * 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 com.github.flowersinthesand.portal.atmosphere;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

import org.atmosphere.cpr.ApplicationConfig;
import org.atmosphere.cpr.AtmosphereFramework;
import org.atmosphere.cpr.AtmosphereServlet;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.github.flowersinthesand.portal.Options;
import com.github.flowersinthesand.portal.spi.Module;

public class AtmosphereModule implements Module {

	private final Logger logger = LoggerFactory.getLogger(AtmosphereModule.class);

	private ServletContext servletContext;
	private AtmosphereFramework framework;

	public AtmosphereModule(ServletContext servletContext) {
		this.servletContext = servletContext;
	}

	public AtmosphereModule(AtmosphereFramework framework) {
		this.framework = framework;
	}

	@Override
	public void configure(Options options) {
		if (servletContext != null) {
			installAtmosphere(servletContext, options);
		}
		if (framework == null) {
			throw new IllegalArgumentException("There is no AtmosphereFramework");
		}

		options.bean("url", options.url()).bean(AtmosphereFramework.class.getName(), framework);
	}

	private void installAtmosphere(ServletContext context, Options options) {
		AtmosphereServlet servlet = null;
		try {
			servlet = context.createServlet(AtmosphereServlet.class);
		} catch (ServletException e) {
			throw new IllegalStateException(e);
		}

		ServletRegistration.Dynamic registration = context.addServlet("portal#" + options.name(), servlet);
		registration.setLoadOnStartup(0);
		registration.setAsyncSupported(true);
		registration.addMapping(options.url());
		registration.setInitParameter(ApplicationConfig.DISABLE_ATMOSPHEREINTERCEPTOR, Boolean.FALSE.toString());
		modifyAtmosphereServletRegistration(registration);
		logger.info("AtmosphereServlet '{}' is installed in accordance with the registration '{}'", servlet, registration);

		framework = servlet.framework();
	}

	protected void modifyAtmosphereServletRegistration(ServletRegistration.Dynamic registration) {}

}