/*
* Copyright 2007-2010 the original author or authors.
*
* 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.impalaframework.web.spring.integration;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServlet;
import org.impalaframework.module.ModuleDefinition;
import org.impalaframework.module.definition.ModuleDefinitionAware;
import org.impalaframework.util.ObjectUtils;
import org.impalaframework.web.integration.IntegrationServletConfig;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanCreationException;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.util.Assert;
import org.springframework.web.context.ServletContextAware;
/**
* <code>FactoryBean</code> which can be used to instantiate an <code>HttpServlet</code> instance.
*
* <i>Init Parameters</i> are passed in via a <code>Map</code>.
* @author Phil Zoio
*/
public class ServletFactoryBean implements FactoryBean<Servlet>, ServletContextAware, InitializingBean, DisposableBean, ModuleDefinitionAware, ApplicationContextAware {
private ServletContext servletContext;
private Map<String,String> initParameters;
private Servlet servlet;
private String servletName;
private Class<?> servletClass;
private ApplicationContext applicationContext;
private ModuleDefinition moduleDefintion;
public Servlet getObject() throws Exception {
return getServlet();
}
public Class<?> getObjectType() {
return Servlet.class;
}
public boolean isSingleton() {
return true;
}
/* ***************** InitializingBean implementation **************** */
public void afterPropertiesSet() throws Exception {
Assert.notNull(servletContext, "servletContext cannot be null - are you sure that the current module is configured as a web module?");
Assert.notNull(servletClass, "servletClass cannot be null");
this.initParameters = (initParameters != null ? new HashMap<String, String>(initParameters) : new HashMap<String, String>());
if (servletName == null) {
if (moduleDefintion == null) {
throw new BeanCreationException("No servlet name provide, and module definition is null");
}
servletName = moduleDefintion.getName();
}
servlet = ObjectUtils.cast(BeanUtils.instantiateClass(servletClass), Servlet.class);
IntegrationServletConfig config = newServletConfig(initParameters);
if (servlet instanceof ApplicationContextAware) {
ApplicationContextAware awa = (ApplicationContextAware) servlet;
awa.setApplicationContext(applicationContext);
}
initServletProperties(servlet);
servlet.init(config);
}
/* ***************** public methods **************** */
public String getServletName() {
return servletName;
}
/* ***************** protected methods **************** */
private IntegrationServletConfig newServletConfig(Map<String, String> parameterMap) {
IntegrationServletConfig config = new IntegrationServletConfig(parameterMap, this.servletContext, this.servletName);
return config;
}
/**
* Hook for subclasses to customise servlet properties
*/
protected void initServletProperties(Servlet servlet) {
}
/* ***************** Protected getters **************** */
protected ServletContext getServletContext() {
return servletContext;
}
protected Map<String, String> getInitParameters() {
return initParameters;
}
protected Servlet getServlet() {
return servlet;
}
/* ***************** DisposableBean implementation **************** */
public void destroy() throws Exception {
servlet.destroy();
}
/* ***************** Protected getters **************** */
protected ApplicationContext getApplicationContext() {
return applicationContext;
}
protected ModuleDefinition getModuleDefintion() {
return moduleDefintion;
}
protected Class<?> getServletClass() {
return servletClass;
}
/* ***************** injection setters **************** */
public void setServletContext(ServletContext servletContext) {
this.servletContext = servletContext;
}
public void setInitParameters(Map<String, String> initParameters) {
this.initParameters = initParameters;
}
public void setServlet(HttpServlet servlet) {
this.servlet = servlet;
}
public void setServletName(String servletName) {
this.servletName = servletName;
}
public void setServletClass(Class<?> servletClass) {
this.servletClass = servletClass;
}
public void setModuleDefinition(ModuleDefinition moduleDefinition) {
this.moduleDefintion = moduleDefinition;
}
public void setApplicationContext(ApplicationContext applicationContext)
throws BeansException {
this.applicationContext = applicationContext;
}
}