org.mule.extension.file.common.api.lock

Interface PathLock

All Known Implementing Classes:

NullPathLock, URLPathLock

public interface PathLock

Use to generate a lock on a file reference by a path.

The extent of such lock depends on the actual implementation. For some implementations it will be possible to create a lock at a file system level. For other implementations this might not be possible (mainly depending on the targeted file system) and thus will use different locking mechanisms.

All implementations of this interface must be (naturally) thread-safe and reentrant, meaning that a lock can be re obtained on this instance it's been released

Since:

1.0

Method Summary

Modifier and Type	Method and Description
boolean	isLocked()
void	release() Releases the lock that was previously obtained by invoking tryLock() on this instance with a true return value.
boolean	tryLock() Attempts to obtain a lock on the referenced path.

Method Detail

tryLock

boolean tryLock()

Attempts to obtain a lock on the referenced path.

Just like with any locking API, any component invoking this method on this and obtaining true as a return value MUST make sure that the release() method is eventually invoked on this same instance.

Returns:

true if the lock could be obtained. false otherwise.

isLocked

boolean isLocked()

Returns:

whether the lock is currently owned by this instance

release

void release()

Releases the lock that was previously obtained by invoking tryLock() on this instance with a true return value.

This method will not fail if no such lock was ever obtained or has already been released.