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