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

Class DefaultNamedLockFactorySelector

java.lang.Object

org.eclipse.aether.internal.impl.named.DefaultNamedLockFactorySelector

All Implemented Interfaces:

NamedLockFactorySelector

@Singleton
@Named
public class DefaultNamedLockFactorySelector
extends Object
implements NamedLockFactorySelector

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROP_FACTORY_NAME	Name of the lock factory to use in system.
static final String	CONFIG_PROP_LOCK_WAIT_TIME	The maximum amount of time to be blocked, while obtaining a named lock.
static final String	CONFIG_PROP_LOCK_WAIT_TIME_UNIT	The unit of maximum amount of time.
static final String	CONFIG_PROPS_PREFIX
static final String	DEFAULT_FACTORY_NAME
static final long	DEFAULT_LOCK_WAIT_TIME
static final String	DEFAULT_LOCK_WAIT_TIME_UNIT
protected final Map<String,NamedLockFactory>	factories
protected final org.slf4j.Logger	logger
protected final ConcurrentMap<String,NamedLockFactory>	usedFactories

Constructor Summary

Constructors

Constructor	Description
DefaultNamedLockFactorySelector(Map<String,NamedLockFactory> factories, RepositorySystemLifecycle lifecycle)

Method Summary

Modifier and Type	Method	Description
Set<String>	getAvailableLockFactories()	Returns immutable set of available lock factory names, to be used for logging purposes or alike.
long	getLockWaitTime(Map<String,?> configuration)	Returns the maximum amount of time to be blocked, while obtaining a named lock, based on configuration.
TimeUnit	getLockWaitTimeUnit(Map<String,?> configuration)	Returns the unit of maximum amount of time based on configuration.
NamedLockFactory	getNamedLockFactory(Map<String,?> configuration)	Selects NamedLockFactory based on configuration.

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_PROPS_PREFIX

public static final String CONFIG_PROPS_PREFIX

See Also:

• Constant Field Values

CONFIG_PROP_FACTORY_NAME

public static final String CONFIG_PROP_FACTORY_NAME

Name of the lock factory to use in system. Out of the box supported ones are "file-lock", "rwlock-local", "semaphore-local", "noop". By adding extensions one can extend available lock factories (for example IPC locking).

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

String

Default value:

DEFAULT_FACTORY_NAME

DEFAULT_FACTORY_NAME

public static final String DEFAULT_FACTORY_NAME

See Also:

• Constant Field Values

CONFIG_PROP_LOCK_WAIT_TIME

public static final String CONFIG_PROP_LOCK_WAIT_TIME

The maximum amount of time to be blocked, while obtaining a named lock.

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Long

Default value:

DEFAULT_LOCK_WAIT_TIME

DEFAULT_LOCK_WAIT_TIME

public static final long DEFAULT_LOCK_WAIT_TIME

See Also:

• Constant Field Values

CONFIG_PROP_LOCK_WAIT_TIME_UNIT

public static final String CONFIG_PROP_LOCK_WAIT_TIME_UNIT

The unit of maximum amount of time. Accepts TimeUnit enum names.

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

String

Default value:

DEFAULT_LOCK_WAIT_TIME_UNIT

DEFAULT_LOCK_WAIT_TIME_UNIT

public static final String DEFAULT_LOCK_WAIT_TIME_UNIT

See Also:

• Constant Field Values

logger

protected final org.slf4j.Logger logger

factories

protected final Map<String,NamedLockFactory> factories

usedFactories

protected final ConcurrentMap<String,NamedLockFactory> usedFactories

Constructor Details

DefaultNamedLockFactorySelector

@Inject
public DefaultNamedLockFactorySelector(Map<String,NamedLockFactory> factories,
 RepositorySystemLifecycle lifecycle)

Method Details

getAvailableLockFactories

public Set<String> getAvailableLockFactories()

Description copied from interface: NamedLockFactorySelector

Returns immutable set of available lock factory names, to be used for logging purposes or alike. Never returns null.

Specified by:

getAvailableLockFactories in interface NamedLockFactorySelector

getNamedLockFactory

public NamedLockFactory getNamedLockFactory(Map<String,?> configuration)

Description copied from interface: NamedLockFactorySelector

Selects NamedLockFactory based on configuration. Never returns null but may throw in case of invalid configuration.

Specified by:

getNamedLockFactory in interface NamedLockFactorySelector

Parameters:

configuration - The configuration maps, must be not null.

getLockWaitTime

public long getLockWaitTime(Map<String,?> configuration)

Description copied from interface: NamedLockFactorySelector

Returns the maximum amount of time to be blocked, while obtaining a named lock, based on configuration. May throw in case of invalid configuration.

Specified by:

getLockWaitTime in interface NamedLockFactorySelector

Parameters:

configuration - The configuration maps, must be not null.

getLockWaitTimeUnit

public TimeUnit getLockWaitTimeUnit(Map<String,?> configuration)

Description copied from interface: NamedLockFactorySelector

Returns the unit of maximum amount of time based on configuration. Never returns null but may throw in case of invalid configuration.

Specified by:

getLockWaitTimeUnit in interface NamedLockFactorySelector

Parameters:

configuration - The configuration maps, must be not null.