/**
* 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.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
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.XmlElement;
import javax.xml.bind.annotation.XmlElementRef;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import org.apache.camel.Predicate;
import org.apache.camel.Processor;
import org.apache.camel.processor.OnCompletionProcessor;
import org.apache.camel.processor.UnitOfWorkProcessor;
import org.apache.camel.spi.RouteContext;
/**
* Represents an XML <onCompletion/> element
*
* @version
*/
@XmlRootElement(name = "onCompletion")
@XmlAccessorType(XmlAccessType.FIELD)
public class OnCompletionDefinition extends ProcessorDefinition<OnCompletionDefinition> implements ExecutorServiceAwareDefinition<OnCompletionDefinition> {
@XmlAttribute
private Boolean onCompleteOnly;
@XmlAttribute
private Boolean onFailureOnly;
@XmlElement(name = "onWhen")
private WhenDefinition onWhen;
@XmlAttribute
private String executorServiceRef;
@XmlAttribute(name = "useOriginalMessage")
private Boolean useOriginalMessagePolicy;
@XmlElementRef
private List<ProcessorDefinition<?>> outputs = new ArrayList<ProcessorDefinition<?>>();
@XmlTransient
private ExecutorService executorService;
@XmlTransient
private Boolean routeScoped;
// TODO: in Camel 3.0 the OnCompletionDefinition should not contain state and OnCompletion processors
@XmlTransient
private final Map<String, Processor> onCompletions = new HashMap<String, Processor>();
public OnCompletionDefinition() {
}
public boolean isRouteScoped() {
// is context scoped by default
return routeScoped != null ? routeScoped : false;
}
public Processor getOnCompletion(String routeId) {
return onCompletions.get(routeId);
}
public Collection<Processor> getOnCompletions() {
return onCompletions.values();
}
@Override
public String toString() {
return "onCompletion[" + getOutputs() + "]";
}
@Override
public String getShortName() {
return "onCompletion";
}
@Override
public String getLabel() {
return "onCompletion";
}
@Override
public boolean isAbstract() {
return true;
}
@Override
public Processor createProcessor(RouteContext routeContext) throws Exception {
// assign whether this was a route scoped onCompletion or not
// we need to know this later when setting the parent, as only route scoped should have parent
// Note: this logic can possible be removed when the Camel routing engine decides at runtime
// to apply onCompletion in a more dynamic fashion than current code base
// and therefore is in a better position to decide among context/route scoped OnCompletion at runtime
if (routeScoped == null) {
routeScoped = super.getParent() != null;
}
if (isOnCompleteOnly() && isOnFailureOnly()) {
throw new IllegalArgumentException("Both onCompleteOnly and onFailureOnly cannot be true. Only one of them can be true. On node: " + this);
}
Processor childProcessor = this.createChildProcessor(routeContext, true);
// wrap the on completion route in a unit of work processor
childProcessor = new UnitOfWorkProcessor(routeContext, childProcessor);
String id = routeContext.getRoute().getId();
onCompletions.put(id, childProcessor);
Predicate when = null;
if (onWhen != null) {
when = onWhen.getExpression().createPredicate(routeContext);
}
// executor service is mandatory for on completion
boolean shutdownThreadPool = ProcessorDefinitionHelper.willCreateNewThreadPool(routeContext, this, true);
ExecutorService threadPool = ProcessorDefinitionHelper.getConfiguredExecutorService(routeContext, "OnCompletion", this, true);
// should be false by default
boolean original = getUseOriginalMessagePolicy() != null ? getUseOriginalMessagePolicy() : false;
OnCompletionProcessor answer = new OnCompletionProcessor(routeContext.getCamelContext(), childProcessor,
threadPool, shutdownThreadPool, isOnCompleteOnly(), isOnFailureOnly(), when, original);
return answer;
}
/**
* Removes all existing {@link org.apache.camel.model.OnCompletionDefinition} from the definition.
* <p/>
* This is used to let route scoped <tt>onCompletion</tt> overrule any global <tt>onCompletion</tt>.
* Hence we remove all existing as they are global.
*
* @param definition the parent definition that is the route
*/
public void removeAllOnCompletionDefinition(ProcessorDefinition<?> definition) {
for (Iterator<ProcessorDefinition<?>> it = definition.getOutputs().iterator(); it.hasNext();) {
ProcessorDefinition<?> out = it.next();
if (out instanceof OnCompletionDefinition) {
it.remove();
}
}
}
@Override
public ProcessorDefinition<?> end() {
// pop parent block, as we added our self as block to parent when synchronized was defined in the route
getParent().popBlock();
return super.end();
}
/**
* Will only synchronize when the {@link org.apache.camel.Exchange} completed successfully (no errors).
*
* @return the builder
*/
public OnCompletionDefinition onCompleteOnly() {
if (isOnFailureOnly()) {
throw new IllegalArgumentException("Both onCompleteOnly and onFailureOnly cannot be true. Only one of them can be true. On node: " + this);
}
// must define return type as OutputDefinition and not this type to avoid end user being able
// to invoke onFailureOnly/onCompleteOnly more than once
setOnCompleteOnly(Boolean.TRUE);
setOnFailureOnly(Boolean.FALSE);
return this;
}
/**
* Will only synchronize when the {@link org.apache.camel.Exchange} ended with failure (exception or FAULT message).
*
* @return the builder
*/
public OnCompletionDefinition onFailureOnly() {
if (isOnCompleteOnly()) {
throw new IllegalArgumentException("Both onCompleteOnly and onFailureOnly cannot be true. Only one of them can be true. On node: " + this);
}
// must define return type as OutputDefinition and not this type to avoid end user being able
// to invoke onFailureOnly/onCompleteOnly more than once
setOnCompleteOnly(Boolean.FALSE);
setOnFailureOnly(Boolean.TRUE);
return this;
}
/**
* Sets an additional predicate that should be true before the onCompletion is triggered.
* <p/>
* To be used for fine grained controlling whether a completion callback should be invoked or not
*
* @param predicate predicate that determines true or false
* @return the builder
*/
public OnCompletionDefinition onWhen(Predicate predicate) {
setOnWhen(new WhenDefinition(predicate));
return this;
}
/**
* Will use the original input body when an {@link org.apache.camel.Exchange} for this on completion.
* <p/>
* By default this feature is off.
*
* @return the builder
*/
public OnCompletionDefinition useOriginalBody() {
setUseOriginalMessagePolicy(Boolean.TRUE);
return this;
}
public OnCompletionDefinition executorService(ExecutorService executorService) {
setExecutorService(executorService);
return this;
}
public OnCompletionDefinition executorServiceRef(String executorServiceRef) {
setExecutorServiceRef(executorServiceRef);
return this;
}
public List<ProcessorDefinition<?>> getOutputs() {
return outputs;
}
public void setOutputs(List<ProcessorDefinition<?>> outputs) {
this.outputs = outputs;
}
public boolean isOutputSupported() {
return true;
}
public Boolean getOnCompleteOnly() {
return onCompleteOnly;
}
public void setOnCompleteOnly(Boolean onCompleteOnly) {
this.onCompleteOnly = onCompleteOnly;
}
public boolean isOnCompleteOnly() {
return onCompleteOnly != null && onCompleteOnly;
}
public Boolean getOnFailureOnly() {
return onFailureOnly;
}
public void setOnFailureOnly(Boolean onFailureOnly) {
this.onFailureOnly = onFailureOnly;
}
public boolean isOnFailureOnly() {
return onFailureOnly != null && onFailureOnly;
}
public WhenDefinition getOnWhen() {
return onWhen;
}
public void setOnWhen(WhenDefinition onWhen) {
this.onWhen = onWhen;
}
public ExecutorService getExecutorService() {
return executorService;
}
public void setExecutorService(ExecutorService executorService) {
this.executorService = executorService;
}
public String getExecutorServiceRef() {
return executorServiceRef;
}
public void setExecutorServiceRef(String executorServiceRef) {
this.executorServiceRef = executorServiceRef;
}
public Boolean getUseOriginalMessagePolicy() {
return useOriginalMessagePolicy != null;
}
public void setUseOriginalMessagePolicy(Boolean useOriginalMessagePolicy) {
this.useOriginalMessagePolicy = useOriginalMessagePolicy;
}
}