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.component.validator;
018
019import org.w3c.dom.ls.LSResourceResolver;
020
021import org.apache.camel.CamelContext;
022
023/**
024 * Can be used to create custom resource resolver for the validator endpoint.
025 * This interface is useful, if the custom resource resolver depends on the
026 * resource URI specified in the validator endpoint. The resource URI of the
027 * endpoint can be even dynamic, like in the following example:
028 * 
029 * <pre>
030 * {@code <camel:recipientList>} 
031 * {@code      <camel:simple>validator:${header.XSD_FILE}?resourceResolverFactory=#resourceResolverFactory</camel:simple>}
032 * {@code </camel:recipientList>}
033 * </pre>
034 * 
035 * The dynamic resource URI given in ${header.XSD_FILE} will be past as
036 * rootResourceUri parameter in the method
037 * {@link #createResourceResolver(CamelContext, String)}
038 */
039public interface ValidatorResourceResolverFactory {
040
041    /**
042     * Method is called during the creation of a validator endpoint.
043     * 
044     * @param camelContext camel context
045     * @param rootResourceUri resource URI specified in the endpoint URI
046     * @return resource resolver
047     */
048    LSResourceResolver createResourceResolver(CamelContext camelContext, String rootResourceUri);
049
050}