org.springframework.integration.config.ChannelInitializer.java Source code

Introduction

Here is the source code for org.springframework.integration.config.ChannelInitializer.java

Source

/*
 * Copyright 2002-2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.integration.config;

import java.util.Collection;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.integration.context.IntegrationContextUtils;
import org.springframework.util.Assert;

/**
 * A {@link InitializingBean} implementation that is responsible for creating
 * channels that are not explicitly defined but identified via the 'input-channel'
 * attribute of the corresponding endpoints.
 *
 * This bean plays a role of pre-instantiator since it is instantiated and
 * initialized as the very first bean of all SI beans using
 * {@link org.springframework.integration.config.xml.AbstractIntegrationNamespaceHandler}.
 *
 * @author Oleg Zhurakousky
 * @author Gary Russell
 * @since 2.1.1
 */
final class ChannelInitializer implements BeanFactoryAware, InitializingBean {

    private final Log logger = LogFactory.getLog(this.getClass());

    private volatile BeanFactory beanFactory;

    private volatile boolean autoCreate = true;

    public void setAutoCreate(boolean autoCreate) {
        this.autoCreate = autoCreate;
    }

    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
        this.beanFactory = beanFactory;
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        Assert.notNull(this.beanFactory, "'beanFactory' must not be null");
        if (!this.autoCreate) {
            return;
        } else {
            AutoCreateCandidatesCollector channelCandidatesCollector = this.beanFactory.getBean(
                    IntegrationContextUtils.AUTO_CREATE_CHANNEL_CANDIDATES_BEAN_NAME,
                    AutoCreateCandidatesCollector.class);
            Assert.notNull(channelCandidatesCollector,
                    "Failed to locate '" + IntegrationContextUtils.AUTO_CREATE_CHANNEL_CANDIDATES_BEAN_NAME);
            // at this point channelNames are all resolved with placeholders and SpEL
            Collection<String> channelNames = channelCandidatesCollector.getChannelNames();
            if (channelNames != null) {
                for (String channelName : channelNames) {
                    if (!this.beanFactory.containsBean(channelName)) {
                        if (this.logger.isDebugEnabled()) {
                            this.logger.debug("Auto-creating channel '" + channelName + "' as DirectChannel");
                        }
                        IntegrationConfigUtils.autoCreateDirectChannel(channelName,
                                (BeanDefinitionRegistry) this.beanFactory);
                    }
                }
            }
        }
    }

    /*
     * Collects candidate channel names to be auto-created by ChannelInitializer
     */
    static class AutoCreateCandidatesCollector {

        private final Collection<String> channelNames;

        AutoCreateCandidatesCollector(Collection<String> channelNames) {
            this.channelNames = channelNames;
        }

        public Collection<String> getChannelNames() {
            return this.channelNames;
        }

    }

}