DataChannelDescriptorLoader.java

/*****************************************************************
 *   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.cayenne.configuration;

import org.apache.cayenne.ConfigurationException;
import org.apache.cayenne.resource.Resource;

/**
 * An object that can load a named {@link DataChannelDescriptor} from some configuration
 * source.
 * 
 * @since 3.1
 */
public interface DataChannelDescriptorLoader {

    /**
     * Loads a DataChannelDescriptor from some configuration resource, usually an XML file
     * found on classpath.
     */
    ConfigurationTree<DataChannelDescriptor> load(Resource configurationResource)
            throws ConfigurationException;
}