Uploaded image for project: 'DSpace'
  1. DSpace
  2. DS-387

Add ability for various Packager plugins to report their custom "options" via command line

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.5.2, 1.6.0
    • Fix Version/s: 1.7.0
    • Component/s: DSpace API
    • Labels:
      None
    • Environment:
      Any command line interface
    • Attachments:
      1
    • Comments:
      3
    • Documentation Status:
      Needed

      Description

      Currently, the various packager plugins (METS & PDF) have no way to report to users what options are available to be passed to the plugin (via the 'packager -o [option]=[value]' flag).

      It'd be nice to allow a user to get a brief description of the valid options for each plugin via the commandline interface. I've implemented a simple patch (see attached) which lets users do this as follows:

      (1) running 'dspace packager -h' will output the normal Help information, including a list of all currently configured packager plugins (this feature already existed)

      (2) running 'dspace packager -h -t METS' will report normal Help information, but will also output some additional options which are specific to the METS packager plugin. Similarly, 'dspace packager -h -t PDF' would report any additional options which are specific to the PDF packager plugin.

      The way this is implemented is to add a "getParameterHelp()" method to both the PackageIngester and PackageDisseminator interfaces. Each implementing packager plugin is responsible for reporting any custom options in this "getParameterHelp()" method.

      See the attached patch for further details. (NOTE: This patch is very slightly dependent on DS-386 in that some of the line numbers in the patch are only correct if you already have installed DS-386.)

        Attachments

          Activity

            People

            • Assignee:
              tdonohue Tim Donohue
              Reporter:
              tdonohue Tim Donohue
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: