Package org.ametys.web.workflow.archive

Class ArchiveContentsSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.cms.workflow.archive.ArchiveContentsSchedulable

org.ametys.web.workflow.archive.ArchiveContentsSchedulable

All Implemented Interfaces:

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

public class ArchiveContentsSchedulable
extends ArchiveContentsSchedulable

Runnable engine that archive the contents that have an scheduled archiving date set before the current date.

Nested Class Summary

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

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields inherited from class org.ametys.cms.workflow.archive.ArchiveContentsSchedulable

_ametysResolver, _archiveRights, _baseUrl, _environmentContext, _i18nUtils, _logger, _mailFrom, _manager, _rightManager, _sourceResolver, _sysadminMail, _userErrorMailBody, _userErrorMailSubject, _userMailBody, _userMailSubject

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, _userManager

Constructor Summary

Constructors

Constructor	Description
ArchiveContentsSchedulable()

Method Summary

Modifier and Type	Method	Description
protected String	_getContentsListAsString(List<Content> contents)	Get the contents list as String
protected String	_getRequestURI(Content content)	Get the request URI to set in mail
protected String	getArchiveActionUri(String contentId)	Get the pipeline uri for the archive action
protected List<String>	getBodyParamsForContributors(Content content, boolean archived)	Get email body parameters
protected void	setRequestAttributes(Request request, Content content)	Set the necessary request attributes

Methods inherited from class org.ametys.cms.workflow.archive.ArchiveContentsSchedulable

_getAuthorizedContributors, _sendMailsToUsers, configure, contextualize, execute, getAdminEmailParams, sendErrorMailToContributors, sendMailToAdministrator, sendMailToContributors, service

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

acceptConcurrentExecution, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, 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

Constructor Details

ArchiveContentsSchedulable

public ArchiveContentsSchedulable()

Method Details

getArchiveActionUri

protected String getArchiveActionUri(String contentId)

Description copied from class: ArchiveContentsSchedulable

Get the pipeline uri for the archive action

Overrides:

getArchiveActionUri in class ArchiveContentsSchedulable

Parameters:

contentId - the current contend id

Returns:

a pipeline uri

setRequestAttributes

protected void setRequestAttributes(Request request,
 Content content)

Description copied from class: ArchiveContentsSchedulable

Set the necessary request attributes

Overrides:

setRequestAttributes in class ArchiveContentsSchedulable

Parameters:

request - The request

content - The content

getBodyParamsForContributors

protected List<String> getBodyParamsForContributors(Content content,
 boolean archived)

Description copied from class: ArchiveContentsSchedulable

Get email body parameters

Overrides:

getBodyParamsForContributors in class ArchiveContentsSchedulable

Parameters:

content - the archived content

archived - true if the content has archived

Returns:

The mail parameters

_getRequestURI

protected String _getRequestURI(Content content)

Description copied from class: ArchiveContentsSchedulable

Get the request URI to set in mail

Overrides:

_getRequestURI in class ArchiveContentsSchedulable

Parameters:

content - The content. Can be null

Returns:

the request URI

_getContentsListAsString

protected String _getContentsListAsString(List<Content> contents)

Description copied from class: ArchiveContentsSchedulable

Get the contents list as String

Overrides:

_getContentsListAsString in class ArchiveContentsSchedulable

Parameters:

contents - The contents

Returns:

the list of contents as String