Package org.ametys.odf.schedulable

Class CatalogPDFExportSchedulable

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.CatalogPDFExportSchedulable

All Implemented Interfaces:

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

Direct Known Subclasses:

CatalogPDFExportSchedulable

public class CatalogPDFExportSchedulable
extends AbstractSendingMailSchedulable

Schedulable to export the ODF catalog as PDF

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	_CATALOG_FILENAME	Map key where the generated filename is stored
protected File	_catalogRootDirectory	The catalog directory.
protected CatalogsManager	_catalogsManager	The catalog manager
protected JSONUtils	_jsonUtils	The JSON utils
protected OdfReferenceTableHelper	_odfRefTableHelper	The ODF reference table helper.
protected AmetysObjectResolver	_resolver	The Ametys object resolver.
protected SourceResolver	_sourceResolver	The avalon source resolver.
static final String	JOBDATAMAP_CATALOG_KEY	The key for the catalog
static final String	JOBDATAMAP_DEGREE_KEY	The key for the degrees
static final String	JOBDATAMAP_INCLUDE_SUBPROGRAMS	The key for including subprograms
static final String	JOBDATAMAP_LANG_KEY	The key for the lang
static final String	JOBDATAMAP_MODE_KEY	The key for the mode
static final String	JOBDATAMAP_ORGUNIT_KEY	The key for the orgunits
static final String	JOBDATAMAP_QUERY_KEY	The key for the query'id
static final String	MODE_QUERY	Mode when catalog is generated from a query

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

Method Summary

Modifier and Type	Method	Description
protected void	_doExecute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Executes the schedulable.
protected String	_getCatalogFilename(String queryId, Object[] orgunits, Object[] degrees)	Get the catalog PDF file name from configuration
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
Map<String,ElementDefinition>	getParameters()	Get the parameters for job execution
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, 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

JOBDATAMAP_CATALOG_KEY

public static final String JOBDATAMAP_CATALOG_KEY

The key for the catalog

See Also:

• Constant Field Values

JOBDATAMAP_LANG_KEY

public static final String JOBDATAMAP_LANG_KEY

The key for the lang

See Also:

• Constant Field Values

JOBDATAMAP_ORGUNIT_KEY

public static final String JOBDATAMAP_ORGUNIT_KEY

The key for the orgunits

See Also:

• Constant Field Values

JOBDATAMAP_DEGREE_KEY

public static final String JOBDATAMAP_DEGREE_KEY

The key for the degrees

See Also:

• Constant Field Values

JOBDATAMAP_QUERY_KEY

public static final String JOBDATAMAP_QUERY_KEY

The key for the query'id

See Also:

• Constant Field Values

JOBDATAMAP_MODE_KEY

public static final String JOBDATAMAP_MODE_KEY

The key for the mode

See Also:

• Constant Field Values

JOBDATAMAP_INCLUDE_SUBPROGRAMS

public static final String JOBDATAMAP_INCLUDE_SUBPROGRAMS

The key for including subprograms

See Also:

• Constant Field Values

MODE_QUERY

public static final String MODE_QUERY

Mode when catalog is generated from a query

See Also:

• Constant Field Values

_CATALOG_FILENAME

protected static final String _CATALOG_FILENAME

Map key where the generated filename is stored

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver.

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF reference table helper.

_sourceResolver

protected SourceResolver _sourceResolver

The avalon source resolver.

_catalogRootDirectory

protected File _catalogRootDirectory

The catalog directory.

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

_catalogsManager

protected CatalogsManager _catalogsManager

The catalog manager

Constructor Details

CatalogPDFExportSchedulable

public CatalogPDFExportSchedulable()

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

_getCatalogFilename

protected String _getCatalogFilename(String queryId,
 Object[] orgunits,
 Object[] degrees)

Get the catalog PDF file name from configuration

Parameters:

queryId - The id of query to execute. null when export is not based on a query

orgunits - The restricted orgunits. null when export is based on a query

degrees - The restricted degrees. null when export is based on a query

Returns:

the computed catalog file name

getParameters

public Map<String,ElementDefinition> getParameters()

Description copied from interface: Schedulable

Get the parameters for job execution

Specified by:

getParameters in interface Schedulable

Overrides:

getParameters in class AbstractStaticSchedulable

Returns:

the parameters

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

_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