Package org.ametys.cms.content.consistency

Class CheckContentConsistencySchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.cms.content.consistency.CheckContentConsistencySchedulable

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckContentConsistencySchedulable

public class CheckContentConsistencySchedulable
extends AbstractStaticSchedulable
implements Initializable

Content consistency schedulable: generate consistency information for all contents. Sends a report e-mail if there are inconsistencies.

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 static final String	__CHECK_CONTENT_CONSISTENCY_NOTIFICATION	Id of progression tracker for notifications
protected static final String	__CHECK_CONTENT_CONSISTENCY_REPORT	Id of progression tracker for consistensy report
protected static final String	__MAIL_RIGHT	The report e-mail will be sent to users who possess this right on the application context.
protected AmetysObjectResolver	_ametysResolver	The ametys object resolver.
protected String	_baseUrl	The server base URL.
protected ContentConsistencyManager	_contentConsistencyManager	The content consistency manager
protected I18nUtils	_i18nUtils	The i18n utils.
protected String	_mailFrom	The content of "from" field in emails.
protected File	_reportDirectory	The report directory.
protected RightManager	_rightManager	The rights manager.
protected SourceResolver	_sourceResolver	The avalon source resolver.
static final String	CHECK_CONTENTS	Id of progression tracker for removing outdated results
static final String	REMOVE_OUTDATED_RESULT	Id of progression tracker for removing outdated results

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
CheckContentConsistencySchedulable()

Method Summary

Modifier and Type	Method	Description
protected String	_getMailBody(ContentConsistencyManager.ConsistenciesReport report)	Retrieves the mail's body
protected I18nizableText	_getMailSubject(ContentConsistencyManager.ConsistenciesReport report)	Retrieves the mail's subject
protected String	_getReportUri()	Get the report URI
protected void	_sendEmail(ContentConsistencyManager.ConsistenciesReport report, Set<UserIdentity> users, SimpleProgressionTracker progressionTracker)	Send a reminder e-mail to all the users who have the right to edit.
protected void	_sendMails(String subject, String body, Set<UserIdentity> users, String from, InputStream attachment, SimpleProgressionTracker progressionTracker)	Send the alert e-mails.
void	execute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	The action to perform when a trigger is fired.
protected Set<UserIdentity>	getUsersToNotify()	Compute the list of user to notify
void	initialize()
void	service(ServiceManager manager)

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

acceptConcurrentExecution, configure, 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

REMOVE_OUTDATED_RESULT

public static final String REMOVE_OUTDATED_RESULT

Id of progression tracker for removing outdated results

See Also:

• Constant Field Values

CHECK_CONTENTS

public static final String CHECK_CONTENTS

Id of progression tracker for removing outdated results

See Also:

• Constant Field Values

__MAIL_RIGHT

protected static final String __MAIL_RIGHT

The report e-mail will be sent to users who possess this right on the application context.

See Also:

• Constant Field Values

__CHECK_CONTENT_CONSISTENCY_NOTIFICATION

protected static final String __CHECK_CONTENT_CONSISTENCY_NOTIFICATION

Id of progression tracker for notifications

See Also:

• Constant Field Values

__CHECK_CONTENT_CONSISTENCY_REPORT

protected static final String __CHECK_CONTENT_CONSISTENCY_REPORT

Id of progression tracker for consistensy report

See Also:

• Constant Field Values

_baseUrl

protected String _baseUrl

The server base URL.

_reportDirectory

protected File _reportDirectory

The report directory.

_ametysResolver

protected AmetysObjectResolver _ametysResolver

The ametys object resolver.

_sourceResolver

protected SourceResolver _sourceResolver

The avalon source resolver.

_rightManager

protected RightManager _rightManager

The rights manager.

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_mailFrom

protected String _mailFrom

The content of "from" field in emails.

_contentConsistencyManager

protected ContentConsistencyManager _contentConsistencyManager

The content consistency manager

Constructor Details

CheckContentConsistencySchedulable

public CheckContentConsistencySchedulable()

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

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

_sendEmail

protected void _sendEmail(ContentConsistencyManager.ConsistenciesReport report,
 Set<UserIdentity> users,
 SimpleProgressionTracker progressionTracker)
                   throws IOException,
ProcessingException

Send a reminder e-mail to all the users who have the right to edit.

Parameters:

report - the consistency report

users - the users to notify

progressionTracker - the progression tracker for sending email

Throws:

IOException - if an error occurs building or sending the mail.

ProcessingException - if an error occurs

getUsersToNotify

protected Set<UserIdentity> getUsersToNotify()

Compute the list of user to notify

Returns:

a list of user identity

_getMailSubject

protected I18nizableText _getMailSubject(ContentConsistencyManager.ConsistenciesReport report)

Retrieves the mail's subject

Parameters:

report - the consistency report

Returns:

the mail's subject

_getMailBody

protected String _getMailBody(ContentConsistencyManager.ConsistenciesReport report)

Retrieves the mail's body

Parameters:

report - the consistency report

Returns:

the mail's body

_getReportUri

protected String _getReportUri()

Get the report URI

Returns:

the report uri

_sendMails

protected void _sendMails(String subject,
 String body,
 Set<UserIdentity> users,
 String from,
 InputStream attachment,
 SimpleProgressionTracker progressionTracker)

Send the alert e-mails.

Parameters:

subject - the e-mail subject.

body - the e-mail body.

users - users to send the mail to.

from - the address sending the e-mail.

attachment - the e-mail attachment

progressionTracker - progression tracker for sending report mail