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.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlRootElement;
022
023import org.apache.camel.Expression;
024import org.apache.camel.Predicate;
025import org.apache.camel.model.language.ExpressionDefinition;
026import org.apache.camel.processor.validation.PredicateValidatingProcessor;
027import org.apache.camel.spi.Metadata;
028import org.apache.camel.spi.RouteContext;
029
030/**
031 * Validates a message based on an expression
032 *
033 * @version 
034 */
035@Metadata(label = "eip,transformation")
036@XmlRootElement(name = "validate")
037@XmlAccessorType(XmlAccessType.FIELD)
038public class ValidateDefinition extends NoOutputExpressionNode {
039
040    public ValidateDefinition() {
041    }
042
043    public ValidateDefinition(Expression expression) {
044        super(expression);
045    }
046
047    public ValidateDefinition(Predicate predicate) {
048        super(predicate);
049    }
050
051    @Override
052    public String toString() {
053        return "Validate[" + getExpression() + " -> " + getOutputs() + "]";
054    }
055    
056    @Override
057    public String getLabel() {
058        return "validate[" + getExpression() + "]";
059    }
060
061    @Override
062    public PredicateValidatingProcessor createProcessor(RouteContext routeContext) throws Exception {
063        Predicate pred = getExpression().createPredicate(routeContext);
064        return new PredicateValidatingProcessor(pred);
065    }
066
067    /**
068     * Expression to use for validation as a predicate. The expression should return either <tt>true</tt> or <tt>false</tt>.
069     * If returning <tt>false</tt> the message is invalid and an exception is thrown.
070     */
071    @Override
072    public void setExpression(ExpressionDefinition expression) {
073        // override to include javadoc what the expression is used for
074        super.setExpression(expression);
075    }
076
077
078}