Package org.ametys.cms.trash.element

Class TrashElementDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.trash.element.TrashElementDAO

All Implemented Interfaces:

TrashElementDAO, LogEnabled, Component, Serviceable

Direct Known Subclasses:

WebTrashElementDAO

public class TrashElementDAO
extends AbstractLogEnabled
implements TrashElementDAO, Serviceable, Component

TrashElementDAO to manage TrashElements.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TrashElementDAO.RestorationReport	Describe the result of a restore operation.

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	the Ametys object resolver

Fields inherited from interface org.ametys.plugins.repository.trash.TrashElementDAO

ROLE

Constructor Summary

Constructors

Constructor	Description
TrashElementDAO()

Method Summary

Modifier and Type	Method	Description
TrashElement	createTrashElement(TrashableAmetysObject ametysObject, String title)	Instantiate a new trash element where the ametys object can store data to be able to restore itself later
void	empty(long lifetime)	Empty the trash.
protected <A> A	executeInTrashSession(Function<javax.jcr.Session,A> functionToExecute)	Execute a function into the trash workspace.
TrashElement	find(String ametysObjectId)	Find a trash element linked to a trashed ametys object.
protected ModifiableTraversableAmetysObject	getOrCreateCollection(ModifiableTraversableAmetysObject parent, String collectionName)	Get or create an Ametys object collection on the given parent
protected ModifiableTraversableAmetysObject	getOrCreateRoot(TrashableAmetysObject ametysObject)	Get or create the trash root
void	remove(String trashElementId)	Remove the TrashElement and its linked objects.
<A extends AmetysObject> A	resolve(String ametysObjectId)	Resolve the AmetysObject into the trash workspace.
TrashElementDAO.RestorationReport	restore(String trashElementId)	Restore the TrashElement and its linked objects.
void	service(ServiceManager serviceManager)
TrashElement	trash(TrashableAmetysObject ametysObject)	Trash the AmetysObject.
TrashElement	trash(TrashableAmetysObject ametysObject, boolean hidden, String[] linkedObjects)	Trash the AmetysObject.

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

_resolver

protected AmetysObjectResolver _resolver

the Ametys object resolver

Constructor Details

TrashElementDAO

public TrashElementDAO()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

resolve

public <A extends AmetysObject> A resolve(String ametysObjectId)

Resolve the AmetysObject into the trash workspace.

Type Parameters:

A - The type of the returned AmetysObject.

Parameters:

ametysObjectId - The identifier

Returns:

the resolved Ametys object, can be null if not found

find

public TrashElement find(String ametysObjectId)

Find a trash element linked to a trashed ametys object.

Parameters:

ametysObjectId - The ametys object id

Returns:

the TrashElement, can be null if not found

empty

public void empty(long lifetime)
           throws javax.jcr.RepositoryException

Empty the trash.

Parameters:

lifetime - Number of days before the trash has to be emptied. 0 or less empty all elements.

Throws:

javax.jcr.RepositoryException - if an error occurs

trash

public TrashElement trash(TrashableAmetysObject ametysObject)

Trash the AmetysObject.

Parameters:

ametysObject - The Ametys object

Returns:

the TrashElement created while moving the object to the trash

trash

public TrashElement trash(TrashableAmetysObject ametysObject,
 boolean hidden,
 String[] linkedObjects)

Trash the AmetysObject.

Parameters:

ametysObject - The Ametys object

hidden - true if it is an object trashed by another one

linkedObjects - The list of linked objects to the current object to trash. Linked objects can be also trashed, but it is not mandatory.

Returns:

the TrashElement created while moving the object to the trash

createTrashElement

public TrashElement createTrashElement(TrashableAmetysObject ametysObject,
 String title)

Description copied from interface: TrashElementDAO

Instantiate a new trash element where the ametys object can store data to be able to restore itself later

Specified by:

createTrashElement in interface TrashElementDAO

Parameters:

ametysObject - the ametys object to trash

title - the title of the element

Returns:

the trash element

remove

public void remove(String trashElementId)

Remove the TrashElement and its linked objects.

Parameters:

trashElementId - The trash element identifier to remove

restore

public TrashElementDAO.RestorationReport restore(String trashElementId)
                                          throws UnknownParentException

Restore the TrashElement and its linked objects.

Parameters:

trashElementId - The trash element identifier to restore

Returns:

a report of the operation

Throws:

UnknownParentException - if its not possible to obtains a parent to restore into

getOrCreateRoot

protected ModifiableTraversableAmetysObject getOrCreateRoot(TrashableAmetysObject ametysObject)

Get or create the trash root

Parameters:

ametysObject - the object that need to be trashed

Returns:

the trash where the ametys will be trashed

getOrCreateCollection

protected ModifiableTraversableAmetysObject getOrCreateCollection(ModifiableTraversableAmetysObject parent,
 String collectionName)

Get or create an Ametys object collection on the given parent

Parameters:

parent - The parent

collectionName - The collection name

Returns:

The AmetysObjectCollection

executeInTrashSession

protected <A> A executeInTrashSession(Function<javax.jcr.Session,A> functionToExecute)

Execute a function into the trash workspace. This method only handles the creation of the session. The caller is responsible for logging out (either in the function itself or by using the returned value).

Type Parameters:

A - The returned type, can be anything. If it is Void, the function should return null

Parameters:

functionToExecute - The function to execute, it takes a Session as parameter

Returns:

The result of the function