org.dspace.harvest

Class OAIHarvester

java.lang.Object

org.dspace.harvest.OAIHarvester

public class OAIHarvester
extends java.lang.Object

This class handles OAI harvesting of externally located records into this repository.

Author:

Alexey Maslov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAIHarvester.HarvestingException Exception class specifically assigned to recoverable errors that occur during harvesting.
static class	OAIHarvester.HarvestScheduler The class responsible for scheduling harvesting cycles are regular intervals.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OAI_ADDRESS_ERROR
static java.lang.String	OAI_DMD_ERROR
static java.lang.String	OAI_ORE_ERROR
static java.lang.String	OAI_SET_ERROR

Constructor Summary

Constructors

Constructor and Description
OAIHarvester(Context c, DSpaceObject dso, HarvestedCollection hc)

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	oaiResolveNamespaceToPrefix(java.lang.String oaiSource, java.lang.String MDNamespace) Query the OAI-PMH server for its mapping of the supplied namespace and metadata prefix.
static void	pauseScheduler() Pause an active harvest scheduler.
static void	resetScheduler()
static void	resumeScheduler() Resume a paused harvest scheduler.
void	runHarvest() Performs a harvest cycle on this collection.
static void	startNewScheduler() Start harvest scheduler.
static void	stopScheduler() Stop an active harvest scheduler.
java.util.List<java.lang.String>	verifyOAIharvester() Verify OAI settings for the current collection
static java.util.List<java.lang.String>	verifyOAIharvester(java.lang.String oaiSource, java.lang.String oaiSetId, java.lang.String metaPrefix, boolean testORE) Verify the existence of an OAI server with the specified set and supporting the provided metadata formats.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OAI_ADDRESS_ERROR

public static final java.lang.String OAI_ADDRESS_ERROR

See Also:

Constant Field Values

OAI_SET_ERROR

public static final java.lang.String OAI_SET_ERROR

See Also:

Constant Field Values

OAI_DMD_ERROR

public static final java.lang.String OAI_DMD_ERROR

See Also:

Constant Field Values

OAI_ORE_ERROR

public static final java.lang.String OAI_ORE_ERROR

See Also:

Constant Field Values

Constructor Detail

OAIHarvester

public OAIHarvester(Context c,
            DSpaceObject dso,
            HarvestedCollection hc)
             throws OAIHarvester.HarvestingException,
                    java.sql.SQLException

Throws:

OAIHarvester.HarvestingException

java.sql.SQLException

Method Detail

runHarvest

public void runHarvest()
                throws java.sql.SQLException,
                       java.io.IOException,
                       AuthorizeException

Performs a harvest cycle on this collection. This will query the remote OAI-PMH provider, check for updates since last harvest, and ingest the returned items.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

oaiResolveNamespaceToPrefix

public static java.lang.String oaiResolveNamespaceToPrefix(java.lang.String oaiSource,
                                           java.lang.String MDNamespace)
                                                    throws java.io.IOException,
                                                           javax.xml.parsers.ParserConfigurationException,
                                                           org.xml.sax.SAXException,
                                                           javax.xml.transform.TransformerException,
                                                           java.net.ConnectException

Query the OAI-PMH server for its mapping of the supplied namespace and metadata prefix. For example for a typical OAI-PMH server a query "http://www.openarchives.org/OAI/2.0/oai_dc/" would return "oai_dc".

Parameters:

oaiSource - the address of the OAI-PMH provider

MDNamespace - the namespace that we are trying to resolve to the metadataPrefix

Returns:

metadataPrefix the OAI-PMH provider has assigned to the supplied namespace

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

javax.xml.transform.TransformerException

java.net.ConnectException

verifyOAIharvester

public java.util.List<java.lang.String> verifyOAIharvester()

Verify OAI settings for the current collection

Returns:

list of errors encountered during verification. Empty list indicates a "success" condition.

verifyOAIharvester

public static java.util.List<java.lang.String> verifyOAIharvester(java.lang.String oaiSource,
                                                  java.lang.String oaiSetId,
                                                  java.lang.String metaPrefix,
                                                  boolean testORE)

Verify the existence of an OAI server with the specified set and supporting the provided metadata formats.

Parameters:

oaiSource - the address of the OAI-PMH provider

oaiSetId -

metaPrefix -

testORE - whether the method should also check the PMH provider for ORE support

Returns:

list of errors encountered during verification. Empty list indicates a "success" condition.

startNewScheduler

public static void startNewScheduler()
                              throws java.sql.SQLException,
                                     AuthorizeException

Start harvest scheduler.

Throws:

java.sql.SQLException

AuthorizeException

stopScheduler

public static void stopScheduler()
                          throws java.sql.SQLException,
                                 AuthorizeException

Stop an active harvest scheduler.

Throws:

java.sql.SQLException

AuthorizeException

pauseScheduler

public static void pauseScheduler()
                           throws java.sql.SQLException,
                                  AuthorizeException

Pause an active harvest scheduler.

Throws:

java.sql.SQLException

AuthorizeException

resumeScheduler

public static void resumeScheduler()
                            throws java.sql.SQLException,
                                   AuthorizeException

Resume a paused harvest scheduler.

Throws:

java.sql.SQLException

AuthorizeException

resetScheduler

public static void resetScheduler()
                           throws java.sql.SQLException,
                                  AuthorizeException,
                                  java.io.IOException

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException