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