Package org.ametys.plugins.workspaces.documents

Class WorkspaceExplorerTrashDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceDAO

org.ametys.plugins.workspaces.documents.WorkspaceExplorerTrashDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class WorkspaceExplorerTrashDAO
extends AbstractWorkspaceDAO

DAO for handling trash in document workspaces

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	WorkspaceExplorerTrashDAO.TrashDocument	Record to hold trash document information

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RIGHTS_HANDLE_TRASH	Rights to handle trash
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceDAO

_context, _currentUserProvider, _observationManager, _projectManager, _projectRightHelper, _projectTagsDAO, _resolver, _richTextTransformer, _rightManager, _userManager, _workflowHelper, _workflowProvider, _workspaceHelper, _workspaceModuleEP

Constructor Summary

Constructors

Constructor	Description
WorkspaceExplorerTrashDAO()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_extractTrashedFileData(WorkspaceExplorerTrashDAO.TrashDocument trashDocument)	Internal method to extract the valuable data of a trashed file
protected Map<String,Object>	_extractTrashedFolderData(WorkspaceExplorerTrashDAO.TrashDocument trashDocument)	Internal method to extract the valuable data of a trashed folder
Map<String,Object>	deleteFromTrash(String trashElementId)	Delete an object from trash
Map<String,Object>	emptyTrash()	Empty all file and folders from trash
Map<String,Object>	getTrashFoldersAndFiles()	Get the child folders and files
long	getUsedTrashStorageSpace(Project project)	Get the used space size (in bytes) for the current project
Map<String,Object>	restoreFromTrash(String trashElementId, String mergeComputationModeId)	Restore an object from trash
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceDAO

_checkReadAccess, _checkUserReadingRights, _checkUserRights, _hasAfterSubComments, _setAttachments, answerComment, contextualize, createComment, deleteComment, editComment, getProjectName, getSitemapLanguage, getSiteName, likeOrUnlikeComment

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

RIGHTS_HANDLE_TRASH

public static final String RIGHTS_HANDLE_TRASH

Rights to handle trash

See Also:

• Constant Field Values

Constructor Details

WorkspaceExplorerTrashDAO

public WorkspaceExplorerTrashDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkspaceDAO

Throws:

ServiceException

getTrashFoldersAndFiles

public Map<String,Object> getTrashFoldersAndFiles()

Get the child folders and files

Returns:

the child folders and files

restoreFromTrash

public Map<String,Object> restoreFromTrash(String trashElementId,
 String mergeComputationModeId)

Restore an object from trash

Parameters:

trashElementId - the trash element id

mergeComputationModeId - the merge computation mode, used to know how to behave when restoring an existing element. May be null.

Returns:

the result map

deleteFromTrash

public Map<String,Object> deleteFromTrash(String trashElementId)

Delete an object from trash

Parameters:

trashElementId - the trash element id

Returns:

the result map

getUsedTrashStorageSpace

public long getUsedTrashStorageSpace(Project project)

Get the used space size (in bytes) for the current project

Parameters:

project - the project

Returns:

the used space size (in bytes)

_extractTrashedFolderData

protected Map<String,Object> _extractTrashedFolderData(WorkspaceExplorerTrashDAO.TrashDocument trashDocument)

Internal method to extract the valuable data of a trashed folder

Parameters:

trashDocument - the trash document

Returns:

the valuable folder data

_extractTrashedFileData

protected Map<String,Object> _extractTrashedFileData(WorkspaceExplorerTrashDAO.TrashDocument trashDocument)

Internal method to extract the valuable data of a trashed file

Parameters:

trashDocument - the trash document

Returns:

the valuable file data

emptyTrash

public Map<String,Object> emptyTrash()

Empty all file and folders from trash

Returns:

the result map