View Javadoc

1   /**
2    * This file Copyright (c) 2010-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.blossom.urimapping;
35  
36  import java.lang.reflect.Method;
37  import java.lang.reflect.Modifier;
38  
39  import org.slf4j.Logger;
40  import org.slf4j.LoggerFactory;
41  import org.springframework.util.ClassUtils;
42  import org.springframework.util.ReflectionUtils;
43  
44  import info.magnolia.cms.beans.config.VirtualURIMapping;
45  import info.magnolia.module.blossom.annotation.VirtualURIMapper;
46  import info.magnolia.module.blossom.support.AbstractBeanDetector;
47  
48  /**
49   * Detects and exposes all methods in a bean annotated with VirtualURIMapper as VirtualURIMappings.
50   *
51   * @see info.magnolia.module.blossom.annotation.VirtualURIMapper
52   * @since 1.1.1
53   */
54  public class AnnotatedVirtualURIMappingExporter extends AbstractBeanDetector {
55  
56      private final Logger logger = LoggerFactory.getLogger(getClass());
57  
58      @Override
59      protected boolean include(Class<?> beanType, String beanName) {
60          if (beanType.isAnnotationPresent(VirtualURIMapper.class)) {
61              if (ClassUtils.isAssignable(VirtualURIMapping.class, beanType)) {
62                  if (logger.isWarnEnabled()) {
63                      logger.warn("Bean [" + beanName + "] annotated with VirtualUriMapper should not also implement VirtualURIMapping, will not have methods exposed");
64                  }
65                  return false;
66              }
67              return true;
68          }
69          return false;
70      }
71  
72      @Override
73      protected void onBeanDetection(final Object bean, final String beanName) {
74  
75          if (logger.isDebugEnabled()) {
76              logger.debug("Detected VirtualURIMapper on bean [" + beanName + "] scanning methods to expose");
77          }
78  
79          final Class<?> beanType = bean.getClass();
80          ReflectionUtils.doWithMethods(beanType, new ReflectionUtils.MethodCallback() {
81  
82              @Override
83              public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {
84                  if (isEligibleMethod(method) && method.equals(ClassUtils.getMostSpecificMethod(method, beanType))) {
85  
86                      if (logger.isDebugEnabled()) {
87                          logger.debug("Exposing VirtualURIMapping for method [" + method + "] on bean [" + beanName + "]");
88                      }
89  
90                      BlossomVirtualURIMapping.addMapping(createMethodAdapter(method, bean));
91                  }
92              }
93          });
94      }
95  
96      protected boolean isEligibleMethod(Method method) {
97          return method.getParameterTypes().length > 0 &&
98                  (method.getReturnType().equals(String.class) || method.getReturnType().equals(VirtualURIMapping.MappingResult.class)) &&
99                  Modifier.isPublic(method.getModifiers()) &&
100                 !Modifier.isStatic(method.getModifiers());
101     }
102 
103     protected VirtualURIMappingAdapter createMethodAdapter(Method method, Object bean) {
104         return new VirtualURIMappingAdapter(bean, method);
105     }
106 }