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 javax.xml.bind.annotation.XmlAccessType;
020    import javax.xml.bind.annotation.XmlAccessorType;
021    import javax.xml.bind.annotation.XmlAttribute;
022    import javax.xml.bind.annotation.XmlRootElement;
023    import javax.xml.bind.annotation.XmlTransient;
024    
025    import org.apache.camel.CamelContext;
026    import org.apache.camel.CamelContextAware;
027    import org.apache.camel.ConsumerTemplate;
028    import org.apache.camel.impl.DefaultConsumerTemplate;
029    import org.apache.camel.model.IdentifiedType;
030    import org.apache.camel.spring.util.CamelContextResolverHelper;
031    import org.apache.camel.util.ServiceHelper;
032    import org.springframework.beans.BeansException;
033    import org.springframework.beans.factory.DisposableBean;
034    import org.springframework.beans.factory.FactoryBean;
035    import org.springframework.beans.factory.InitializingBean;
036    import org.springframework.context.ApplicationContext;
037    import org.springframework.context.ApplicationContextAware;
038    
039    /**
040     * A Spring {@link org.springframework.beans.factory.FactoryBean} for creating a new {@link org.apache.camel.ConsumerTemplate}
041     * instance with a minimum of XML
042     *
043     * @version $Revision: 934375 $
044     */
045    @XmlRootElement(name = "consumerTemplate")
046    @XmlAccessorType(XmlAccessType.FIELD)
047    public class CamelConsumerTemplateFactoryBean extends IdentifiedType implements FactoryBean, InitializingBean, DisposableBean, CamelContextAware, ApplicationContextAware {
048        @XmlTransient
049        private ConsumerTemplate template;
050        @XmlAttribute
051        private String camelContextId;
052        @XmlTransient
053        private CamelContext camelContext;
054        @XmlTransient
055        private ApplicationContext applicationContext;
056        @XmlAttribute
057        private Integer maximumCacheSize;
058    
059        public void afterPropertiesSet() throws Exception {
060            if (camelContext == null && camelContextId != null) {
061                camelContext = CamelContextResolverHelper.getCamelContextWithId(applicationContext, camelContextId);
062            }
063            if (camelContext == null) {
064                throw new IllegalArgumentException("A CamelContext or a CamelContextId must be injected!");
065            }
066        }
067    
068        public Object getObject() throws Exception {
069            template = new DefaultConsumerTemplate(camelContext);
070    
071            // set custom cache size if provided
072            if (maximumCacheSize != null) {
073                template.setMaximumCacheSize(maximumCacheSize);
074            }
075    
076            // must start it so its ready to use
077            ServiceHelper.startService(template);
078            return template;
079        }
080    
081        public Class getObjectType() {
082            return DefaultConsumerTemplate.class;
083        }
084    
085        public boolean isSingleton() {
086            return true;
087        }
088    
089        public void destroy() throws Exception {
090            ServiceHelper.stopService(template);
091        }
092    
093        // Properties
094        // -------------------------------------------------------------------------
095    
096        public CamelContext getCamelContext() {
097            return camelContext;
098        }
099    
100        public void setCamelContext(CamelContext camelContext) {
101            this.camelContext = camelContext;
102        }
103    
104        public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
105            this.applicationContext = applicationContext;
106        }
107    
108        public void setCamelContextId(String camelContextId) {
109            this.camelContextId = camelContextId;
110        }
111    
112        public Integer getMaximumCacheSize() {
113            return maximumCacheSize;
114        }
115    
116        public void setMaximumCacheSize(Integer maximumCacheSize) {
117            this.maximumCacheSize = maximumCacheSize;
118        }
119    }