/*
* #%L
* BroadleafCommerce Common Libraries
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* 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.
* #L%
*/
package org.broadleafcommerce.common.web.extensibility;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.broadleafcommerce.common.extensibility.context.MergeApplicationContextXmlConfigResource;
import org.broadleafcommerce.common.extensibility.context.ResourceInputStream;
import org.broadleafcommerce.common.extensibility.context.StandardConfigLocations;
import org.broadleafcommerce.common.extensibility.context.merge.ImportProcessor;
import org.broadleafcommerce.common.extensibility.context.merge.exceptions.MergeException;
import org.springframework.beans.BeansException;
import org.springframework.beans.FatalBeanException;
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.io.Resource;
import org.springframework.util.StringUtils;
import org.springframework.web.context.support.XmlWebApplicationContext;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.ArrayList;
/**
* {@link org.springframework.web.context.WebApplicationContext} implementation
* which takes its configuration from XML documents, understood by an
* {@link org.springframework.beans.factory.xml.XmlBeanDefinitionReader}.
*
* <p>By default, the configuration will be taken from "/WEB-INF/applicationContext.xml"
* for the rootId context, and "/WEB-INF/test-servlet.xml" for a context with the namespace
* "test-servlet" (like for a DispatcherServlet instance with the servlet-name "test").
*
* <p>The config location defaults can be overridden via the "contextConfigLocation"
* context-param of {@link org.springframework.web.context.ContextLoader} and servlet
* init-param of {@link org.springframework.web.servlet.FrameworkServlet}. Config locations
* can either denote concrete files like "/WEB-INF/context.xml" or Ant-style patterns
* like "/WEB-INF/*-context.xml" (see {@link org.springframework.util.PathMatcher}
* javadoc for pattern details).
*
* <p>Note: In case of multiple config locations, later bean definitions will
* override ones defined in earlier loaded files. This can be leveraged to
* deliberately override certain bean definitions via an extra XML file.
*
* <p>In addition to standard configuration, this implementation also takes a list of
* patch configuration files that are merged into the configuration provided above.
* {@link org.broadleafcommerce.profile.extensibility.MergeXmlConfigResourceFactory}. The patch
* file locations are set via the "patchConfigLocation" context-param of
* {@link MergeContextLoader}. Patch locations
* can either denote concrete files like "/WEB-INF/patch.xml" or Ant-style patterns
* like "/WEB-INF/*-context.xml" (see {@link org.springframework.util.pathMatcher}
* javadoc for pattern details).
*
* @author Jeff Fischer
*/
public class MergeXmlWebApplicationContext extends XmlWebApplicationContext {
private static final Log LOG = LogFactory.getLog(MergeXmlWebApplicationContext.class);
private String patchLocation;
private String shutdownBean;
private String shutdownMethod;
/**
* Load the bean definitions with the given XmlBeanDefinitionReader.
* <p>The lifecycle of the bean factory is handled by the refreshBeanFactory method;
* therefore this method is just supposed to load and/or register bean definitions.
* <p>Delegates to a ResourcePatternResolver for resolving location patterns
* into Resource instances.
* @throws org.springframework.beans.BeansException in case of bean registration errors
* @throws java.io.IOException if the required XML document isn't found
* @see #refreshBeanFactory
* @see #getConfigLocations
* @see #getResources
* @see #getResourcePatternResolver
*/
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
String[] broadleafConfigLocations = StandardConfigLocations.retrieveAll(StandardConfigLocations.APPCONTEXTTYPE);
ArrayList<ResourceInputStream> sources = new ArrayList<ResourceInputStream>(20);
for (String location : broadleafConfigLocations) {
InputStream source = MergeXmlWebApplicationContext.class.getClassLoader().getResourceAsStream(location);
if (source != null) {
sources.add(new ResourceInputStream(source, location));
}
}
ResourceInputStream[] filteredSources = new ResourceInputStream[]{};
filteredSources = sources.toArray(filteredSources);
String patchLocation = getPatchLocation();
String[] patchLocations = StringUtils.tokenizeToStringArray(patchLocation, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
ResourceInputStream[] patches = new ResourceInputStream[patchLocations.length];
for (int i = 0; i < patchLocations.length; i++) {
if (patchLocations[i].startsWith("classpath")) {
InputStream is = MergeXmlWebApplicationContext.class.getClassLoader().getResourceAsStream(patchLocations[i].substring("classpath*:".length(), patchLocations[i].length()));
patches[i] = new ResourceInputStream(is, patchLocations[i]);
} else {
Resource resource = getResourceByPath(patchLocations[i]);
patches[i] = new ResourceInputStream(resource.getInputStream(), patchLocations[i]);
}
if (patches[i] == null || patches[i].available() <= 0) {
throw new IOException("Unable to open an input stream on specified application context resource: " + patchLocations[i]);
}
}
ImportProcessor importProcessor = new ImportProcessor(this);
try {
filteredSources = importProcessor.extract(filteredSources);
patches = importProcessor.extract(patches);
} catch (MergeException e) {
throw new FatalBeanException("Unable to merge source and patch locations", e);
}
Resource[] resources = new MergeApplicationContextXmlConfigResource().getConfigResources(filteredSources, patches);
reader.loadBeanDefinitions(resources);
}
/* (non-Javadoc)
* @see org.springframework.context.support.AbstractApplicationContext#doClose()
*/
@Override
protected void doClose() {
if (getShutdownBean() != null && getShutdownMethod() != null) {
try {
Object shutdownBean = getBean(getShutdownBean());
Method shutdownMethod = shutdownBean.getClass().getMethod(getShutdownMethod(), new Class[]{});
shutdownMethod.invoke(shutdownBean, new Object[]{});
} catch (Throwable e) {
LOG.error("Unable to execute custom shutdown call", e);
}
}
super.doClose();
}
/**
* @return the patchLocation
*/
public String getPatchLocation() {
return patchLocation;
}
/**
* @param patchLocation the patchLocation to set
*/
public void setPatchLocation(String patchLocation) {
this.patchLocation = patchLocation;
}
/**
* @return the shutdownBean
*/
public String getShutdownBean() {
return shutdownBean;
}
/**
* @param shutdownBean the shutdownBean to set
*/
public void setShutdownBean(String shutdownBean) {
this.shutdownBean = shutdownBean;
}
/**
* @return the shutdownMethod
*/
public String getShutdownMethod() {
return shutdownMethod;
}
/**
* @param shutdownMethod the shutdownMethod to set
*/
public void setShutdownMethod(String shutdownMethod) {
this.shutdownMethod = shutdownMethod;
}
}