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 Spring
031 * {@link org.springframework.context.ApplicationContext}.
032 */
033public class ContextScanRouteBuilderFinder {
034    private static final Logger LOG = LoggerFactory.getLogger(ContextScanRouteBuilderFinder.class);
035    private final ApplicationContext applicationContext;
036    private final PackageScanFilter filter;
037    private final boolean includeNonSingletons;
038
039    public ContextScanRouteBuilderFinder(SpringCamelContext camelContext, PackageScanFilter filter,
040                                         boolean includeNonSingletons) {
041        this.applicationContext = camelContext.getApplicationContext();
042        this.filter = filter;
043        this.includeNonSingletons = includeNonSingletons;
044    }
045
046    /**
047     * Appends all the {@link org.apache.camel.builder.RouteBuilder} instances that can be found in the context
048     */
049    public void appendBuilders(List<RoutesBuilder> list) {
050        Map<String, RoutesBuilder> beans = applicationContext.getBeansOfType(RoutesBuilder.class, includeNonSingletons, true);
051
052        for (Entry<String, RoutesBuilder> entry : beans.entrySet()) {
053            Object bean = entry.getValue();
054            Object key = entry.getKey();
055
056            LOG.trace("Found RouteBuilder with id: {} -> {}", key, bean);
057
058            // certain beans should be ignored
059            if (shouldIgnoreBean(bean)) {
060                LOG.debug("Ignoring RouteBuilder id: {}", key);
061                continue;
062            }
063
064            if (!isFilteredClass(bean)) {
065                LOG.debug("Ignoring filtered RouteBuilder id: {} as class: {}", key, bean.getClass());
066                continue;
067            }
068
069            LOG.debug("Adding instantiated RouteBuilder id: {} as class: {}", key, bean.getClass());
070            list.add((RoutesBuilder) bean);
071        }
072    }
073
074    protected boolean shouldIgnoreBean(Object bean) {
075        return false;
076    }
077
078    protected boolean isFilteredClass(Object bean) {
079        if (filter != null) {
080            return filter.matches(bean.getClass());
081        } else {
082            return false;
083        }
084    }
085
086}