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

Class URLPathLock

java.lang.Object

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

All Implemented Interfaces:

PathLock

public class URLPathLock
extends Object
implements PathLock

A PathLock which is based on locks obtained through a lockFactory. The lock's keys are generated through the external form of a URL

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
URLPathLock(URL url, org.mule.runtime.api.lock.LockFactory lockFactory) Creates a new instance

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

URLPathLock

public URLPathLock(URL url,
                   org.mule.runtime.api.lock.LockFactory lockFactory)

Creates a new instance

Parameters:

url - the URL from which the lock's key is to be extracted

lockFactory - a LockFactory

Method Detail

tryLock

public 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 PathLock.release() method is eventually invoked on this same instance.

Specified by:

tryLock in interface PathLock

Returns:

true if the lock could be obtained. false otherwise.

isLocked

public boolean isLocked()

Specified by:

isLocked in interface PathLock

Returns:

whether the lock is currently owned by this instance

release

public void release()

Releases the lock that was previously obtained by invoking PathLock.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.

Specified by:

release in interface PathLock