PortletBeanFactoryCleaner.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.spring.context;

import com.liferay.portal.kernel.exception.LoggedExceptionInInitializerError;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.util.ReflectionUtil;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import org.aspectj.weaver.tools.ShadowMatch;

import org.springframework.aop.ClassFilter;
import org.springframework.aop.Pointcut;
import org.springframework.aop.aspectj.AspectJExpressionPointcut;
import org.springframework.aop.aspectj.AspectJPointcutAdvisor;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.ListableBeanFactory;

/**
 * @author Shuyang Zhou
 */
public class PortletBeanFactoryCleaner implements BeanFactoryAware {

	public static void readBeans() {
		if (_beanFactory == null) {
			if (_log.isWarnEnabled()) {
				_log.warn("Bean factory is null");
			}

			return;
		}

		if (!(_beanFactory instanceof ListableBeanFactory)) {
			return;
		}

		ListableBeanFactory listableBeanFactory =
			(ListableBeanFactory)_beanFactory;

		String[] names = listableBeanFactory.getBeanDefinitionNames();

		for (String name : names) {
			try {
				_readBean(listableBeanFactory, name);
			}
			catch (Exception e) {
			}
		}
	}

	public void destroy() {
		for (BeanFactoryAware beanFactoryAware : _beanFactoryAwares) {
			try {
				beanFactoryAware.setBeanFactory(null);
			}
			catch (Exception e) {
			}
		}

		_beanFactoryAwares.clear();

		for (AspectJExpressionPointcut aspectJExpressionPointcut :
				_aspectJExpressionPointcuts) {

			try {
				Map<Method, ShadowMatch> shadowMatchCache =
					(Map<Method, ShadowMatch>)_SHADOW_MATCH_CACHE_FIELD.get(
						aspectJExpressionPointcut);

				shadowMatchCache.clear();
			}
			catch (Exception e) {
			}
		}

		_aspectJExpressionPointcuts.clear();
	}

	@Override
	public void setBeanFactory(BeanFactory beanFactory) {
		_beanFactory = beanFactory;
	}

	private static void _readBean(
			ListableBeanFactory listableBeanFactory, String name)
		throws Exception {

		Object bean = listableBeanFactory.getBean(name);

		if (bean instanceof AspectJPointcutAdvisor) {
			AspectJPointcutAdvisor aspectJPointcutAdvisor =
				(AspectJPointcutAdvisor)bean;

			Pointcut pointcut = aspectJPointcutAdvisor.getPointcut();

			ClassFilter classFilter = pointcut.getClassFilter();

			if (classFilter instanceof AspectJExpressionPointcut) {
				AspectJExpressionPointcut aspectJExpressionPointcut =
					(AspectJExpressionPointcut)classFilter;

				_beanFactoryAwares.add(aspectJExpressionPointcut);
				_aspectJExpressionPointcuts.add(aspectJExpressionPointcut);
			}
		}
		else if (bean instanceof BeanFactoryAware) {
			_beanFactoryAwares.add((BeanFactoryAware)bean);
		}
	}

	private static final Field _SHADOW_MATCH_CACHE_FIELD;

	private static final Log _log = LogFactoryUtil.getLog(
		PortletBeanFactoryCleaner.class);

	private static final Set<AspectJExpressionPointcut>
		_aspectJExpressionPointcuts = new HashSet<>();
	private static BeanFactory _beanFactory;
	private static final Set<BeanFactoryAware> _beanFactoryAwares =
		new HashSet<>();

	static {
		try {
			_SHADOW_MATCH_CACHE_FIELD = ReflectionUtil.getDeclaredField(
				AspectJExpressionPointcut.class, "shadowMatchCache");
		}
		catch (Exception e) {
			throw new LoggedExceptionInInitializerError(e);
		}
	}

}