io.quarkus.bootstrap.resolver

Class BootstrapAppModelResolver

java.lang.Object

io.quarkus.bootstrap.resolver.BootstrapAppModelResolver

All Implemented Interfaces:

AppModelResolver

public class BootstrapAppModelResolver
extends Object
implements AppModelResolver

Author:

Alexey Loubyansky

Field Summary

Fields

Modifier and Type	Field and Description
protected Consumer<String>	buildTreeConsumer
protected boolean	devmode
protected MavenArtifactResolver	mvn

Constructor Summary

Constructors

Constructor and Description
BootstrapAppModelResolver(MavenArtifactResolver mvn)

Method Summary

Modifier and Type	Method and Description
void	addRemoteRepositories(List<org.eclipse.aether.repository.RemoteRepository> repos)
String	getLatestVersion(AppArtifact appArtifact, String upToVersion, boolean inclusive) Returns the latest version for the artifact up to the version specified.
String	getLatestVersionFromRange(AppArtifact appArtifact, String range) Resolves the latest version from the specified range.
String	getNextVersion(AppArtifact appArtifact, String fromVersion, boolean fromVersionIncluded, String upToVersion, boolean upToVersionInclusive) Returns the next version of the artifact from the specified range.
void	install(AppArtifact appArtifact, Path localPath)
List<String>	listLaterVersions(AppArtifact appArtifact, String upToVersion, boolean inclusive) Lists versions released later than the version of the artifact up to the version specified or all the later versions in case the up-to-version is not provided.
void	relink(AppArtifact artifact, Path path) (Re-)links an artifact to a path.
Path	resolve(AppArtifact artifact) Resolves an artifact.
List<org.eclipse.aether.repository.RemoteRepository>	resolveArtifactRepos(AppArtifact appArtifact)
AppModel	resolveManagedModel(AppArtifact appArtifact, List<AppDependency> directDeps, AppArtifact managingProject)
AppModel	resolveModel(AppArtifact appArtifact) Resolve dependencies that are required at runtime, excluding test and optional dependencies.
AppModel	resolveModel(AppArtifact appArtifact, List<AppDependency> directDeps) Resolve artifact dependencies given the specific versions of the direct dependencies
List<AppDependency>	resolveUserDependencies(AppArtifact appArtifact, List<AppDependency> deps) Resolve application direct and transitive dependencies configured by the user, given the specific versions of the direct dependencies.
void	setBuildTreeLogger(Consumer<String> buildTreeConsumer)
BootstrapAppModelResolver	setDevMode(boolean devmode) Indicates whether application should be resolved to set up the dev mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.bootstrap.resolver.AppModelResolver

resolveUserDependencies

Field Detail

mvn

protected final MavenArtifactResolver mvn

buildTreeConsumer

protected Consumer<String> buildTreeConsumer

devmode

protected boolean devmode

Constructor Detail

BootstrapAppModelResolver

public BootstrapAppModelResolver(MavenArtifactResolver mvn)

Method Detail

setBuildTreeLogger

public void setBuildTreeLogger(Consumer<String> buildTreeConsumer)

setDevMode

public BootstrapAppModelResolver setDevMode(boolean devmode)

Indicates whether application should be resolved to set up the dev mode. The important difference between the dev mode and the usual build is that in the dev mode the user application will have to be compiled, so the classpath will have to include dependencies of scope provided.

Parameters:

devmode - whether the resolver is going to be used to set up the dev mode

addRemoteRepositories

public void addRemoteRepositories(List<org.eclipse.aether.repository.RemoteRepository> repos)

relink

public void relink(AppArtifact artifact,
                   Path path)
            throws AppModelResolverException

Description copied from interface: AppModelResolver

(Re-)links an artifact to a path.

Specified by:

relink in interface AppModelResolver

Parameters:

artifact - an artifact to (re-)link to the path

path - local path to the artifact

Throws:

AppModelResolverException - in case of a failure

resolve

public Path resolve(AppArtifact artifact)
             throws AppModelResolverException

Description copied from interface: AppModelResolver

Resolves an artifact.

Specified by:

resolve in interface AppModelResolver

Parameters:

artifact - artifact to resolve

Returns:

local path

Throws:

AppModelResolverException - in case of a failure

resolveUserDependencies

public List<AppDependency> resolveUserDependencies(AppArtifact appArtifact,
                                                   List<AppDependency> deps)
                                            throws AppModelResolverException

Description copied from interface: AppModelResolver

Resolve application direct and transitive dependencies configured by the user, given the specific versions of the direct dependencies. Note that deployment dependencies are not included in the result.

Specified by:

resolveUserDependencies in interface AppModelResolver

Parameters:

appArtifact - application artifact

deps - some or all of the direct dependencies that should be used in place of the original ones

Returns:

the list of dependencies configured by the user

Throws:

AppModelResolverException - in case of a failure

resolveModel

public AppModel resolveModel(AppArtifact appArtifact)
                      throws AppModelResolverException

Description copied from interface: AppModelResolver

Resolve dependencies that are required at runtime, excluding test and optional dependencies.

Specified by:

resolveModel in interface AppModelResolver

Returns:

Throws:

AppModelResolverException

resolveModel

public AppModel resolveModel(AppArtifact appArtifact,
                             List<AppDependency> directDeps)
                      throws AppModelResolverException

Description copied from interface: AppModelResolver

Resolve artifact dependencies given the specific versions of the direct dependencies

Specified by:

resolveModel in interface AppModelResolver

Parameters:

appArtifact - root artifact

directDeps - some or all of the direct dependencies that should be used in place of the original ones

Returns:

collected dependencies

Throws:

AppModelResolverException - in case of a failure

resolveManagedModel

public AppModel resolveManagedModel(AppArtifact appArtifact,
                                    List<AppDependency> directDeps,
                                    AppArtifact managingProject)
                             throws AppModelResolverException

Throws:

AppModelResolverException

listLaterVersions

public List<String> listLaterVersions(AppArtifact appArtifact,
                                      String upToVersion,
                                      boolean inclusive)
                               throws AppModelResolverException

Description copied from interface: AppModelResolver

Lists versions released later than the version of the artifact up to the version specified or all the later versions in case the up-to-version is not provided.

Specified by:

listLaterVersions in interface AppModelResolver

Parameters:

appArtifact - artifact to list the versions for

Returns:

the list of versions released later than the version of the artifact

Throws:

AppModelResolverException - in case of a failure

getNextVersion

public String getNextVersion(AppArtifact appArtifact,
                             String fromVersion,
                             boolean fromVersionIncluded,
                             String upToVersion,
                             boolean upToVersionInclusive)
                      throws AppModelResolverException

Description copied from interface: AppModelResolver

Returns the next version of the artifact from the specified range. In case the next version is not available, the method returns null.

Specified by:

getNextVersion in interface AppModelResolver

Parameters:

appArtifact - artifact

fromVersion - the lowest version of the range

fromVersionIncluded - whether the specified lowest version should be included in the range

upToVersion - the highest version of the range

upToVersionInclusive - whether the specified highest version should be included in the range

Returns:

the next version from the specified range or null if the next version is not available

Throws:

AppModelResolverException - in case of a failure

getLatestVersion

public String getLatestVersion(AppArtifact appArtifact,
                               String upToVersion,
                               boolean inclusive)
                        throws AppModelResolverException

Description copied from interface: AppModelResolver

Returns the latest version for the artifact up to the version specified. In case there is no later version available, the artifact's version is returned.

Specified by:

getLatestVersion in interface AppModelResolver

Parameters:

appArtifact - artifact

upToVersion - max version boundary

inclusive - whether the upToVersion should be included in the range or not

Returns:

the latest version up to specified boundary

Throws:

AppModelResolverException - in case of a failure

getLatestVersionFromRange

public String getLatestVersionFromRange(AppArtifact appArtifact,
                                        String range)
                                 throws AppModelResolverException

Description copied from interface: AppModelResolver

Resolves the latest version from the specified range. The version of the artifact is ignored.

Specified by:

getLatestVersionFromRange in interface AppModelResolver

Parameters:

appArtifact - the artifact

range - the version range

Returns:

the latest version of the artifact from the range or null, if no version was found for the specified range

Throws:

AppModelResolverException - in case of a failure

resolveArtifactRepos

public List<org.eclipse.aether.repository.RemoteRepository> resolveArtifactRepos(AppArtifact appArtifact)
                                                                          throws AppModelResolverException

Throws:

AppModelResolverException

install

public void install(AppArtifact appArtifact,
                    Path localPath)
             throws AppModelResolverException

Throws:

AppModelResolverException