001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.model;
018
019import javax.xml.bind.annotation.XmlRootElement;
020
021import org.apache.camel.Exchange;
022import org.apache.camel.Predicate;
023import org.apache.camel.model.language.ExpressionDefinition;
024import org.apache.camel.spi.Metadata;
025import org.apache.camel.spi.RouteContext;
026
027/**
028 * Predicate to determine if the message should be sent or not to the endpoint, when using interceptSentToEndpoint.
029 */
030@Metadata(label = "configuration")
031@XmlRootElement(name = "whenSkipSendToEndpoint")
032public class WhenSkipSendToEndpointDefinition extends WhenDefinition {
033
034    @Override
035    protected Predicate createPredicate(RouteContext routeContext) {
036        // we need to keep track whether the when matches or not, so delegate
037        // the predicate and add the matches result as a property on the exchange
038        final Predicate delegate = super.createPredicate(routeContext);
039        return new Predicate() {
040            @Override
041            public boolean matches(Exchange exchange) {
042                boolean matches = delegate.matches(exchange);
043                exchange.setProperty(Exchange.INTERCEPT_SEND_TO_ENDPOINT_WHEN_MATCHED, matches);
044                return matches;
045            }
046
047            @Override
048            public String toString() {
049                return delegate.toString();
050            }
051        };
052    }
053
054    /**
055     * Expression used as the predicate to evaluate whether the message should be sent or not to the endpoint
056     */
057    @Override
058    public void setExpression(ExpressionDefinition expression) {
059        // override to include javadoc what the expression is used for
060        super.setExpression(expression);
061    }
062
063}