Package org.dspace.ctask.replicate

Class AbstractPackagerTask

  • All Implemented Interfaces:
    org.dspace.curate.CurationTask
    Direct Known Subclasses:
    METSRestoreFromAIP
    public abstract class AbstractPackagerTask
extends org.dspace.curate.AbstractCurationTask
    AbstractPackagerTask encapsulates a few common convenience methods which may be useful to curation tasks that wrap or utilize DSpace Packager classes (org.dspace.content.packager.*).
    Author:
    Tim Donohue
    See Also:
    Packager, PackageDisseminator, PackageIngester

    • Field Summary

      • Fields inherited from class org.dspace.curate.AbstractCurationTask

        communityService, configurationService, curator, handleService, itemService, taskId

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.dspace.content.packager.PackageParameters loadPackagerParameters​(String moduleName)
      Loads pre-configured PackageParameters settings from a given Module configuration file (specified by 'moduleName').

      • Methods inherited from class org.dspace.curate.AbstractCurationTask

        dereference, distribute, init, perform, perform, performItem, performObject, report, setResult, taskArrayProperty, taskBooleanProperty, taskIntProperty, taskLongProperty, taskProperty

    • Constructor Detail

      • AbstractPackagerTask

        public AbstractPackagerTask()

    • Method Detail

      • loadPackagerParameters

        protected org.dspace.content.packager.PackageParameters loadPackagerParameters​(String moduleName)
        Loads pre-configured PackageParameters settings from a given Module configuration file (specified by 'moduleName').

        These PackageParameters should be configured using the following configuration file format:

        SETTING FORMAT: [modulename].[taskname].[option] = [value]

        Valid 'options' include all packager options supported by the Packager class, e.g. AIP packagers minimally support these options: https://wiki.lyrasis.org/display/DSDOC6x/AIP+Backup+and+Restore#AIPBackupandRestore-AdditionalPackagerOptions

        Please note that different Packager classes will support different options. You should determine which options are valid for your Packager class and the curation task that utilizes it.

        Example usage: if your module is named "mymodule" and your curation task is named "myreplacetask" in curate.cfg, then you can configure its PackageParameters like so:

        mymodule.myreplacetask.replaceMode = true mymodule.myreplacetask.recursiveMode = true mymodule.myreplacetask.createMetadataFields = true mymodule.myreplacetask.[any-supported-option] = [any-supported-value]

        Parameters:
        moduleName - Module name to load configuration file and settings from
        Returns:
        configured PackageParameters (or null, if configurations not found)
        See Also:
        PackageParameters