org.sonatype.aether.util
Class DefaultRepositorySystemSession

java.lang.Object
  org.sonatype.aether.util.DefaultRepositorySystemSession

All Implemented Interfaces:

RepositorySystemSession

public class DefaultRepositorySystemSession
extends java.lang.Object
implements RepositorySystemSession

A simple repository system session.

Author:

Benjamin Bentmann

Constructor Summary

DefaultRepositorySystemSession()
Creates an uninitialized session.

DefaultRepositorySystemSession(RepositorySystemSession session)
Creates a shallow copy of the specified session.

Method Summary

ArtifactTypeRegistry	getArtifactTypeRegistry() Gets the registry of artifact types recognized by this session.
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() The configuration properties used to tweak internal aspects of the repository system (e.g.
SessionData	getData() Gets the custom data associated with this session.
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.
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.
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.
java.util.Map<java.lang.String,java.lang.String>	getUserProperties() Gets the user properties to use, e.g.
WorkspaceReader	getWorkspaceReader() Gets the workspace reader used during this session.
boolean	isIgnoreInvalidArtifactDescriptor() Indicates whether invalid artifact descriptors are silently ignored.
boolean	isIgnoreMissingArtifactDescriptor() Indicates whether missing artifact descriptors are silently ignored.
boolean	isNotFoundCachingEnabled() Indicates whether missing artifacts/metadata from resolution attempts should be cached in the local repository.
boolean	isOffline() Indicates whether the repository system operates in offline mode and avoids/refuses any access to remote repositories.
boolean	isTransferErrorCachingEnabled() Indicates whether transfer errors (e.g.
DefaultRepositorySystemSession	setArtifactTypeRegistry(ArtifactTypeRegistry artifactTypeRegistry)
DefaultRepositorySystemSession	setAuthenticationSelector(AuthenticationSelector authenticationSelector)
DefaultRepositorySystemSession	setCache(RepositoryCache cache)
DefaultRepositorySystemSession	setChecksumPolicy(java.lang.String checksumPolicy)
DefaultRepositorySystemSession	setConfigProperties(java.util.Map<java.lang.String,java.lang.Object> configProperties)
DefaultRepositorySystemSession	setConfigProperty(java.lang.String key, java.lang.Object value)
DefaultRepositorySystemSession	setConfigProps(java.util.Map<?,?> configProperties)
DefaultRepositorySystemSession	setData(SessionData data)
DefaultRepositorySystemSession	setDependencyGraphTransformer(DependencyGraphTransformer dependencyGraphTransformer)
DefaultRepositorySystemSession	setDependencyManager(DependencyManager dependencyManager)
DefaultRepositorySystemSession	setDependencySelector(DependencySelector dependencySelector)
DefaultRepositorySystemSession	setDependencyTraverser(DependencyTraverser dependencyTraverser)
DefaultRepositorySystemSession	setIgnoreInvalidArtifactDescriptor(boolean ignoreInvalidArtifactDescriptor)
DefaultRepositorySystemSession	setIgnoreMissingArtifactDescriptor(boolean ignoreMissingArtifactDescriptor)
DefaultRepositorySystemSession	setLocalRepositoryManager(LocalRepositoryManager localRepositoryManager)
DefaultRepositorySystemSession	setMirrorSelector(MirrorSelector mirrorSelector)
DefaultRepositorySystemSession	setNotFoundCachingEnabled(boolean notFoundCachingEnabled)
DefaultRepositorySystemSession	setOffline(boolean offline)
DefaultRepositorySystemSession	setProxySelector(ProxySelector proxySelector)
DefaultRepositorySystemSession	setRepositoryListener(RepositoryListener repositoryListener)
DefaultRepositorySystemSession	setSystemProperties(java.util.Map<java.lang.String,java.lang.String> systemProperties)
DefaultRepositorySystemSession	setSystemProperty(java.lang.String key, java.lang.String value)
DefaultRepositorySystemSession	setSystemProps(java.util.Hashtable<?,?> systemProperties)
DefaultRepositorySystemSession	setTransferErrorCachingEnabled(boolean transferErrorCachingEnabled)
DefaultRepositorySystemSession	setTransferListener(TransferListener transferListener)
DefaultRepositorySystemSession	setUpdatePolicy(java.lang.String updatePolicy)
DefaultRepositorySystemSession	setUserProperties(java.util.Map<java.lang.String,java.lang.String> userProperties)
DefaultRepositorySystemSession	setUserProperty(java.lang.String key, java.lang.String value)
DefaultRepositorySystemSession	setUserProps(java.util.Map<?,?> userProperties)
DefaultRepositorySystemSession	setWorkspaceReader(WorkspaceReader workspaceReader)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRepositorySystemSession

public DefaultRepositorySystemSession()

Creates an uninitialized session.

DefaultRepositorySystemSession

public DefaultRepositorySystemSession(RepositorySystemSession session)

Creates a shallow copy of the specified session.

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)

isTransferErrorCachingEnabled

public boolean isTransferErrorCachingEnabled()

Description copied from interface: RepositorySystemSession

Indicates whether transfer errors (e.g. unreachable host, bad authentication) from resolution attempts should be cached in the local repository. If caching is enabled, resolution will not be reattempted until the update policy for the affected resource has expired.

Specified by:

isTransferErrorCachingEnabled in interface RepositorySystemSession

Returns:

true if transfer errors are cached, false to always reattempt downloading.

setTransferErrorCachingEnabled

public DefaultRepositorySystemSession setTransferErrorCachingEnabled(boolean transferErrorCachingEnabled)

isNotFoundCachingEnabled

public boolean isNotFoundCachingEnabled()

Description copied from interface: RepositorySystemSession

Indicates whether missing artifacts/metadata from resolution attempts should be cached in the local repository. If caching is enabled, resolution will not be reattempted until the update policy for the affected resource has expired.

Specified by:

isNotFoundCachingEnabled in interface RepositorySystemSession

Returns:

true if missing resources are cached, false to always reattempt downloading.

setNotFoundCachingEnabled

public DefaultRepositorySystemSession setNotFoundCachingEnabled(boolean notFoundCachingEnabled)

isIgnoreMissingArtifactDescriptor

public boolean isIgnoreMissingArtifactDescriptor()

Description copied from interface: RepositorySystemSession

Indicates whether missing artifact descriptors are silently ignored. If enabled and no artifact descriptor is available, an empty stub descriptor is used instead.

Specified by:

isIgnoreMissingArtifactDescriptor in interface RepositorySystemSession

Returns:

true if missing artifact descriptors are ignored, false to fail the operation with an exception.

setIgnoreMissingArtifactDescriptor

public DefaultRepositorySystemSession setIgnoreMissingArtifactDescriptor(boolean ignoreMissingArtifactDescriptor)

isIgnoreInvalidArtifactDescriptor

public boolean isIgnoreInvalidArtifactDescriptor()

Description copied from interface: RepositorySystemSession

Indicates whether invalid artifact descriptors are silently ignored. If enabled and an artifact descriptor is invalid, an empty stub descriptor is used instead.

Specified by:

isIgnoreInvalidArtifactDescriptor in interface RepositorySystemSession

Returns:

true if invalid artifact descriptors are ignored, false to fail the operation with an exception.

setIgnoreInvalidArtifactDescriptor

public DefaultRepositorySystemSession setIgnoreInvalidArtifactDescriptor(boolean ignoreInvalidArtifactDescriptor)

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

setChecksumPolicy

public DefaultRepositorySystemSession setChecksumPolicy(java.lang.String checksumPolicy)

getUpdatePolicy

public java.lang.String getUpdatePolicy()

Description copied from interface: RepositorySystemSession

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

Specified by:

getUpdatePolicy in interface RepositorySystemSession

Returns:

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

See Also:

RepositoryPolicy

setUpdatePolicy

public DefaultRepositorySystemSession setUpdatePolicy(java.lang.String updatePolicy)

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)

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)

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)

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)

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<java.lang.String,java.lang.String> systemProperties)

setSystemProps

public DefaultRepositorySystemSession setSystemProps(java.util.Hashtable<?,?> systemProperties)

setSystemProperty

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

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<java.lang.String,java.lang.String> userProperties)

setUserProps

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

setUserProperty

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

getConfigProperties

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

Description copied from interface: RepositorySystemSession

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<java.lang.String,java.lang.Object> configProperties)

setConfigProps

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

setConfigProperty

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

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.

setMirrorSelector

public DefaultRepositorySystemSession setMirrorSelector(MirrorSelector mirrorSelector)

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()

setProxySelector

public DefaultRepositorySystemSession setProxySelector(ProxySelector proxySelector)

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()

setAuthenticationSelector

public DefaultRepositorySystemSession setAuthenticationSelector(AuthenticationSelector authenticationSelector)

getArtifactTypeRegistry

public ArtifactTypeRegistry getArtifactTypeRegistry()

Description copied from interface: RepositorySystemSession

Gets the registry of artifact types recognized by this session.

Specified by:

getArtifactTypeRegistry in interface RepositorySystemSession

Returns:

The artifact type registry, never null.

setArtifactTypeRegistry

public DefaultRepositorySystemSession setArtifactTypeRegistry(ArtifactTypeRegistry artifactTypeRegistry)

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, never null.

setDependencyTraverser

public DefaultRepositorySystemSession setDependencyTraverser(DependencyTraverser dependencyTraverser)

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, never null.

setDependencyManager

public DefaultRepositorySystemSession setDependencyManager(DependencyManager dependencyManager)

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, never null.

setDependencySelector

public DefaultRepositorySystemSession setDependencySelector(DependencySelector dependencySelector)

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, never null.

setDependencyGraphTransformer

public DefaultRepositorySystemSession setDependencyGraphTransformer(DependencyGraphTransformer dependencyGraphTransformer)

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.

setData

public DefaultRepositorySystemSession setData(SessionData data)

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.

setCache

public DefaultRepositorySystemSession setCache(RepositoryCache cache)