TrashManager (JCMS API)

java.lang.Object
- com.jalios.jcms.trash.TrashManager

All Implemented Interfaces:

JPropertiesListener
```
public class TrashManager
extends java.lang.Object
implements JPropertiesListener
```
Manager of Trash related action and configuration.

Since:

jcms-10.0.5 / JCMS-8353

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`IS_AUTOMATIC_TRASH_DELETE` Name of attribute added in context map during performDelete() to indicate delete is being automatically after a specific period in the trash.
`static java.lang.String`	`PROP_AUTOMATIC_DELETE_DELAY` Name of property from which delay (in days) before automatic delete is read.
`static java.lang.String`	`PROP_AUTOMATIC_DELETE_ENABLED` Name of property from which automatic delete after a specific duration is enabled or not.
`static java.lang.String`	`PROP_AUTOMATIC_DELETE_SCHEDULE` Name of property from which automatic delete schedule is read (jdring cron syntax).
`static java.lang.String`	`PROP_FINAL_DELETE_ENABLED` Name of property from which option to propose final delete (to end user) for trashable type is read (i.e.
`static java.lang.String`	`PROP_TRASHABLE_TYPES` Name of property from which trashable types is read (i.e.
`static java.util.Set<java.lang.Class<? extends Publication>>`	`TRASHABLE_TYPES_DEFAULT` Default configuration of trashable types (i.e.

Fields inherited from interface com.jalios.util.JPropertiesListener
REVISION

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.time.Duration`	`getAutoDeleteDelay()` Retrieve the duration publications are kept in trash before being permanently deleted automatically (if auto delete is enabled).
`static TrashManager`	`getInstance()` Retrieve the TrashManager singleton intance
`java.util.Set<java.lang.Class<? extends Publication>>`	`getTrashableTypes()` Retrieve publication class authorized to be put in trash.
`boolean`	`isAutoDeleteEnabled()` Check if automatic delete is enabled
`boolean`	`isFinalDeleteEnabled()` Check if final delete should be proposed to end user for enabled
`boolean`	`isTrashableClass(java.lang.Class<? extends Publication> clazz)` Check if an instance of the specified Publication class can be put in trash
`void`	`propertiesChange(JProperties properties)` Invoked after properties have been modified in JCMS and save on disk.
`boolean`	`proposeFinalDeleteAction(Publication pub, Member loggedMember)` Check if final delete action should be proposed for the specified publication given current logged member.
`boolean`	`proposeTrashAction(Publication pub)` Check if Trash action should be proposed for the specified publication

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - IS_AUTOMATIC_TRASH_DELETE
```
public static final java.lang.String IS_AUTOMATIC_TRASH_DELETE
```
    Name of attribute added in context map during performDelete() to indicate delete is being automatically after a specific period in the trash.
    
    See Also:
    
    Constant Field Values
  - PROP_AUTOMATIC_DELETE_ENABLED
```
public static final java.lang.String PROP_AUTOMATIC_DELETE_ENABLED
```
    Name of property from which automatic delete after a specific duration is enabled or not.
    
    See Also:
    
    Constant Field Values
  - PROP_AUTOMATIC_DELETE_DELAY
```
public static final java.lang.String PROP_AUTOMATIC_DELETE_DELAY
```
    Name of property from which delay (in days) before automatic delete is read.
    
    See Also:
    
    Constant Field Values
  - PROP_AUTOMATIC_DELETE_SCHEDULE
```
public static final java.lang.String PROP_AUTOMATIC_DELETE_SCHEDULE
```
    Name of property from which automatic delete schedule is read (jdring cron syntax).
    
    See Also:
    
    Constant Field Values
  - PROP_TRASHABLE_TYPES
```
public static final java.lang.String PROP_TRASHABLE_TYPES
```
    Name of property from which trashable types is read (i.e. types which can be put in trash).
    
    See Also:
    
    Constant Field Values
  - PROP_FINAL_DELETE_ENABLED
```
public static final java.lang.String PROP_FINAL_DELETE_ENABLED
```
    Name of property from which option to propose final delete (to end user) for trashable type is read (i.e. types which can be put in trash).
    If true, final delete action will be displayed to all users. If false, final delete action will only be displayed to administrators.
    
    See Also:
    
    Constant Field Values
  - TRASHABLE_TYPES_DEFAULT
```
public static final java.util.Set<java.lang.Class<? extends Publication>> TRASHABLE_TYPES_DEFAULT
```
    Default configuration of trashable types (i.e. types which can be put in trash).
- Method Detail
  - getInstance
```
public static TrashManager getInstance()
```
    Retrieve the TrashManager singleton intance
    
    Returns:
    
    the singleton instance
  - propertiesChange
```
public void propertiesChange(JProperties properties)
```
    Description copied from interface: JPropertiesListener
    
    Invoked after properties have been modified in JCMS and save on disk.
    You cannot alter the value received in parameters.
    
    Specified by:
    
    propertiesChange in interface JPropertiesListener
    
    Parameters:
    
    properties - the properties which have been modified (may not contain all JCMS properties)
  - isAutoDeleteEnabled
```
public boolean isAutoDeleteEnabled()
```
    Check if automatic delete is enabled
    
    Returns:
    
    true if enabled, false otherwise
  - getAutoDeleteDelay
```
public java.time.Duration getAutoDeleteDelay()
```
    Retrieve the duration publications are kept in trash before being permanently deleted automatically (if auto delete is enabled).
    
    Returns:
    
    a duration, never return null
  - getTrashableTypes
```
public java.util.Set<java.lang.Class<? extends Publication>> getTrashableTypes()
```
    Retrieve publication class authorized to be put in trash.
    
    Returns:
    
    a Set of Class, never return null.
  - isTrashableClass
```
public boolean isTrashableClass(java.lang.Class<? extends Publication> clazz)
```
    Check if an instance of the specified Publication class can be put in trash
    
    Parameters:
    
    clazz - a publication subclass class
    
    Returns:
    
    true if it can be put in trash, false if it cannot
  - isFinalDeleteEnabled
```
public boolean isFinalDeleteEnabled()
```
    Check if final delete should be proposed to end user for enabled
    
    Returns:
    
    true if to propose , false otherwise
  - proposeTrashAction
```
public boolean proposeTrashAction(Publication pub)
```
    Check if Trash action should be proposed for the specified publication
    
    Parameters:
    
    pub - the Publication for which trash action display is verified
    
    Returns:
    
    true if Trash action will be displayed, false otherwsie
  - proposeFinalDeleteAction
```
public boolean proposeFinalDeleteAction(Publication pub,
                                        Member loggedMember)
```
    Check if final delete action should be proposed for the specified publication given current logged member.
    
    Parameters:
    
    pub - the Publication for which final delete action display is verified
    
    loggedMember - the current
    
    Returns:
    
    true if final delete action should be proposed, false otherwise

Class TrashManager

Field Summary

Fields inherited from interface com.jalios.util.JPropertiesListener

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IS_AUTOMATIC_TRASH_DELETE

PROP_AUTOMATIC_DELETE_ENABLED

PROP_AUTOMATIC_DELETE_DELAY

PROP_AUTOMATIC_DELETE_SCHEDULE

PROP_TRASHABLE_TYPES

PROP_FINAL_DELETE_ENABLED

TRASHABLE_TYPES_DEFAULT

Method Detail

getInstance

propertiesChange

isAutoDeleteEnabled

getAutoDeleteDelay

getTrashableTypes

isTrashableClass

isFinalDeleteEnabled

proposeTrashAction

proposeFinalDeleteAction