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 */
017package org.apache.camel.spring;
018
019import java.util.List;
020import java.util.Map;
021import java.util.Map.Entry;
022
023import org.apache.camel.RoutesBuilder;
024import org.apache.camel.spi.PackageScanFilter;
025import org.slf4j.Logger;
026import org.slf4j.LoggerFactory;
027import 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 */
035public class ContextScanRouteBuilderFinder {
036    private static final 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<String, RoutesBuilder> beans = applicationContext.getBeansOfType(RoutesBuilder.class, true, true);
050
051        for (Entry<String, RoutesBuilder> entry : beans.entrySet()) {
052            Object bean = entry.getValue();
053            Object key = entry.getKey();
054
055            LOG.trace("Found RouteBuilder with id: {} -> {}", key, bean);
056
057            // certain beans should be ignored
058            if (shouldIgnoreBean(bean)) {
059                LOG.debug("Ignoring RouteBuilder id: {}", key);
060                continue;
061            }
062
063            if (!isFilteredClass(bean)) {
064                LOG.debug("Ignoring filtered RouteBuilder id: {} as class: {}", key, bean.getClass());
065                continue;
066            }
067
068            LOG.debug("Adding instantiated RouteBuilder id: {} as class: {}", key, bean.getClass());
069            list.add((RoutesBuilder) bean);
070        }
071    }
072
073    protected boolean shouldIgnoreBean(Object bean) {
074        return false;
075    }
076
077    protected boolean isFilteredClass(Object bean) {
078        if (filter != null) {
079            return filter.matches(bean.getClass());
080        } else {
081            return false;
082        }
083    }
084
085}