org.jboss.shrinkwrap.resolver.api.maven

Interface ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,CONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage,PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE extends ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURABLERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE,PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE>>

All Superinterfaces:

ConfigurableResolverSystem<UNCONFIGURABLERESOLVERSYSTEMTYPE,PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE>, MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, MavenResolveStageBase<UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, ResolverSystem, ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy>, ResolveWithRangeSupportStage<MavenDependency,MavenCoordinate,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy,MavenVersionRangeResult>

All Known Subinterfaces:

ConfigurableMavenResolverSystem

public interface ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,CONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage,PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE extends ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURABLERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE,PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE>>
extends ConfigurableResolverSystem<UNCONFIGURABLERESOLVERSYSTEMTYPE,PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE>, MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

Entry point of a Maven-based Resolver system which supports configuration. To create a new instance, pass in this class reference to Resolvers.use(Class) or Resolvers.use(Class, ClassLoader), or instead call upon Maven.configureResolver()

Author:

Andrew Lee Rubinger, Karel Piwko

Method Summary

Methods

Modifier and Type	Method and Description
EQUIPPEDRESOLVESTAGETYPE	configureViaPlugin() Configures the current session from POM metadata found via the ShrinkWrap Resolver Maven Plugin; retrieves information from the currently-running Maven process.
PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE	withClassPathResolution(boolean useClassPathResolution) Sets that resolution from the ClassPath should be permitted in addition to configured repositories - defaults to "true"
PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE	withMavenCentralRepo(boolean useMavenCentral) Sets whether to consult the Maven Central Repository in resolution; defaults to true.
PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE	withRemoteRepo(MavenRemoteRepository repository) Adds a remote repository to use in resolution.
PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE	withRemoteRepo(String name, String url, String layout) Adds a remote repository to use in resolution.
PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE	withRemoteRepo(String name, URL url, String layout) See withRemoteRepo(String, String, String)
PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE	workOffline() Sets whether to consult any remote Maven Repository in resolution; defaults to false.
PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE	workOffline(boolean workOffline) Sets whether to consult any remote Maven Repository in resolution; defaults to false.

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.ConfigurableResolverSystem

configureFromClassloaderResource, configureFromClassloaderResource, configureFromFile, configureFromFile, fromClassloaderResource, fromClassloaderResource, fromFile, fromFile

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.maven.MavenResolverSystemBase

offline, offline

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase

loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromFile, loadPomFromFile, loadPomFromFile, loadPomFromFile

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.ResolveWithRangeSupportStage

resolveVersionRange

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.ResolveStage

addDependencies, addDependencies, addDependency, resolve, resolve, resolve, resolve

Method Detail

configureViaPlugin

EQUIPPEDRESOLVESTAGETYPE configureViaPlugin()
                                                                                                                                            throws InvalidEnvironmentException

Configures the current session from POM metadata found via the ShrinkWrap Resolver Maven Plugin; retrieves information from the currently-running Maven process.

Returns:

Throws:

InvalidEnvironmentException - If the currently-executing environment is not under the control of the ShrinkWrap Resolver Maven Plugin

withClassPathResolution

PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE withClassPathResolution(boolean useClassPathResolution)

Sets that resolution from the ClassPath should be permitted in addition to configured repositories - defaults to "true"

Parameters:

useClassPathResolution -

Returns:

withRemoteRepo

PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE withRemoteRepo(String name,
                                                   String url,
                                                   String layout)

Adds a remote repository to use in resolution.

Parameters:

name - a unique arbitrary ID such as "codehaus"

url - the repository URL, such as "http://snapshots.maven.codehaus.org/maven2"

layout - the repository layout. Should always be "default" (may be reused one day by Maven with other values).

Throws:

IllegalArgumentException - if name or layout are null or if layout is not "default", or if no url protocol is specified, or an unknown url protocol is found, or url is null

withRemoteRepo

PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE withRemoteRepo(String name,
                                                   URL url,
                                                   String layout)

See withRemoteRepo(String, String, String)

withRemoteRepo

PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE withRemoteRepo(MavenRemoteRepository repository)

Adds a remote repository to use in resolution. This repository should be built with MavenRemoteRepositories#createRemoteRepository(String, String)

withMavenCentralRepo

PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE withMavenCentralRepo(boolean useMavenCentral)

Sets whether to consult the Maven Central Repository in resolution; defaults to true.

Parameters:

useMavenCentral -

Returns:

workOffline

PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE workOffline(boolean workOffline)

Sets whether to consult any remote Maven Repository in resolution; defaults to false. This method is able to override value defined in settings.xml if loaded later.

Returns:

workOffline

PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE workOffline()

Sets whether to consult any remote Maven Repository in resolution; defaults to false. This method is able to override value defined in settings.xml if loaded later.

Returns: