Package org.eclipse.aether.internal.impl.synccontext.named

Class BasedirNameMapper

java.lang.Object

org.eclipse.aether.internal.impl.synccontext.named.BasedirNameMapper

All Implemented Interfaces:

NameMapper

public class BasedirNameMapper
extends Object
implements NameMapper

Wrapping NameMapper class that is file system friendly: it wraps another NameMapper and resolves the resulting "file system friendly" names against local repository basedir.

Since:

1.9.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROP_LOCKS_DIR	The location of the directory toi use for locks.
static final String	DEFAULT_LOCKS_DIR

Constructor Summary

Constructors

Constructor	Description
BasedirNameMapper(NameMapper delegate)
BasedirNameMapper(NameMapper delegate, Path path)	Creates basedir name mapper with provided path as base.

Method Summary

Modifier and Type	Method	Description
boolean	isFileSystemFriendly()	Returns true if lock names returned by this lock name mapper are file system friendly, can be used as file names and paths.
Collection<org.eclipse.aether.named.NamedLockKey>	nameLocks(org.eclipse.aether.RepositorySystemSession session, Collection<? extends org.eclipse.aether.artifact.Artifact> artifacts, Collection<? extends org.eclipse.aether.metadata.Metadata> metadatas)	Creates (opaque) names for passed in artifacts and metadata.

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_PROP_LOCKS_DIR

public static final String CONFIG_PROP_LOCKS_DIR

The location of the directory toi use for locks. If relative path, it is resolved from the local repository root.

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

String

Default value:

DEFAULT_LOCKS_DIR

DEFAULT_LOCKS_DIR

public static final String DEFAULT_LOCKS_DIR

See Also:

• Constant Field Values

Constructor Details

BasedirNameMapper

public BasedirNameMapper(NameMapper delegate)

BasedirNameMapper

public BasedirNameMapper(NameMapper delegate,
 Path path)

Creates basedir name mapper with provided path as base.

Parameters:

delegate - The delegate to resolve against basedir, must not be null. The delegate must be "file system friendly", see NameMapper.isFileSystemFriendly() method.

path - The basedir, may be null in which case given session local repository root is used as basedir.

Since:

2.0.0

Method Details

isFileSystemFriendly

public boolean isFileSystemFriendly()

Description copied from interface: NameMapper

Returns true if lock names returned by this lock name mapper are file system friendly, can be used as file names and paths.

Note: The fact that name mapper is "file system friendly" means ONLY that names it produces CAN be used as file names and paths. Still, it does not mean they will work with ANY file based locking, as for example FileLockNamedLockFactory expects names as string encoded URIs. The only name mapper doing it is BasedirNameMapper.

Specified by:

isFileSystemFriendly in interface NameMapper

nameLocks

public Collection<org.eclipse.aether.named.NamedLockKey> nameLocks(org.eclipse.aether.RepositorySystemSession session,
 Collection<? extends org.eclipse.aether.artifact.Artifact> artifacts,
 Collection<? extends org.eclipse.aether.metadata.Metadata> metadatas)

Description copied from interface: NameMapper

Creates (opaque) names for passed in artifacts and metadata. Returned collection has max size of sum of the passed in artifacts and metadata collections, or less. If an empty collection is returned, there will be no locking happening. Never returns null. The resulting collection MUST BE "stable" (always sorted by same criteria) to avoid deadlocks by acquiring locks in same order, essentially disregarding the order of the input collections.

There is no requirement of any kind of "parity" between input element count (sum of two collections, that is) and output collection size, just the returned upper size limit is defined (sum of the passed in two collections size). If returned collection is empty, no locking will happen, if single element, one lock will be used, if two then two named locks will be used etc.

Note: name mapper must not use same string for artifacts and metadata, so even the simplest possible implementation like StaticNameMapper uses two different static strings.

Specified by:

nameLocks in interface NameMapper