Package org.ametys.cms.duplicate.contents

Class DuplicateContentsDetectionSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.cms.schedule.AbstractSendingMailSchedulable

org.ametys.cms.duplicate.contents.DuplicateContentsDetectionSchedulable

All Implemented Interfaces:

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

Direct Known Subclasses:

DuplicateContentsDetectionSchedulable

public class DuplicateContentsDetectionSchedulable
extends AbstractSendingMailSchedulable

A Schedulable job for detecting duplicates.

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 String	_baseUrl	The server base URL.
protected ContentTypesHelper	_contentTypesHelper	The content types helper
protected ContentTypeExtensionPoint	_cTypeEP	The content type extension point
protected DuplicateContentsManager	_duplicatesManager	The duplicates manager

Fields inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_currentUserProvider, _i18nUtils, _mailSender, _sysadminMail, _userHelper

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

Method Summary

Modifier and Type	Method	Description
protected String	_createBody(Map<Content,List<Content>> duplicatesMap, Map<Content,List<Content>> nearDuplicatesMap, Map<Content,DuplicateContentsManager.Status> tooComplexMap, boolean hasErrors)	Create the body of the email
protected String	_displayContents(Map<Content,List<Content>> duplicatesMap, Map<Content,List<Content>> nearDuplicatesMap, Map<Content,DuplicateContentsManager.Status> tooComplexMap)	Create StringBuilder used to display contents
protected StringBuilder	_displayDuplicateContent(Map<Content,List<Content>> duplicatesMap, Map<Content,List<Content>> nearDuplicatesMap, Map<Content,DuplicateContentsManager.Status> tooComplexMap, Content content)	Create StringBuilder used to display a content
protected void	_doExecute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Executes the schedulable.
protected String	_getErrorMailBody(JobExecutionContext context, Throwable throwable)	Retrieves the body of the error mail
protected I18nizableText	_getErrorMailSubject(JobExecutionContext context)	Retrieves the subject of the error mail
protected String	_getSuccessMailBody(JobExecutionContext context)	Retrieves the body of the success mail
protected I18nizableText	_getSuccessMailSubject(JobExecutionContext context)	Retrieves the subject of the success mail
protected boolean	_isMailBodyInHTML(JobExecutionContext context)	Determines if the mail body is in HTML
protected String	_renderCmsToolLink(Content content)	Render the cms tool link
protected String	_renderContentTitle(Content content)	Render the content title
void	initialize()
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_getRecipient, _sendMail, execute

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

_duplicatesManager

protected DuplicateContentsManager _duplicatesManager

The duplicates manager

_baseUrl

protected String _baseUrl

The server base URL.

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point

Constructor Details

DuplicateContentsDetectionSchedulable

public DuplicateContentsDetectionSchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSendingMailSchedulable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractSendingMailSchedulable

Throws:

Exception

_doExecute

protected void _doExecute(JobExecutionContext context,
 ContainerProgressionTracker progressionTracker)
                   throws Exception

Description copied from class: AbstractSendingMailSchedulable

Executes the schedulable.

Specified by:

_doExecute in class AbstractSendingMailSchedulable

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

_getSuccessMailSubject

protected I18nizableText _getSuccessMailSubject(JobExecutionContext context)
                                         throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the success mail

Specified by:

_getSuccessMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the success mail

Throws:

Exception - If an error occurs while building the mail subject

_isMailBodyInHTML

protected boolean _isMailBodyInHTML(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Determines if the mail body is in HTML

Overrides:

_isMailBodyInHTML in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

true if the mail body is in HTML, false otherwise

_getSuccessMailBody

protected String _getSuccessMailBody(JobExecutionContext context)
                              throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the success mail

Specified by:

_getSuccessMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the body of the success mail

Throws:

Exception - If an error occurs while building the mail body

_createBody

protected String _createBody(Map<Content,List<Content>> duplicatesMap,
 Map<Content,List<Content>> nearDuplicatesMap,
 Map<Content,DuplicateContentsManager.Status> tooComplexMap,
 boolean hasErrors)
                      throws IOException

Create the body of the email

Parameters:

duplicatesMap - map linking a content to his duplicates

nearDuplicatesMap - map linking a content to his near duplicates

tooComplexMap - map linking a content to his search status (used to know if a query failed because the fuzzy query was too complex for example)

hasErrors - true if the configuration have some errors

Returns:

the body

Throws:

IOException - if failed to build HTML email body for report

_displayContents

protected String _displayContents(Map<Content,List<Content>> duplicatesMap,
 Map<Content,List<Content>> nearDuplicatesMap,
 Map<Content,DuplicateContentsManager.Status> tooComplexMap)

Create StringBuilder used to display contents

Parameters:

duplicatesMap - map linking a content to his duplicates

nearDuplicatesMap - map linking a content to his near duplicates

tooComplexMap - map linking a content to his search status (used to know if a query failed because the fuzzy query was too complex for example)

Returns:

the StringBuilder used to display contents

_displayDuplicateContent

protected StringBuilder _displayDuplicateContent(Map<Content,List<Content>> duplicatesMap,
 Map<Content,List<Content>> nearDuplicatesMap,
 Map<Content,DuplicateContentsManager.Status> tooComplexMap,
 Content content)

Create StringBuilder used to display a content

Parameters:

duplicatesMap - map linking a content to his duplicates

nearDuplicatesMap - map linking a content to his near duplicates

tooComplexMap - map linking a content to his search status (used to know if a query failed because the fuzzy query was too complex for example)

content - the content

Returns:

the StringBuilder used to display a content

_renderContentTitle

protected String _renderContentTitle(Content content)

Render the content title

Parameters:

content - The content

Returns:

the link

_renderCmsToolLink

protected String _renderCmsToolLink(Content content)

Render the cms tool link

Parameters:

content - The content

Returns:

the link

_getErrorMailSubject

protected I18nizableText _getErrorMailSubject(JobExecutionContext context)
                                       throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the error mail

Specified by:

_getErrorMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the error mail

Throws:

Exception - If an error occurs while building the mail subject

_getErrorMailBody

protected String _getErrorMailBody(JobExecutionContext context,
 Throwable throwable)
                            throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the error mail

Specified by:

_getErrorMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

throwable - the error

Returns:

the body of the error mail

Throws:

Exception - If an error occurs while building the mail body