Package org.eclipse.aether

Interface RepositorySystemSession.SessionBuilder

Enclosing interface:

RepositorySystemSession

public static interface RepositorySystemSession.SessionBuilder

Builder for building RepositorySystemSession.CloseableSession instances. Builder instances can be created with RepositorySystem.createSessionBuilder() method. Instances are not thread-safe nor immutable.

Important: if you set a stateful member on builder (for example SessionData or RepositoryCache), the builder will create session instances using same provided stateful members, that may lead to unexpected side effects. Solution for these cases is to not reuse builder instances, or, keep reconfiguring it, or ultimately provide suppliers that create new instance per each call.

Since:

2.0.0

Restriction:

This interface is not intended to be extended by clients.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

Modifier and Type	Method	Description
RepositorySystemSession.SessionBuilder	addOnSessionEndedHandler(Runnable handler)	Adds on session ended handler to be immediately registered when this builder creates session.
RepositorySystemSession.CloseableSession	build()	Creates immutable closeable session out this builder instance.
RepositorySystemSession.SessionBuilder	setArtifactDescriptorPolicy(ArtifactDescriptorPolicy artifactDescriptorPolicy)	Sets the policy which controls how errors related to reading artifact descriptors should be handled.
RepositorySystemSession.SessionBuilder	setArtifactTypeRegistry(ArtifactTypeRegistry artifactTypeRegistry)	Sets the registry of artifact types recognized by this session.
RepositorySystemSession.SessionBuilder	setArtifactUpdatePolicy(String artifactUpdatePolicy)	Sets the global artifact update policy.
RepositorySystemSession.SessionBuilder	setAuthenticationSelector(AuthenticationSelector authenticationSelector)	Sets the authentication selector to use for repositories discovered in artifact descriptors.
RepositorySystemSession.SessionBuilder	setCache(RepositoryCache cache)	Sets the cache the repository system may use to save data for future reuse during the session.
RepositorySystemSession.SessionBuilder	setChecksumPolicy(String checksumPolicy)	Sets the global checksum policy.
RepositorySystemSession.SessionBuilder	setConfigProperties(Map<?,?> configProperties)	Sets the configuration properties used to tweak internal aspects of the repository system (e.g.
RepositorySystemSession.SessionBuilder	setConfigProperty(String key, Object value)	Sets the specified configuration property.
RepositorySystemSession.SessionBuilder	setData(SessionData data)	Sets the custom data associated with this session.
RepositorySystemSession.SessionBuilder	setDependencyGraphTransformer(DependencyGraphTransformer dependencyGraphTransformer)	Sets the dependency graph transformer to use for building dependency graphs.
RepositorySystemSession.SessionBuilder	setDependencyManager(DependencyManager dependencyManager)	Sets the dependency manager to use for building dependency graphs.
RepositorySystemSession.SessionBuilder	setDependencySelector(DependencySelector dependencySelector)	Sets the dependency selector to use for building dependency graphs.
RepositorySystemSession.SessionBuilder	setDependencyTraverser(DependencyTraverser dependencyTraverser)	Sets the dependency traverser to use for building dependency graphs.
RepositorySystemSession.SessionBuilder	setIgnoreArtifactDescriptorRepositories(boolean ignoreArtifactDescriptorRepositories)	Controls whether repositories declared in artifact descriptors should be ignored during transitive dependency collection.
RepositorySystemSession.SessionBuilder	setLocalRepositoryManager(LocalRepositoryManager localRepositoryManager)	Sets the local repository manager used during this session.
RepositorySystemSession.SessionBuilder	setMetadataUpdatePolicy(String metadataUpdatePolicy)	Sets the global metadata update policy.
RepositorySystemSession.SessionBuilder	setMirrorSelector(MirrorSelector mirrorSelector)	Sets the mirror selector to use for repositories discovered in artifact descriptors.
RepositorySystemSession.SessionBuilder	setOffline(boolean offline)	Controls whether the repository system operates in offline mode and avoids/refuses any access to remote repositories.
RepositorySystemSession.SessionBuilder	setProxySelector(ProxySelector proxySelector)	Sets the proxy selector to use for repositories discovered in artifact descriptors.
RepositorySystemSession.SessionBuilder	setRepositoryCacheSupplier(Supplier<RepositoryCache> cacheSupplier)	Sets the cache supplier for the repository system may use to save data for future reuse during the session.
RepositorySystemSession.SessionBuilder	setRepositoryListener(RepositoryListener repositoryListener)	Sets the listener being notified of actions in the repository system.
RepositorySystemSession.SessionBuilder	setResolutionErrorPolicy(ResolutionErrorPolicy resolutionErrorPolicy)	Sets the policy which controls whether resolutions errors from remote repositories should be cached.
RepositorySystemSession.SessionBuilder	setScopeManager(ScopeManager scopeManager)	Sets the scope manager for session, may be null.
RepositorySystemSession.SessionBuilder	setSessionDataSupplier(Supplier<SessionData> dataSupplier)	Sets the custom session data supplier associated with this session.
RepositorySystemSession.SessionBuilder	setSystemProperties(Map<?,?> systemProperties)	Sets the system properties to use, e.g.
RepositorySystemSession.SessionBuilder	setSystemProperty(String key, String value)	Sets the specified system property.
RepositorySystemSession.SessionBuilder	setTransferListener(TransferListener transferListener)	Sets the listener being notified of uploads/downloads by the repository system.
RepositorySystemSession.SessionBuilder	setUpdatePolicy(String updatePolicy)	Sets the global update policy.
RepositorySystemSession.SessionBuilder	setUserProperties(Map<?,?> userProperties)	Sets the user properties to use, e.g.
RepositorySystemSession.SessionBuilder	setUserProperty(String key, String value)	Sets the specified user property.
RepositorySystemSession.SessionBuilder	setVersionFilter(VersionFilter versionFilter)	Sets the version filter to use for building dependency graphs.
RepositorySystemSession.SessionBuilder	setWorkspaceReader(WorkspaceReader workspaceReader)	Sets the workspace reader used during this session.
RepositorySystemSession.SessionBuilder	withLocalRepositories(Collection<LocalRepository> localRepositories)	Shortcut method to set up local repository manager directly onto builder.
RepositorySystemSession.SessionBuilder	withLocalRepositories(LocalRepository... localRepositories)	Shortcut method to set up local repository manager directly onto builder.
RepositorySystemSession.SessionBuilder	withLocalRepositoryBaseDirectories(Path... baseDirectories)	Shortcut method to set up local repository manager directly onto builder.
RepositorySystemSession.SessionBuilder	withLocalRepositoryBaseDirectories(Collection<Path> baseDirectories)	Shortcut method to set up local repository manager directly onto builder.
RepositorySystemSession.SessionBuilder	withRepositoryListener(Collection<RepositoryListener> repositoryListeners)	Adds the listeners to be notified of actions in the repository system.
RepositorySystemSession.SessionBuilder	withRepositoryListener(RepositoryListener... repositoryListeners)	Adds the listeners to be notified of actions in the repository system.
RepositorySystemSession.SessionBuilder	withRepositorySystemSession(RepositorySystemSession session)	Shortcut method to shallow-copy passed in session into current builder.
RepositorySystemSession.SessionBuilder	withTransferListener(Collection<TransferListener> transferListeners)	Adds the listener to be notified of uploads/downloads by the repository system.
RepositorySystemSession.SessionBuilder	withTransferListener(TransferListener... transferListeners)	Adds the listener to be notified of uploads/downloads by the repository system.

Method Details

setOffline

RepositorySystemSession.SessionBuilder 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.

setIgnoreArtifactDescriptorRepositories

RepositorySystemSession.SessionBuilder 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.

setResolutionErrorPolicy

RepositorySystemSession.SessionBuilder 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.

setArtifactDescriptorPolicy

RepositorySystemSession.SessionBuilder 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.

setChecksumPolicy

RepositorySystemSession.SessionBuilder setChecksumPolicy(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

setUpdatePolicy

RepositorySystemSession.SessionBuilder setUpdatePolicy(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)

setArtifactUpdatePolicy

RepositorySystemSession.SessionBuilder setArtifactUpdatePolicy(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

setMetadataUpdatePolicy

RepositorySystemSession.SessionBuilder setMetadataUpdatePolicy(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

setLocalRepositoryManager

RepositorySystemSession.SessionBuilder setLocalRepositoryManager(LocalRepositoryManager localRepositoryManager)

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

The provisioning of LocalRepositoryManager for use with this method introduces chicken and egg situation. Integrators MUST NOT use this method, but instead, hook into Local Repository Manager Provider by any means they can (ie by using Provider or Sisu Components) and use custom string and/or priorities instead. This method existence is not meant for "everyday use" (normal session creation), but for some more advanced use cases. Do not use it, unless you know what are you doing.

Parameters:

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

Returns:

This session for chaining, never null.

setWorkspaceReader

RepositorySystemSession.SessionBuilder 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.

setRepositoryListener

RepositorySystemSession.SessionBuilder 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.

setTransferListener

RepositorySystemSession.SessionBuilder 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.

setSystemProperties

RepositorySystemSession.SessionBuilder setSystemProperties(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

RepositorySystemSession.SessionBuilder setSystemProperty(String key,
 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.

setUserProperties

RepositorySystemSession.SessionBuilder setUserProperties(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

RepositorySystemSession.SessionBuilder setUserProperty(String key,
 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.

setConfigProperties

RepositorySystemSession.SessionBuilder setConfigProperties(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

RepositorySystemSession.SessionBuilder setConfigProperty(String key,
 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.

setMirrorSelector

RepositorySystemSession.SessionBuilder 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.

setProxySelector

RepositorySystemSession.SessionBuilder 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()

setAuthenticationSelector

RepositorySystemSession.SessionBuilder 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()

setArtifactTypeRegistry

RepositorySystemSession.SessionBuilder 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.

setDependencyTraverser

RepositorySystemSession.SessionBuilder 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.

setDependencyManager

RepositorySystemSession.SessionBuilder 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.

setDependencySelector

RepositorySystemSession.SessionBuilder 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.

setVersionFilter

RepositorySystemSession.SessionBuilder 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.

setDependencyGraphTransformer

RepositorySystemSession.SessionBuilder 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.

setData

RepositorySystemSession.SessionBuilder setData(SessionData data)

Sets the custom data associated with this session. Note: When this method used to set instance, same passed instance will be used for every built session out of this builder instance, hence the built sessions will share these instances as well!

Parameters:

data - The session data, may be null.

Returns:

This session for chaining, never null.

setCache

RepositorySystemSession.SessionBuilder setCache(RepositoryCache cache)

Sets the cache the repository system may use to save data for future reuse during the session. Note: When this method used to set instance, same passed instance will be used for every built session out of this builder instance, hence the built sessions will share these instances as well!

Parameters:

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

Returns:

This session for chaining, never null.

setScopeManager

RepositorySystemSession.SessionBuilder setScopeManager(ScopeManager scopeManager)

Sets the scope manager for session, may be null.

Parameters:

scopeManager - The scope manager, may be null.

Returns:

The session for chaining, never null.

addOnSessionEndedHandler

RepositorySystemSession.SessionBuilder addOnSessionEndedHandler(Runnable handler)

Adds on session ended handler to be immediately registered when this builder creates session.

Parameters:

handler - The on session ended handler, may not be null.

Returns:

The session for chaining, never null.

setSessionDataSupplier

RepositorySystemSession.SessionBuilder setSessionDataSupplier(Supplier<SessionData> dataSupplier)

Sets the custom session data supplier associated with this session. Note: The supplier will be used for every built session out of this builder instance, so if supplier supplies same instance the built sessions will share these instances as well!

Parameters:

dataSupplier - The session data supplier, may not be null.

Returns:

This session for chaining, never null.

setRepositoryCacheSupplier

RepositorySystemSession.SessionBuilder setRepositoryCacheSupplier(Supplier<RepositoryCache> cacheSupplier)

Sets the cache supplier for the repository system may use to save data for future reuse during the session. Note: The supplier will be used for every built session out of this builder instance, so if supplier supplies same instance the built sessions will share these instances as well!

Parameters:

cacheSupplier - The repository cache supplier, may not be null.

Returns:

This session for chaining, never null.

withLocalRepositoryBaseDirectories

RepositorySystemSession.SessionBuilder withLocalRepositoryBaseDirectories(Path... baseDirectories)

Shortcut method to set up local repository manager directly onto builder. There must be at least one non-null Path passed in this method. In case multiple files, session builder will use chained local repository manager.

Parameters:

baseDirectories - The local repository base directories.

Returns:

This session for chaining, never null.

See Also:

• withLocalRepositories(LocalRepository...)

withLocalRepositoryBaseDirectories

RepositorySystemSession.SessionBuilder withLocalRepositoryBaseDirectories(Collection<Path> baseDirectories)

Shortcut method to set up local repository manager directly onto builder. There must be at least one non-null Path present in passed in list. In case multiple files, session builder will use chained local repository manager.

Parameters:

baseDirectories - The local repository base directories.

Returns:

This session for chaining, never null.

See Also:

• withLocalRepositories(Collection)

withLocalRepositories

RepositorySystemSession.SessionBuilder withLocalRepositories(LocalRepository... localRepositories)

Shortcut method to set up local repository manager directly onto builder. There must be at least one non-null LocalRepository passed in this method. In case multiple local repositories, session builder will use chained local repository manager.

Parameters:

localRepositories - The local repositories.

Returns:

This session for chaining, never null.

withLocalRepositories

RepositorySystemSession.SessionBuilder withLocalRepositories(Collection<LocalRepository> localRepositories)

Shortcut method to set up local repository manager directly onto builder. There must be at least one non-null LocalRepository present in passed in list. In case multiple local repositories, session builder will use chained local repository manager.

Parameters:

localRepositories - The local repositories.

Returns:

This session for chaining, never null.

withRepositoryListener

RepositorySystemSession.SessionBuilder withRepositoryListener(RepositoryListener... repositoryListeners)

Adds the listeners to be notified of actions in the repository system.

Parameters:

repositoryListeners - The repository listeners, never null.

Returns:

This session for chaining, never null.

withRepositoryListener

RepositorySystemSession.SessionBuilder withRepositoryListener(Collection<RepositoryListener> repositoryListeners)

Adds the listeners to be notified of actions in the repository system.

Parameters:

repositoryListeners - The repository listeners, never null.

Returns:

This session for chaining, never null.

withTransferListener

RepositorySystemSession.SessionBuilder withTransferListener(TransferListener... transferListeners)

Adds the listener to be notified of uploads/downloads by the repository system.

Parameters:

transferListeners - The transfer listeners, never null.

Returns:

This session for chaining, never null.

withTransferListener

RepositorySystemSession.SessionBuilder withTransferListener(Collection<TransferListener> transferListeners)

Adds the listener to be notified of uploads/downloads by the repository system.

Parameters:

transferListeners - The transfer listeners, never null.

Returns:

This session for chaining, never null.

withRepositorySystemSession

RepositorySystemSession.SessionBuilder withRepositorySystemSession(RepositorySystemSession session)

Shortcut method to shallow-copy passed in session into current builder.

Parameters:

session - The session to shallow-copy from.

Returns:

This session for chaining, never null.

build

RepositorySystemSession.CloseableSession build()

Creates immutable closeable session out this builder instance.

Returns:

Immutable closeable session, never null.