org.nuxeo.ecm.core.trash

Class TrashServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.trash.TrashServiceImpl

All Implemented Interfaces:

TrashService, Adaptable, Component, Extensible, TimestampedService

public class TrashServiceImpl
extends DefaultComponent
implements TrashService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TrashServiceImpl.PathComparator Path-based comparator used to put folders before their children.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	COLLISION_PATTERN Matches names resulting from a collision, suffixed with a time in milliseconds, created by DuplicatedNameFixer.
protected static Pattern	TRASHED_PATTERN Matches names of documents in the trash, created by trashDocument(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.api.DocumentModel).

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Constructor Summary

Constructors

Constructor and Description
TrashServiceImpl()

Method Summary

Modifier and Type	Method and Description
boolean	canDelete(List<DocumentModel> docs, Principal principal, boolean checkProxies) Is at least one doc deletable?
boolean	canPurgeOrUndelete(List<DocumentModel> docs, Principal principal) Are all documents purgeable/undeletable?
boolean	canUndelete(List<DocumentModel> docs)
boolean	checkDeletePermOnParents(List<DocumentModel> docs) Is at least one doc deletable according to its container?
boolean	folderAllowsDelete(DocumentModel folder) Can a child of the folder be deleted?
DocumentModel	getAboveDocument(DocumentModel doc, Set<Path> rootPaths) Gets the closest document's ancestor above all the paths.
protected static String	getDocumentLocker(DocumentModel doc)
DocumentModelList	getDocuments(DocumentModel currentDoc) Get all documents from the trash of the current document.
protected TrashInfo	getInfo(List<DocumentModel> docs, Principal principal, boolean checkProxies, boolean checkDeleted)
TrashInfo	getTrashInfo(List<DocumentModel> docs, Principal principal, boolean checkProxies, boolean checkDeleted) Gets the trash info for a list of documents.
String	mangleName(DocumentModel doc) Mangles the name of a document to avoid collisions with non-trashed documents when it's in the trash.
protected void	notifyEvent(CoreSession session, String eventId, DocumentModel doc)
void	purgeDocuments(CoreSession session, List<DocumentRef> docRefs) Purges (completely deletes) documents .
protected void	trashDocument(CoreSession session, DocumentModel doc)
void	trashDocuments(List<DocumentModel> docs) Moves documents to the trash, or directly deletes them if their lifecycle does not allow trash use.
protected void	undeleteAncestors(CoreSession session, DocumentRef docRef, Set<DocumentRef> undeleted) Undeletes ancestors of a document.
protected void	undeleteDocument(CoreSession session, DocumentModel doc)
protected Set<DocumentRef>	undeleteDocumentList(CoreSession session, List<DocumentModel> docs) Undeletes a list of documents.
Set<DocumentRef>	undeleteDocuments(List<DocumentModel> docs) Undeletes documents (and ancestors if needed to make them visible).
protected static boolean	underOneOf(Path testedPath, Set<Path> paths)
String	unmangleName(DocumentModel doc) Unmangles the name of a document in the trash to find its un-trashed name.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, deactivate, getAdapter, getLastModified, registerContribution, registerExtension, setLastModified, setModifiedNow, start, stop, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

Field Detail

TRASHED_PATTERN

protected static final Pattern TRASHED_PATTERN

Matches names of documents in the trash, created by trashDocument(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.api.DocumentModel).

COLLISION_PATTERN

protected static final Pattern COLLISION_PATTERN

Matches names resulting from a collision, suffixed with a time in milliseconds, created by DuplicatedNameFixer. We also attempt to remove this when getting a doc out of the trash.

Constructor Detail

TrashServiceImpl

public TrashServiceImpl()

Method Detail

folderAllowsDelete

public boolean folderAllowsDelete(DocumentModel folder)

Description copied from interface: TrashService

Can a child of the folder be deleted?

Specified by:

folderAllowsDelete in interface TrashService

Parameters:

folder - the folder

Returns:

true if the folder allows its children to be deleted

checkDeletePermOnParents

public boolean checkDeletePermOnParents(List<DocumentModel> docs)

Description copied from interface: TrashService

Is at least one doc deletable according to its container?

Specified by:

checkDeletePermOnParents in interface TrashService

Parameters:

docs - the documents

Returns:

true if one doc is in a folder that allows its children to be deleted

canDelete

public boolean canDelete(List<DocumentModel> docs,
                         Principal principal,
                         boolean checkProxies)

Description copied from interface: TrashService

Is at least one doc deletable?

Specified by:

canDelete in interface TrashService

Parameters:

docs - the documents

principal - the current user (to check locks)

checkProxies - true to count proxies as non-deletable

Returns:

true if at least one doc is deletable

canPurgeOrUndelete

public boolean canPurgeOrUndelete(List<DocumentModel> docs,
                                  Principal principal)

Description copied from interface: TrashService

Are all documents purgeable/undeletable?

Documents need to be in the deleted lifecycle state for this to be true, in addition to the standard permission checks.

Specified by:

canPurgeOrUndelete in interface TrashService

Parameters:

docs - the documents

principal - the current user (to check locks)

Returns:

true if the documents are purgeable/undeletable

canUndelete

public boolean canUndelete(List<DocumentModel> docs)

getInfo

protected TrashInfo getInfo(List<DocumentModel> docs,
                            Principal principal,
                            boolean checkProxies,
                            boolean checkDeleted)

getDocumentLocker

protected static String getDocumentLocker(DocumentModel doc)

getTrashInfo

public TrashInfo getTrashInfo(List<DocumentModel> docs,
                              Principal principal,
                              boolean checkProxies,
                              boolean checkDeleted)

Description copied from interface: TrashService

Gets the trash info for a list of documents.

Specified by:

getTrashInfo in interface TrashService

Parameters:

docs - the documents

principal - the current user (to check locks)

checkProxies - true to count proxies as non-deletable

checkDeleted - true if documents have to be in the deleted state to be considered (otherwise forbidden)

Returns:

the trash info

getAboveDocument

public DocumentModel getAboveDocument(DocumentModel doc,
                                      Set<Path> rootPaths)

Description copied from interface: TrashService

Gets the closest document's ancestor above all the paths.

This is used to find what safe document to redirect to when deleting some.

Specified by:

getAboveDocument in interface TrashService

Parameters:

doc - the document

rootPaths - the paths

Returns:

the closer document above doc and above all the paths

underOneOf

protected static boolean underOneOf(Path testedPath,
                                    Set<Path> paths)

trashDocuments

public void trashDocuments(List<DocumentModel> docs)

Description copied from interface: TrashService

Moves documents to the trash, or directly deletes them if their lifecycle does not allow trash use.

Do nothing if the document current state is deleted.

Placeless documents are deleted immediately.

Specified by:

trashDocuments in interface TrashService

Parameters:

docs - the documents to trash

purgeDocuments

public void purgeDocuments(CoreSession session,
                           List<DocumentRef> docRefs)

Description copied from interface: TrashService

Purges (completely deletes) documents .

Specified by:

purgeDocuments in interface TrashService

Parameters:

session - the session

docRefs - the documents to purge

undeleteDocuments

public Set<DocumentRef> undeleteDocuments(List<DocumentModel> docs)

Description copied from interface: TrashService

Undeletes documents (and ancestors if needed to make them visible).

Also fires async events to undelete the children.

Specified by:

undeleteDocuments in interface TrashService

Parameters:

docs - the documents to undelete

Returns:

the set of ancestors whose children have been undeleted (for UI notification)

notifyEvent

protected void notifyEvent(CoreSession session,
                           String eventId,
                           DocumentModel doc)

undeleteDocumentList

protected Set<DocumentRef> undeleteDocumentList(CoreSession session,
                                                List<DocumentModel> docs)

Undeletes a list of documents. Session is not saved. Log about non-deletable documents.

undeleteAncestors

protected void undeleteAncestors(CoreSession session,
                                 DocumentRef docRef,
                                 Set<DocumentRef> undeleted)

Undeletes ancestors of a document. Session is not saved. Stops as soon as an ancestor is not undeletable.

mangleName

public String mangleName(DocumentModel doc)

Description copied from interface: TrashService

Mangles the name of a document to avoid collisions with non-trashed documents when it's in the trash.

Specified by:

mangleName in interface TrashService

Parameters:

doc - the document

Returns:

unmangleName

public String unmangleName(DocumentModel doc)

Description copied from interface: TrashService

Unmangles the name of a document in the trash to find its un-trashed name.

Specified by:

unmangleName in interface TrashService

Parameters:

doc - the trashed document

Returns:

the unmangled name

trashDocument

protected void trashDocument(CoreSession session,
                             DocumentModel doc)

undeleteDocument

protected void undeleteDocument(CoreSession session,
                                DocumentModel doc)

getDocuments

public DocumentModelList getDocuments(DocumentModel currentDoc)

Get all documents from the trash of the current document.

Specified by:

getDocuments in interface TrashService

Parameters:

currentDoc - The current/parent document of trash document.

Returns:

All documents in the trash of the current document.