org.dspace.app.harvest.HarvestScriptConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
There is a newer version: 8.0
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.app.harvest;

import java.sql.SQLException;

import org.apache.commons.cli.Options;
import org.dspace.authorize.service.AuthorizeService;
import org.dspace.core.Context;
import org.dspace.scripts.configuration.ScriptConfiguration;
import org.springframework.beans.factory.annotation.Autowired;


public class HarvestScriptConfiguration extends ScriptConfiguration {
    @Autowired
    private AuthorizeService authorizeService;

    private Class dspaceRunnableClass;

    @Override
    public Class getDspaceRunnableClass() {
        return dspaceRunnableClass;
    }

    @Override
    public void setDspaceRunnableClass(Class dspaceRunnableClass) {
        this.dspaceRunnableClass = dspaceRunnableClass;
    }

    public boolean isAllowedToExecute(final Context context) {
        try {
            return authorizeService.isAdmin(context);
        } catch (SQLException e) {
            throw new RuntimeException("SQLException occurred when checking if the current user is an admin", e);
        }
    }

    public Options getOptions() {
        Options options = new Options();
        options.addOption("p", "purge", false, "delete all items in the collection");
        options.getOption("p").setType(boolean.class);
        options.addOption("r", "run", false, "run the standard harvest procedure");
        options.getOption("r").setType(boolean.class);
        options.addOption("g", "ping", false, "test the OAI server and set");
        options.getOption("g").setType(boolean.class);
        options.addOption("s", "setup", false, "Set the collection up for harvesting");
        options.getOption("s").setType(boolean.class);
        options.addOption("S", "start", false, "start the harvest loop");
        options.getOption("S").setType(boolean.class);
        options.addOption("R", "reset", false, "reset harvest status on all collections");
        options.getOption("R").setType(boolean.class);
        options.addOption("P", "purgeCollections", false, "purge all harvestable collections");
        options.getOption("P").setType(boolean.class);
        options.addOption("o", "reimport", false, "reimport all items in the collection, " +
            "this is equivalent to -p -r, purging all items in a collection and reimporting them");
        options.getOption("o").setType(boolean.class);
        options.addOption("c", "collection", true,
                          "harvesting collection (handle or id)");
        options.addOption("t", "type", true,
                          "type of harvesting (0 for none)");
        options.addOption("a", "address", true,
                          "address of the OAI-PMH server");
        options.addOption("i", "oai_set_id", true,
                          "id of the PMH set representing the harvested collection");
        options.addOption("m", "metadata_format", true,
                          "the name of the desired metadata format for harvesting, resolved to namespace and " +
                                  "crosswalk in dspace.cfg");

        options.addOption("h", "help", false, "help");
        options.getOption("h").setType(boolean.class);

        return options;
    }
}