org.jboss.shrinkwrap.resolver.impl.maven

Class MavenWorkingSessionImpl

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.MavenWorkingSessionImpl

All Implemented Interfaces:

MavenWorkingSession

public class MavenWorkingSessionImpl
extends Object
implements MavenWorkingSession

Implementation of a MavenWorkingSession, encapsulating Maven/Aether backend

Author:

Karel Piwko, Michal Matloka

Constructor Summary

Constructors

Constructor and Description
MavenWorkingSessionImpl()

Method Summary

Methods

Modifier and Type	Method and Description
MavenWorkingSession	configureSettingsFromFile(File globalSettings, File userSettings) Loads Maven configuration and updates session settings accordingly.
void	disableClassPathWorkspaceReader() Disables the classpath workspace reader which may be used to resolve from dependencies on the ClassPath
void	disableMavenCentral() Disables use of the Maven Central Repository
Set<MavenDependency>	getDeclaredDependencies() Metadata for all defined elements
List<MavenDependency>	getDependenciesForResolution() Gets the Set of dependencies to be resolved for this session
Set<MavenDependency>	getDependencyManagement() Gets a set af dependency declarations stored in version management.
ParsedPomFile	getParsedPomFile() Returns an abstraction of Project Object Model.
MavenWorkingSession	loadPomFromFile(File pomFile, String... profiles) Loads an effective POM file and updates session settings accordingly.
MavenWorkingSession	regenerateSession() Refreshes underlying Aether session in order to contain newly acquired information, such as new settings.xml content
Collection<MavenResolvedArtifact>	resolveDependencies(MavenResolutionStrategy strategy)
MavenVersionRangeResult	resolveVersionRange(MavenCoordinate coordinate) Resolves version range request for given coordinate
void	setOffline(boolean offline) Whether or not to set this session in "offline" mode

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenWorkingSessionImpl

public MavenWorkingSessionImpl()

Method Detail

getDependencyManagement

public Set<MavenDependency> getDependencyManagement()

Description copied from interface: MavenWorkingSession

Gets a set af dependency declarations stored in version management. These dependency declarations are used to get versions if none are specified in MavenDependency#getAddress() address and also affect transitive dependency resolutions.

Specified by:

getDependencyManagement in interface MavenWorkingSession

Returns:

Set of defined MavenDependencys

getDependenciesForResolution

public List<MavenDependency> getDependenciesForResolution()

Description copied from interface: MavenWorkingSession

Gets the Set of dependencies to be resolved for this session

Specified by:

getDependenciesForResolution in interface MavenWorkingSession

Returns:

MavenDependencys to be resolved as part of the request to the backend; may be a subset of MavenWorkingSession.getDeclaredDependencies() after pre-request filtering has been done

getDeclaredDependencies

public Set<MavenDependency> getDeclaredDependencies()

Metadata for all defined elements

Specified by:

getDeclaredDependencies in interface MavenWorkingSession

Returns:

See Also:

MavenWorkingSession.getDeclaredDependencies()

loadPomFromFile

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

Description copied from interface: MavenWorkingSession

Loads an effective POM file and updates session settings accordingly.

Specified by:

loadPomFromFile in interface MavenWorkingSession

Parameters:

pomFile - which represents Project Object Model file

profiles - List of profiles to activated/disabled

Returns:

Modified session instance

Throws:

InvalidConfigurationFileException

configureSettingsFromFile

public MavenWorkingSession configureSettingsFromFile(File globalSettings,
                                            File userSettings)
                                              throws InvalidConfigurationFileException

Description copied from interface: MavenWorkingSession

Loads Maven configuration and updates session settings accordingly.

Specified by:

configureSettingsFromFile in interface MavenWorkingSession

Parameters:

globalSettings - File which represents global settings file

userSettings - File which represents user settings file

Returns:

Modified session instance

Throws:

InvalidConfigurationFileException

resolveDependencies

public Collection<MavenResolvedArtifact> resolveDependencies(MavenResolutionStrategy strategy)
                                                      throws ResolutionException

Specified by:

resolveDependencies in interface MavenWorkingSession

Throws:

ResolutionException

resolveVersionRange

public MavenVersionRangeResult resolveVersionRange(MavenCoordinate coordinate)
                                            throws VersionResolutionException

Description copied from interface: MavenWorkingSession

Resolves version range request for given coordinate

Specified by:

resolveVersionRange in interface MavenWorkingSession

Returns:

Throws:

VersionResolutionException

getParsedPomFile

public ParsedPomFile getParsedPomFile()

Description copied from interface: MavenWorkingSession

Returns an abstraction of Project Object Model. This abstraction can be used to get additional information about the project

Specified by:

getParsedPomFile in interface MavenWorkingSession

Returns:

Information about the project

regenerateSession

public MavenWorkingSession regenerateSession()

Description copied from interface: MavenWorkingSession

Refreshes underlying Aether session in order to contain newly acquired information, such as new settings.xml content

Specified by:

regenerateSession in interface MavenWorkingSession

Returns:

Modified session instance

setOffline

public void setOffline(boolean offline)

Description copied from interface: MavenWorkingSession

Whether or not to set this session in "offline" mode

Specified by:

setOffline in interface MavenWorkingSession

disableClassPathWorkspaceReader

public void disableClassPathWorkspaceReader()

Disables the classpath workspace reader which may be used to resolve from dependencies on the ClassPath

Specified by:

disableClassPathWorkspaceReader in interface MavenWorkingSession

See Also:

MavenWorkingSession.disableClassPathWorkspaceReader()

disableMavenCentral

public void disableMavenCentral()

Disables use of the Maven Central Repository

Specified by:

disableMavenCentral in interface MavenWorkingSession

See Also:

MavenWorkingSession.disableMavenCentral()