org.nuxeo.ecm.webapp.edit.lock

Class LockActionsBean

java.lang.Object

org.nuxeo.ecm.webapp.edit.lock.LockActionsBean

All Implemented Interfaces:

Serializable, LockActions

@Name(value="lockActions")
 @Scope(value=EVENT)
 @Install(precedence=10)
public class LockActionsBean
extends Object
implements LockActions

This is the action listener that knows to decide if an user has the right to take the lock or release the lock of a document.

Most of the logic of this bean should either be moved into a DocumentModel adapter or directly into the core API.

Author:

Bogdan Tatar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LockActionsBean.UnrestrictedUnlocker

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreSession	documentManager
protected org.jboss.seam.faces.FacesMessages	facesMessages
protected ResourcesAccessor	resourcesAccessor
protected WebActions	webActions

Fields inherited from interface org.nuxeo.ecm.webapp.edit.lock.LockActions

LOCK_CREATED, LOCKER

Constructor Summary

Constructors

Constructor and Description
LockActionsBean()

Method Summary

Modifier and Type	Method and Description
Boolean	getCanLockCurrentDoc() Tests if the user can get the lock of the current document.
Boolean	getCanLockDoc(DocumentModel document) Tests if the user can get the lock of a document.
Boolean	getCanUnlockCurrentDoc() Tests if the user can unlock the current document.
Boolean	getCanUnlockDoc(DocumentModel document) Tests if the user can unlock a document.
Map<String,Serializable>	getCurrentDocLockDetails() Gets the details about the lock of the current document, who did the lock and when the lock took place.
Map<String,Serializable>	getLockDetails(DocumentModel document) Gets the details about the lock of a document,who did the lock and when the lock took place.
Action	getLockOrUnlockAction() Returns the action of lock or unlock for a document.
protected boolean	isManagerOnDocument(DocumentRef ref)
String	lockCurrentDocument() Gets the lock of the current document.
String	lockDocument(DocumentModel document) Gets the lock of the document.
void	resetEventContext()
void	resetLockState()
String	unlockCurrentDocument() Releases the lock of the current document.
String	unlockDocument(DocumentModel document) Releases the lock of the document.

Methods inherited from class java.lang.Object

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

Field Detail

facesMessages

@In(create=true,
    required=false)
protected transient org.jboss.seam.faces.FacesMessages facesMessages

resourcesAccessor

@In(create=true)
protected transient ResourcesAccessor resourcesAccessor

webActions

@In(create=true)
protected transient WebActions webActions

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

Constructor Detail

LockActionsBean

public LockActionsBean()

Method Detail

getCanLockDoc

public Boolean getCanLockDoc(DocumentModel document)

Description copied from interface: LockActions

Tests if the user can get the lock of a document.

Specified by:

getCanLockDoc in interface LockActions

Returns:

true if the user has this right, false otherwise

isManagerOnDocument

protected boolean isManagerOnDocument(DocumentRef ref)

getCanLockCurrentDoc

@Factory(value="currentDocumentCanBeLocked",
         scope=EVENT)
public Boolean getCanLockCurrentDoc()

Description copied from interface: LockActions

Tests if the user can get the lock of the current document.

Specified by:

getCanLockCurrentDoc in interface LockActions

Returns:

true if the user has this right, false otherwise

resetEventContext

@Observer(value="userAllDocumentTypesSelectionChanged",
          create=false)
 @BypassInterceptors
public void resetEventContext()

getCanUnlockDoc

public Boolean getCanUnlockDoc(DocumentModel document)

Description copied from interface: LockActions

Tests if the user can unlock a document.

Specified by:

getCanUnlockDoc in interface LockActions

Returns:

true if the user has this right, false otherwise

getCanUnlockCurrentDoc

@Factory(value="currentDocumentCanBeUnlocked",
         scope=EVENT)
public Boolean getCanUnlockCurrentDoc()

Description copied from interface: LockActions

Tests if the user can unlock the current document.

Specified by:

getCanUnlockCurrentDoc in interface LockActions

Returns:

true if the user has this right, false otherwise

lockCurrentDocument

public String lockCurrentDocument()

Description copied from interface: LockActions

Gets the lock of the current document.

Specified by:

lockCurrentDocument in interface LockActions

lockDocument

public String lockDocument(DocumentModel document)

Description copied from interface: LockActions

Gets the lock of the document.

Specified by:

lockDocument in interface LockActions

Parameters:

document - the document of which lock is to be taken

unlockCurrentDocument

public String unlockCurrentDocument()

Description copied from interface: LockActions

Releases the lock of the current document.

Specified by:

unlockCurrentDocument in interface LockActions

unlockDocument

public String unlockDocument(DocumentModel document)

Description copied from interface: LockActions

Releases the lock of the document.

Specified by:

unlockDocument in interface LockActions

Parameters:

document - the document of which lock is to be released

getLockOrUnlockAction

public Action getLockOrUnlockAction()

Description copied from interface: LockActions

Returns the action of lock or unlock for a document.

Specified by:

getLockOrUnlockAction in interface LockActions

Returns:

the action of lock or unlock for a document

getCurrentDocLockDetails

@Factory(value="currentDocumentLockDetails",
         scope=EVENT)
public Map<String,Serializable> getCurrentDocLockDetails()

Description copied from interface: LockActions

Gets the details about the lock of the current document, who did the lock and when the lock took place.

Specified by:

getCurrentDocLockDetails in interface LockActions

Returns:

the user who took the look and the time when he/she did this in a map

getLockDetails

public Map<String,Serializable> getLockDetails(DocumentModel document)

Description copied from interface: LockActions

Gets the details about the lock of a document,who did the lock and when the lock took place.

Specified by:

getLockDetails in interface LockActions

Parameters:

document - the document for which this information is needed

Returns:

the user who took the look and the time when he/she did this in a map

resetLockState

@BypassInterceptors
public void resetLockState()

Specified by:

resetLockState in interface LockActions