Package org.eclipse.aether

Class DefaultRepositorySystemSession

java.lang.Object

org.eclipse.aether.DefaultRepositorySystemSession

All Implemented Interfaces:

RepositorySystemSession

public final class DefaultRepositorySystemSession
extends java.lang.Object
implements RepositorySystemSession

A legacy repository system session. It is usable to "derive" sessions from existing session instances (using copy-constructor), but the recommended way to derive sessions is using RepositorySystemSession.SessionBuilder.withRepositorySystemSession(RepositorySystemSession) instead.

Important: while the default constructor on this class is deprecated only, it is left only to guarantee backward compatibility with legacy code, but the default constructor should not be used anymore. Using that constructor will lead to resource leaks.

Note: This class is not thread-safe. It is assumed that the mutators get only called during an initialization phase and that the session itself is not changed once initialized and being used by the repository system. It is recommended to call setReadOnly() once the session has been fully initialized to prevent accidental manipulation of it afterward.

See Also:

RepositorySystem.createSessionBuilder(), RepositorySystemSession.SessionBuilder, RepositorySystemSession.CloseableSession

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.aether.RepositorySystemSession

RepositorySystemSession.CloseableSession, RepositorySystemSession.SessionBuilder

Constructor Summary

Constructors

Constructor	Description
DefaultRepositorySystemSession()	Deprecated. This way of creating session should be avoided, is in place just to offer backward binary compatibility with Resolver 1.x using code, but offers reduced functionality.
DefaultRepositorySystemSession(java.util.function.Function<java.lang.Runnable,java.lang.Boolean> onSessionEndedRegistrar)	Creates an uninitialized session.
DefaultRepositorySystemSession(RepositorySystemSession session)	Creates a shallow copy of the specified session.

Method Summary

Modifier and Type	Method	Description
boolean	addOnSessionEndedHandler(java.lang.Runnable handler)	Registers onSessionEnded handler, if able to.
ArtifactDescriptorPolicy	getArtifactDescriptorPolicy()	Gets the policy which controls how errors related to reading artifact descriptors should be handled.
ArtifactTypeRegistry	getArtifactTypeRegistry()	Gets the registry of artifact types recognized by this session, for instance when processing artifact descriptors.
java.lang.String	getArtifactUpdatePolicy()	Gets the global artifact update policy.
AuthenticationSelector	getAuthenticationSelector()	Gets the authentication selector to use for repositories discovered in artifact descriptors.
RepositoryCache	getCache()	Gets the cache the repository system may use to save data for future reuse during the session.
java.lang.String	getChecksumPolicy()	Gets the global checksum policy.
java.util.Map<java.lang.String,java.lang.Object>	getConfigProperties()	Gets the configuration properties used to tweak internal aspects of the repository system (e.g.
SessionData	getData()	Gets the custom data associated with this session.
DependencyCollectionChecker	getDependencyCollectionChecker()	Returns the dependency collector checker, may be null.
DependencyGraphTransformer	getDependencyGraphTransformer()	Gets the dependency graph transformer to use for building dependency graphs.
DependencyManager	getDependencyManager()	Gets the dependency manager to use for building dependency graphs.
DependencySelector	getDependencySelector()	Gets the dependency selector to use for building dependency graphs.
DependencyTraverser	getDependencyTraverser()	Gets the dependency traverser to use for building dependency graphs.
LocalRepository	getLocalRepository()	Gets the local repository used during this session.
LocalRepositoryManager	getLocalRepositoryManager()	Gets the local repository manager used during this session.
java.lang.String	getMetadataUpdatePolicy()	Gets the global metadata update policy.
MirrorSelector	getMirrorSelector()	Gets the mirror selector to use for repositories discovered in artifact descriptors.
ProxySelector	getProxySelector()	Gets the proxy selector to use for repositories discovered in artifact descriptors.
RepositoryListener	getRepositoryListener()	Gets the listener being notified of actions in the repository system.
ResolutionErrorPolicy	getResolutionErrorPolicy()	Gets the policy which controls whether resolutions errors from remote repositories should be cached.
ScopeManager	getScopeManager()	Returns the scope manager to be used in this session, may be null if not set.
SystemDependencyScope	getSystemDependencyScope()	Returns the system dependency scope.
java.util.Map<java.lang.String,java.lang.String>	getSystemProperties()	Gets the system properties to use, e.g.
TransferListener	getTransferListener()	Gets the listener being notified of uploads/downloads by the repository system.
java.lang.String	getUpdatePolicy()	Gets the global update policy, or null if not set.
java.util.Map<java.lang.String,java.lang.String>	getUserProperties()	Gets the user properties to use, e.g.
VersionFilter	getVersionFilter()	Gets the version filter to use for building dependency graphs.
WorkspaceReader	getWorkspaceReader()	Gets the workspace reader used during this session.
boolean	isIgnoreArtifactDescriptorRepositories()	Indicates whether repositories declared in artifact descriptors should be ignored during transitive dependency collection.
boolean	isOffline()	Indicates whether the repository system operates in offline mode and avoids/refuses any access to remote repositories.
DefaultRepositorySystemSession	setArtifactDescriptorPolicy(ArtifactDescriptorPolicy artifactDescriptorPolicy)	Sets the policy which controls how errors related to reading artifact descriptors should be handled.
DefaultRepositorySystemSession	setArtifactTypeRegistry(ArtifactTypeRegistry artifactTypeRegistry)	Sets the registry of artifact types recognized by this session.
DefaultRepositorySystemSession	setArtifactUpdatePolicy(java.lang.String artifactUpdatePolicy)	Sets the global artifact update policy.
DefaultRepositorySystemSession	setAuthenticationSelector(AuthenticationSelector authenticationSelector)	Sets the authentication selector to use for repositories discovered in artifact descriptors.
DefaultRepositorySystemSession	setCache(RepositoryCache cache)	Sets the cache the repository system may use to save data for future reuse during the session.
DefaultRepositorySystemSession	setChecksumPolicy(java.lang.String checksumPolicy)	Sets the global checksum policy.
DefaultRepositorySystemSession	setConfigProperties(java.util.Map<?,?> configProperties)	Sets the configuration properties used to tweak internal aspects of the repository system (e.g.
DefaultRepositorySystemSession	setConfigProperty(java.lang.String key, java.lang.Object value)	Sets the specified configuration property.
DefaultRepositorySystemSession	setData(SessionData data)	Sets the custom data associated with this session.
DefaultRepositorySystemSession	setDependencyCollectionChecker(DependencyCollectionChecker dependencyCollectionChecker)	Sets the dependency collection checker, may be null.
DefaultRepositorySystemSession	setDependencyGraphTransformer(DependencyGraphTransformer dependencyGraphTransformer)	Sets the dependency graph transformer to use for building dependency graphs.
DefaultRepositorySystemSession	setDependencyManager(DependencyManager dependencyManager)	Sets the dependency manager to use for building dependency graphs.
DefaultRepositorySystemSession	setDependencySelector(DependencySelector dependencySelector)	Sets the dependency selector to use for building dependency graphs.
DefaultRepositorySystemSession	setDependencyTraverser(DependencyTraverser dependencyTraverser)	Sets the dependency traverser to use for building dependency graphs.
DefaultRepositorySystemSession	setIgnoreArtifactDescriptorRepositories(boolean ignoreArtifactDescriptorRepositories)	Controls whether repositories declared in artifact descriptors should be ignored during transitive dependency collection.
DefaultRepositorySystemSession	setLocalRepositoryManager(LocalRepositoryManager localRepositoryManager)	Sets the local repository manager used during this session.
DefaultRepositorySystemSession	setMetadataUpdatePolicy(java.lang.String metadataUpdatePolicy)	Sets the global metadata update policy.
DefaultRepositorySystemSession	setMirrorSelector(MirrorSelector mirrorSelector)	Sets the mirror selector to use for repositories discovered in artifact descriptors.
DefaultRepositorySystemSession	setOffline(boolean offline)	Controls whether the repository system operates in offline mode and avoids/refuses any access to remote repositories.
DefaultRepositorySystemSession	setProxySelector(ProxySelector proxySelector)	Sets the proxy selector to use for repositories discovered in artifact descriptors.
void	setReadOnly()	Marks this session as read-only such that any future attempts to call its mutators will fail with an exception.
DefaultRepositorySystemSession	setRepositoryListener(RepositoryListener repositoryListener)	Sets the listener being notified of actions in the repository system.
DefaultRepositorySystemSession	setResolutionErrorPolicy(ResolutionErrorPolicy resolutionErrorPolicy)	Sets the policy which controls whether resolutions errors from remote repositories should be cached.
DefaultRepositorySystemSession	setScopeManager(ScopeManager scopeManager)	Sets the scope manager, may be null.
DefaultRepositorySystemSession	setSystemProperties(java.util.Map<?,?> systemProperties)	Sets the system properties to use, e.g.
DefaultRepositorySystemSession	setSystemProperty(java.lang.String key, java.lang.String value)	Sets the specified system property.
DefaultRepositorySystemSession	setTransferListener(TransferListener transferListener)	Sets the listener being notified of uploads/downloads by the repository system.
DefaultRepositorySystemSession	setUpdatePolicy(java.lang.String updatePolicy)	Sets the global update policy.
DefaultRepositorySystemSession	setUserProperties(java.util.Map<?,?> userProperties)	Sets the user properties to use, e.g.
DefaultRepositorySystemSession	setUserProperty(java.lang.String key, java.lang.String value)	Sets the specified user property.
DefaultRepositorySystemSession	setVersionFilter(VersionFilter versionFilter)	Sets the version filter to use for building dependency graphs.
DefaultRepositorySystemSession	setWorkspaceReader(WorkspaceReader workspaceReader)	Sets the workspace reader used during this session.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRepositorySystemSession

@Deprecated
public DefaultRepositorySystemSession()

Deprecated.

This way of creating session should be avoided, is in place just to offer backward binary compatibility with Resolver 1.x using code, but offers reduced functionality. Use RepositorySystem.createSessionBuilder() instead.

Creates an uninitialized session. Note: The new session is not ready to use, as a bare minimum, setLocalRepositoryManager(LocalRepositoryManager) needs to be called but usually other settings also need to be customized to achieve meaningful behavior.

DefaultRepositorySystemSession

public DefaultRepositorySystemSession(java.util.function.Function<java.lang.Runnable,java.lang.Boolean> onSessionEndedRegistrar)

Creates an uninitialized session. Note: The new session is not ready to use, as a bare minimum, setLocalRepositoryManager(LocalRepositoryManager) needs to be called but usually other settings also need to be customized to achieve meaningful behavior.

Note: preferred way to create sessions is RepositorySystem.createSessionBuilder(), as then client code does not have to fiddle with session close callbacks. This constructor is meant more for testing purposes.

Since:

2.0.0

DefaultRepositorySystemSession

public DefaultRepositorySystemSession(RepositorySystemSession session)

Creates a shallow copy of the specified session. Actually, the copy is not completely shallow, all maps holding system/user/config properties are copied as well. In other words, invoking any mutator on the new session itself has no effect on the original session. Other mutable objects like the session data and cache (if any) are not copied and will be shared with the original session unless reconfigured.

Parameters:

session - The session to copy, must not be null.

Method Detail

isOffline

public boolean isOffline()

Description copied from interface: RepositorySystemSession

Indicates whether the repository system operates in offline mode and avoids/refuses any access to remote repositories.

Specified by:

isOffline in interface RepositorySystemSession

Returns:

true if the repository system is in offline mode, false otherwise.

setOffline

public DefaultRepositorySystemSession setOffline(boolean offline)

Controls whether the repository system operates in offline mode and avoids/refuses any access to remote repositories.

Parameters:

offline - true if the repository system is in offline mode, false otherwise.

Returns:

This session for chaining, never null.

isIgnoreArtifactDescriptorRepositories

public boolean isIgnoreArtifactDescriptorRepositories()

Description copied from interface: RepositorySystemSession

Indicates whether repositories declared in artifact descriptors should be ignored during transitive dependency collection. If enabled, only the repositories originally provided with the collect request will be considered.

Specified by:

isIgnoreArtifactDescriptorRepositories in interface RepositorySystemSession

Returns:

true if additional repositories from artifact descriptors are ignored, false to merge those with the originally specified repositories.

setIgnoreArtifactDescriptorRepositories

public DefaultRepositorySystemSession setIgnoreArtifactDescriptorRepositories(boolean ignoreArtifactDescriptorRepositories)

Controls whether repositories declared in artifact descriptors should be ignored during transitive dependency collection. If enabled, only the repositories originally provided with the collect request will be considered.

Parameters:

ignoreArtifactDescriptorRepositories - true to ignore additional repositories from artifact descriptors, false to merge those with the originally specified repositories.

Returns:

This session for chaining, never null.

getResolutionErrorPolicy

public ResolutionErrorPolicy getResolutionErrorPolicy()

Description copied from interface: RepositorySystemSession

Gets the policy which controls whether resolutions errors from remote repositories should be cached.

Specified by:

getResolutionErrorPolicy in interface RepositorySystemSession

Returns:

The resolution error policy for this session or null if resolution errors should generally not be cached.

setResolutionErrorPolicy

public DefaultRepositorySystemSession setResolutionErrorPolicy(ResolutionErrorPolicy resolutionErrorPolicy)

Sets the policy which controls whether resolutions errors from remote repositories should be cached.

Parameters:

resolutionErrorPolicy - The resolution error policy for this session, may be null if resolution errors should generally not be cached.

Returns:

This session for chaining, never null.

getArtifactDescriptorPolicy

public ArtifactDescriptorPolicy getArtifactDescriptorPolicy()

Description copied from interface: RepositorySystemSession

Gets the policy which controls how errors related to reading artifact descriptors should be handled.

Specified by:

getArtifactDescriptorPolicy in interface RepositorySystemSession

Returns:

The descriptor error policy for this session or null if descriptor errors should generally not be tolerated.

setArtifactDescriptorPolicy

public DefaultRepositorySystemSession setArtifactDescriptorPolicy(ArtifactDescriptorPolicy artifactDescriptorPolicy)

Sets the policy which controls how errors related to reading artifact descriptors should be handled.

Parameters:

artifactDescriptorPolicy - The descriptor error policy for this session, may be null if descriptor errors should generally not be tolerated.

Returns:

This session for chaining, never null.

getChecksumPolicy

public java.lang.String getChecksumPolicy()

Description copied from interface: RepositorySystemSession

Gets the global checksum policy. If set, the global checksum policy overrides the checksum policies of the remote repositories being used for resolution.

Specified by:

getChecksumPolicy in interface RepositorySystemSession

Returns:

The global checksum policy or null/empty if not set and the per-repository policies apply.

See Also:

RepositoryPolicy.CHECKSUM_POLICY_FAIL, RepositoryPolicy.CHECKSUM_POLICY_IGNORE, RepositoryPolicy.CHECKSUM_POLICY_WARN

setChecksumPolicy

public DefaultRepositorySystemSession setChecksumPolicy(java.lang.String checksumPolicy)

Sets the global checksum policy. If set, the global checksum policy overrides the checksum policies of the remote repositories being used for resolution.

Parameters:

checksumPolicy - The global checksum policy, may be null/empty to apply the per-repository policies.

Returns:

This session for chaining, never null.

See Also:

RepositoryPolicy.CHECKSUM_POLICY_FAIL, RepositoryPolicy.CHECKSUM_POLICY_IGNORE, RepositoryPolicy.CHECKSUM_POLICY_WARN

getUpdatePolicy

public java.lang.String getUpdatePolicy()

Description copied from interface: RepositorySystemSession

Gets the global update policy, or null if not set.

This method is meant for code that does not want to distinguish between artifact and metadata policies. Note: applications should either use get/set updatePolicy (this method and setUpdatePolicy(String)) or also distinguish between artifact and metadata update policies (and use other methods), but should not mix the two!

Specified by:

getUpdatePolicy in interface RepositorySystemSession

See Also:

RepositorySystemSession.getArtifactUpdatePolicy(), RepositorySystemSession.getMetadataUpdatePolicy()

setUpdatePolicy

public DefaultRepositorySystemSession setUpdatePolicy(java.lang.String updatePolicy)

Sets the global update policy. If set, the global update policy overrides the update policies of the remote repositories being used for resolution.

This method is meant for code that does not want to distinguish between artifact and metadata policies. Note: applications should either use get/set updatePolicy (this method and RepositorySystemSession.getUpdatePolicy()) or also distinguish between artifact and metadata update policies (and use other methods), but should not mix the two!

Parameters:

updatePolicy - The global update policy, may be null/empty to apply the per-repository policies.

Returns:

This session for chaining, never null.

See Also:

RepositoryPolicy.UPDATE_POLICY_ALWAYS, RepositoryPolicy.UPDATE_POLICY_DAILY, RepositoryPolicy.UPDATE_POLICY_NEVER, setArtifactUpdatePolicy(String), setMetadataUpdatePolicy(String)

getArtifactUpdatePolicy

public java.lang.String getArtifactUpdatePolicy()

Description copied from interface: RepositorySystemSession

Gets the global artifact update policy. If set, the global update policy overrides the update policies of the remote repositories being used for resolution.

Specified by:

getArtifactUpdatePolicy in interface RepositorySystemSession

Returns:

The global update policy or null/empty if not set and the per-repository policies apply.

See Also:

RepositoryPolicy.UPDATE_POLICY_ALWAYS, RepositoryPolicy.UPDATE_POLICY_DAILY, RepositoryPolicy.UPDATE_POLICY_NEVER

setArtifactUpdatePolicy

public DefaultRepositorySystemSession setArtifactUpdatePolicy(java.lang.String artifactUpdatePolicy)

Sets the global artifact update policy. If set, the global update policy overrides the artifact update policies of the remote repositories being used for resolution.

Parameters:

artifactUpdatePolicy - The global update policy, may be null/empty to apply the per-repository policies.

Returns:

This session for chaining, never null.

Since:

2.0.0

See Also:

RepositoryPolicy.UPDATE_POLICY_ALWAYS, RepositoryPolicy.UPDATE_POLICY_DAILY, RepositoryPolicy.UPDATE_POLICY_NEVER

getMetadataUpdatePolicy

public java.lang.String getMetadataUpdatePolicy()

Description copied from interface: RepositorySystemSession

Gets the global metadata update policy. If set, the global update policy overrides the update policies of the remote repositories being used for resolution.

Specified by:

getMetadataUpdatePolicy in interface RepositorySystemSession

Returns:

The global update policy or null/empty if not set and the per-repository policies apply.

See Also:

RepositoryPolicy.UPDATE_POLICY_ALWAYS, RepositoryPolicy.UPDATE_POLICY_DAILY, RepositoryPolicy.UPDATE_POLICY_NEVER

setMetadataUpdatePolicy

public DefaultRepositorySystemSession setMetadataUpdatePolicy(java.lang.String metadataUpdatePolicy)

Sets the global metadata update policy. If set, the global update policy overrides the metadata update policies of the remote repositories being used for resolution.

Parameters:

metadataUpdatePolicy - The global update policy, may be null/empty to apply the per-repository policies.

Returns:

This session for chaining, never null.

Since:

2.0.0

See Also:

RepositoryPolicy.UPDATE_POLICY_ALWAYS, RepositoryPolicy.UPDATE_POLICY_DAILY, RepositoryPolicy.UPDATE_POLICY_NEVER

getLocalRepository

public LocalRepository getLocalRepository()

Description copied from interface: RepositorySystemSession

Gets the local repository used during this session. This is a convenience method for LocalRepositoryManager.getRepository().

Specified by:

getLocalRepository in interface RepositorySystemSession

Returns:

The local repository being during this session, never null.

getLocalRepositoryManager

public LocalRepositoryManager getLocalRepositoryManager()

Description copied from interface: RepositorySystemSession

Gets the local repository manager used during this session.

Specified by:

getLocalRepositoryManager in interface RepositorySystemSession

Returns:

The local repository manager used during this session, never null.

setLocalRepositoryManager

public DefaultRepositorySystemSession setLocalRepositoryManager(LocalRepositoryManager localRepositoryManager)

Sets the local repository manager used during this session. Note: Eventually, a valid session must have a local repository manager set.

Parameters:

localRepositoryManager - The local repository manager used during this session, may be null.

Returns:

This session for chaining, never null.

getWorkspaceReader

public WorkspaceReader getWorkspaceReader()

Description copied from interface: RepositorySystemSession

Gets the workspace reader used during this session. If set, the workspace reader will usually be consulted first to resolve artifacts.

Specified by:

getWorkspaceReader in interface RepositorySystemSession

Returns:

The workspace reader for this session or null if none.

setWorkspaceReader

public DefaultRepositorySystemSession setWorkspaceReader(WorkspaceReader workspaceReader)

Sets the workspace reader used during this session. If set, the workspace reader will usually be consulted first to resolve artifacts.

Parameters:

workspaceReader - The workspace reader for this session, may be null if none.

Returns:

This session for chaining, never null.

getRepositoryListener

public RepositoryListener getRepositoryListener()

Description copied from interface: RepositorySystemSession

Gets the listener being notified of actions in the repository system.

Specified by:

getRepositoryListener in interface RepositorySystemSession

Returns:

The repository listener or null if none.

setRepositoryListener

public DefaultRepositorySystemSession setRepositoryListener(RepositoryListener repositoryListener)

Sets the listener being notified of actions in the repository system.

Parameters:

repositoryListener - The repository listener, may be null if none.

Returns:

This session for chaining, never null.

getTransferListener

public TransferListener getTransferListener()

Description copied from interface: RepositorySystemSession

Gets the listener being notified of uploads/downloads by the repository system.

Specified by:

getTransferListener in interface RepositorySystemSession

Returns:

The transfer listener or null if none.

setTransferListener

public DefaultRepositorySystemSession setTransferListener(TransferListener transferListener)

Sets the listener being notified of uploads/downloads by the repository system.

Parameters:

transferListener - The transfer listener, may be null if none.

Returns:

This session for chaining, never null.

getSystemProperties

public java.util.Map<java.lang.String,java.lang.String> getSystemProperties()

Description copied from interface: RepositorySystemSession

Gets the system properties to use, e.g. for processing of artifact descriptors. System properties are usually collected from the runtime environment like System.getProperties() and environment variables.

Specified by:

getSystemProperties in interface RepositorySystemSession

Returns:

The (read-only) system properties, never null.

setSystemProperties

public DefaultRepositorySystemSession setSystemProperties(java.util.Map<?,?> systemProperties)

Sets the system properties to use, e.g. for processing of artifact descriptors. System properties are usually collected from the runtime environment like System.getProperties() and environment variables.

Note: System properties are of type Map<String, String> and any key-value pair in the input map that doesn't match this type will be silently ignored.

Parameters:

systemProperties - The system properties, may be null or empty if none.

Returns:

This session for chaining, never null.

setSystemProperty

public DefaultRepositorySystemSession setSystemProperty(java.lang.String key,
                                                        java.lang.String value)

Sets the specified system property.

Parameters:

key - The property key, must not be null.

value - The property value, may be null to remove/unset the property.

Returns:

This session for chaining, never null.

getUserProperties

public java.util.Map<java.lang.String,java.lang.String> getUserProperties()

Description copied from interface: RepositorySystemSession

Gets the user properties to use, e.g. for processing of artifact descriptors. User properties are similar to system properties but are set on the discretion of the user and hence are considered of higher priority than system properties.

Specified by:

getUserProperties in interface RepositorySystemSession

Returns:

The (read-only) user properties, never null.

setUserProperties

public DefaultRepositorySystemSession setUserProperties(java.util.Map<?,?> userProperties)

Sets the user properties to use, e.g. for processing of artifact descriptors. User properties are similar to system properties but are set on the discretion of the user and hence are considered of higher priority than system properties in case of conflicts.

Note: User properties are of type Map<String, String> and any key-value pair in the input map that doesn't match this type will be silently ignored.

Parameters:

userProperties - The user properties, may be null or empty if none.

Returns:

This session for chaining, never null.

setUserProperty

public DefaultRepositorySystemSession setUserProperty(java.lang.String key,
                                                      java.lang.String value)

Sets the specified user property.

Parameters:

key - The property key, must not be null.

value - The property value, may be null to remove/unset the property.

Returns:

This session for chaining, never null.

getConfigProperties

public java.util.Map<java.lang.String,java.lang.Object> getConfigProperties()

Description copied from interface: RepositorySystemSession

Gets the configuration properties used to tweak internal aspects of the repository system (e.g. thread pooling, connector-specific behavior, etc.)

Specified by:

getConfigProperties in interface RepositorySystemSession

Returns:

The (read-only) configuration properties, never null.

See Also:

ConfigurationProperties

setConfigProperties

public DefaultRepositorySystemSession setConfigProperties(java.util.Map<?,?> configProperties)

Sets the configuration properties used to tweak internal aspects of the repository system (e.g. thread pooling, connector-specific behavior, etc.).

Note: Configuration properties are of type Map<String, Object> and any key-value pair in the input map that doesn't match this type will be silently ignored.

Parameters:

configProperties - The configuration properties, may be null or empty if none.

Returns:

This session for chaining, never null.

setConfigProperty

public DefaultRepositorySystemSession setConfigProperty(java.lang.String key,
                                                        java.lang.Object value)

Sets the specified configuration property.

Parameters:

key - The property key, must not be null.

value - The property value, may be null to remove/unset the property.

Returns:

This session for chaining, never null.

getMirrorSelector

public MirrorSelector getMirrorSelector()

Description copied from interface: RepositorySystemSession

Gets the mirror selector to use for repositories discovered in artifact descriptors. Note that this selector is not used for remote repositories which are passed as request parameters to the repository system, those repositories are supposed to denote the effective repositories.

Specified by:

getMirrorSelector in interface RepositorySystemSession

Returns:

The mirror selector to use, never null.

See Also:

RepositorySystem.newResolutionRepositories(RepositorySystemSession, java.util.List)

setMirrorSelector

public DefaultRepositorySystemSession setMirrorSelector(MirrorSelector mirrorSelector)

Sets the mirror selector to use for repositories discovered in artifact descriptors. Note that this selector is not used for remote repositories which are passed as request parameters to the repository system, those repositories are supposed to denote the effective repositories.

Parameters:

mirrorSelector - The mirror selector to use, may be null.

Returns:

This session for chaining, never null.

getProxySelector

public ProxySelector getProxySelector()

Description copied from interface: RepositorySystemSession

Gets the proxy selector to use for repositories discovered in artifact descriptors. Note that this selector is not used for remote repositories which are passed as request parameters to the repository system, those repositories are supposed to have their proxy (if any) already set.

Specified by:

getProxySelector in interface RepositorySystemSession

Returns:

The proxy selector to use, never null.

See Also:

RemoteRepository.getProxy(), RepositorySystem.newResolutionRepositories(RepositorySystemSession, java.util.List)

setProxySelector

public DefaultRepositorySystemSession setProxySelector(ProxySelector proxySelector)

Sets the proxy selector to use for repositories discovered in artifact descriptors. Note that this selector is not used for remote repositories which are passed as request parameters to the repository system, those repositories are supposed to have their proxy (if any) already set.

Parameters:

proxySelector - The proxy selector to use, may be null.

Returns:

This session for chaining, never null.

See Also:

RemoteRepository.getProxy()

getAuthenticationSelector

public AuthenticationSelector getAuthenticationSelector()

Description copied from interface: RepositorySystemSession

Gets the authentication selector to use for repositories discovered in artifact descriptors. Note that this selector is not used for remote repositories which are passed as request parameters to the repository system, those repositories are supposed to have their authentication (if any) already set.

Specified by:

getAuthenticationSelector in interface RepositorySystemSession

Returns:

The authentication selector to use, never null.

See Also:

RemoteRepository.getAuthentication(), RepositorySystem.newResolutionRepositories(RepositorySystemSession, java.util.List)

setAuthenticationSelector

public DefaultRepositorySystemSession setAuthenticationSelector(AuthenticationSelector authenticationSelector)

Sets the authentication selector to use for repositories discovered in artifact descriptors. Note that this selector is not used for remote repositories which are passed as request parameters to the repository system, those repositories are supposed to have their authentication (if any) already set.

Parameters:

authenticationSelector - The authentication selector to use, may be null.

Returns:

This session for chaining, never null.

See Also:

RemoteRepository.getAuthentication()

getArtifactTypeRegistry

public ArtifactTypeRegistry getArtifactTypeRegistry()

Description copied from interface: RepositorySystemSession

Gets the registry of artifact types recognized by this session, for instance when processing artifact descriptors.

Specified by:

getArtifactTypeRegistry in interface RepositorySystemSession

Returns:

The artifact type registry, never null.

setArtifactTypeRegistry

public DefaultRepositorySystemSession setArtifactTypeRegistry(ArtifactTypeRegistry artifactTypeRegistry)

Sets the registry of artifact types recognized by this session.

Parameters:

artifactTypeRegistry - The artifact type registry, may be null.

Returns:

This session for chaining, never null.

getDependencyTraverser

public DependencyTraverser getDependencyTraverser()

Description copied from interface: RepositorySystemSession

Gets the dependency traverser to use for building dependency graphs.

Specified by:

getDependencyTraverser in interface RepositorySystemSession

Returns:

The dependency traverser to use for building dependency graphs or null if dependencies are unconditionally traversed.

setDependencyTraverser

public DefaultRepositorySystemSession setDependencyTraverser(DependencyTraverser dependencyTraverser)

Sets the dependency traverser to use for building dependency graphs.

Parameters:

dependencyTraverser - The dependency traverser to use for building dependency graphs, may be null.

Returns:

This session for chaining, never null.

getDependencyManager

public DependencyManager getDependencyManager()

Description copied from interface: RepositorySystemSession

Gets the dependency manager to use for building dependency graphs.

Specified by:

getDependencyManager in interface RepositorySystemSession

Returns:

The dependency manager to use for building dependency graphs or null if dependency management is not performed.

setDependencyManager

public DefaultRepositorySystemSession setDependencyManager(DependencyManager dependencyManager)

Sets the dependency manager to use for building dependency graphs.

Parameters:

dependencyManager - The dependency manager to use for building dependency graphs, may be null.

Returns:

This session for chaining, never null.

getDependencySelector

public DependencySelector getDependencySelector()

Description copied from interface: RepositorySystemSession

Gets the dependency selector to use for building dependency graphs.

Specified by:

getDependencySelector in interface RepositorySystemSession

Returns:

The dependency selector to use for building dependency graphs or null if dependencies are unconditionally included.

setDependencySelector

public DefaultRepositorySystemSession setDependencySelector(DependencySelector dependencySelector)

Sets the dependency selector to use for building dependency graphs.

Parameters:

dependencySelector - The dependency selector to use for building dependency graphs, may be null.

Returns:

This session for chaining, never null.

getVersionFilter

public VersionFilter getVersionFilter()

Description copied from interface: RepositorySystemSession

Gets the version filter to use for building dependency graphs.

Specified by:

getVersionFilter in interface RepositorySystemSession

Returns:

The version filter to use for building dependency graphs or null if versions aren't filtered.

setVersionFilter

public DefaultRepositorySystemSession setVersionFilter(VersionFilter versionFilter)

Sets the version filter to use for building dependency graphs.

Parameters:

versionFilter - The version filter to use for building dependency graphs, may be null to not filter versions.

Returns:

This session for chaining, never null.

getDependencyGraphTransformer

public DependencyGraphTransformer getDependencyGraphTransformer()

Description copied from interface: RepositorySystemSession

Gets the dependency graph transformer to use for building dependency graphs.

Specified by:

getDependencyGraphTransformer in interface RepositorySystemSession

Returns:

The dependency graph transformer to use for building dependency graphs or null if none.

setDependencyGraphTransformer

public DefaultRepositorySystemSession setDependencyGraphTransformer(DependencyGraphTransformer dependencyGraphTransformer)

Sets the dependency graph transformer to use for building dependency graphs.

Parameters:

dependencyGraphTransformer - The dependency graph transformer to use for building dependency graphs, may be null.

Returns:

This session for chaining, never null.

getData

public SessionData getData()

Description copied from interface: RepositorySystemSession

Gets the custom data associated with this session.

Specified by:

getData in interface RepositorySystemSession

Returns:

The session data, never null.

setData

public DefaultRepositorySystemSession setData(SessionData data)

Sets the custom data associated with this session.

Parameters:

data - The session data, may be null.

Returns:

This session for chaining, never null.

getCache

public RepositoryCache getCache()

Description copied from interface: RepositorySystemSession

Gets the cache the repository system may use to save data for future reuse during the session.

Specified by:

getCache in interface RepositorySystemSession

Returns:

The repository cache or null if none.

setCache

public DefaultRepositorySystemSession setCache(RepositoryCache cache)

Sets the cache the repository system may use to save data for future reuse during the session.

Parameters:

cache - The repository cache, may be null if none.

Returns:

This session for chaining, never null.

getScopeManager

public ScopeManager getScopeManager()

Description copied from interface: RepositorySystemSession

Returns the scope manager to be used in this session, may be null if not set.

Specified by:

getScopeManager in interface RepositorySystemSession

Returns:

The scope manager or null if not set.

setScopeManager

public DefaultRepositorySystemSession setScopeManager(ScopeManager scopeManager)

Sets the scope manager, may be null.

Parameters:

scopeManager - The scope manager, may be null.

Returns:

The session for chaining, never null.

Since:

2.0.0

getSystemDependencyScope

public SystemDependencyScope getSystemDependencyScope()

Description copied from interface: RepositorySystemSession

Returns the system dependency scope.

Shorthand method for ScopeManager.getSystemDependencyScope().

If ScopeManager is set, RepositorySystemSession.getScopeManager() returns non-null value, the result of ScopeManager.getSystemDependencyScope() is returned (that may be null). If no ScopeManager if set, then SystemDependencyScope.LEGACY instance is returned, as lack of scope manager means that resolver operates in "legacy" mode (Maven3 compatible mode).

Specified by:

getSystemDependencyScope in interface RepositorySystemSession

Returns:

The system dependency scope or null if no such scope.

getDependencyCollectionChecker

public DependencyCollectionChecker getDependencyCollectionChecker()

Description copied from interface: RepositorySystemSession

Returns the dependency collector checker, may be null.

Specified by:

getDependencyCollectionChecker in interface RepositorySystemSession

Returns:

The effective DependencyCollectionChecker instance, may be null.

setDependencyCollectionChecker

public DefaultRepositorySystemSession setDependencyCollectionChecker(DependencyCollectionChecker dependencyCollectionChecker)

Sets the dependency collection checker, may be null.

Parameters:

dependencyCollectionChecker - The dependency collection checker, may be null.

Returns:

The session for chaining, never null.

Since:

2.0.19

addOnSessionEndedHandler

public boolean addOnSessionEndedHandler(java.lang.Runnable handler)

Registers onSessionEnded handler, if able to.

Specified by:

addOnSessionEndedHandler in interface RepositorySystemSession

Parameters:

handler - The handler to register

Returns:

Return true if registration was possible, otherwise false.

setReadOnly

public void setReadOnly()

Marks this session as read-only such that any future attempts to call its mutators will fail with an exception. Marking an already read-only session as read-only has no effect. The session's data and cache remain writable though.