org.exoplatform.officeonline

Class WOPILockManagerPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.officeonline.WOPILockManagerPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class WOPILockManagerPlugin
extends org.exoplatform.container.component.BaseComponentPlugin

The Class WOPILockManagerPlugin is used to manage locks for WOPI.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CACHE_NAME The Constant CACHE_NAME.
protected static long	EXPIRES_DELAY The Constant EXPIRES_DELAY.
protected ScheduledExecutorService	expiresExecutor The executor for removing expired locks.
protected org.exoplatform.services.jcr.RepositoryService	jcrService The jcr service.
protected static long	LOCK_EXPIRES The Constant LOCK_EXPIRES.
protected org.exoplatform.services.cache.ExoCache<String,FileLock>	locks The locks.
protected org.exoplatform.services.cms.lock.LockService	lockService The lock service.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected static String	MIX_LOCKABLE The Constant MIX_LOCKABLE.
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviders The session providers.

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
WOPILockManagerPlugin(org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.cms.lock.LockService lockService) Instantiates a new WOPI lock manager plugin.

Method Summary

Modifier and Type	Method and Description
FileLock	getLock(javax.jcr.Node node) Gets the lock from cache.
protected javax.jcr.Session	getSystemSession() Gets the system session.
protected javax.jcr.Session	getUserSession(String workspace) Gets the user session.
void	lock(javax.jcr.Node node, String lockId) Locks the node with provided lockId, stores the lock in the cache.
void	refreshLock(javax.jcr.Node node, String lockId) Refreshes lock by prolonging the lock expires.
protected void	removeExpired() Removes the expired locks or locks with expiration time less than EXPIRES_DELAY.
void	unlock(javax.jcr.Node node, String lockId, String workspace) Unlocks the node with provided lockId.

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

locks

protected org.exoplatform.services.cache.ExoCache<String,FileLock> locks

The locks.

CACHE_NAME

protected static final String CACHE_NAME

The Constant CACHE_NAME.

MIX_LOCKABLE

protected static final String MIX_LOCKABLE

The Constant MIX_LOCKABLE.

See Also:

Constant Field Values

LOG

protected static final org.exoplatform.services.log.Log LOG

The Constant LOG.

LOCK_EXPIRES

protected static final long LOCK_EXPIRES

The Constant LOCK_EXPIRES.

See Also:

Constant Field Values

EXPIRES_DELAY

protected static final long EXPIRES_DELAY

The Constant EXPIRES_DELAY.

See Also:

Constant Field Values

sessionProviders

protected org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders

The session providers.

jcrService

protected org.exoplatform.services.jcr.RepositoryService jcrService

The jcr service.

lockService

protected org.exoplatform.services.cms.lock.LockService lockService

The lock service.

expiresExecutor

protected ScheduledExecutorService expiresExecutor

The executor for removing expired locks.

Constructor Detail

WOPILockManagerPlugin

public WOPILockManagerPlugin(org.exoplatform.services.cache.CacheService cacheService,
                             org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                             org.exoplatform.services.jcr.RepositoryService jcrService,
                             org.exoplatform.services.cms.lock.LockService lockService)

Instantiates a new WOPI lock manager plugin.

Parameters:

cacheService - the cache service

sessionProviders - the session providers

jcrService - the jcr service

lockService - the lock service

Method Detail

lock

public void lock(javax.jcr.Node node,
                 String lockId)
          throws javax.jcr.RepositoryException,
                 LockMismatchException

Locks the node with provided lockId, stores the lock in the cache. Refreshes the lock if the node is locked and lockIds matches.

Parameters:

node - the node

lockId - the lock id

Throws:

javax.jcr.RepositoryException - the repository exception

LockMismatchException - the lock mismatch exception

getLock

public FileLock getLock(javax.jcr.Node node)
                 throws javax.jcr.RepositoryException

Gets the lock from cache.

Parameters:

node - the node

Returns:

the lock or null, if the node isn't locked

Throws:

javax.jcr.RepositoryException - the repository exception

unlock

public void unlock(javax.jcr.Node node,
                   String lockId,
                   String workspace)
            throws javax.jcr.RepositoryException,
                   LockMismatchException

Unlocks the node with provided lockId.

Parameters:

node - the node

lockId - the lock id

workspace - the workspace

Throws:

javax.jcr.RepositoryException - the repository exception

LockMismatchException - if the node isn't locked of provided lockId doesn't match the current one

refreshLock

public void refreshLock(javax.jcr.Node node,
                        String lockId)
                 throws javax.jcr.RepositoryException,
                        LockMismatchException

Refreshes lock by prolonging the lock expires.

Parameters:

node - the node

lockId - the lock id

Throws:

javax.jcr.RepositoryException - the repository exception

LockMismatchException - the lock mismatch exception

getUserSession

protected javax.jcr.Session getUserSession(String workspace)
                                    throws javax.jcr.RepositoryException

Gets the user session.

Parameters:

workspace - the workspace

Returns:

the user session

Throws:

javax.jcr.RepositoryException - the repository exception

getSystemSession

protected javax.jcr.Session getSystemSession()
                                      throws javax.jcr.RepositoryException

Gets the system session.

Returns:

the system session

Throws:

javax.jcr.RepositoryException - the repository exception

removeExpired

protected void removeExpired()

Removes the expired locks or locks with expiration time less than EXPIRES_DELAY.