Package org.ametys.plugins.contentio.archive

Class ImportArchiveSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.contentio.archive.ImportArchiveSchedulable

All Implemented Interfaces:

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

public class ImportArchiveSchedulable
extends AbstractStaticSchedulable

Job for importing data from an archive.

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 ArchiveHandler	_archiveHandler
protected I18nUtils	_i18nUtils
static final String	ID	This schedulable id

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

Method Summary

Modifier and Type	Method	Description
protected final String	_getUserEmail()
protected final void	_sendMail(String subject, String body, String userEmail)
void	execute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	The action to perform when a trigger is fired.
protected String	getSuccessMailBody(File input, Optional<Collection<String>> elements, ImportReport importReport)	Gets the body of the success mail
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

ID

public static final String ID

This schedulable id

_i18nUtils

protected I18nUtils _i18nUtils

_archiveHandler

protected ArchiveHandler _archiveHandler

Constructor Details

ImportArchiveSchedulable

public ImportArchiveSchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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.

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

getSuccessMailBody

protected String getSuccessMailBody(File input,
 Optional<Collection<String>> elements,
 ImportReport importReport)
                             throws IOException

Gets the body of the success mail

Parameters:

input - The file input

elements - the imported elements or empty if all the archive was imported

importReport - The ImportReport

Returns:

the body of the success mail

Throws:

IOException - If an I/O error occurs with the ZIP filesystem

_getUserEmail

protected final String _getUserEmail()

_sendMail

protected final void _sendMail(String subject,
 String body,
 String userEmail)