org.alfresco.repo.webdav

Interface LockStore

All Known Implementing Classes:

LockStoreImpl, SimpleLockStore

public interface LockStore

Provides storage for WebDAV lock information.

Note: the existence of LockInfo does NOT mean that a node is necessarily locked. It may have timed-out, been unlocked, or be left in an invalid state for some reason. The LockInfo is a record of a requested lock - the actual values should be examined as necessary.

Implementations of this interface should be fast, ideally an in-memory map. Implementations should also be thread- and cluster-safe (if used in a cluster).

Method Summary

Methods

Modifier and Type	Method and Description
LockInfo	get(org.alfresco.service.cmr.repository.NodeRef nodeRef) Retrieves LockInfo for as given nodeRef.
void	put(org.alfresco.service.cmr.repository.NodeRef nodeToLock, LockInfo lockInfo) Provide LockInfo about a specific node to the LockStore.
void	remove(org.alfresco.service.cmr.repository.NodeRef nodeRef) Remove LockInfo for the specified NodeRef.

Method Detail

put

void put(org.alfresco.service.cmr.repository.NodeRef nodeToLock,
       LockInfo lockInfo)

Provide LockInfo about a specific node to the LockStore.

Parameters:

nodeToLock -

lockInfo -

get

LockInfo get(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Retrieves LockInfo for as given nodeRef. The LockInfo may specify that a node is NOT locked, so the LockInfo should always be checked for validity.

The presence of LockInfo does not imply that a node is locked.

Parameters:

nodeRef -

Returns:

remove

void remove(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Remove LockInfo for the specified NodeRef. The LockInfo cannot be considered locked once removed from the LockStore.

Parameters:

nodeRef -