Package org.ametys.cms.workflow.purge

Class PurgeContentsSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

org.ametys.cms.workflow.purge.PurgeContentsSchedulable

All Implemented Interfaces:

Schedulable, LogEnabled, PluginAware, Initializable, Component, Configurable, Contextualizable, Serviceable

public class PurgeContentsSchedulable
extends AbstractStaticSchedulable
implements Initializable

Schedulable that removes old versions of contents.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysResolver	The ametys object resolver.
protected String	_baseUrl	The server base URL.
protected int	_firstVersionsToKeep	The count of oldest versions to keep.
protected I18nUtils	_i18nUtils	The i18n utils.
protected String	_mailFrom	The content of "from" field in emails.
protected SourceResolver	_sourceResolver	The avalon source resolver.
protected String	_sysadminMail	The sysadmin mail address, to which will be sent the report e-mail.
protected Map<String,Long>	_validationStepId	A Map of the validation step ID by workflow name.
protected PurgeVersionsManager	_versionPurger	The version purger.
protected WorkflowProvider	_workflowProvider	The workflow provider

Fields inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

_acceptConcurrentExecution, _context, _description, _iconGlyph, _iconLarge, _iconMedium, _iconSmall, _id, _label, _parameters, _pluginName, _private, _schedulableParameterTypeExtensionPoint, _smanager, _startTime, _userManager, PROGRESSION_TRACKER

Constructor Summary

Constructors

Constructor	Description
PurgeContentsSchedulable()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
protected Map<String,Long>	configureValidationStepId(Configuration configuration)	Get the validation step ID by workflow from the component configuration.
void	execute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	The action to perform when a trigger is fired.
protected Map<String,String>	getEmailParams(Date startDate, Date endDate, int totalContentsPurged, int totalVersionsPurged)	Get the report e-mail parameters.
protected Map<String,String>	getErrorEmailParams(Date startDate, Throwable throwable)	Get the error e-mail parameters.
protected String	getErrorMailUri(Map<String,String> parameters)	Get the pipeline uri for error mail body.
protected String	getMailBody(Map<String,String> parameters)	Get a mail part.
protected String	getMailUri(Map<String,String> parameters)	Get the pipeline uri for mail body
void	initialize()
protected void	sendErrorMail(Date startDate, Throwable throwable)	Send the error e-mail.
protected void	sendMail(Date startDate, Date endDate, int totalContentsPurged, int totalVersionsPurged)	Send the purge report e-mail.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

acceptConcurrentExecution, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, getProgressionTracker, isPrivate, setPluginInfo

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

_baseUrl

protected String _baseUrl

The server base URL.

_ametysResolver

protected AmetysObjectResolver _ametysResolver

The ametys object resolver.

_sourceResolver

protected SourceResolver _sourceResolver

The avalon source resolver.

_versionPurger

protected PurgeVersionsManager _versionPurger

The version purger.

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_validationStepId

protected Map<String,Long> _validationStepId

A Map of the validation step ID by workflow name.

_firstVersionsToKeep

protected int _firstVersionsToKeep

The count of oldest versions to keep.

_mailFrom

protected String _mailFrom

The content of "from" field in emails.

_sysadminMail

protected String _sysadminMail

The sysadmin mail address, to which will be sent the report e-mail.

Constructor Details

PurgeContentsSchedulable

public PurgeContentsSchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticSchedulable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticSchedulable

Throws:

ConfigurationException

configureValidationStepId

protected Map<String,Long> configureValidationStepId(Configuration configuration)
                                              throws ConfigurationException

Get the validation step ID by workflow from the component configuration.

Parameters:

configuration - the component configuration.

Returns:

a Map of the validation step ID by workflow.

Throws:

ConfigurationException - If an error occurred

execute

public void execute(JobExecutionContext context,
 ContainerProgressionTracker progressionTracker)
             throws Exception

Description copied from interface: Schedulable

The action to perform when a trigger is fired. Do not manually call this method.

Specified by:

execute in interface Schedulable

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

sendMail

protected void sendMail(Date startDate,
 Date endDate,
 int totalContentsPurged,
 int totalVersionsPurged)

Send the purge report e-mail.

Parameters:

startDate - the purge start date.

endDate - the purge end date.

totalContentsPurged - the total count of contents of which versions were purged.

totalVersionsPurged - the total count of content versions removed.

sendErrorMail

protected void sendErrorMail(Date startDate,
 Throwable throwable)

Send the error e-mail.

Parameters:

startDate - the purge start date.

throwable - the error.

getEmailParams

protected Map<String,String> getEmailParams(Date startDate,
 Date endDate,
 int totalContentsPurged,
 int totalVersionsPurged)

Get the report e-mail parameters.

Parameters:

startDate - the purge start date.

endDate - the purge end date.

totalContentsPurged - the total count of contents of which versions were purged.

totalVersionsPurged - the total count of content versions removed.

Returns:

the e-mail parameters.

getErrorEmailParams

protected Map<String,String> getErrorEmailParams(Date startDate,
 Throwable throwable)

Get the error e-mail parameters.

Parameters:

startDate - the purge start date.

throwable - the error.

Returns:

the e-mail parameters.

getMailBody

protected String getMailBody(Map<String,String> parameters)
                      throws IOException

Get a mail part.

Parameters:

parameters - the pipeline parameters.

Returns:

the mail part.

Throws:

IOException - If an error occurred

getMailUri

protected String getMailUri(Map<String,String> parameters)

Get the pipeline uri for mail body

Parameters:

parameters - the mail parameters

Returns:

a pipeline uri

getErrorMailUri

protected String getErrorMailUri(Map<String,String> parameters)

Get the pipeline uri for error mail body.

Parameters:

parameters - the mail parameters

Returns:

a pipeline uri