org.hibernate.boot.registry.classloading.spi.ClassLoaderService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
JPMS Module-Info's for a few of the Jakarta Libraries just until they add them in themselves
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.boot.registry.classloading.spi;
import java.io.InputStream;
import java.lang.reflect.InvocationHandler;
import java.net.URL;
import java.util.Collection;
import java.util.List;
import org.hibernate.service.Service;
import org.hibernate.service.spi.Stoppable;
/**
* A service for interacting with class loaders.
*
* @author Steve Ebersole
*/
public interface ClassLoaderService extends Service, Stoppable {
/**
* Locate a class by name.
*
* @param className The name of the class to locate
* @param The returned class type.
*
* @return The class reference
*
* @throws ClassLoadingException Indicates the class could not be found
*/
Class classForName(String className);
/**
* Locate a resource by name (classpath lookup).
*
* @param name The resource name.
*
* @return The located URL; may return {@code null} to indicate the resource was not found
*/
URL locateResource(String name);
/**
* Locate a resource by name (classpath lookup) and gets its stream.
*
* @param name The resource name.
*
* @return The stream of the located resource; may return {@code null} to indicate the resource was not found
*/
InputStream locateResourceStream(String name);
/**
* Locate a series of resource by name (classpath lookup).
*
* @param name The resource name.
*
* @return The list of URL matching; may return {@code null} to indicate the resource was not found
*/
List locateResources(String name);
/**
* Discovers and instantiates implementations of the named service contract.
*
* NOTE : the terms service here is used differently than {@link Service}. Instead here we are talking about
* services as defined by {@link java.util.ServiceLoader}.
*
* @param serviceContract The java type defining the service contract
* @param The type of the service contract
*
* @return The ordered set of discovered services.
*/
Collection loadJavaServices(Class serviceContract);
T generateProxy(InvocationHandler handler, Class... interfaces);
/**
* Loading a Package from the classloader. In case it's not found or an
* internal error (such as @see {@link LinkageError} occurs, we
* return null rather than throwing an exception.
* This is significantly different than loading a Class, as in all
* currently known usages, being unable to load the Package will
* only result in ignoring annotations on it - which is totally
* fine when the object doesn't exist.
* In case of other errors, implementations are expected to log
* a warning but it's still not treated as a fatal error.
* @param packageName
* @return the matching Package, or null.
*/
Package packageForNameOrNull(String packageName);
interface Work {
T doWork(ClassLoader classLoader);
}
T workWithClassLoader(Work work);
}