Files
alfresco-community-repo/source/java/org/alfresco/repo/webdav/WebDAVLockService.java
Dave Ward 65a802b9c8 Merged V4.1-BUG-FIX to HEAD
47581: Merged DEV to V4.1-BUG-FIX (with corrections)
      47557: ALF-16846 : Checkout version from Microsoft Office does not work
      AlfrescoCheckOutCheckInServiceHandler.checkOutDocument() was changed. Now we unlock before checkout if current user is LOCK_OWNER and a node has a WRITE_LOCK lock type. 
   47584: Remove unused import
   47586: Merged V3.4-BUG-FIX to V4.1-BUG-FIX
      47583: Add serialVersionUID for Path$Element (see ALF-18265)
   47599: Set Surf version to 1.2.0-SNAPSHOT in POMs
   47616: Workaround ALF-16888: NodeServiceTest.testConcurrentArchive() failing on DB2
    - This test no longer runs on DB2
    - Unable to find configuration that allows it to succeed
   47640: Merged PATCHES/V4.1.4 to V4.1-BUG-FIX
      47576: Merged DEV to PATCHES/V4.1.4
         47560: ALF-18248 : Upgrade from 3.2.2 to 4.1.4 fails with java.lang.NullPointerException when applying patch 'patch.thumbnailsAssocQName'
         Test for null value was added to the QNamePatch#applyInternal() method.
      47638: ALF-18258: Alfresco does not start with XAM module applied
      - Broke circular dependency in storeSelectorContentStoreBase
      47639: ALF-18249: Fixed performance-killing typo discovered by Kev!
      - One innocent ! sign got lost


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@47642 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2013-03-06 12:20:33 +00:00

84 lines
2.8 KiB
Java

/*
* Copyright (C) 2005-2012 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.webdav;
import javax.servlet.http.HttpSession;
import org.alfresco.service.cmr.lock.LockService;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* 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
* @author Matt Ward
*/
public interface WebDAVLockService
{
static final String BEAN_NAME = "webDAVLockService";
@SuppressWarnings("unchecked")
void sessionDestroyed();
/**
* 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.
*
* @param nodeRef the node to lock
* @param userName the current user's user name
* @param timeout the number of seconds before the locks expires
*/
void lock(NodeRef nodeRef, String userName, int timeout);
void lock(NodeRef nodeRef, LockInfo lockInfo);
/**
* Shared method for webdav/vti to unlock node. Unlocked node is automatically removed from
* current sessions's locked resources list.
*
* @param nodeRef the node to lock
*/
void unlock(NodeRef nodeRef);
/**
* Gets the lock info for the node reference relative to the current user.
*
* @see LockService#getLockStatus(NodeRef, NodeRef)
*
* @param nodeRef the node reference
* @return the lock status
*/
LockInfo getLockInfo(NodeRef nodeRef);
/**
* Determines if the node is locked AND it's not a WRITE_LOCK for the current user.<p>
*
* @return true if the node is locked AND it's not a WRITE_LOCK for the current user
*/
public boolean isLockedAndReadOnly(NodeRef nodeRef);
/**
* Caches current session in a thread local variable.
*
* @param session
*/
void setCurrentSession(HttpSession session);
}