/**
* 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.processor;
import java.util.Collections;
import java.util.Iterator;
import java.util.concurrent.ExecutorService;
import org.apache.camel.AsyncCallback;
import org.apache.camel.AsyncProcessor;
import org.apache.camel.CamelContext;
import org.apache.camel.Endpoint;
import org.apache.camel.Exchange;
import org.apache.camel.Expression;
import org.apache.camel.Processor;
import org.apache.camel.impl.ProducerCache;
import org.apache.camel.processor.aggregate.AggregationStrategy;
import org.apache.camel.processor.aggregate.UseLatestAggregationStrategy;
import org.apache.camel.support.ServiceSupport;
import org.apache.camel.util.AsyncProcessorHelper;
import org.apache.camel.util.ExchangeHelper;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.ServiceHelper;
import static org.apache.camel.util.ObjectHelper.notNull;
/**
* Implements a dynamic <a
* href="http://camel.apache.org/recipient-list.html">Recipient List</a>
* pattern where the list of actual endpoints to send a message exchange to are
* dependent on some dynamic expression.
*
* @version
*/
public class RecipientList extends ServiceSupport implements AsyncProcessor {
private static final String IGNORE_DELIMITER_MARKER = "false";
private final CamelContext camelContext;
private ProducerCache producerCache;
private Expression expression;
private final String delimiter;
private boolean parallelProcessing;
private boolean stopOnException;
private boolean ignoreInvalidEndpoints;
private boolean streaming;
private long timeout;
private Processor onPrepare;
private boolean shareUnitOfWork;
private ExecutorService executorService;
private boolean shutdownExecutorService;
private ExecutorService aggregateExecutorService;
private AggregationStrategy aggregationStrategy = new UseLatestAggregationStrategy();
public RecipientList(CamelContext camelContext) {
// use comma by default as delimiter
this(camelContext, ",");
}
public RecipientList(CamelContext camelContext, String delimiter) {
notNull(camelContext, "camelContext");
ObjectHelper.notEmpty(delimiter, "delimiter");
this.camelContext = camelContext;
this.delimiter = delimiter;
}
public RecipientList(CamelContext camelContext, Expression expression) {
// use comma by default as delimiter
this(camelContext, expression, ",");
}
public RecipientList(CamelContext camelContext, Expression expression, String delimiter) {
notNull(camelContext, "camelContext");
ObjectHelper.notNull(expression, "expression");
ObjectHelper.notEmpty(delimiter, "delimiter");
this.camelContext = camelContext;
this.expression = expression;
this.delimiter = delimiter;
}
@Override
public String toString() {
return "RecipientList[" + (expression != null ? expression : "") + "]";
}
public void process(Exchange exchange) throws Exception {
AsyncProcessorHelper.process(this, exchange);
}
public boolean process(Exchange exchange, AsyncCallback callback) {
if (!isStarted()) {
throw new IllegalStateException("RecipientList has not been started: " + this);
}
// use the evaluate expression result if exists
Object recipientList = exchange.removeProperty(Exchange.EVALUATE_EXPRESSION_RESULT);
if (recipientList == null && expression != null) {
// fallback and evaluate the expression
recipientList = expression.evaluate(exchange, Object.class);
}
return sendToRecipientList(exchange, recipientList, callback);
}
/**
* Sends the given exchange to the recipient list
*/
public boolean sendToRecipientList(Exchange exchange, Object recipientList, AsyncCallback callback) {
Iterator<Object> iter;
if (delimiter != null && delimiter.equalsIgnoreCase(IGNORE_DELIMITER_MARKER)) {
iter = ObjectHelper.createIterator(recipientList, null);
} else {
iter = ObjectHelper.createIterator(recipientList, delimiter);
}
RecipientListProcessor rlp = new RecipientListProcessor(exchange.getContext(), producerCache, iter, getAggregationStrategy(),
isParallelProcessing(), getExecutorService(), isShutdownExecutorService(),
isStreaming(), isStopOnException(), getTimeout(), getOnPrepare(), isShareUnitOfWork()) {
@Override
protected synchronized ExecutorService createAggregateExecutorService(String name) {
// use a shared executor service to avoid creating new thread pools
if (aggregateExecutorService == null) {
aggregateExecutorService = super.createAggregateExecutorService("RecipientList-AggregateTask");
}
return aggregateExecutorService;
}
};
rlp.setIgnoreInvalidEndpoints(isIgnoreInvalidEndpoints());
// start the service
try {
ServiceHelper.startService(rlp);
} catch (Exception e) {
exchange.setException(e);
callback.done(true);
return true;
}
AsyncProcessor target = rlp;
if (isShareUnitOfWork()) {
// wrap answer in a sub unit of work, since we share the unit of work
CamelInternalProcessor internalProcessor = new CamelInternalProcessor(rlp);
internalProcessor.addAdvice(new CamelInternalProcessor.SubUnitOfWorkProcessorAdvice());
target = internalProcessor;
}
// now let the multicast process the exchange
return target.process(exchange, callback);
}
protected Endpoint resolveEndpoint(Exchange exchange, Object recipient) {
// trim strings as end users might have added spaces between separators
if (recipient instanceof String) {
recipient = ((String)recipient).trim();
}
return ExchangeHelper.resolveEndpoint(exchange, recipient);
}
protected void doStart() throws Exception {
if (producerCache == null) {
producerCache = new ProducerCache(this, camelContext);
}
ServiceHelper.startServices(aggregationStrategy, producerCache);
}
protected void doStop() throws Exception {
ServiceHelper.stopServices(producerCache, aggregationStrategy);
}
protected void doShutdown() throws Exception {
ServiceHelper.stopAndShutdownServices(producerCache, aggregationStrategy);
if (shutdownExecutorService && executorService != null) {
camelContext.getExecutorServiceManager().shutdownNow(executorService);
}
}
public boolean isStreaming() {
return streaming;
}
public void setStreaming(boolean streaming) {
this.streaming = streaming;
}
public boolean isIgnoreInvalidEndpoints() {
return ignoreInvalidEndpoints;
}
public void setIgnoreInvalidEndpoints(boolean ignoreInvalidEndpoints) {
this.ignoreInvalidEndpoints = ignoreInvalidEndpoints;
}
public boolean isParallelProcessing() {
return parallelProcessing;
}
public void setParallelProcessing(boolean parallelProcessing) {
this.parallelProcessing = parallelProcessing;
}
public boolean isStopOnException() {
return stopOnException;
}
public void setStopOnException(boolean stopOnException) {
this.stopOnException = stopOnException;
}
public ExecutorService getExecutorService() {
return executorService;
}
public void setExecutorService(ExecutorService executorService) {
this.executorService = executorService;
}
public boolean isShutdownExecutorService() {
return shutdownExecutorService;
}
public void setShutdownExecutorService(boolean shutdownExecutorService) {
this.shutdownExecutorService = shutdownExecutorService;
}
public AggregationStrategy getAggregationStrategy() {
return aggregationStrategy;
}
public void setAggregationStrategy(AggregationStrategy aggregationStrategy) {
this.aggregationStrategy = aggregationStrategy;
}
public long getTimeout() {
return timeout;
}
public void setTimeout(long timeout) {
this.timeout = timeout;
}
public Processor getOnPrepare() {
return onPrepare;
}
public void setOnPrepare(Processor onPrepare) {
this.onPrepare = onPrepare;
}
public boolean isShareUnitOfWork() {
return shareUnitOfWork;
}
public void setShareUnitOfWork(boolean shareUnitOfWork) {
this.shareUnitOfWork = shareUnitOfWork;
}
}