Package org.eclipse.aether.named.support

Class NamedLockFactorySupport

java.lang.Object

org.eclipse.aether.named.support.NamedLockFactorySupport

All Implemented Interfaces:

NamedLockFactory

Direct Known Subclasses:

FileLockNamedLockFactory, LocalReadWriteLockNamedLockFactory, LocalSemaphoreNamedLockFactory, NoopNamedLockFactory

public abstract class NamedLockFactorySupport
extends Object
implements NamedLockFactory

Support class for NamedLockFactory implementations providing reference counting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	NamedLockFactorySupport.NamedLockHolder

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	DIAGNOSTIC_ENABLED	System property key to enable locking diagnostic collection.
private final boolean	diagnosticEnabled
private final ConcurrentMap<String,NamedLockFactorySupport.NamedLockHolder>	locks
protected final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
NamedLockFactorySupport()
NamedLockFactorySupport(boolean diagnosticEnabled)

Method Summary

Modifier and Type	Method	Description
void	closeLock(String name)
protected abstract NamedLockSupport	createLock(String name)	Implementations shall create and return NamedLockSupport for given name, this method must never return null.
protected void	destroyLock(String name)	Implementation may override this (empty) method to perform some sort of implementation specific cleanup for given lock name.
NamedLockSupport	getLock(String name)	Creates or reuses existing NamedLock.
boolean	isDiagnosticEnabled()	Returns true if factory diagnostic collection is enabled.
<E extends Throwable> E	onFailure(E failure)	Method to notify factory about locking failure, to make it possible to provide more (factory specific) information about factory state when a locking operation failed.
void	shutdown()	Performs a clean shut down of the factory.

Methods inherited from class java.lang.Object

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

Field Details

DIAGNOSTIC_ENABLED

private static final boolean DIAGNOSTIC_ENABLED

System property key to enable locking diagnostic collection.

Since:

1.9.11

logger

protected final org.slf4j.Logger logger

locks

private final ConcurrentMap<String,NamedLockFactorySupport.NamedLockHolder> locks

diagnosticEnabled

private final boolean diagnosticEnabled

Constructor Details

NamedLockFactorySupport

public NamedLockFactorySupport()

NamedLockFactorySupport

public NamedLockFactorySupport(boolean diagnosticEnabled)

Method Details

isDiagnosticEnabled

public boolean isDiagnosticEnabled()

Returns true if factory diagnostic collection is enabled.

Since:

1.9.11

getLock

public NamedLockSupport getLock(String name)

Description copied from interface: NamedLockFactory

Creates or reuses existing NamedLock. Returns instance MUST BE treated as "resource", best in try-with-resource block.

Specified by:

getLock in interface NamedLockFactory

Parameters:

name - the lock name, must not be null.

Returns:

named lock instance, never null.

shutdown

public void shutdown()

Description copied from interface: NamedLockFactory

Performs a clean shut down of the factory.

Specified by:

shutdown in interface NamedLockFactory

onFailure

public <E extends Throwable> E onFailure(E failure)

Description copied from interface: NamedLockFactory

Method to notify factory about locking failure, to make it possible to provide more (factory specific) information about factory state when a locking operation failed. Factory may alter provided failure or provide information via some other side effect (for example via logging).

The default implementation merely does what happened before: adds no extra information.

Specified by:

onFailure in interface NamedLockFactory

closeLock

public void closeLock(String name)

createLock

protected abstract NamedLockSupport createLock(String name)

Implementations shall create and return NamedLockSupport for given name, this method must never return null.

destroyLock

protected void destroyLock(String name)

Implementation may override this (empty) method to perform some sort of implementation specific cleanup for given lock name. Invoked when reference count for given name drops to zero and named lock was removed.