org.opencms.lock

Class CmsLockUtil

java.lang.Object

org.opencms.lock.CmsLockUtil

public final class CmsLockUtil
extends java.lang.Object

Locking utility class.

Method Summary

Methods

Modifier and Type	Method and Description
static CmsLockActionRecord	ensureLock(CmsObject cms, CmsResource resource) Static helper method to lock a resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ensureLock

public static CmsLockActionRecord ensureLock(CmsObject cms,
                             CmsResource resource)
                                      throws CmsException

Static helper method to lock a resource.

Parameters:

cms - the CMS context to use

resource - the resource to lock

Returns:

the action that was taken

Throws:

CmsException - if something goes wrong