Package org.ametys.odf.schedulable

Class EducationalBookletSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.cms.schedule.AbstractSendingMailSchedulable

org.ametys.odf.schedulable.EducationalBookletSchedulable

All Implemented Interfaces:

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

Direct Known Subclasses:

ArchiveEducationalBookletSchedulable, EducationalBookletSchedulable

public class EducationalBookletSchedulable
extends AbstractSendingMailSchedulable

Schedulable for educational booklet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	EducationalBookletSchedulable.EducationalBookletReport	Object to represent list of programs exported and list of programs with error after PDF generation

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

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	The content workflow helper
protected static final String	_EDUCATIONAL_BOOKLET_REPORT	Map key where the report is stored
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SourceResolver	_sourceResolver	The avalon source resolver.
static final String	EDUCATIONAL_BOOKLET_DIR_NAME	The directory under ametys home data directory for educational booklet
static final String	PARAM_INCLUDE_SUBPROGRAMS	Scheduler parameter name of including of subprograms
static final String	PARAM_PROGRAM_ITEM_ID	Scheduler parameter name of including of subprograms

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

Method Summary

Modifier and Type	Method	Description
protected void	_doExecute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Executes the schedulable.
protected void	_generateEducationalBookletZip(JobExecutionContext context, File bookletDirectory, List<Content> exportedProgramItems, String zipKey)	Generate the zip with the educational booklet for each exported program items
protected void	_generateFile(File bookletDirectory, String uri, Map<String,Object> params, String name, String extension)	Generate a file from the uri
protected void	_generateProgramItemEducationalBookletPDF(File bookletDirectory, Content programItem, Map<String,Object> pdfParameters)	Generate the educational booklet for one program item
protected void	_generateProgramItemsEducationalBooklet(JobExecutionContext context, File bookletDirectory, Map<String,Object> pdfParameters)	Generate educational booklet for each program items
protected String	_getDownloadLink(JobExecutionContext context, EducationalBookletSchedulable.EducationalBookletReport report, List<Content> exportedProgramItems)	Get the link to download PDF
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	_getMailBodyBaseKey()	The base key for mail bodies.
protected String	_getMailSubjectBaseKey()	The base key for mail subjects.
protected I18nizableText	_getProgramItemsI18nText(List<Content> programItems)	Transform a list of program items in a readable list.
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
void	service(ServiceManager manager)

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

_getRecipient, _sendMail, execute, initialize

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

EDUCATIONAL_BOOKLET_DIR_NAME

public static final String EDUCATIONAL_BOOKLET_DIR_NAME

The directory under ametys home data directory for educational booklet

See Also:

• Constant Field Values

PARAM_INCLUDE_SUBPROGRAMS

public static final String PARAM_INCLUDE_SUBPROGRAMS

Scheduler parameter name of including of subprograms

See Also:

• Constant Field Values

PARAM_PROGRAM_ITEM_ID

public static final String PARAM_PROGRAM_ITEM_ID

Scheduler parameter name of including of subprograms

See Also:

• Constant Field Values

_EDUCATIONAL_BOOKLET_REPORT

protected static final String _EDUCATIONAL_BOOKLET_REPORT

Map key where the report is stored

See Also:

• Constant Field Values

_sourceResolver

protected SourceResolver _sourceResolver

The avalon source resolver.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

Constructor Details

EducationalBookletSchedulable

public EducationalBookletSchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSendingMailSchedulable

Throws:

ServiceException

_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)

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

_getErrorMailSubject

protected I18nizableText _getErrorMailSubject(JobExecutionContext context)

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

_getMailSubjectBaseKey

protected String _getMailSubjectBaseKey()

The base key for mail subjects.

Returns:

The prefix of an I18N key

_isMailBodyInHTML

protected boolean _isMailBodyInHTML(JobExecutionContext context)
                             throws Exception

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

Throws:

Exception - If an error occurs while retrieving if mail body should be HTML

_getSuccessMailBody

protected String _getSuccessMailBody(JobExecutionContext context)
                              throws IOException

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:

IOException

_getDownloadLink

protected String _getDownloadLink(JobExecutionContext context,
 EducationalBookletSchedulable.EducationalBookletReport report,
 List<Content> exportedProgramItems)
                           throws IOException

Get the link to download PDF

Parameters:

context - the job execution context

report - the report

exportedProgramItems - the exported programs

Returns:

the download

Throws:

IOException - if failed to build the download uri

_getErrorMailBody

protected String _getErrorMailBody(JobExecutionContext context,
 Throwable throwable)

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

_getMailBodyBaseKey

protected String _getMailBodyBaseKey()

The base key for mail bodies.

Returns:

The prefix of an I18N key

_getProgramItemsI18nText

protected I18nizableText _getProgramItemsI18nText(List<Content> programItems)

Transform a list of program items in a readable list.

Parameters:

programItems - The program items to iterate on

Returns:

An I18nizableText representing the program items

_generateProgramItemsEducationalBooklet

protected void _generateProgramItemsEducationalBooklet(JobExecutionContext context,
 File bookletDirectory,
 Map<String,Object> pdfParameters)

Generate educational booklet for each program items

Parameters:

context - the context

bookletDirectory - the booklet directory

pdfParameters - the parameters to generate PDF

_generateProgramItemEducationalBookletPDF

protected void _generateProgramItemEducationalBookletPDF(File bookletDirectory,
 Content programItem,
 Map<String,Object> pdfParameters)
                                                  throws IOException

Generate the educational booklet for one program item

Parameters:

bookletDirectory - the booklet directory

programItem - the program item

pdfParameters - the parameters to generate PDF

Throws:

IOException - if an error occured with files

_generateEducationalBookletZip

protected void _generateEducationalBookletZip(JobExecutionContext context,
 File bookletDirectory,
 List<Content> exportedProgramItems,
 String zipKey)
                                       throws IOException

Generate the zip with the educational booklet for each exported program items

Parameters:

context - the context

bookletDirectory - the booklet directory

exportedProgramItems - the exported program items

zipKey - the zip key

Throws:

IOException - if an error occured with files

_generateFile

protected void _generateFile(File bookletDirectory,
 String uri,
 Map<String,Object> params,
 String name,
 String extension)
                      throws IOException

Generate a file from the uri

Parameters:

bookletDirectory - the booklet directory where the file are created

uri - the uri

params - the parameters of the uri

name - the name of the file

extension - the extension of the file

Throws:

IOException - if an error occured with files