org.jboss.shrinkwrap.resolver.impl.maven

Class ConfigurableMavenResolverSystemImpl

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.MavenResolverSystemBaseImpl<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURABLEBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

org.jboss.shrinkwrap.resolver.impl.maven.ConfigurableMavenResolverSystemBaseImpl<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage>

org.jboss.shrinkwrap.resolver.impl.maven.ConfigurableMavenResolverSystemImpl

All Implemented Interfaces:

ConfigurableResolverSystem<MavenResolverSystem,ConfigurableMavenResolverSystem>, ConfigurableMavenResolverSystem, ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>, MavenResolverSystemBase<PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage>, MavenResolveStageBase<PomlessResolveStage,MavenStrategyStage,MavenFormatStage>, PomlessResolveStageBase<PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage>, ResolverSystem, ResolveStage<MavenDependency,MavenResolutionFilter,PomlessResolveStage,MavenStrategyStage,MavenResolvedArtifact,MavenFormatStage,MavenResolutionStrategy>, ResolveWithRangeSupportStage<MavenDependency,MavenCoordinate,MavenResolutionFilter,PomlessResolveStage,MavenStrategyStage,MavenResolvedArtifact,MavenFormatStage,MavenResolutionStrategy,MavenVersionRangeResult>, MavenWorkingSessionContainer

public class ConfigurableMavenResolverSystemImpl
extends ConfigurableMavenResolverSystemBaseImpl<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage>
implements ConfigurableMavenResolverSystem, MavenWorkingSessionContainer

ConfigurableMavenResolverSystem implementation

Author:

Andrew Lee Rubinger

Constructor Summary

Constructors

Constructor and Description
ConfigurableMavenResolverSystemImpl() Creates a new instance with a new backing MavenWorkingSession

Method Summary

Modifier and Type	Method and Description
protected PomEquippedResolveStage	createPomEquippedResolveStage() Returns a new EQUIPPEDRESOLVESTAGETYPE for the current session
MavenWorkingSession	getMavenWorkingSession()
protected MavenResolverSystem	getUnconfigurableView() Returns the UNCONFIGURABLERESOLVERSYSTEMTYPE view type of this ConfigurableMavenResolverSystemBase
ConfigurableMavenResolverSystem	useLegacyLocalRepo(boolean useLegacyLocalRepository) Sets whether to consult artifact metadata in local repository and track origin of artifacts there; ignores origin of artifacts in local repository.
ConfigurableMavenResolverSystem	withClassPathResolution(boolean useClassPathResolution) Sets that resolution from the ClassPath should be permitted in addition to configured repositories - defaults to "true"
ConfigurableMavenResolverSystem	withMavenCentralRepo(boolean useMavenCentral) Sets whether to consult the Maven Central Repository in resolution; defaults to true.
ConfigurableMavenResolverSystem	withRemoteRepo(MavenRemoteRepository repository) Adds a remote repository to use in resolution.
ConfigurableMavenResolverSystem	withRemoteRepo(String name, String url, String layout) Adds a remote repository to use in resolution.
ConfigurableMavenResolverSystem	withRemoteRepo(String name, URL url, String layout) See ConfigurableMavenResolverSystemBase.withRemoteRepo(String, String, String)
ConfigurableMavenResolverSystem	workOffline() Sets whether to consult any remote Maven Repository in resolution; ignores all remote repositories.
ConfigurableMavenResolverSystem	workOffline(boolean workOffline) Sets whether to consult any remote Maven Repository in resolution; defaults to false.

Methods inherited from class org.jboss.shrinkwrap.resolver.impl.maven.ConfigurableMavenResolverSystemBaseImpl

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

Methods inherited from class org.jboss.shrinkwrap.resolver.impl.maven.MavenResolverSystemBaseImpl

addDependencies, addDependencies, addDependency, getSession, loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromFile, loadPomFromFile, loadPomFromFile, loadPomFromFile, offline, offline, resolve, resolve, resolve, resolve, resolveVersionRange

Methods inherited from class java.lang.Object

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

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

configureViaPlugin

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

Constructor Detail

ConfigurableMavenResolverSystemImpl

public ConfigurableMavenResolverSystemImpl()
                                    throws IllegalArgumentException

Creates a new instance with a new backing MavenWorkingSession

Throws:

IllegalArgumentException

Method Detail

withClassPathResolution

public ConfigurableMavenResolverSystem withClassPathResolution(boolean useClassPathResolution)

Description copied from interface: ConfigurableMavenResolverSystemBase

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

Specified by:

withClassPathResolution in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

Parameters:

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

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

withRemoteRepo

public ConfigurableMavenResolverSystem withRemoteRepo(String name,
                                                      String url,
                                                      String layout)

Description copied from interface: ConfigurableMavenResolverSystemBase

Adds a remote repository to use in resolution.

Specified by:

withRemoteRepo in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

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).

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

withRemoteRepo

public ConfigurableMavenResolverSystem withRemoteRepo(String name,
                                                      URL url,
                                                      String layout)

Description copied from interface: ConfigurableMavenResolverSystemBase

See ConfigurableMavenResolverSystemBase.withRemoteRepo(String, String, String)

Specified by:

withRemoteRepo in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

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).

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

withRemoteRepo

public ConfigurableMavenResolverSystem withRemoteRepo(MavenRemoteRepository repository)

Description copied from interface: ConfigurableMavenResolverSystemBase

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

Specified by:

withRemoteRepo in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

Parameters:

repository - The remote repository

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

withMavenCentralRepo

public ConfigurableMavenResolverSystem withMavenCentralRepo(boolean useMavenCentral)

Description copied from interface: ConfigurableMavenResolverSystemBase

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

Specified by:

withMavenCentralRepo in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

Parameters:

useMavenCentral - Whether to consult the Maven Central Repository in resolution; defaults to true.

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

workOffline

public ConfigurableMavenResolverSystem workOffline()

Description copied from interface: ConfigurableMavenResolverSystemBase

Sets whether to consult any remote Maven Repository in resolution; ignores all remote repositories.

Specified by:

workOffline in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

workOffline

public ConfigurableMavenResolverSystem workOffline(boolean workOffline)

Description copied from interface: ConfigurableMavenResolverSystemBase

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.

Specified by:

workOffline in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

Parameters:

workOffline - Whether to consult any remote Maven Repository in resolution; defaults to false.

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

useLegacyLocalRepo

public ConfigurableMavenResolverSystem useLegacyLocalRepo(boolean useLegacyLocalRepository)

Description copied from interface: ConfigurableMavenResolverSystemBase

Sets whether to consult artifact metadata in local repository and track origin of artifacts there; ignores origin of artifacts in local repository. Note that offline repository has the same behavior.

Specified by:

useLegacyLocalRepo in interface ConfigurableMavenResolverSystemBase<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage,ConfigurableMavenResolverSystem>

Parameters:

useLegacyLocalRepository - Whether to ignore origin of artifacts in local repository; defaults to false

Returns:

Modified instance of PARTIALLYCONFIGUREDRESOLVERSYSTEMTYPE

getMavenWorkingSession

public MavenWorkingSession getMavenWorkingSession()

Specified by:

getMavenWorkingSession in interface MavenWorkingSessionContainer

getUnconfigurableView

protected MavenResolverSystem getUnconfigurableView()

Returns the UNCONFIGURABLERESOLVERSYSTEMTYPE view type of this ConfigurableMavenResolverSystemBase (non-Javadoc)

Specified by:

getUnconfigurableView in class ConfigurableMavenResolverSystemBaseImpl<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage>

Returns:

The UNCONFIGURABLERESOLVERSYSTEMTYPE view type of this ConfigurableMavenResolverSystemBase

See Also:

ConfigurableMavenResolverSystemBaseImpl.getUnconfigurableView()

createPomEquippedResolveStage

protected PomEquippedResolveStage createPomEquippedResolveStage()

Returns a new EQUIPPEDRESOLVESTAGETYPE for the current session

Specified by:

createPomEquippedResolveStage in class ConfigurableMavenResolverSystemBaseImpl<MavenResolverSystem,ConfigurableMavenResolverSystem,PomEquippedResolveStage,PomlessResolveStage,MavenStrategyStage,MavenFormatStage>

Returns:

A new EQUIPPEDRESOLVESTAGETYPE for the current session

See Also:

ConfigurableMavenResolverSystemBaseImpl.createPomEquippedResolveStage()