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 java.lang.Object
implements NamedLockFactory

Support class for NamedLockFactory implementations providing reference counting.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	logger
static java.lang.String	SYSTEM_PROP_DIAGNOSTIC_ENABLED	System property key to enable locking diagnostic collection.

Constructor Summary

Constructors

Constructor	Description
NamedLockFactorySupport()
NamedLockFactorySupport(boolean diagnosticEnabled)

Method Summary

Modifier and Type	Method	Description
void	closeLock(NamedLockKey key)
protected abstract NamedLockSupport	createLock(NamedLockKey key)	Implementations shall create and return NamedLockSupport for given name, this method must never return null.
protected void	destroyLock(NamedLock namedLock)	Implementation may override this (empty) method to perform some sort of implementation specific cleanup for given lock name.
protected NamedLock	doGetLock(java.util.Collection<NamedLockKey> keys)
protected void	doShutdown()
NamedLock	getLock(java.util.Collection<NamedLockKey> keys)	Creates or reuses existing NamedLock.
protected NamedLock	getLockAndRefTrack(NamedLockKey key, java.util.function.Supplier<NamedLockSupport> supplier)
boolean	isDiagnosticEnabled()	Returns true if factory diagnostic collection is enabled.
<E extends java.lang.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

Methods inherited from interface org.eclipse.aether.named.NamedLockFactory

getLock

Field Detail

SYSTEM_PROP_DIAGNOSTIC_ENABLED

public static final java.lang.String SYSTEM_PROP_DIAGNOSTIC_ENABLED

System property key to enable locking diagnostic collection.

Since:

1.9.11

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Constructor Detail

NamedLockFactorySupport

public NamedLockFactorySupport()

NamedLockFactorySupport

public NamedLockFactorySupport(boolean diagnosticEnabled)

Method Detail

isDiagnosticEnabled

public boolean isDiagnosticEnabled()

Returns true if factory diagnostic collection is enabled.

Since:

1.9.11

getLock

public final NamedLock getLock(java.util.Collection<NamedLockKey> keys)

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:

keys - the lock keys, must not be null and must not be empty collection.

Returns:

named lock instance, never null.

doGetLock

protected NamedLock doGetLock(java.util.Collection<NamedLockKey> keys)

getLockAndRefTrack

protected NamedLock getLockAndRefTrack(NamedLockKey key,
                                       java.util.function.Supplier<NamedLockSupport> supplier)

shutdown

public void shutdown()

Description copied from interface: NamedLockFactory

Performs a clean shut down of the factory.

Specified by:

shutdown in interface NamedLockFactory

doShutdown

protected void doShutdown()

onFailure

public <E extends java.lang.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(NamedLockKey key)

createLock

protected abstract NamedLockSupport createLock(NamedLockKey key)

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

destroyLock

protected void destroyLock(NamedLock namedLock)

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.