org.jboss.shrinkwrap.resolver.impl.maven

Class MavenResolverSystemBaseImpl<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>

java.lang.Object

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

All Implemented Interfaces:

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>

Direct Known Subclasses:

ConfigurableMavenResolverSystemBaseImpl, MavenResolverSystemImpl

public abstract class MavenResolverSystemBaseImpl<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>
extends Object
implements MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

Support for implementations of MavenResolverSystem

Author:

Karel Piwko, Andrew Lee Rubinger, Michal Matloka

Constructor Summary

Constructors

Constructor and Description
MavenResolverSystemBaseImpl(UNEQUIPPEDRESOLVESTAGETYPE delegate) Creates a new instance using the specified delegate, which is required and must also implement the MavenWorkingSessionContainer SPI, else IllegalArgumentException will be thrown.

Method Summary

Modifier and Type	Method and Description
UNEQUIPPEDRESOLVESTAGETYPE	addDependencies(Collection<MavenDependency> dependencies) Adds the specified dependencies to be resolved
UNEQUIPPEDRESOLVESTAGETYPE	addDependencies(MavenDependency... coordinates) Adds the specified coordinates to be resolved
UNEQUIPPEDRESOLVESTAGETYPE	addDependency(MavenDependency coordinate) Adds the specified coordinate to be resolved
protected MavenWorkingSession	getSession() Returns the MavenWorkingSession associated with this MavenResolverSystem
EQUIPPEDRESOLVESTAGETYPE	loadPomFromClassLoaderResource(String pathToPomResource) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the current Thread.getContextClassLoader().
EQUIPPEDRESOLVESTAGETYPE	loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl, String... profiles) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(File pomFile) Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(File pomFile, String... profiles) Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(String pathToPomFile) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(String pathToPomFile, String... profiles) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path.
UNEQUIPPEDRESOLVESTAGETYPE	offline() Sets that resolution should be done in "offline" (ie.
UNEQUIPPEDRESOLVESTAGETYPE	offline(boolean offline) Sets whether resolution should be done in "offline" (ie.
STRATEGYSTAGETYPE	resolve() Begins resolution of the prior-defined dependencies, returning the next StrategyStage for the user to define the ResolutionStrategy
STRATEGYSTAGETYPE	resolve(Collection<String> canonicalForms) Begins resolution by defining a Collection of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
STRATEGYSTAGETYPE	resolve(String... coordinates) Begins resolution by defining a set of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
STRATEGYSTAGETYPE	resolve(String coordinate) Begins resolution by defining the single desired dependency (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
MavenVersionRangeResult	resolveVersionRange(String coordinate) Performs version range resolution of specified artifact defined in canonical form.

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenResolverSystemBaseImpl

public MavenResolverSystemBaseImpl(UNEQUIPPEDRESOLVESTAGETYPE delegate)
                            throws IllegalArgumentException

Creates a new instance using the specified delegate, which is required and must also implement the MavenWorkingSessionContainer SPI, else IllegalArgumentException will be thrown.

Parameters:

delegate - The delegate

Throws:

IllegalArgumentException - If the delegate is either null or doesn't implement the MavenWorkingSessionContainer

Method Detail

getSession

protected MavenWorkingSession getSession()

Returns the MavenWorkingSession associated with this MavenResolverSystem

Returns:

The MavenWorkingSession associated with this MavenResolverSystem

resolve

public STRATEGYSTAGETYPE resolve()
                          throws IllegalStateException,
                                 ResolutionException

Begins resolution of the prior-defined dependencies, returning the next StrategyStage for the user to define the ResolutionStrategy

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalStateException - If no dependencies have yet been added

ResolutionException - If an error occurred in resolution

See Also:

ResolveStage.resolve()

loadPomFromFile

public EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(File pomFile)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pomFile - The File representing a POM file

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

IllegalArgumentException - If no file was specified, if the file does not exist or points to a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

See Also:

PomlessResolveStageBase.loadPomFromFile(java.io.File)

resolve

public STRATEGYSTAGETYPE resolve(String coordinate)
                          throws IllegalArgumentException,
                                 ResolutionException

Begins resolution by defining the single desired dependency (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

coordinate - The canonical form of the single desired dependency.

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalArgumentException - If no coordinate is supplied

ResolutionException - If an error occurred in resolution

See Also:

ResolveStage.resolve(java.lang.String)

loadPomFromFile

public EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(File pomFile,
                                                String... profiles)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pomFile - The File representing a POM file

profiles - List of profiles to activated/disabled Active/inactive profiles

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

IllegalArgumentException - If no file was specified, if the file does not exist or points to a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

See Also:

PomlessResolveStageBase.loadPomFromFile(java.io.File, java.lang.String[])

resolve

public STRATEGYSTAGETYPE resolve(String... coordinates)
                          throws IllegalArgumentException,
                                 ResolutionException

Begins resolution by defining a set of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

coordinates - The canonical forms of the set of desired dependencies.

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalArgumentException - If no coordinates are supplied

ResolutionException - If an error occurred in resolution

See Also:

ResolveStage.resolve(java.lang.String[])

resolveVersionRange

public MavenVersionRangeResult resolveVersionRange(String coordinate)
                                            throws IllegalArgumentException

Performs version range resolution of specified artifact defined in canonical form. Returns info about available versions.

Specified by:

resolveVersionRange in interface ResolveWithRangeSupportStage<MavenDependency,MavenCoordinate,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy,MavenVersionRangeResult>

Parameters:

coordinate - coordinate in canonical form containing version range: Maven doc}

Returns:

A info about available versions.StrategyStage

Throws:

IllegalArgumentException - If no coordinate is supplied

See Also:

ResolveWithRangeSupportStage.resolveVersionRange(String)

loadPomFromFile

public EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(String pathToPomFile)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path. The path will be represented as a new File by means of File(String)

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomFile - The path to a POM file

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

IllegalArgumentException - If no path was specified, or if the path points to a file which does not exist or is a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

See Also:

PomlessResolveStageBase.loadPomFromFile(java.lang.String)

loadPomFromFile

public EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(String pathToPomFile,
                                                String... profiles)
                                         throws IllegalArgumentException,
                                                InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path. The path will be represented as a new File by means of File(String)

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomFile - The path to a POM file

profiles - List of profiles to activated/disabled Active/inactive profiles

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

IllegalArgumentException - If no path was specified, or if the path points to a file which does not exist or is a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

See Also:

PomlessResolveStageBase.loadPomFromFile(java.lang.String, java.lang.String[])

addDependency

public UNEQUIPPEDRESOLVESTAGETYPE addDependency(MavenDependency coordinate)
                                         throws IllegalArgumentException

Adds the specified coordinate to be resolved

Specified by:

addDependency in interface ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

coordinate - The coordinate to be resolved.

Returns:

Modified instance of the ResolveStage with added coordinate.

Throws:

IllegalArgumentException - If no dependency is supplied

See Also:

ResolveStage.addDependency(org.jboss.shrinkwrap.resolver.api.Coordinate)

loadPomFromClassLoaderResource

public EQUIPPEDRESOLVESTAGETYPE loadPomFromClassLoaderResource(String pathToPomResource)
                                                        throws IllegalArgumentException,
                                                               InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the current Thread.getContextClassLoader().

Specified by:

loadPomFromClassLoaderResource in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomResource - The ClassLoader resource path to a POM file.

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

IllegalArgumentException - If no path was specified, or if the resource could not be found at the specified path

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

See Also:

PomlessResolveStageBase.loadPomFromClassLoaderResource(java.lang.String)

addDependencies

public UNEQUIPPEDRESOLVESTAGETYPE addDependencies(MavenDependency... coordinates)
                                           throws IllegalArgumentException

Adds the specified coordinates to be resolved

Specified by:

addDependencies in interface ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

coordinates - The set of coordinates to be resolved.

Returns:

Modified instance of the ResolveStage with added coordinates.

Throws:

IllegalArgumentException - If no dependencies are supplied

See Also:

ResolveStage.addDependencies(Coordinate[])

loadPomFromClassLoaderResource

public EQUIPPEDRESOLVESTAGETYPE loadPomFromClassLoaderResource(String pathToPomResource,
                                                               ClassLoader cl)
                                                        throws IllegalArgumentException,
                                                               InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.

Specified by:

loadPomFromClassLoaderResource in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomResource - The ClassLoader resource path to a POM file.

cl - The ClassLoader

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

IllegalArgumentException - If no path was specified, no ClassLoader was specified, or if the resource could not be found at the specified path

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

See Also:

PomlessResolveStageBase.loadPomFromClassLoaderResource(java.lang.String, java.lang.ClassLoader)

loadPomFromClassLoaderResource

public EQUIPPEDRESOLVESTAGETYPE loadPomFromClassLoaderResource(String pathToPomResource,
                                                               ClassLoader cl,
                                                               String... profiles)
                                                        throws IllegalArgumentException,
                                                               InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.

Specified by:

loadPomFromClassLoaderResource in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomResource - The ClassLoader resource path to a POM file.

cl - The ClassLoader

profiles - List of profiles to activated/disabled Active/inactive profiles

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

IllegalArgumentException - If no path was specified, no ClassLoader was specified, any specified profiles are invalid or null, or if the resource could not be found at the specified path

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

See Also:

PomlessResolveStageBase.loadPomFromClassLoaderResource(java.lang.String, java.lang.ClassLoader, java.lang.String[])

resolve

public STRATEGYSTAGETYPE resolve(Collection<String> canonicalForms)
                          throws IllegalArgumentException,
                                 ResolutionException,
                                 CoordinateParseException

Begins resolution by defining a Collection of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

canonicalForms - A Collection of the canonical forms a of the desired dependencies.

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalArgumentException - If no coordinates are supplied

ResolutionException - If an error occurred in resolution

CoordinateParseException - If one or more of the specified canonical forms is invalid

See Also:

ResolveStage.resolve(java.util.Collection)

addDependencies

public UNEQUIPPEDRESOLVESTAGETYPE addDependencies(Collection<MavenDependency> dependencies)
                                           throws IllegalArgumentException

Adds the specified dependencies to be resolved

Specified by:

addDependencies in interface ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

dependencies - A collection of coordinates to be resolved.

Returns:

Modified instance of the ResolveStage with added coordinates.

Throws:

IllegalArgumentException - If the Collection is null

See Also:

ResolveStage.addDependencies(java.util.Collection)

offline

public UNEQUIPPEDRESOLVESTAGETYPE offline(boolean offline)

Sets whether resolution should be done in "offline" (ie. not connected to Internet) mode. Make sure that you call this method before loading POM file. Also, loading settings.xml might change this flag. This method is deprecated. Please use ConfigurableMavenResolverSystemBase.workOffline() by calling Maven.configureResolver().workOffline(boolean) instead which does not have similar issues - offline flag is set before settings.xml and POM are loaded and it is able to persist different flag value in settings.xml

Specified by:

offline in interface MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

offline - Whether resolution should be done in "offline" (ie. not connected to Internet) mode.

Returns:

Modified instance of UNEQUIPPEDRESOLVESTAGETYPE

See Also:

offline(boolean)

offline

public UNEQUIPPEDRESOLVESTAGETYPE offline()

Sets that resolution should be done in "offline" (ie. not connected to Internet) mode. Alias to MavenResolverSystemBase.offline(boolean), passing true as a parameter. Make sure that you call this method before loading POM file. Also, loading settings.xml might change this flag. This method is deprecated. Please use ConfigurableMavenResolverSystemBase.workOffline() by calling Maven.configureResolver().workOffline() instead which does not have similar issues - offline flag is set before settings.xml and POM are loaded and it is able to persist different flag value in settings.xml

Specified by:

offline in interface MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Returns:

Modified instance of UNEQUIPPEDRESOLVESTAGETYPE

See Also:

offline()