Package dev.getelements.elements.sdk

Interface ElementArtifactLoader

All Known Implementing Classes:

CachingShrinkwrapElementArtifactLoader

public interface ElementArtifactLoader

An interface to load artifacts from coordinates. Artifacts are bundles of code, typically in jar form, that can provide additional functionality. This service can load artifacts on-the-fly from various sources and load them into the application. Unless otherwise specified, the find family of methods will throw exceptions for any reason except a missing artifact.

Method Summary

Modifier and Type	Method	Description
Optional<Artifact>	findArtifact(Set<ArtifactRepository> repositories, String coordinates)	Finds the artifact with the repositories and coordinates.
default Optional<ClassLoader>	findClassLoader(ClassLoader parent, Set<ArtifactRepository> repositories, String first, String... additional)	Gets the ClassLoader loaded with the supplied coordinates.
Optional<ClassLoader>	findClassLoader(ClassLoader parent, Set<ArtifactRepository> repositories, Set<String> coordinates)	Opens a ClassLoader with the supplied coordinates.
Stream<Artifact>	findClasspathForArtifact(Set<ArtifactRepository> repositories, String coordinates)	Finds the classpath for a particular artifact, including all transient dependencies.
default Artifact	getArtifact(Set<ArtifactRepository> repositories, String coordinates)	Gets a single artifact.
default ClassLoader	getClassLoader(ClassLoader parent, Set<ArtifactRepository> repositories, String first, String... additional)	Gets the ClassLoader loaded with the supplied coordinates.
default ClassLoader	getClassLoader(ClassLoader parent, Set<ArtifactRepository> repositories, Set<String> coordinates)	Opens a ClassLoader with the supplied coordinates.
static ElementArtifactLoader	newDefaultInstance()	Gets a new default instance of the ElementArtifactLoader.

Method Details

getClassLoader

default ClassLoader getClassLoader(ClassLoader parent,
 Set<ArtifactRepository> repositories,
 String first,
 String... additional)

Gets the ClassLoader loaded with the supplied coordinates.

Parameters:

parent - the parent ClassLoader, may be null indicating that the system classpath is to be used

repositories - the set of repositories to use for resolution

first - the first coordinates

additional - the additional coordinates

Returns:

the ClassLoader

getClassLoader

default ClassLoader getClassLoader(ClassLoader parent,
 Set<ArtifactRepository> repositories,
 Set<String> coordinates)

Opens a ClassLoader with the supplied coordinates. This will resolve all requested coordinates and then return a ClassLoader with the artifacts.

Parameters:

parent - the parent ClassLoader, may be null indicating that the system classpath is to be used

repositories - the set of repositories to use for resolution

coordinates - the full set of coordinates

Returns:

a ClassLoader for the artifact registry

Throws:

SdkArtifactNotFoundException - if one or more of the requested artifacts can't be found

findClassLoader

default Optional<ClassLoader> findClassLoader(ClassLoader parent,
 Set<ArtifactRepository> repositories,
 String first,
 String... additional)

Gets the ClassLoader loaded with the supplied coordinates.

Parameters:

parent - the parent ClassLoader, may be null indicating that the system classpath is to be used

repositories - the set of repositories to use for resolution

first - the first coordinates

additional - the additional coordinates

Returns:

the ClassLoader

findClassLoader

Optional<ClassLoader> findClassLoader(ClassLoader parent,
 Set<ArtifactRepository> repositories,
 Set<String> coordinates)

Opens a ClassLoader with the supplied coordinates. This will resolve all requested coordinates and then return a ClassLoader with the artifacts.

Returns:

a ClassLoader for the artifact registry

getArtifact

default Artifact getArtifact(Set<ArtifactRepository> repositories,
 String coordinates)

Gets a single artifact.

Parameters:

repositories - the repositories to search

coordinates - the coordinates

Returns:

the Artifact

Throws:

SdkArtifactNotFoundException - if the artifact can't be found

findClasspathForArtifact

Stream<Artifact> findClasspathForArtifact(Set<ArtifactRepository> repositories,
 String coordinates)

Finds the classpath for a particular artifact, including all transient dependencies.

Parameters:

repositories - the repositories to search

coordinates - the coordinates

Returns:

a stream of Artifacts

findArtifact

Optional<Artifact> findArtifact(Set<ArtifactRepository> repositories,
 String coordinates)

Finds the artifact with the repositories and coordinates.

Parameters:

repositories - the repositories to search

coordinates - the coordinates

Returns:

an Optional with the artifact

newDefaultInstance

static ElementArtifactLoader newDefaultInstance()

Gets a new default instance of the ElementArtifactLoader.

Returns:

the ElementArtifactLoader