001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.camel.spring;
018    
019    import java.util.List;
020    import java.util.Map;
021    import java.util.Map.Entry;
022    
023    import org.apache.camel.RoutesBuilder;
024    import org.apache.camel.spi.PackageScanFilter;
025    import org.slf4j.Logger;
026    import org.slf4j.LoggerFactory;
027    import org.springframework.context.ApplicationContext;
028    
029    /**
030     * A helper class which will find all {@link org.apache.camel.builder.RouteBuilder} instances on the
031     * Spring {@link org.springframework.context.ApplicationContext}.
032     *
033     * @version 
034     */
035    public class ContextScanRouteBuilderFinder {
036        private static final transient Logger LOG = LoggerFactory.getLogger(ContextScanRouteBuilderFinder.class);
037        private final ApplicationContext applicationContext;
038        private final PackageScanFilter filter;
039    
040        public ContextScanRouteBuilderFinder(SpringCamelContext camelContext, PackageScanFilter filter) {
041            this.applicationContext = camelContext.getApplicationContext();
042            this.filter = filter;
043        }
044    
045        /**
046         * Appends all the {@link org.apache.camel.builder.RouteBuilder} instances that can be found in the context
047         */
048        public void appendBuilders(List<RoutesBuilder> list) {
049            Map beans = applicationContext.getBeansOfType(RoutesBuilder.class, true, true);
050    
051            for (Object object : beans.entrySet()) {
052                Entry entry = (Entry) object;
053                Object bean = entry.getValue();
054                Object key = entry.getKey();
055    
056                if (LOG.isTraceEnabled()) {
057                    LOG.trace("Found RouteBuilder with id: " + key + " -> " + bean);
058                }
059    
060                // certain beans should be ignored
061                if (shouldIgnoreBean(bean)) {
062                    if (LOG.isDebugEnabled()) {
063                        LOG.debug("Ignoring RouteBuilder id: " + key);
064                    }
065                    continue;
066                }
067    
068                if (!isFilteredClass(bean)) {
069                    if (LOG.isDebugEnabled()) {
070                        LOG.debug("Ignoring filtered RouteBuilder id: " + key + " as class: " + bean.getClass());
071                    }
072                    continue;
073                }
074    
075                if (LOG.isDebugEnabled()) {
076                    LOG.debug("Adding instantiated RouteBuilder id: " + key + " as class: " + bean.getClass());
077                }
078                list.add((RoutesBuilder) bean);
079            }
080        }
081    
082        protected boolean shouldIgnoreBean(Object bean) {
083            return false;
084        }
085    
086        protected boolean isFilteredClass(Object bean) {
087            if (filter != null) {
088                return filter.matches(bean.getClass());
089            } else {
090                return false;
091            }
092        }
093    
094    }