com.apporiented.spring.override.BeanOverrideProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-override Show documentation
Namespace handler that allows for overriding, extending or modifying Spring beans in an modular environment.
The newest version!
/* 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.apporiented.spring.override;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.config.ConstructorArgumentValues;
import org.springframework.core.PriorityOrdered;

/**
 * BeanFactoryPostProcessor that can be used to replace beans that have been
 * defined elsewhere. Use this class when you want to write a Riot module that
 * needs to replace a bean which is provided by another module.
 * Simply defining a bean with the same id would not work, because the order
 * in which the module configurations are processed is not defined.  
 * 
 * @author Felix Gnass [fgnass at neteye dot de]
 */
public class BeanOverrideProcessor implements BeanFactoryPostProcessor, PriorityOrdered {

	private Logger log = LoggerFactory.getLogger(BeanOverrideProcessor.class);
	
	private String ref;

	private BeanDefinition beanDefinition;
	
	private boolean merge;
	
	private int order = 1;
	
	public void setRef(String ref) {
		this.ref = ref;
	}

	public void setBeanDefinition(BeanDefinition beanDefinition) {
		this.beanDefinition = beanDefinition;
	}

	public void setBeanReplacement(OverrideNamespaceHandler.BeanReplacement replacement) {
		setBeanDefinition(replacement.getBeanDefinition());
	}
	
	public void setMerge(boolean merge) {
		this.merge = merge;
	}
	
	public int getOrder() {
		return this.order;
	}

	public void setOrder(int order) {
		this.order = order;
	}

	public void postProcessBeanFactory(
			ConfigurableListableBeanFactory beanFactory)
			throws BeansException {
		
		BeanDefinition target = beanFactory.getBeanDefinition(ref);
		overwriteBeanDefinition(target, beanDefinition);
	}
	
	private void overwriteBeanDefinition(BeanDefinition target, BeanDefinition source) {
		log.debug("Replacing bean [" + ref + "] with a [" 
				+ source.getBeanClassName() + "]");
		
		target.setBeanClassName(source.getBeanClassName());
		ConstructorArgumentValues cas = target.getConstructorArgumentValues();
		cas.clear();
		cas.addArgumentValues(source.getConstructorArgumentValues());
		
		MutablePropertyValues pvs = target.getPropertyValues();
		if (!merge) {
			pvs.getPropertyValueList().clear();
		}
		pvs.addPropertyValues(source.getPropertyValues());
	}
	
}