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

org.ametys.plugins.contentio.archive.ImportArchiveSchedulable

All Implemented Interfaces:

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

public class ImportArchiveSchedulable
extends AbstractArchiveSchedulable

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
private static String	__ERROR_TEMPLATE
private static String	__JOBDATAMAP_ARCHIVE_KEY
private static String	__JOBDATAMAP_ELEMENTS_KEY
private static String	__JOBDATAMAP_MERGE_POLICY_KEY
private ArchiverExtensionPoint	_archiverEP
(package private) static String	ARCHIVE_KEY
(package private) static String	ELEMENTS_KEY
static String	ID	This schedulable id
(package private) static String	MERGE_POLICY_KEY

Fields inherited from class org.ametys.plugins.contentio.archive.AbstractArchiveSchedulable

_archiveHandler, _i18nUtils, _userManager

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

Constructor Summary

Constructors

Constructor	Description
ImportArchiveSchedulable()

Method Summary

Modifier and Type	Method	Description
private File	_getFileInput(String archiveName)
private ImportReport	_import(File input, Optional<Collection<String>> elements, Merger merger)
void	execute(JobExecutionContext context)	The action to perform when a trigger is fired.
protected String	getSuccessMailBody(File input, ImportReport importReport)	Gets the body of the success mail
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.contentio.archive.AbstractArchiveSchedulable

_getUserEmail, _sendMail

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

_getLaunchUser, _getLaunchUserIdentity, acceptConcurrentExecution, configure, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, 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 Detail

ID

public static final String ID

This schedulable id

ARCHIVE_KEY

static final String ARCHIVE_KEY

See Also:

Constant Field Values

ELEMENTS_KEY

static final String ELEMENTS_KEY

See Also:

Constant Field Values

MERGE_POLICY_KEY

static final String MERGE_POLICY_KEY

See Also:

Constant Field Values

__JOBDATAMAP_ARCHIVE_KEY

private static final String __JOBDATAMAP_ARCHIVE_KEY

See Also:

Constant Field Values

__JOBDATAMAP_ELEMENTS_KEY

private static final String __JOBDATAMAP_ELEMENTS_KEY

See Also:

Constant Field Values

__JOBDATAMAP_MERGE_POLICY_KEY

private static final String __JOBDATAMAP_MERGE_POLICY_KEY

See Also:

Constant Field Values

__ERROR_TEMPLATE

private static final String __ERROR_TEMPLATE

See Also:

Constant Field Values

_archiverEP

private ArchiverExtensionPoint _archiverEP

Constructor Detail

ImportArchiveSchedulable

public ImportArchiveSchedulable()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractArchiveSchedulable

Throws:

ServiceException

execute

public void execute(JobExecutionContext context)
             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

Specified by:

execute in class AbstractStaticSchedulable

Parameters:

context - the context

Throws:

Exception - if an error occured

_import

private ImportReport _import(File input,
                             Optional<Collection<String>> elements,
                             Merger merger)
                      throws IOException

Throws:

IOException

_getFileInput

private File _getFileInput(String archiveName)

getSuccessMailBody

protected String getSuccessMailBody(File input,
                                    ImportReport importReport)
                             throws IOException

Gets the body of the success mail

Parameters:

input - The file input

importReport - The ImportReport

Returns:

the body of the success mail

Throws:

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