/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.camel.model;
import java.util.concurrent.ExecutorService;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import org.apache.camel.Expression;
import org.apache.camel.Processor;
import org.apache.camel.builder.ExpressionClause;
import org.apache.camel.model.language.ExpressionDefinition;
import org.apache.camel.processor.Splitter;
import org.apache.camel.processor.aggregate.AggregationStrategy;
import org.apache.camel.spi.RouteContext;
import org.apache.camel.util.CamelContextHelper;
import org.apache.camel.util.concurrent.ExecutorServiceHelper;
/**
* Represents an XML <split/> element
*
* @version $Revision: 957153 $
*/
@XmlRootElement(name = "split")
@XmlAccessorType(XmlAccessType.FIELD)
public class SplitDefinition extends ExpressionNode implements ExecutorServiceAwareDefinition<SplitDefinition> {
@XmlTransient
private AggregationStrategy aggregationStrategy;
@XmlTransient
private ExecutorService executorService;
@XmlAttribute(required = false)
private Boolean parallelProcessing;
@XmlAttribute(required = false)
private String strategyRef;
@XmlAttribute(required = false)
private String executorServiceRef;
@XmlAttribute(required = false)
private Boolean streaming = false;
@XmlAttribute(required = false)
private Boolean stopOnException;
public SplitDefinition() {
}
public SplitDefinition(Expression expression) {
super(expression);
}
public SplitDefinition(ExpressionDefinition expression) {
super(expression);
}
@Override
public String toString() {
return "Split[" + getExpression() + " -> " + getOutputs() + "]";
}
@Override
public String getShortName() {
return "split";
}
@Override
public String getLabel() {
return "split";
}
@Override
public Processor createProcessor(RouteContext routeContext) throws Exception {
Processor childProcessor = this.createChildProcessor(routeContext, true);
aggregationStrategy = createAggregationStrategy(routeContext);
executorService = ExecutorServiceHelper.getConfiguredExecutorService(routeContext, "Split", this);
if (isParallelProcessing() && executorService == null) {
// we are running in parallel so create a cached thread pool which grows/shrinks automatic
executorService = routeContext.getCamelContext().getExecutorServiceStrategy().newDefaultThreadPool(this, "Split");
}
Expression exp = getExpression().createExpression(routeContext);
return new Splitter(routeContext.getCamelContext(), exp, childProcessor, aggregationStrategy,
isParallelProcessing(), executorService, isStreaming(), isStopOnException());
}
private AggregationStrategy createAggregationStrategy(RouteContext routeContext) {
AggregationStrategy strategy = getAggregationStrategy();
if (strategy == null && strategyRef != null) {
strategy = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(), strategyRef, AggregationStrategy.class);
}
return strategy;
}
// Fluent API
// -------------------------------------------------------------------------
/**
* Set the expression that the splitter will use
*
* @return the builder
*/
public ExpressionClause<SplitDefinition> expression() {
return ExpressionClause.createAndSetExpression(this);
}
/**
* Set the aggregationStrategy
*
* @return the builder
*/
public SplitDefinition aggregationStrategy(AggregationStrategy aggregationStrategy) {
setAggregationStrategy(aggregationStrategy);
return this;
}
/**
* Set the aggregationStrategy
*
* @param aggregationStrategyRef a reference to a strategy to lookup
* @return the builder
*/
public SplitDefinition aggregationStrategyRef(String aggregationStrategyRef) {
setStrategyRef(aggregationStrategyRef);
return this;
}
/**
* Doing the splitting work in parallel
*
* @return the builder
*/
public SplitDefinition parallelProcessing() {
setParallelProcessing(true);
return this;
}
/**
* Enables streaming.
* See {@link SplitDefinition#setStreaming(boolean)} for more information
*
* @return the builder
*/
public SplitDefinition streaming() {
setStreaming(true);
return this;
}
/**
* Will now stop further processing if an exception occurred during processing of an
* {@link org.apache.camel.Exchange} and the caused exception will be thrown.
* <p/>
* The default behavior is to <b>not</b> stop but continue processing till the end
*
* @return the builder
*/
public SplitDefinition stopOnException() {
setStopOnException(true);
return this;
}
public SplitDefinition executorService(ExecutorService executorService) {
setExecutorService(executorService);
return this;
}
public SplitDefinition executorServiceRef(String executorServiceRef) {
setExecutorServiceRef(executorServiceRef);
return this;
}
// Properties
//-------------------------------------------------------------------------
public AggregationStrategy getAggregationStrategy() {
return aggregationStrategy;
}
public void setAggregationStrategy(AggregationStrategy aggregationStrategy) {
this.aggregationStrategy = aggregationStrategy;
}
public boolean isParallelProcessing() {
return parallelProcessing != null ? parallelProcessing : false;
}
public void setParallelProcessing(boolean parallelProcessing) {
this.parallelProcessing = parallelProcessing;
}
/**
* The splitter should use streaming -- exchanges are being sent as the data for them becomes available.
* This improves throughput and memory usage, but it has a drawback:
* - the sent exchanges will no longer contain the {@link org.apache.camel.Exchange#SPLIT_SIZE} header property
*
* @return whether or not streaming should be used
*/
public boolean isStreaming() {
return streaming != null ? streaming : false;
}
public void setStreaming(boolean streaming) {
this.streaming = streaming;
}
public Boolean isStopOnException() {
return stopOnException != null ? stopOnException : false;
}
public void setStopOnException(Boolean stopOnException) {
this.stopOnException = stopOnException;
}
public ExecutorService getExecutorService() {
return executorService;
}
public void setExecutorService(ExecutorService executorService) {
this.executorService = executorService;
}
public String getStrategyRef() {
return strategyRef;
}
public void setStrategyRef(String strategyRef) {
this.strategyRef = strategyRef;
}
public String getExecutorServiceRef() {
return executorServiceRef;
}
public void setExecutorServiceRef(String executorServiceRef) {
this.executorServiceRef = executorServiceRef;
}
}