001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.spring.bean;
016    
017    import com.liferay.portal.cluster.ClusterableAdvice;
018    import com.liferay.portal.kernel.bean.BeanLocatorException;
019    import com.liferay.portal.kernel.bean.BeanReference;
020    import com.liferay.portal.kernel.bean.IdentifiableBean;
021    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
022    import com.liferay.portal.kernel.log.Log;
023    import com.liferay.portal.kernel.log.LogFactoryUtil;
024    
025    import java.io.PrintWriter;
026    import java.io.StringWriter;
027    
028    import java.lang.reflect.Field;
029    
030    import java.util.HashMap;
031    import java.util.Map;
032    
033    import org.springframework.beans.BeansException;
034    import org.springframework.beans.factory.BeanCreationException;
035    import org.springframework.beans.factory.BeanFactory;
036    import org.springframework.beans.factory.BeanFactoryAware;
037    import org.springframework.beans.factory.NoSuchBeanDefinitionException;
038    import org.springframework.beans.factory.config.BeanPostProcessor;
039    import org.springframework.util.ReflectionUtils;
040    
041    /**
042     * @author Michael Young
043     * @author Shuyang Zhou
044     */
045    public class BeanReferenceAnnotationBeanPostProcessor
046            implements BeanFactoryAware, BeanPostProcessor {
047    
048            public BeanReferenceAnnotationBeanPostProcessor() {
049                    if (_log.isDebugEnabled()) {
050                            _log.debug("Creating instance " + this.hashCode());
051                    }
052            }
053    
054            public void destroy() {
055                    _beans.clear();
056            }
057    
058            @Override
059            public Object postProcessAfterInitialization(Object bean, String beanName)
060                    throws BeansException {
061    
062                    return bean;
063            }
064    
065            @Override
066            public Object postProcessBeforeInitialization(Object bean, String beanName)
067                    throws BeansException {
068    
069                    if (bean instanceof IdentifiableBean) {
070                            IdentifiableBean identifiableBean = (IdentifiableBean)bean;
071    
072                            identifiableBean.setBeanIdentifier(beanName);
073                    }
074                    else if (beanName.endsWith("Service")) {
075                            if (_log.isWarnEnabled()) {
076                                    _log.warn(
077                                            beanName + " should implement " +
078                                                    IdentifiableBean.class.getName() +
079                                                            " for " + ClusterableAdvice.class.getName());
080                            }
081                    }
082    
083                    _autoInject(bean, beanName, bean.getClass());
084    
085                    return bean;
086            }
087    
088            @Override
089            public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
090                    _beanFactory = beanFactory;
091            }
092    
093            private void _autoInject(
094                    Object targetBean, String targetBeanName, Class<?> beanClass) {
095    
096                    if ((beanClass == null) || beanClass.isInterface()) {
097                            return;
098                    }
099    
100                    String className = beanClass.getName();
101    
102                    if (className.equals(_JAVA_LANG_OBJECT) ||
103                            className.startsWith(_ORG_SPRINGFRAMEWORK)) {
104    
105                            return;
106                    }
107    
108                    Field[] fields = beanClass.getDeclaredFields();
109    
110                    for (Field field : fields) {
111                            BeanReference beanReference = field.getAnnotation(
112                                    BeanReference.class);
113    
114                            String referencedBeanName = null;
115                            Class<?> referencedBeanType = null;
116    
117                            if (beanReference != null) {
118                                    referencedBeanName = beanReference.name();
119                                    referencedBeanType = beanReference.type();
120                            }
121                            else {
122                                    continue;
123                            }
124    
125                            if (!Object.class.equals(referencedBeanType)) {
126                                    referencedBeanName = referencedBeanType.getName();
127                            }
128    
129                            Object referencedBean = _beans.get(referencedBeanName);
130    
131                            if (referencedBean == null) {
132                                    try {
133                                            referencedBean = _beanFactory.getBean(referencedBeanName);
134                                    }
135                                    catch (NoSuchBeanDefinitionException nsbde) {
136                                            try {
137                                                    referencedBean = PortalBeanLocatorUtil.locate(
138                                                            referencedBeanName);
139                                            }
140                                            catch (BeanLocatorException ble) {
141                                                    StringWriter stringWriter = new StringWriter();
142    
143                                                    PrintWriter printWriter = new PrintWriter(stringWriter);
144    
145                                                    printWriter.print("BeanFactory could not find bean: ");
146    
147                                                    nsbde.printStackTrace(printWriter);
148    
149                                                    printWriter.print(
150                                                            " and PortalBeanLocator failed with: ");
151                                                    printWriter.append(ble.getMessage());
152    
153                                                    printWriter.close();
154    
155                                                    throw new BeanLocatorException(
156                                                            stringWriter.toString(), ble);
157                                            }
158                                    }
159    
160                                    _beans.put(referencedBeanName, referencedBean);
161                            }
162    
163                            ReflectionUtils.makeAccessible(field);
164    
165                            BeanReferenceRefreshUtil.registerRefreshPoint(
166                                    targetBean, field, referencedBeanName);
167    
168                            try {
169                                    field.set(targetBean, referencedBean);
170                            }
171                            catch (Throwable t) {
172                                    throw new BeanCreationException(
173                                            targetBeanName, "Could not inject BeanReference fields", t);
174                            }
175                    }
176    
177                    _autoInject(targetBean, targetBeanName, beanClass.getSuperclass());
178            }
179    
180            private static final String _JAVA_LANG_OBJECT = "java.lang.Object";
181    
182            private static final String _ORG_SPRINGFRAMEWORK = "org.springframework";
183    
184            private static Log _log = LogFactoryUtil.getLog(
185                    BeanReferenceAnnotationBeanPostProcessor.class);
186    
187            private BeanFactory _beanFactory;
188            private Map<String, Object> _beans = new HashMap<String, Object>();
189    
190    }