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 forNamedLockFactory
implementations providing reference counting.
-
-
Field Summary
Fields Modifier and Type Field Description protected org.slf4j.Logger
logger
-
Constructor Summary
Constructors Constructor Description NamedLockFactorySupport()
NamedLockFactorySupport(boolean diagnosticEnabled)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
closeLock(java.lang.String name)
protected abstract NamedLockSupport
createLock(java.lang.String name)
Implementations shall create and returnNamedLockSupport
for givenname
, this method must never returnnull
.protected void
destroyLock(java.lang.String name)
Implementation may override this (empty) method to perform some sort of implementation specific cleanup for given lock name.NamedLockSupport
getLock(java.lang.String name)
Creates or reuses existingNamedLock
.boolean
isDiagnosticEnabled()
Returnstrue
if factory diagnostic collection is enabled.<E extends java.lang.Throwable>
EonFailure(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.
-
-
-
Field Detail
-
logger
protected final org.slf4j.Logger logger
-
-
Constructor Detail
-
NamedLockFactorySupport
public NamedLockFactorySupport()
-
NamedLockFactorySupport
public NamedLockFactorySupport(boolean diagnosticEnabled)
-
-
Method Detail
-
isDiagnosticEnabled
public boolean isDiagnosticEnabled()
Returnstrue
if factory diagnostic collection is enabled.- Since:
- 1.9.11
-
getLock
public NamedLockSupport getLock(java.lang.String name)
Description copied from interface:NamedLockFactory
Creates or reuses existingNamedLock
. Returns instance MUST BE treated as "resource", best in try-with-resource block.- Specified by:
getLock
in interfaceNamedLockFactory
- Parameters:
name
- the lock name, must not benull
.- 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 interfaceNamedLockFactory
-
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 interfaceNamedLockFactory
-
closeLock
public void closeLock(java.lang.String name)
-
createLock
protected abstract NamedLockSupport createLock(java.lang.String name)
Implementations shall create and returnNamedLockSupport
for givenname
, this method must never returnnull
.
-
destroyLock
protected void destroyLock(java.lang.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.
-
-