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.blueprint;
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.osgi.service.blueprint.container.BlueprintContainer;
026import org.slf4j.Logger;
027import org.slf4j.LoggerFactory;
028
029/**
030 * A helper class which will find all {@link org.apache.camel.builder.RouteBuilder} instances in the
031 *  {@link org.osgi.service.blueprint.container.BlueprintContainer}.
032 */
033public class ContextScanRouteBuilderFinder {
034    private static final Logger LOG = LoggerFactory.getLogger(ContextScanRouteBuilderFinder.class);
035    private final BlueprintContainer blueprintContainer;
036    private final PackageScanFilter filter;
037    private final boolean includeNonSingletons;
038
039    public ContextScanRouteBuilderFinder(BlueprintCamelContext camelContext, PackageScanFilter filter, boolean includeNonSingletons) {
040        this.blueprintContainer = camelContext.getBlueprintContainer();
041        this.filter = filter;
042        this.includeNonSingletons = includeNonSingletons;
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 = BlueprintContainerBeanRepository.lookupByType(blueprintContainer, RoutesBuilder.class, includeNonSingletons);
050
051        for (Entry<String, RoutesBuilder> entry : beans.entrySet()) {
052            String key = entry.getKey();
053            Object bean = entry.getValue();
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                if (LOG.isDebugEnabled()) {
065                    LOG.debug("Ignoring filtered RouteBuilder id: {} as class: {}", key, bean.getClass());
066                }
067                continue;
068            }
069
070            if (LOG.isDebugEnabled()) {
071                LOG.debug("Adding instantiated RouteBuilder id: {} as class: {}", key, bean.getClass());
072            }
073            list.add((RoutesBuilder) bean);
074        }
075    }
076
077    protected boolean shouldIgnoreBean(Object bean) {
078        return false;
079    }
080
081    protected boolean isFilteredClass(Object bean) {
082        if (filter != null) {
083            return filter.matches(bean.getClass());
084        } else {
085            return false;
086        }
087    }
088
089}