org.apache.camel.model.validator.ValidatorDefinition Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
There is a newer version: 4.6.0
/**
 * 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.validator;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlType;
import org.apache.camel.CamelContext;
import org.apache.camel.model.InputTypeDefinition;
import org.apache.camel.model.OutputTypeDefinition;
import org.apache.camel.spi.DataType;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.Validator;

/**
 * Represents a {@link Validator} which declaratively validates message content
 * according to the input type declared by {@link InputTypeDefinition} and/or output type
 * declared by {@link OutputTypeDefinition}.
 * If you specify type='xml:ABC', the validator
 * will be picked up when current message type is 'xml:ABC'.
 * If you specify type='json', then it will be picked up for all of json validation.
 * 
 * {@see Validator}
 * {@see InputTypeDefinition}
 * {@see OutputTypeDefinition}
 */
@Metadata(label = "validation")
@XmlType(name = "validator")
@XmlAccessorType(XmlAccessType.FIELD)
public abstract class ValidatorDefinition {

    @XmlAttribute
    private String type;

    public Validator createValidator(CamelContext context) throws Exception {
        return doCreateValidator(context);
    };

    protected abstract Validator doCreateValidator(CamelContext context) throws Exception;

    public String getType() {
        return type;
    }

    /**
     * Set the data type name.
     * If you specify 'xml:XYZ', the validator will be picked up if message type is
     * 'xml:XYZ'. If you specify just 'xml', the validator matches with all of
     * 'xml' message type like 'xml:ABC' or 'xml:DEF'.
     * 
     * @param type data type name
     */
    public void setType(String type) {
        this.type = type;
    }

    /**
     * Set the data type using Java class.
     * @param clazz Java class
     */
    public void setType(Class clazz) {
        this.type = new DataType(clazz).toString();
    }
}