/**
* 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.ArrayList;
import java.util.List;
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.CamelContextAware;
import org.apache.camel.Processor;
import org.apache.camel.processor.CamelInternalProcessor;
import org.apache.camel.processor.MulticastProcessor;
import org.apache.camel.processor.aggregate.AggregationStrategy;
import org.apache.camel.processor.aggregate.AggregationStrategyBeanAdapter;
import org.apache.camel.processor.aggregate.UseLatestAggregationStrategy;
import org.apache.camel.spi.RouteContext;
import org.apache.camel.util.CamelContextHelper;
/**
* Represents an XML <multicast/> element
*
* @version
*/
@XmlRootElement(name = "multicast")
@XmlAccessorType(XmlAccessType.FIELD)
public class MulticastDefinition extends OutputDefinition<MulticastDefinition> implements ExecutorServiceAwareDefinition<MulticastDefinition> {
@XmlAttribute
private Boolean parallelProcessing;
@XmlAttribute
private String strategyRef;
@XmlAttribute
private String strategyMethodName;
@XmlAttribute
private Boolean strategyMethodAllowNull;
@XmlTransient
private ExecutorService executorService;
@XmlAttribute
private String executorServiceRef;
@XmlAttribute
private Boolean streaming;
@XmlAttribute
private Boolean stopOnException;
@XmlAttribute
private Long timeout;
@XmlTransient
private AggregationStrategy aggregationStrategy;
@XmlAttribute
private String onPrepareRef;
@XmlTransient
private Processor onPrepare;
@XmlAttribute
private Boolean shareUnitOfWork;
public MulticastDefinition() {
}
@Override
public String toString() {
return "Multicast[" + getOutputs() + "]";
}
@Override
public String getLabel() {
return "multicast";
}
@Override
public String getShortName() {
return "multicast";
}
@Override
public Processor createProcessor(RouteContext routeContext) throws Exception {
Processor answer = this.createChildProcessor(routeContext, true);
// force the answer as a multicast processor even if there is only one child processor in the multicast
if (!(answer instanceof MulticastProcessor)) {
List<Processor> list = new ArrayList<Processor>(1);
list.add(answer);
answer = createCompositeProcessor(routeContext, list);
}
return answer;
}
// Fluent API
// -------------------------------------------------------------------------
/**
* Set the multicasting aggregationStrategy
*
* @return the builder
*/
public MulticastDefinition aggregationStrategy(AggregationStrategy aggregationStrategy) {
setAggregationStrategy(aggregationStrategy);
return this;
}
/**
* Set the aggregationStrategy
*
* @param aggregationStrategyRef a reference to a strategy to lookup
* @return the builder
*/
public MulticastDefinition aggregationStrategyRef(String aggregationStrategyRef) {
setStrategyRef(aggregationStrategyRef);
return this;
}
/**
* Sets the method name to use when using a POJO as {@link AggregationStrategy}.
*
* @param methodName the method name to call
* @return the builder
*/
public MulticastDefinition aggregationStrategyMethodName(String methodName) {
setStrategyMethodName(methodName);
return this;
}
/**
* Sets allowing null when using a POJO as {@link AggregationStrategy}.
*
* @return the builder
*/
public MulticastDefinition aggregationStrategyMethodAllowNull() {
setStrategyMethodAllowNull(true);
return this;
}
/**
* Uses the {@link java.util.concurrent.ExecutorService} to do the multicasting work
*
* @return the builder
*/
public MulticastDefinition parallelProcessing() {
setParallelProcessing(true);
return this;
}
/**
* Aggregates the responses as the are done (e.g. out of order sequence)
*
* @return the builder
*/
public MulticastDefinition streaming() {
setStreaming(true);
return this;
}
/**
* Will now stop further processing if an exception or failure occurred during processing of an
* {@link org.apache.camel.Exchange} and the caused exception will be thrown.
* <p/>
* Will also stop if processing the exchange failed (has a fault message) or an exception
* was thrown and handled by the error handler (such as using onException). In all situations
* the multicast will stop further processing. This is the same behavior as in pipeline, which
* is used by the routing engine.
* <p/>
* The default behavior is to <b>not</b> stop but continue processing till the end
*
* @return the builder
*/
public MulticastDefinition stopOnException() {
setStopOnException(true);
return this;
}
public MulticastDefinition executorService(ExecutorService executorService) {
setExecutorService(executorService);
return this;
}
public MulticastDefinition executorServiceRef(String executorServiceRef) {
setExecutorServiceRef(executorServiceRef);
return this;
}
/**
* Uses the {@link Processor} when preparing the {@link org.apache.camel.Exchange} to be send.
* This can be used to deep-clone messages that should be send, or any custom logic needed before
* the exchange is send.
*
* @param onPrepare the processor
* @return the builder
*/
public MulticastDefinition onPrepare(Processor onPrepare) {
setOnPrepare(onPrepare);
return this;
}
/**
* Uses the {@link Processor} when preparing the {@link org.apache.camel.Exchange} to be send.
* This can be used to deep-clone messages that should be send, or any custom logic needed before
* the exchange is send.
*
* @param onPrepareRef reference to the processor to lookup in the {@link org.apache.camel.spi.Registry}
* @return the builder
*/
public MulticastDefinition onPrepareRef(String onPrepareRef) {
setOnPrepareRef(onPrepareRef);
return this;
}
/**
* Sets a timeout value in millis to use when using parallelProcessing.
*
* @param timeout timeout in millis
* @return the builder
*/
public MulticastDefinition timeout(long timeout) {
setTimeout(timeout);
return this;
}
/**
* Shares the {@link org.apache.camel.spi.UnitOfWork} with the parent and each of the sub messages.
*
* @return the builder.
* @see org.apache.camel.spi.SubUnitOfWork
*/
public MulticastDefinition shareUnitOfWork() {
setShareUnitOfWork(true);
return this;
}
protected Processor createCompositeProcessor(RouteContext routeContext, List<Processor> list) throws Exception {
AggregationStrategy strategy = createAggregationStrategy(routeContext);
if (strategy == null) {
// default to use latest aggregation strategy
strategy = new UseLatestAggregationStrategy();
}
boolean shutdownThreadPool = ProcessorDefinitionHelper.willCreateNewThreadPool(routeContext, this, isParallelProcessing());
ExecutorService threadPool = ProcessorDefinitionHelper.getConfiguredExecutorService(routeContext, "Multicast", this, isParallelProcessing());
long timeout = getTimeout() != null ? getTimeout() : 0;
if (timeout > 0 && !isParallelProcessing()) {
throw new IllegalArgumentException("Timeout is used but ParallelProcessing has not been enabled.");
}
if (onPrepareRef != null) {
onPrepare = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(), onPrepareRef, Processor.class);
}
MulticastProcessor answer = new MulticastProcessor(routeContext.getCamelContext(), list, strategy, isParallelProcessing(),
threadPool, shutdownThreadPool, isStreaming(), isStopOnException(), timeout, onPrepare, isShareUnitOfWork());
if (isShareUnitOfWork()) {
// wrap answer in a sub unit of work, since we share the unit of work
CamelInternalProcessor internalProcessor = new CamelInternalProcessor(answer);
internalProcessor.addAdvice(new CamelInternalProcessor.SubUnitOfWorkProcessorAdvice());
return internalProcessor;
}
return answer;
}
private AggregationStrategy createAggregationStrategy(RouteContext routeContext) {
AggregationStrategy strategy = getAggregationStrategy();
if (strategy == null && strategyRef != null) {
Object aggStrategy = routeContext.lookup(strategyRef, Object.class);
if (aggStrategy instanceof AggregationStrategy) {
strategy = (AggregationStrategy) aggStrategy;
} else if (aggStrategy != null) {
AggregationStrategyBeanAdapter adapter = new AggregationStrategyBeanAdapter(aggStrategy, getStrategyMethodName());
if (getStrategyMethodAllowNull() != null) {
adapter.setAllowNullNewExchange(getStrategyMethodAllowNull());
adapter.setAllowNullOldExchange(getStrategyMethodAllowNull());
}
strategy = adapter;
} else {
throw new IllegalArgumentException("Cannot find AggregationStrategy in Registry with name: " + strategyRef);
}
}
if (strategy != null && strategy instanceof CamelContextAware) {
((CamelContextAware) strategy).setCamelContext(routeContext.getCamelContext());
}
return strategy;
}
public AggregationStrategy getAggregationStrategy() {
return aggregationStrategy;
}
public MulticastDefinition setAggregationStrategy(AggregationStrategy aggregationStrategy) {
this.aggregationStrategy = aggregationStrategy;
return this;
}
public Boolean getParallelProcessing() {
return parallelProcessing;
}
public void setParallelProcessing(Boolean parallelProcessing) {
this.parallelProcessing = parallelProcessing;
}
public boolean isParallelProcessing() {
return parallelProcessing != null && parallelProcessing;
}
public Boolean getStreaming() {
return streaming;
}
public void setStreaming(Boolean streaming) {
this.streaming = streaming;
}
public boolean isStreaming() {
return streaming != null && streaming;
}
public Boolean getStopOnException() {
return stopOnException;
}
public void setStopOnException(Boolean stopOnException) {
this.stopOnException = stopOnException;
}
public Boolean isStopOnException() {
return stopOnException != null && 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 getStrategyMethodName() {
return strategyMethodName;
}
public void setStrategyMethodName(String strategyMethodName) {
this.strategyMethodName = strategyMethodName;
}
public Boolean getStrategyMethodAllowNull() {
return strategyMethodAllowNull;
}
public void setStrategyMethodAllowNull(Boolean strategyMethodAllowNull) {
this.strategyMethodAllowNull = strategyMethodAllowNull;
}
public String getExecutorServiceRef() {
return executorServiceRef;
}
public void setExecutorServiceRef(String executorServiceRef) {
this.executorServiceRef = executorServiceRef;
}
public Long getTimeout() {
return timeout;
}
public void setTimeout(Long timeout) {
this.timeout = timeout;
}
public String getOnPrepareRef() {
return onPrepareRef;
}
public void setOnPrepareRef(String onPrepareRef) {
this.onPrepareRef = onPrepareRef;
}
public Processor getOnPrepare() {
return onPrepare;
}
public void setOnPrepare(Processor onPrepare) {
this.onPrepare = onPrepare;
}
public Boolean getShareUnitOfWork() {
return shareUnitOfWork;
}
public void setShareUnitOfWork(Boolean shareUnitOfWork) {
this.shareUnitOfWork = shareUnitOfWork;
}
public boolean isShareUnitOfWork() {
return shareUnitOfWork != null && shareUnitOfWork;
}
}