mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
Moving to root below branch label
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
244
source/java/org/alfresco/service/cmr/lock/LockService.java
Normal file
244
source/java/org/alfresco/service/cmr/lock/LockService.java
Normal file
@@ -0,0 +1,244 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.lock;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.repository.StoreRef;
|
||||
|
||||
|
||||
/**
|
||||
* Interface for public and internal lock operations.
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public interface LockService
|
||||
{
|
||||
/**
|
||||
* Places a lock on a node.
|
||||
* <p>
|
||||
* The lock prevents any other user or process from comitting updates
|
||||
* to the node untill the lock is released.
|
||||
* <p>
|
||||
* The user reference passed indicates who the owner of the lock is.
|
||||
* <p>
|
||||
* A lock made with this call will never expire.
|
||||
*
|
||||
* @param nodeRef a reference to a node
|
||||
* @param userName a reference to the user that will own the lock
|
||||
* @param lockType the lock type
|
||||
* @throws UnableToAquireLockException
|
||||
* thrown if the lock could not be obtained
|
||||
*/
|
||||
public void lock(NodeRef nodeRef, LockType lockType)
|
||||
throws UnableToAquireLockException;
|
||||
|
||||
/**
|
||||
* Places a lock on a node.
|
||||
* <p>
|
||||
* The lock prevents any other user or process from comitting updates
|
||||
* to the node untill the lock is released.
|
||||
* <p>
|
||||
* The user reference passed indicates who the owner of the lock is.
|
||||
* <p>
|
||||
* If the time to expire is 0 then the lock will never expire. Otherwise the
|
||||
* timeToExpire indicates the number of seconds before the lock expires. When
|
||||
* a lock expires the lock is considered to have been released.
|
||||
* <p>
|
||||
* If the node is already locked and the user is the lock owner then the lock will
|
||||
* be renewed with the passed timeToExpire.
|
||||
*
|
||||
* @param nodeRef a reference to a node
|
||||
* @param userName a reference to the user that will own the lock
|
||||
* @param lockType the lock type
|
||||
* @param timeToExpire the number of seconds before the locks expires.
|
||||
* @throws UnableToAquireLockException
|
||||
* thrown if the lock could not be obtained
|
||||
*/
|
||||
public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire)
|
||||
throws UnableToAquireLockException;
|
||||
|
||||
/**
|
||||
* Places a lock on a node and optionally on all its children.
|
||||
* <p>
|
||||
* The lock prevents any other user or process from comitting updates
|
||||
* to the node untill the lock is released.
|
||||
* <p>
|
||||
* The user reference passed indicates who the owner of the lock(s) is.
|
||||
* If any one of the child locks can not be taken then an exception will
|
||||
* be raised and all locks canceled.
|
||||
* <p>
|
||||
* If the time to expire is 0 then the lock will never expire. Otherwise the
|
||||
* timeToExpire indicates the number of seconds before the lock expires. When
|
||||
* a lock expires the lock is considered to have been released.
|
||||
* <p>
|
||||
* If the node is already locked and the user is the lock owner then the lock will
|
||||
* be renewed with the passed timeToExpire.
|
||||
*
|
||||
* @param nodeRef a reference to a node
|
||||
* @param userName a reference to the user that will own the lock(s)
|
||||
* @param lockType the lock type
|
||||
* @param timeToExpire the number of seconds before the locks expires.
|
||||
* @param lockChildren if true indicates that all the children (and
|
||||
* grandchildren, etc) of the node will also be locked,
|
||||
* false otherwise
|
||||
*
|
||||
* @throws UnableToAquireLockException
|
||||
* thrown if the lock could not be obtained
|
||||
*/
|
||||
public void lock(NodeRef nodeRef, LockType lockType, int timeToExpire, boolean lockChildren)
|
||||
throws UnableToAquireLockException;
|
||||
|
||||
/**
|
||||
* Places a lock on all the nodes referenced in the passed list.
|
||||
* <p>
|
||||
* The lock prevents any other user or process from comitting updates
|
||||
* to the node untill the lock is released.
|
||||
* <p>
|
||||
* The user reference passed indicates who the owner of the lock(s) is.
|
||||
* If any one of the child locks can not be taken then an exception will
|
||||
* be raised and all locks canceled.
|
||||
* <p>
|
||||
* If the time to expire is 0 then the lock will never expire. Otherwise the
|
||||
* timeToExpire indicates the number of seconds before the lock expires. When
|
||||
* a lock expires the lock is considered to have been released.
|
||||
* <p>
|
||||
* If the node is already locked and the user is the lock owner then the lock will
|
||||
* be renewed with the passed timeToExpire.
|
||||
*
|
||||
* @param nodeRefs a list of node references
|
||||
* @param userName a reference to the user that will own the lock(s)
|
||||
* @param lockType the type of lock being created
|
||||
* @param timeToExpire the number of seconds before the locks expires.
|
||||
* @throws UnableToAquireLockException
|
||||
* thrown if the lock could not be obtained
|
||||
*/
|
||||
public void lock(Collection<NodeRef> nodeRefs, LockType lockType, int timeToExpire)
|
||||
throws UnableToAquireLockException;
|
||||
|
||||
/**
|
||||
* Removes the lock on a node.
|
||||
* <p>
|
||||
* The user must have sufficient permissions to remove the lock (ie: be the
|
||||
* owner of the lock or have admin rights) otherwise an exception will be raised.
|
||||
*
|
||||
* @param nodeRef a reference to a node
|
||||
* @param userName the user reference
|
||||
* @throws UnableToReleaseLockException
|
||||
* thrown if the lock could not be released
|
||||
*/
|
||||
public void unlock(NodeRef nodeRef)
|
||||
throws UnableToReleaseLockException;
|
||||
|
||||
/**
|
||||
* Removes the lock on a node and optional on its children.
|
||||
* <p>
|
||||
* The user must have sufficient permissions to remove the lock(s) (ie: be
|
||||
* the owner of the lock(s) or have admin rights) otherwise an exception
|
||||
* will be raised.
|
||||
* <p>
|
||||
* If one of the child nodes is not locked then it will be ignored and
|
||||
* the process continue without error.
|
||||
* <p>
|
||||
* If the lock on any one of the child nodes cannot be released then an
|
||||
* exception will be raised.
|
||||
*
|
||||
* @param nodeRef a node reference
|
||||
* @param userName the user reference
|
||||
* @param lockChildren if true then all the children (and grandchildren, etc)
|
||||
* of the node will also be unlocked, false otherwise
|
||||
* @throws UnableToReleaseLockException
|
||||
* thrown if the lock could not be released
|
||||
*/
|
||||
public void unlock(NodeRef nodeRef, boolean lockChildren)
|
||||
throws UnableToReleaseLockException;
|
||||
|
||||
/**
|
||||
* Removes a lock on the nodes provided.
|
||||
* <p>
|
||||
* The user must have sufficient permissions to remove the locks (ie: be
|
||||
* the owner of the locks or have admin rights) otherwise an exception
|
||||
* will be raised.
|
||||
* <p>
|
||||
* If one of the nodes is not locked then it will be ignored and the
|
||||
* process will continue without an error.
|
||||
* <p>
|
||||
* If the lock on any one of the nodes cannot be released than an exception
|
||||
* will be raised and the process rolled back.
|
||||
*
|
||||
* @param nodeRefs the node references
|
||||
* @param userName the user reference
|
||||
* @throws UnableToReleaseLockException
|
||||
* thrown if the lock could not be released
|
||||
*/
|
||||
public void unlock(Collection<NodeRef> nodeRefs)
|
||||
throws UnableToReleaseLockException;
|
||||
|
||||
/**
|
||||
* Gets the lock status for the node reference relative to the current user.
|
||||
*
|
||||
* @see LockService#getLockStatus(NodeRef, NodeRef)
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @return the lock status
|
||||
*/
|
||||
public LockStatus getLockStatus(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Gets the lock type for the node indicated.
|
||||
* <p>
|
||||
* Returns null if the node is not locked.
|
||||
* <p>
|
||||
* Throws an exception if the node does not have the lock aspect.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
* @return the lock type, null is returned if the object in question has no
|
||||
* lock
|
||||
*/
|
||||
public LockType getLockType(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Checks to see if the node is locked or not. Gets the user reference from the current
|
||||
* session.
|
||||
* <p>
|
||||
* Throws a NodeLockedException based on the lock status of the lock, the user ref and the
|
||||
* lock type.
|
||||
*
|
||||
* @param nodeRef the node reference
|
||||
*/
|
||||
public void checkForLock(NodeRef nodeRef);
|
||||
|
||||
/**
|
||||
* Get all the node references that the current user has locked.
|
||||
*
|
||||
* @param storeRef the store reference
|
||||
* @return a list of nodes that the current user has locked.
|
||||
*/
|
||||
public List<NodeRef> getLocks(StoreRef storeRef);
|
||||
|
||||
/**
|
||||
* Get all the node references that the current user has locked filtered by the provided lock type.
|
||||
*
|
||||
* @param storeRef the store reference
|
||||
* @param lockType the lock type to filter the results by
|
||||
*
|
||||
* @return a list of nodes that the current user has locked filtered by the lock type provided
|
||||
*/
|
||||
public List<NodeRef> getLocks(StoreRef storeRef, LockType lockType);
|
||||
}
|
||||
30
source/java/org/alfresco/service/cmr/lock/LockStatus.java
Normal file
30
source/java/org/alfresco/service/cmr/lock/LockStatus.java
Normal file
@@ -0,0 +1,30 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.lock;
|
||||
|
||||
/**
|
||||
* Enum used to indicate lock status.
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public enum LockStatus
|
||||
{
|
||||
NO_LOCK, // Indicates that there is no lock present
|
||||
LOCKED, // Indicates that the node is locked
|
||||
LOCK_OWNER, // Indicates that the node is locked and you have lock ownership rights
|
||||
LOCK_EXPIRED // Indicates that the lock has expired and the node can be considered to be unlocked
|
||||
}
|
||||
24
source/java/org/alfresco/service/cmr/lock/LockType.java
Normal file
24
source/java/org/alfresco/service/cmr/lock/LockType.java
Normal file
@@ -0,0 +1,24 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.lock;
|
||||
|
||||
/**
|
||||
* Enum used to indicate lock type
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public enum LockType {READ_ONLY_LOCK, WRITE_LOCK}
|
||||
@@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.lock;
|
||||
|
||||
import java.text.MessageFormat;
|
||||
|
||||
import org.alfresco.error.AlfrescoRuntimeException;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
|
||||
/**
|
||||
* Node locked exception class
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public class NodeLockedException extends AlfrescoRuntimeException
|
||||
{
|
||||
/**
|
||||
* Serial version UID
|
||||
*/
|
||||
private static final long serialVersionUID = 3762254149525582646L;
|
||||
|
||||
/**
|
||||
* Error message
|
||||
*/
|
||||
private static final String ERROR_MESSAGE = "Can not perform operation since " +
|
||||
"the node (id:{0}) is locked by another user.";
|
||||
private static final String ERROR_MESSAGE_2 = "Can not perform operation {0} since " +
|
||||
"the node (id:{1}) is locked by another user.";
|
||||
|
||||
/**
|
||||
* @param message
|
||||
*/
|
||||
public NodeLockedException(NodeRef nodeRef)
|
||||
{
|
||||
super(MessageFormat.format(ERROR_MESSAGE, new Object[]{nodeRef.getId()}));
|
||||
}
|
||||
|
||||
public NodeLockedException(NodeRef nodeRef, String operation)
|
||||
{
|
||||
super(MessageFormat.format(ERROR_MESSAGE_2, new Object[]{operation, nodeRef.getId()}));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.lock;
|
||||
|
||||
import java.text.MessageFormat;
|
||||
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
|
||||
/**
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public class UnableToAquireLockException extends RuntimeException
|
||||
{
|
||||
/**
|
||||
* Serial version UID
|
||||
*/
|
||||
private static final long serialVersionUID = 3258689892710889781L;
|
||||
|
||||
/**
|
||||
* Error message
|
||||
*/
|
||||
private final static String ERROR_MESSAGE = "The node (id: {0})could not be locked since it" +
|
||||
" is already locked by antoher user.";
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public UnableToAquireLockException(NodeRef nodeRef)
|
||||
{
|
||||
super(MessageFormat.format(ERROR_MESSAGE, new Object[]{nodeRef.getId()}));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.service.cmr.lock;
|
||||
|
||||
import java.text.MessageFormat;
|
||||
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
|
||||
/**
|
||||
* Runtime exception class
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
public class UnableToReleaseLockException extends RuntimeException
|
||||
{
|
||||
/**
|
||||
* Serial verison UID
|
||||
*/
|
||||
private static final long serialVersionUID = 3257565088071432243L;
|
||||
|
||||
/**
|
||||
* Error message
|
||||
*/
|
||||
private static final String ERROR_MESSAGE =
|
||||
"You have insufficent priveleges to realese the " +
|
||||
"lock on the node (id: {0}). The node is locked by " +
|
||||
"another user.";
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public UnableToReleaseLockException(NodeRef nodeRef)
|
||||
{
|
||||
super(MessageFormat.format(ERROR_MESSAGE, new Object[]{nodeRef.getId()}));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user