org.jboss.shrinkwrap.resolver.impl.maven

Class ConfigurableMavenWorkingSessionImpl

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.ConfigurableMavenWorkingSessionImpl

All Implemented Interfaces:

MavenWorkingSession

Direct Known Subclasses:

MavenWorkingSessionImpl

public abstract class ConfigurableMavenWorkingSessionImpl
extends Object
implements MavenWorkingSession

Configurable implementation of a MavenWorkingSession, encapsulating Maven/Aether backend.

This is an abstract class and doesn't contain all the implementation - this class contains:

• methods for generating an instance of DefaultRepositorySystemSession when necessary
• methods for modification of properties related to the DefaultRepositorySystemSession
• methods related to the MavenWorkingSession that doesn't need to have created an instance of the DefaultRepositorySystemSession for its calling
• delegating methods related to Settings

Author:

Matous Jobanek, Karel Piwko, Michal Matloka

Constructor Summary

Constructors

Constructor and Description
ConfigurableMavenWorkingSessionImpl()

Method Summary

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
protected org.eclipse.aether.DefaultRepositorySystemSession	getSession() Returns an instance of the DefaultRepositorySystemSession that is generated if hasn't been yet.
protected org.apache.maven.settings.Settings	getSettings() Returns an instance of the Settings.
protected MavenRepositorySystem	getSystem() Returns an instance of the MavenRepositorySystem.
protected boolean	isOffline() Returns whether the resolver should work in offline mode or not
MavenWorkingSession	regenerateSession() Refreshes underlying Aether session in order to contain newly acquired information, such as new settings.xml content
void	setOffline(boolean offline) Whether or not to set this session in "offline" mode
void	useLegacyLocalRepository(boolean useLegacyLocalRepository) Whether or not to track origin of artifacts present is local repository

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

addRemoteRepo, disableMavenCentral, getDeclaredDependencies, getDependenciesForResolution, getDependencyManagement, getParsedPomFile, loadPomFromFile, resolveDependencies, resolveVersionRange

Constructor Detail

ConfigurableMavenWorkingSessionImpl

public ConfigurableMavenWorkingSessionImpl()

Method Detail

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

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

Parameters:

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

disableClassPathWorkspaceReader

public void disableClassPathWorkspaceReader()

Description copied from interface: MavenWorkingSession

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

Specified by:

disableClassPathWorkspaceReader in interface MavenWorkingSession

useLegacyLocalRepository

public void useLegacyLocalRepository(boolean useLegacyLocalRepository)

Description copied from interface: MavenWorkingSession

Whether or not to track origin of artifacts present is local repository

Specified by:

useLegacyLocalRepository in interface MavenWorkingSession

Parameters:

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

getSession

protected org.eclipse.aether.DefaultRepositorySystemSession getSession()

Returns an instance of the DefaultRepositorySystemSession that is generated if hasn't been yet.

Returns:

an instance of the DefaultRepositorySystemSession

getSettings

protected org.apache.maven.settings.Settings getSettings()

Returns an instance of the Settings.

Returns:

an instance of the Settings

See Also:

SettingsManager.getSettings()

isOffline

protected boolean isOffline()

Returns whether the resolver should work in offline mode or not

Returns:

whether the resolver should work in offline mode or not

See Also:

SettingsManager.isOffline()

getSystem

protected MavenRepositorySystem getSystem()

Returns an instance of the MavenRepositorySystem.

Returns:

an instance of the MavenRepositorySystem