org.mule.runtime.module.artifact.api.classloader

Interface ArtifactClassLoader

All Superinterfaces:

ClassLoaderLookupPolicyProvider, DisposableClassLoader, LocalResourceLocator

All Known Implementing Classes:

FilteringArtifactClassLoader, MuleArtifactClassLoader, MuleDeployableArtifactClassLoader, RegionClassLoader

@NoImplement
public interface ArtifactClassLoader
extends DisposableClassLoader, LocalResourceLocator, ClassLoaderLookupPolicyProvider

Method Summary

Modifier and Type	Method and Description
void	addShutdownListener(ShutdownListener listener) Adds a shutdown listener to the class loader.
Class<?>	findLocalClass(String name) Loads the class with the specified binary name if defined on this class loader.
URL	findResource(String resource)
Enumeration<URL>	findResources(String name) Returns an enumeration of URL objects representing all the resources with the given name which are local to the classloader
<T extends ArtifactDescriptor> T	getArtifactDescriptor()
String	getArtifactId()
ClassLoader	getClassLoader() ClassLoader is an abstract class.

Methods inherited from interface org.mule.runtime.module.artifact.api.classloader.DisposableClassLoader

dispose

Methods inherited from interface org.mule.runtime.module.artifact.api.classloader.LocalResourceLocator

findLocalResource

Methods inherited from interface org.mule.runtime.module.artifact.api.classloader.ClassLoaderLookupPolicyProvider

getClassLoaderLookupPolicy

Method Detail

getArtifactId

String getArtifactId()

Returns:

the artifact unique identifier

getArtifactDescriptor

<T extends ArtifactDescriptor> T getArtifactDescriptor()

Type Parameters:

T - the generic type of the artifact descriptor.

Returns:

the artifact descriptor corresponding to this classloader instance. Non null.

findResource

URL findResource(String resource)

Parameters:

resource - name of the resource to find.

Returns:

the resource URL, null if it doesn't exists.

findResources

Enumeration<URL> findResources(String name)
                        throws IOException

Returns an enumeration of URL objects representing all the resources with the given name which are local to the classloader

Parameters:

name - The resource name

Returns:

An enumeration of URL objects for the resources

Throws:

IOException - If I/O errors occur

findLocalClass

Class<?> findLocalClass(String name)
                 throws ClassNotFoundException

Loads the class with the specified binary name if defined on this class loader.

Parameters:

name - The binary name of the class

Returns:

The resulting Class object

Throws:

ClassNotFoundException - If the class was not found

getClassLoader

ClassLoader getClassLoader()

ClassLoader is an abstract class. Not an interface. There are parts of the code that requires a ClassLoader and others that requires an ArtifactClassLoader. Ideally I would make ArtifactClassLoader implement ClassLoader interface but there's no such interface. So if I have a method that requires a ClassLoader instance and an ArtifactClassLoader I would have to down cast and assume that it can be down casted or send two parameters, one for the ClassLoader and one for the ArtifactClassLoader: public void doSomething(ArtifactClassLoader acl) { doSomething2(acl); //this requires an ArtifactClassLoader doSomething3((ClassLoader)acl); //this requires a ClassLoader } public void doSomething(ArtifactClassLoader acl, ClassLoader cl) { doSomething2(acl); //this requires an ArtifactClassLoader doSomething3(cl); //this requires a ClassLoader } To overcome that problem seems much better to have a method in ArtifactClassLoader that can actually return a ClassLoader instance: public void doSomething(ArtifactClassLoader acl) { doSomething2(acl); //this requires an ArtifactClassLoader doSomething3(acl.getDomainClassLoader()); //this requires a ClassLoader }

Returns:

class loader to use for this artifact.

addShutdownListener

void addShutdownListener(ShutdownListener listener)

Adds a shutdown listener to the class loader. This listener will be invoked synchronously right before the class loader is disposed and closed.