org.microbean.maven.cdi

Class MavenArtifactClassLoader

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

org.microbean.maven.cdi.MavenArtifactClassLoader

All Implemented Interfaces:

Closeable, AutoCloseable

public class MavenArtifactClassLoader
extends URLClassLoader

A URLClassLoader that uses the Maven Resolver API to resolve artifacts from Maven repositories.

Author:

Laird Nelson

See Also:

MavenArtifactClassLoader(RepositorySystem, RepositorySystemSession, DependencyRequest, ClassLoader, URLStreamHandlerFactory)

Constructor Summary

Constructors

Constructor and Description
MavenArtifactClassLoader(RepositorySystem repositorySystem, RepositorySystemSession session, DependencyRequest dependencyRequest) Creates a new MavenArtifactClassLoader.
MavenArtifactClassLoader(RepositorySystem repositorySystem, RepositorySystemSession session, DependencyRequest dependencyRequest, ClassLoader parentClassLoader) Creates a new MavenArtifactClassLoader.
MavenArtifactClassLoader(RepositorySystem repositorySystem, RepositorySystemSession session, DependencyRequest dependencyRequest, ClassLoader parentClassLoader, URLStreamHandlerFactory urlStreamHandlerFactory) Creates a new MavenArtifactClassLoader.

Method Summary

Modifier and Type	Method and Description
static DependencyRequest	getDependencyRequest(CollectRequest collectRequest) Returns a non-null DependencyRequest suitable for the supplied CollectRequest.
static DependencyRequest	getDependencyRequest(Set<? extends Artifact> artifacts, List<RemoteRepository> remoteRepositories) Given a Set of Artifacts and a List of RemoteRepository instances representing repositories from which they might be resolved, creates and returns a DependencyRequest for their resolution, using runtime scope.
static DependencyRequest	getDependencyRequest(Set<? extends Artifact> artifacts, String scope, List<RemoteRepository> remoteRepositories) Given a Set of Artifacts and a List of RemoteRepository instances representing repositories from which they might be resolved, creates and returns a DependencyRequest for their resolution in the supplied scope.
static DependencyRequest	getDependencyRequest(String classpathLikeString, List<RemoteRepository> remoteRepositories) Returns a non-null DependencyRequest by parsing the supplied classpath-like String for Maven artifact coordinates, and then invoking and returning the result of the getDependencyRequest(Set, List) method.
static Collection<? extends URL>	getUrls(RepositorySystem repositorySystem, RepositorySystemSession session, DependencyRequest dependencyRequest) Returns a Collection of (file) URLs that results from resolution of the dependencies described by the supplied DependencyRequest.
String	toClasspath() Returns a non-null String with a classpath-like format that can represent this MavenArtifactClassLoader's URLs.

Methods inherited from class java.net.URLClassLoader

addURL, close, definePackage, findClass, findResource, findResources, getPermissions, getResourceAsStream, getURLs, newInstance, newInstance

Methods inherited from class java.security.SecureClassLoader

defineClass, defineClass

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResource, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MavenArtifactClassLoader

public MavenArtifactClassLoader(RepositorySystem repositorySystem,
                                RepositorySystemSession session,
                                DependencyRequest dependencyRequest)
                         throws DependencyResolutionException

Creates a new MavenArtifactClassLoader.

Parameters:

repositorySystem - the RepositorySystem responsible for resolving artifacts; must not be null

session - the RepositorySystemSession governing certain aspects of the resolution process; must not be null

dependencyRequest - the DependencyRequest that describes what artifacts should be resolved; must not be null

Throws:

NullPointerException - if a parameter that must not be null is discovered to be null

DependencyResolutionException - if there was a problem resolving dependencies

See Also:

getUrls(RepositorySystem, RepositorySystemSession, DependencyRequest), getDependencyRequest(String, List), URLClassLoader.URLClassLoader(URL[])

MavenArtifactClassLoader

public MavenArtifactClassLoader(RepositorySystem repositorySystem,
                                RepositorySystemSession session,
                                DependencyRequest dependencyRequest,
                                ClassLoader parentClassLoader)
                         throws DependencyResolutionException

Creates a new MavenArtifactClassLoader.

Parameters:

repositorySystem - the RepositorySystem responsible for resolving artifacts; must not be null

session - the RepositorySystemSession governing certain aspects of the resolution process; must not be null

dependencyRequest - the DependencyRequest that describes what artifacts should be resolved; must not be null

parentClassLoader - the ClassLoader that will parent this one; may be null

Throws:

NullPointerException - if a parameter that must not be null is discovered to be null

DependencyResolutionException - if there was a problem resolving dependencies

See Also:

getUrls(RepositorySystem, RepositorySystemSession, DependencyRequest), getDependencyRequest(String, List), URLClassLoader.URLClassLoader(URL[], ClassLoader)

MavenArtifactClassLoader

public MavenArtifactClassLoader(RepositorySystem repositorySystem,
                                RepositorySystemSession session,
                                DependencyRequest dependencyRequest,
                                ClassLoader parentClassLoader,
                                URLStreamHandlerFactory urlStreamHandlerFactory)
                         throws DependencyResolutionException

Creates a new MavenArtifactClassLoader.

Parameters:

repositorySystem - the RepositorySystem responsible for resolving artifacts; must not be null

session - the RepositorySystemSession governing certain aspects of the resolution process; must not be null

dependencyRequest - the DependencyRequest that describes what artifacts should be resolved; must not be null

parentClassLoader - the ClassLoader that will parent this one; may be null

urlStreamHandlerFactory - the URLStreamHandlerFactory to create URLStreamHandlers for the URLs URLs that constitute this MavenArtifactClassLoader's classpath; URLClassLoader does not define whether this can be null or not

Throws:

NullPointerException - if a parameter that must not be null is discovered to be null

DependencyResolutionException - if there was a problem resolving dependencies

See Also:

getUrls(RepositorySystem, RepositorySystemSession, DependencyRequest), getDependencyRequest(String, List), URLClassLoader.URLClassLoader(URL[], ClassLoader, URLStreamHandlerFactory)

Method Detail

toClasspath

public String toClasspath()

Returns a non-null String with a classpath-like format that can represent this MavenArtifactClassLoader's URLs.

The format of the String that is returned is exactly like a classpath string appropriate for the current platform with the exception that the platform-specific classpath separator is doubled if any of the URLs belonging to this MavenArtifactClassLoader is not a file URL.

For any given URL, the returned String will represent it as its String form, unless it has a protocol equal to file, in which case will represent it as its path.

Returns:

a non-null classpath-like String (with doubled classpath separators) consisting of this MavenArtifactClassLoader's URLs represented as described above

getDependencyRequest

public static final DependencyRequest getDependencyRequest(String classpathLikeString,
                                                           List<RemoteRepository> remoteRepositories)

Returns a non-null DependencyRequest by parsing the supplied classpath-like String for Maven artifact coordinates, and then invoking and returning the result of the getDependencyRequest(Set, List) method.

This method never returns null.

Elements within the supplied classpathLikeString are separated by double occurrences of the platform-specific classpath separator. For example, on Unix and Unix-derived systems, a classpath-like string of the form com.foo:bar:1.0::com.fizz:buzz:1.0 will yield two elements: com.foo:bar:1.0 and com.fizz:buzz:1.0. On Windows systems, a classpath-like string of the form com.foo:bar:1.0;;com.fizz:buzz:1.0 will yield two elements: com.foo:bar:1.0 and com.fizz:buzz:1.0.

Parameters:

classpathLikeString - a classpath-like String formatted as described above; may be null

remoteRepositories - a List of RemoteRepository instances that will be forwarded on to the getDependencyRequest(Set, List) method; must not be null

Returns:

the return value that results from invoking the getDependencyRequest(Set, List) method

Throws:

NullPointerException - if remoteRepositories is null

getDependencyRequest

public static final DependencyRequest getDependencyRequest(Set<? extends Artifact> artifacts,
                                                           List<RemoteRepository> remoteRepositories)

Given a Set of Artifacts and a List of RemoteRepository instances representing repositories from which they might be resolved, creates and returns a DependencyRequest for their resolution, using runtime scope.

This method never returns null.

Parameters:

artifacts - a Set of Artifacts to resolve; may be null

remoteRepositories - a List of RemoteRepository instances representing Maven repositories from which the supplied Artifact instances may be resolved; must not be null

Returns:

a non-null DependencyRequest

Throws:

NullPointerException - if remoteRepositories is null

See Also:

getDependencyRequest(Set, String, List)

getDependencyRequest

public static final DependencyRequest getDependencyRequest(Set<? extends Artifact> artifacts,
                                                           String scope,
                                                           List<RemoteRepository> remoteRepositories)

Given a Set of Artifacts and a List of RemoteRepository instances representing repositories from which they might be resolved, creates and returns a DependencyRequest for their resolution in the supplied scope.

This method never returns null.

Parameters:

artifacts - a Set of Artifacts to resolve; may be null

scope - the scope in which resolution should take place; may be null in which case JavaScopes.RUNTIME will be used instead; see JavaScopes for commonly-used scopes

remoteRepositories - a List of RemoteRepository instances representing Maven repositories from which the supplied Artifact instances may be resolved; must not be null

Returns:

a non-null DependencyRequest

Throws:

NullPointerException - if remoteRepositories is null

See Also:

JavaScopes, getDependencyRequest(CollectRequest)

getDependencyRequest

public static final DependencyRequest getDependencyRequest(CollectRequest collectRequest)

Returns a non-null DependencyRequest suitable for the supplied CollectRequest.

This method never returns null.

Parameters:

collectRequest - a CollectRequest describing dependency collection; must not be null

Returns:

a new DependencyRequest; never null

Throws:

NullPointerException - if collectRequest is null

See Also:

CollectRequest, DependencyRequest, MavenArtifactClassLoader(RepositorySystem, RepositorySystemSession, DependencyRequest, ClassLoader, URLStreamHandlerFactory)

getUrls

public static final Collection<? extends URL> getUrls(RepositorySystem repositorySystem,
                                                      RepositorySystemSession session,
                                                      DependencyRequest dependencyRequest)
                                               throws DependencyResolutionException

Returns a Collection of (file) URLs that results from resolution of the dependencies described by the supplied DependencyRequest.

This method never returns null.

Parameters:

repositorySystem - the RepositorySystem responsible for resolving artifacts; must not be null

session - the RepositorySystemSession governing certain aspects of the resolution process; must not be null

dependencyRequest - the DependencyRequest that describes what artifacts should be resolved; must not be null

Returns:

a non-null Collection of distinct URLs; a Set is not part of the contract of this method only because the URL.equals(Object) method involves DNS lookups

Throws:

NullPointerException - if any parameter is null

DependencyResolutionException - if there was a problem with dependency resolution