org.opencms.ade.sitemap

类 CmsAliasEditorLockTable

java.lang.Object

org.opencms.ade.sitemap.CmsAliasEditorLockTable

public class CmsAliasEditorLockTable
extends java.lang.Object

A class used to keep track of which user is editing the alias table from which sites.

It consists of a table from site roots to users. The entries of the table will be removed if they haven't been updated in a given interval of time, but can also be removed manually.

字段概要

字段

限定符和类型	字段和说明
static long	TIMEOUT_INTERVAL The interval after which a lock which has not been updated will be removed.

构造器概要

构造器

构造器和说明
CmsAliasEditorLockTable() Creates a new lock table instance.

方法概要

方法

限定符和类型	方法和说明
void	clear(CmsObject cms, java.lang.String siteRoot) Clears the entry for a given site root, but only if the user from the given CMS context matches the user in the entry.
CmsUser	update(CmsObject cms, java.lang.String siteRoot) Tries to update or create an entry for the given user/site root combination.

从类继承的方法 java.lang.Object

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

字段详细资料

TIMEOUT_INTERVAL

public static final long TIMEOUT_INTERVAL

The interval after which a lock which has not been updated will be removed.

另请参阅:

常量字段值

构造器详细资料

CmsAliasEditorLockTable

public CmsAliasEditorLockTable()

Creates a new lock table instance.

方法详细资料

clear

public void clear(CmsObject cms,
         java.lang.String siteRoot)

Clears the entry for a given site root, but only if the user from the given CMS context matches the user in the entry.

参数:

cms - the current CMS context

siteRoot - the site root for which the entry should be cleared

update

public CmsUser update(CmsObject cms,
             java.lang.String siteRoot)

Tries to update or create an entry for the given user/site root combination.

If this method succeeds, it will return null, but if another user has created an entry for the site root, it will return that user.

参数:

cms - the current CMS context

siteRoot - the site root

返回:

null of the user who has already created an entry