Package org.ops4j.pax.url.mvn.internal

Class AetherBasedResolver

java.lang.Object

org.ops4j.pax.url.mvn.internal.AetherBasedResolver

All Implemented Interfaces:

Closeable, AutoCloseable, MavenResolver

public class AetherBasedResolver
extends Object
implements MavenResolver

MavenResolver based on Apache Maven Resolver (formerly - Eclipse Aether Resolver (formerly - Sonatype Aether Resolver)).

The resolution process is almost the same as in usual mvn invocation with one big difference. While in pure Maven, remote repositories are used to download the artifacts to local repository if not already available, in Pax URL Aether, there's an initial resolution attempt based on default repositories which are treated as local repositories without write access. This is important for managing separate directories with Maven-like structure - for example in $KARAF_HOME/system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AetherBasedResolver.LocalRepositoryWithConfig	Combination of LocalRepository and MavenRepositoryURL

Nested classes/interfaces inherited from interface org.ops4j.pax.url.mvn.MavenResolver

MavenResolver.RetryChance

Constructor Summary

Constructors

Constructor	Description
AetherBasedResolver(MavenConfiguration configuration)	Create a AetherBasedResolver
AetherBasedResolver(MavenConfiguration configuration, MirrorInfo mirror)	Create a AetherBasedResolver

Method Summary

Modifier and Type	Method	Description
List<org.eclipse.aether.repository.RemoteRepository>	assignMirrorsAndProxies(org.eclipse.aether.RepositorySystemSession session, List<org.eclipse.aether.repository.RemoteRepository> repositories)	Pax URL 2.6 manually checked mirros, proxies and authentication configuration to replace list of target repositories with mirrored/proxied ones.
void	close()
protected org.eclipse.aether.RepositoryException	findAetherException(Exception e)	Find top-most Aether exception
MavenResolver.RetryChance	isRetryableException(Exception exception)	Returns a hint about possible retry of operation that ended with exception
File	resolve(String url)	Resolve and download a maven based url
File	resolve(String url, Exception previousException)	Resolve and download a maven based url - possibly as another attempt.
File	resolve(String groupId, String artifactId, String classifier, String extension, String version)	Resolve and download an artifact
File	resolve(String groupId, String artifactId, String classifier, String extension, String version, Exception previousException)	Resolve and download an artifact - possibly as another attempt.
File	resolve(String groupId, String artifactId, String classifier, String extension, String version, MavenRepositoryURL url, Exception previousException)	Resolve artifact, possibly checking extra (comparing to configured repositories) MavenRepositoryURL obtained from mvn: URI.
File	resolve(List<AetherBasedResolver.LocalRepositoryWithConfig> defaultRepositories, List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories, org.eclipse.aether.artifact.Artifact artifact)	Main resolution method that operates on passed default and remote repositories and doesn't determine the checked repositories on its own.
File	resolve(org.eclipse.aether.artifact.Artifact artifact, MavenRepositoryURL url, Exception previousException)	Main resolution method that resolves artifact using data from Artifact and repositories prepared from global configuration.
File	resolveMetadata(String groupId, String artifactId, String type, String version)	Resolve the maven metadata xml for the specified groupId:artifactId:version
File	resolveMetadata(String groupId, String artifactId, String type, String version, Exception previousException)	Resolve the maven metadata xml for the specified groupId:artifactId:version - possibly as another attempt.
protected Throwable	rootException(Exception ex)	Find root exception
void	upload(String groupId, String artifactId, String classifier, String extension, String version, File file)	Install the specified artifact in the local repository
void	uploadMetadata(String groupId, String artifactId, String type, String version, File artifact)	Install the specified artifact metadata in the local repository

Methods inherited from class java.lang.Object

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

Constructor Detail

AetherBasedResolver

public AetherBasedResolver(MavenConfiguration configuration)

Create a AetherBasedResolver

Parameters:

configuration - (must be not null)

AetherBasedResolver

public AetherBasedResolver(MavenConfiguration configuration,
                           MirrorInfo mirror)

Create a AetherBasedResolver

Parameters:

configuration - (must be not null)

mirror -

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

resolve

public File resolve(String url)
             throws IOException

Description copied from interface: MavenResolver

Resolve and download a maven based url

Specified by:

resolve in interface MavenResolver

Throws:

IOException

resolve

public File resolve(String url,
                    Exception previousException)
             throws IOException

Description copied from interface: MavenResolver

Resolve and download a maven based url - possibly as another attempt. Specifying previousException is a hint for resolver.

Specified by:

resolve in interface MavenResolver

Throws:

IOException

resolve

public File resolve(String groupId,
                    String artifactId,
                    String classifier,
                    String extension,
                    String version)
             throws IOException

Description copied from interface: MavenResolver

Resolve and download an artifact

Specified by:

resolve in interface MavenResolver

Throws:

IOException

resolve

public File resolve(String groupId,
                    String artifactId,
                    String classifier,
                    String extension,
                    String version,
                    Exception previousException)
             throws IOException

Description copied from interface: MavenResolver

Resolve and download an artifact - possibly as another attempt. Specifying previousException is a hint for resolver.

Specified by:

resolve in interface MavenResolver

Throws:

IOException

resolve

public File resolve(String groupId,
                    String artifactId,
                    String classifier,
                    String extension,
                    String version,
                    MavenRepositoryURL url,
                    Exception previousException)
             throws IOException

Resolve artifact, possibly checking extra (comparing to configured repositories) MavenRepositoryURL obtained from mvn: URI.

Parameters:

groupId -

artifactId -

classifier -

extension -

version -

url - additional Maven Repository URL to check

previousException -

Returns:

Throws:

IOException

resolve

public File resolve(org.eclipse.aether.artifact.Artifact artifact,
                    MavenRepositoryURL url,
                    Exception previousException)
             throws IOException

Main resolution method that resolves artifact using data from Artifact and repositories prepared from global configuration.

Parameters:

artifact -

url - extra URL for remote repository to check if the original mvn: URI included source repository

previousException -

Returns:

Throws:

IOException

resolve

public File resolve(List<AetherBasedResolver.LocalRepositoryWithConfig> defaultRepositories,
                    List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories,
                    org.eclipse.aether.artifact.Artifact artifact)
             throws IOException

Main resolution method that operates on passed default and remote repositories and doesn't determine the checked repositories on its own.

This is the main method that implements Pax URL resolution, which involves a set of default repositories and defaults to remote repository resolution if artifact is not found.

This method requires that RemoteRepository objects used are already processed (mirrors, proxies, auth).

Parameters:

defaultRepositories -

remoteRepositories -

artifact -

Returns:

Throws:

IOException

resolveMetadata

public File resolveMetadata(String groupId,
                            String artifactId,
                            String type,
                            String version)
                     throws IOException

Description copied from interface: MavenResolver

Resolve the maven metadata xml for the specified groupId:artifactId:version

Specified by:

resolveMetadata in interface MavenResolver

Throws:

IOException

resolveMetadata

public File resolveMetadata(String groupId,
                            String artifactId,
                            String type,
                            String version,
                            Exception previousException)
                     throws IOException

Description copied from interface: MavenResolver

Resolve the maven metadata xml for the specified groupId:artifactId:version - possibly as another attempt. Specifying previousException is a hint for resolver.

Specified by:

resolveMetadata in interface MavenResolver

Throws:

IOException

upload

public void upload(String groupId,
                   String artifactId,
                   String classifier,
                   String extension,
                   String version,
                   File file)
            throws IOException

Description copied from interface: MavenResolver

Install the specified artifact in the local repository

Specified by:

upload in interface MavenResolver

Throws:

IOException

uploadMetadata

public void uploadMetadata(String groupId,
                           String artifactId,
                           String type,
                           String version,
                           File artifact)
                    throws IOException

Description copied from interface: MavenResolver

Install the specified artifact metadata in the local repository

Specified by:

uploadMetadata in interface MavenResolver

Throws:

IOException

isRetryableException

public MavenResolver.RetryChance isRetryableException(Exception exception)

Description copied from interface: MavenResolver

Returns a hint about possible retry of operation that ended with exception

Specified by:

isRetryableException in interface MavenResolver

Returns:

findAetherException

protected org.eclipse.aether.RepositoryException findAetherException(Exception e)

Find top-most Aether exception

Parameters:

e -

Returns:

rootException

protected Throwable rootException(Exception ex)

Find root exception

Parameters:

ex -

Returns:

assignMirrorsAndProxies

public List<org.eclipse.aether.repository.RemoteRepository> assignMirrorsAndProxies(org.eclipse.aether.RepositorySystemSession session,
                                                                                    List<org.eclipse.aether.repository.RemoteRepository> repositories)

Pax URL 2.6 manually checked mirros, proxies and authentication configuration to replace list of target repositories with mirrored/proxied ones.

Here we'll use RepositorySystem.newResolutionRepositories(org.eclipse.aether.RepositorySystemSession, java.util.List<org.eclipse.aether.repository.RemoteRepository>). If passes session is null, a static session is used that satisfies requirements of underlying resolver mechanisms (like getting global update/checksum policies).

Parameters:

session -

repositories -

Returns: