org.phenotips.locks

Interface DocumentLockManager

@Unstable(value="New API introduced in 1.4")
 @Role
public interface DocumentLockManager

Allows acquiring and releasing locks on specific documents. Acquiring locks is a blocking operation, the method will hang until the document is released.

Since:

1.3.7, 1.4

Version:

$Id: 3b2e09f4d0aa3cdc2ca50e2582ece1bfc9cc993f $

Method Summary

Modifier and Type	Method and Description
void	lock(org.xwiki.model.reference.DocumentReference document) Lock a document.
void	unlock(org.xwiki.model.reference.DocumentReference document) Unlock a document.

Method Detail

lock

void lock(@Nonnull
          org.xwiki.model.reference.DocumentReference document)

Lock a document. This method will block until the lock is successfully obtained.

Parameters:

document - the document to lock

unlock

void unlock(@Nonnull
            org.xwiki.model.reference.DocumentReference document)

Unlock a document.

Parameters:

document - the document to unlock