| /* |
| * 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.function.Supplier; |
| |
| 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.AggregationStrategy; |
| import org.apache.camel.model.language.ExpressionDefinition; |
| import org.apache.camel.spi.Metadata; |
| |
| /** |
| * Enriches a message with data from a secondary resource |
| * |
| * @see org.apache.camel.processor.Enricher |
| */ |
| @Metadata(label = "eip,transformation") |
| @XmlRootElement(name = "enrich") |
| @XmlAccessorType(XmlAccessType.FIELD) |
| public class EnrichDefinition extends ExpressionNode { |
| @XmlAttribute(name = "strategyRef") |
| private String aggregationStrategyRef; |
| @XmlAttribute(name = "strategyMethodName") |
| private String aggregationStrategyMethodName; |
| @XmlAttribute(name = "strategyMethodAllowNull") |
| private Boolean aggregationStrategyMethodAllowNull; |
| @XmlAttribute |
| private Boolean aggregateOnException; |
| @XmlTransient |
| private AggregationStrategy aggregationStrategy; |
| @XmlAttribute |
| private Boolean shareUnitOfWork; |
| @XmlAttribute |
| private Integer cacheSize; |
| @XmlAttribute |
| private Boolean ignoreInvalidEndpoint; |
| |
| public EnrichDefinition() { |
| this(null); |
| } |
| |
| public EnrichDefinition(AggregationStrategy aggregationStrategy) { |
| this.aggregationStrategy = aggregationStrategy; |
| } |
| |
| @Override |
| public String toString() { |
| return "Enrich[" + getExpression() + "]"; |
| } |
| |
| @Override |
| public String getShortName() { |
| return "enrich"; |
| } |
| |
| @Override |
| public String getLabel() { |
| return "enrich[" + getExpression() + "]"; |
| } |
| |
| // Fluent API |
| // ------------------------------------------------------------------------- |
| |
| /** |
| * Sets the AggregationStrategy to be used to merge the reply from the |
| * external service, into a single outgoing message. By default Camel will |
| * use the reply from the external service as outgoing message. |
| */ |
| public EnrichDefinition aggregationStrategy(AggregationStrategy aggregationStrategy) { |
| setAggregationStrategy(aggregationStrategy); |
| return this; |
| } |
| |
| /** |
| * Sets the AggregationStrategy to be used to merge the reply from the |
| * external service, into a single outgoing message. By default Camel will |
| * use the reply from the external service as outgoing message. |
| */ |
| public EnrichDefinition aggregationStrategy(Supplier<AggregationStrategy> aggregationStrategy) { |
| setAggregationStrategy(aggregationStrategy.get()); |
| return this; |
| } |
| |
| /** |
| * Refers to an AggregationStrategy to be used to merge the reply from the |
| * external service, into a single outgoing message. By default Camel will |
| * use the reply from the external service as outgoing message. |
| */ |
| public EnrichDefinition aggregationStrategyRef(String aggregationStrategyRef) { |
| setAggregationStrategyRef(aggregationStrategyRef); |
| return this; |
| } |
| |
| /** |
| * This option can be used to explicit declare the method name to use, when |
| * using POJOs as the AggregationStrategy. |
| */ |
| public EnrichDefinition aggregationStrategyMethodName(String aggregationStrategyMethodName) { |
| setAggregationStrategyMethodName(aggregationStrategyMethodName); |
| return this; |
| } |
| |
| /** |
| * If this option is false then the aggregate method is not used if there |
| * was no data to enrich. If this option is true then null values is used as |
| * the oldExchange (when no data to enrich), when using POJOs as the |
| * AggregationStrategy. |
| */ |
| public EnrichDefinition aggregationStrategyMethodAllowNull(boolean aggregationStrategyMethodAllowNull) { |
| setAggregationStrategyMethodAllowNull(aggregationStrategyMethodAllowNull); |
| return this; |
| } |
| |
| /** |
| * If this option is false then the aggregate method is not used if there |
| * was an exception thrown while trying to retrieve the data to enrich from |
| * the resource. Setting this option to true allows end users to control |
| * what to do if there was an exception in the aggregate method. For example |
| * to suppress the exception or set a custom message body etc. |
| */ |
| public EnrichDefinition aggregateOnException(boolean aggregateOnException) { |
| setAggregateOnException(aggregateOnException); |
| return this; |
| } |
| |
| /** |
| * Shares the {@link org.apache.camel.spi.UnitOfWork} with the parent and |
| * the resource exchange. Enrich will by default not share unit of work |
| * between the parent exchange and the resource exchange. This means the |
| * resource exchange has its own individual unit of work. |
| */ |
| public EnrichDefinition shareUnitOfWork() { |
| setShareUnitOfWork(true); |
| return this; |
| } |
| |
| /** |
| * Sets the maximum size used by the |
| * {@link org.apache.camel.spi.ProducerCache} which is used to cache and |
| * reuse producer when uris are reused. |
| * |
| * @param cacheSize the cache size, use <tt>0</tt> for default cache size, |
| * or <tt>-1</tt> to turn cache off. |
| * @return the builder |
| */ |
| public EnrichDefinition cacheSize(int cacheSize) { |
| setCacheSize(cacheSize); |
| return this; |
| } |
| |
| /** |
| * Ignore the invalidate endpoint exception when try to create a producer |
| * with that endpoint |
| * |
| * @return the builder |
| */ |
| public EnrichDefinition ignoreInvalidEndpoint() { |
| setIgnoreInvalidEndpoint(true); |
| return this; |
| } |
| |
| // Properties |
| // ------------------------------------------------------------------------- |
| |
| /** |
| * Expression that computes the endpoint uri to use as the resource endpoint |
| * to enrich from |
| */ |
| @Override |
| public void setExpression(ExpressionDefinition expression) { |
| // override to include javadoc what the expression is used for |
| super.setExpression(expression); |
| } |
| |
| public String getAggregationStrategyRef() { |
| return aggregationStrategyRef; |
| } |
| |
| public void setAggregationStrategyRef(String aggregationStrategyRef) { |
| this.aggregationStrategyRef = aggregationStrategyRef; |
| } |
| |
| public String getAggregationStrategyMethodName() { |
| return aggregationStrategyMethodName; |
| } |
| |
| public void setAggregationStrategyMethodName(String aggregationStrategyMethodName) { |
| this.aggregationStrategyMethodName = aggregationStrategyMethodName; |
| } |
| |
| public Boolean getAggregationStrategyMethodAllowNull() { |
| return aggregationStrategyMethodAllowNull; |
| } |
| |
| public void setAggregationStrategyMethodAllowNull(Boolean aggregationStrategyMethodAllowNull) { |
| this.aggregationStrategyMethodAllowNull = aggregationStrategyMethodAllowNull; |
| } |
| |
| public AggregationStrategy getAggregationStrategy() { |
| return aggregationStrategy; |
| } |
| |
| public void setAggregationStrategy(AggregationStrategy aggregationStrategy) { |
| this.aggregationStrategy = aggregationStrategy; |
| } |
| |
| public Boolean getAggregateOnException() { |
| return aggregateOnException; |
| } |
| |
| public void setAggregateOnException(Boolean aggregateOnException) { |
| this.aggregateOnException = aggregateOnException; |
| } |
| |
| public Boolean getShareUnitOfWork() { |
| return shareUnitOfWork; |
| } |
| |
| public void setShareUnitOfWork(Boolean shareUnitOfWork) { |
| this.shareUnitOfWork = shareUnitOfWork; |
| } |
| |
| public Integer getCacheSize() { |
| return cacheSize; |
| } |
| |
| public void setCacheSize(Integer cacheSize) { |
| this.cacheSize = cacheSize; |
| } |
| |
| public Boolean getIgnoreInvalidEndpoint() { |
| return ignoreInvalidEndpoint; |
| } |
| |
| public void setIgnoreInvalidEndpoint(Boolean ignoreInvalidEndpoint) { |
| this.ignoreInvalidEndpoint = ignoreInvalidEndpoint; |
| } |
| } |