Files
alfresco-community-repo/source/java/org/alfresco/repo/webdav/WebDAVLockService.java
Alan Davis 3e1e1edbaa Merged 5.2.N (5.2.1) to HEAD (5.2)
125788 rmunteanu: Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
      125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
         125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@127810 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-06-03 17:08:06 +00:00

91 lines
3.1 KiB
Java

/*
* #%L
* Alfresco Remote API
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* 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/>.
* #L%
*/
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(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
*
* @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 HttpSession
*/
void setCurrentSession(HttpSession session);
}