/**
    * This file Copyright (c) 2010 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.module.blossom.urimapping;
  
  import info.magnolia.cms.beans.config.VirtualURIMapping;
  import info.magnolia.module.blossom.annotation.VirtualURIMapper;
  import info.magnolia.module.blossom.support.AbstractBeanDetector;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  import org.springframework.util.ClassUtils;
  import org.springframework.util.ReflectionUtils;
  
  import java.lang.reflect.Method;
  import java.lang.reflect.Modifier;
  
  /**
   * Detects and exposes all methods in a bean annotated with VirtualURIMapper as VirtualURIMappings.
   *
   * @see info.magnolia.module.blossom.annotation.VirtualURIMapper
   */
  public class AnnotatedVirtualURIMappingExporter extends AbstractBeanDetector {
  
      private final Logger logger = LoggerFactory.getLogger(getClass());
  
      @Override
      protected boolean include(Class<?> beanType, String beanName) {
          if (beanType.isAnnotationPresent(VirtualURIMapper.class)) {
              if (ClassUtils.isAssignable(VirtualURIMapping.class, beanType)) {
                  if (logger.isWarnEnabled())
                      logger.warn("Bean [" + beanName + "] annotated with VirtualUriMapper should not also implement VirtualURIMapping, will not have methods exposed");
                  return false;
              }
              return true;
          }
          return false;
      }
  
      @Override
      protected void onBeanDetection(final Object bean, final String beanName) {
  
          if (logger.isDebugEnabled())
              logger.debug("Detected VirtualURIMapper on bean [" + beanName + "] scanning methods to expose");
  
          final Class<?> beanType = bean.getClass();
          ReflectionUtils.doWithMethods(beanType, new ReflectionUtils.MethodCallback() {
              public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {
                  if (isEligibleMethod(method) && method.equals(ClassUtils.getMostSpecificMethod(method, beanType))) {
  
                      if (logger.isDebugEnabled())
                          logger.debug("Exposing VirtualURIMapping for method [" + method + "] on bean [" + beanName + "]");
  
                      BlossomVirtualURIMapping.addMapping(createMethodAdapter(method, bean));
                  }
              }
          });
      }
  
      protected boolean isEligibleMethod(Method method) {
          return method.getParameterTypes().length > 0 &&
                  (method.getReturnType().equals(String.class) || method.getReturnType().equals(VirtualURIMapping.MappingResult.class)) &&
                  Modifier.isPublic(method.getModifiers()) &&
                  !Modifier.isStatic(method.getModifiers());
      }
  
      protected VirtualURIMappingAdapter createMethodAdapter(Method method, Object bean) {
          return new VirtualURIMappingAdapter(bean, method);
      }
  }