Class WebDAVLockServiceImpl

  • All Implemented Interfaces:
    WebDAVLockService

    public class WebDAVLockServiceImpl
    extends Object
    implements WebDAVLockService

    WebDAVLockService is used to manage file locks for WebDAV and Sharepoint protocol. It ensures a lock never persists for more than 24 hours, and also ensures locks are timed out on session timeout.

    Author:
    Pavel.Yurkevich
    • Constructor Detail

      • WebDAVLockServiceImpl

        public WebDAVLockServiceImpl()
    • Method Detail

      • setLockService

        public void setLockService​(LockService lockService)
        Set the LockService
        Parameters:
        lockService - LockService
      • setNodeService

        public void setNodeService​(NodeService nodeService)
        Set the NodeService
        Parameters:
        nodeService - NodeService
      • setTransactionService

        public void setTransactionService​(TransactionService transactionService)
        Set the TransactionService
        Parameters:
        transactionService - TransactionService
      • setCheckOutCheckInService

        public void setCheckOutCheckInService​(CheckOutCheckInService checkOutCheckInService)
        Set the CheckOutCheckInService
        Parameters:
        checkOutCheckInService - CheckOutCheckInService
      • setCurrentSession

        public void setCurrentSession​(javax.servlet.http.HttpSession session)
        Caches current session to the thread local variable
        Specified by:
        setCurrentSession in interface WebDAVLockService
        Parameters:
        session - HttpSession
      • lock

        public void lock​(NodeRef nodeRef,
                         String userName,
                         int timeout)
        Shared method for webdav/vti protocols to lock node. If node is locked for more than 24 hours it is automatically added to the current session locked resources list.
        Specified by:
        lock in interface WebDAVLockService
        Parameters:
        nodeRef - the node to lock
        userName - userName
        timeout - the number of seconds before the locks expires
      • unlock

        public void unlock​(NodeRef nodeRef)
        Shared method for webdav/vti to unlock node. Unlocked node is automatically removed from current sessions's locked resources list.
        Specified by:
        unlock in interface WebDAVLockService
        Parameters:
        nodeRef - the node to lock
      • isLockedAndReadOnly

        public boolean isLockedAndReadOnly​(NodeRef nodeRef)
        Determines if the node is locked AND it's not a WRITE_LOCK for the current user.

        Specified by:
        isLockedAndReadOnly in interface WebDAVLockService
        Returns:
        true if the node is locked AND it's not a WRITE_LOCK for the current user