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.model;
018    
019    import java.util.List;
020    import java.util.concurrent.Executor;
021    
022    import javax.xml.bind.annotation.XmlAccessType;
023    import javax.xml.bind.annotation.XmlAccessorType;
024    import javax.xml.bind.annotation.XmlAttribute;
025    import javax.xml.bind.annotation.XmlRootElement;
026    import javax.xml.bind.annotation.XmlTransient;
027    
028    import org.apache.camel.Processor;
029    import org.apache.camel.processor.MulticastProcessor;
030    import org.apache.camel.processor.aggregate.AggregationStrategy;
031    import org.apache.camel.processor.aggregate.UseLatestAggregationStrategy;
032    import org.apache.camel.processor.interceptor.StreamCachingInterceptor;
033    import org.apache.camel.spi.RouteContext;
034    
035    /**
036     * Represents an XML <multicast/> element
037     *
038     * @version $Revision: 750806 $
039     */
040    @XmlRootElement(name = "multicast")
041    @XmlAccessorType(XmlAccessType.FIELD)
042    public class MulticastDefinition extends OutputDefinition<ProcessorDefinition> {
043        @XmlAttribute(required = false)
044        private Boolean parallelProcessing;
045        @XmlAttribute(required = false)
046        private String strategyRef;
047        @XmlAttribute(required = false)
048        private String threadPoolRef;    
049        @XmlTransient
050        private AggregationStrategy aggregationStrategy;
051        @XmlTransient
052        private Executor executor;
053    
054        @Override
055        public String toString() {
056            return "Multicast[" + getOutputs() + "]";
057        }
058    
059        @Override
060        public String getShortName() {
061            return "multicast";
062        }
063    
064        @Override
065        public Processor createProcessor(RouteContext routeContext) throws Exception {
066            return createOutputsProcessor(routeContext);
067        }
068    
069        // Fluent API
070        // -------------------------------------------------------------------------
071    
072        /**
073         * Set the multicasting aggregationStrategy
074         *
075         * @return the builder
076         */
077        public MulticastDefinition aggregationStrategy(AggregationStrategy aggregationStrategy) {
078            setAggregationStrategy(aggregationStrategy);
079            return this;
080        }
081        
082        /**
083         * use a thread pool to do the multicasting work
084         *     
085         * @return the builder
086         */
087        public MulticastDefinition parallelProcessing() {
088            setParallelProcessing(true);
089            return this;
090        }
091        
092        /**
093         * Set the multicasting action's thread model
094         *
095         * @param parallelProcessing <tt>true</tt> to use a thread pool, if <tt>false</tt> then work is done in the
096         * calling thread.
097         *
098         * @return the builder
099         */
100        public MulticastDefinition parallelProcessing(boolean parallelProcessing) {
101            setParallelProcessing(parallelProcessing);
102            return this;
103        }
104        
105        /**
106         * Setting the executor for executing the multicasting action. 
107         *
108         * @return the builder
109         */
110        public MulticastDefinition executor(Executor executor) {
111            setExecutor(executor);
112            return this;
113        }    
114            
115        protected Processor createCompositeProcessor(RouteContext routeContext, List<Processor> list) {
116            if (aggregationStrategy == null && strategyRef != null) {
117                aggregationStrategy = routeContext.lookup(strategyRef, AggregationStrategy.class);
118            }
119            if (aggregationStrategy == null) {
120                aggregationStrategy = new UseLatestAggregationStrategy();
121            }
122            if (threadPoolRef != null) {
123                executor = routeContext.lookup(threadPoolRef, Executor.class);
124            }
125            return new MulticastProcessor(list, aggregationStrategy, isParallelProcessing(), executor);
126        }
127    
128        public AggregationStrategy getAggregationStrategy() {
129            return aggregationStrategy;
130        }
131    
132        public MulticastDefinition setAggregationStrategy(AggregationStrategy aggregationStrategy) {
133            this.aggregationStrategy = aggregationStrategy;
134            return this;
135        }
136    
137        public boolean isParallelProcessing() {
138            return parallelProcessing != null ? parallelProcessing : false;
139        }
140    
141        public void setParallelProcessing(boolean parallelProcessing) {
142            this.parallelProcessing = parallelProcessing;        
143        }
144    
145        public Executor getExecutor() {
146            return executor;
147        }
148    
149        public void setExecutor(Executor executor) {
150            this.executor = executor;        
151        }
152        
153        @Override
154        protected Processor wrapProcessorInInterceptors(RouteContext routeContext, Processor target) throws Exception {        
155            //CAMEL-1193 now we need to wrap the multicast processor with the interceptors
156            //Current we wrap the StreamCachingInterceptor by default
157            return super.wrapProcessorInInterceptors(routeContext, new StreamCachingInterceptor(target));        
158        }
159    }