org.apache.camel.spi.ClassResolver Maven / Gradle / Ivy
/**
* 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.spi;
import java.io.InputStream;
import java.net.URL;
/**
* A class resolver for loading classes in a loosly coupled manner to cater for different platforms such
* as standalone, web container, j2ee container and OSGi platforms.
*/
public interface ClassResolver {
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @return the class if resolved, null if not found.
*/
Class resolveClass(String name);
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @param type the expected type of the class
* @return the class if resolved, null if not found.
*/
Class resolveClass(String name, Class type);
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @param loader use the provided class loader
* @return the class if resolved, null if not found.
*/
Class resolveClass(String name, ClassLoader loader);
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @param type the expected type of the class
* @param loader use the provided class loader
* @return the class if resolved, null if not found.
*/
Class resolveClass(String name, Class type, ClassLoader loader);
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @return the class if resolved, null if not found.
* @throws ClassNotFoundException is thrown if class not found
*/
Class resolveMandatoryClass(String name) throws ClassNotFoundException;
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @param type the expected type of the class
* @return the class if resolved, null if not found.
* @throws ClassNotFoundException is thrown if class not found
*/
Class resolveMandatoryClass(String name, Class type) throws ClassNotFoundException;
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @param loader use the provided class loader
* @return the class if resolved, null if not found.
* @throws ClassNotFoundException is thrown if class not found
*/
Class resolveMandatoryClass(String name, ClassLoader loader) throws ClassNotFoundException;
/**
* Resolves the given class by its name
*
* @param name full qualified name of class
* @param type the expected type of the class
* @param loader use the provided class loader
* @return the class if resolved, null if not found.
* @throws ClassNotFoundException is thrown if class not found
*/
Class resolveMandatoryClass(String name, Class type, ClassLoader loader) throws ClassNotFoundException;
/**
* Loads the given resource as a stream
*
* @param uri the uri of the resource
* @return as a stream
*/
InputStream loadResourceAsStream(String uri);
/**
* Loads the given resource as a URL
*
* @param uri the uri of the resource
* @return as a URL
*/
URL loadResourceAsURL(String uri);
}