org.dspace.content.packager

Class InternalDSpaceAIPIngester

java.lang.Object

org.dspace.content.packager.AbstractPackageIngester

org.dspace.content.packager.AbstractInternalMETSIngester

org.dspace.content.packager.InternalDSpaceAIPIngester

All Implemented Interfaces:

org.dspace.content.packager.PackageIngester

public class InternalDSpaceAIPIngester
extends AbstractInternalMETSIngester

InternalDSpaceAIPIngester will be used to restore previous versions of Items from Assetstore. Overrides existing AIP behavior, but must be used in "manifestOnly" mode.

Nested Class Summary

Nested classes/interfaces inherited from class org.dspace.content.packager.AbstractInternalMETSIngester

AbstractInternalMETSIngester.MdrefManager

Constructor Summary

Constructors

Constructor and Description
InternalDSpaceAIPIngester()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBitstreams(org.dspace.core.Context context, org.dspace.content.Item item, org.dspace.content.packager.METSManifest manifest, File pkgFile, org.dspace.content.packager.PackageParameters params, AbstractInternalMETSIngester.MdrefManager mdRefCallback) Add Bitstreams to an Item, based on the files listed in the METS Manifest
void	addLicense(org.dspace.core.Context context, org.dspace.content.Item item, String license, org.dspace.content.Collection collection, org.dspace.content.packager.PackageParameters params) Ignore license when restoring an manifest-only AIP, since it should be a bitstream in the AIP already.
protected static void	createMissingMetadataFields(org.dspace.core.Context context, org.dspace.content.Item item) Verifies that all the unsaved, crosswalked metadata fields that have been added to an Item actually exist in our Database.
void	crosswalkObjectDmd(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.METSManifest manifest, AbstractInternalMETSIngester.MdrefManager callback, org.jdom.Element[] dmds, org.dspace.content.packager.PackageParameters params) Choose DMD section(s) to crosswalk.
void	finishBitstream(org.dspace.core.Context context, org.dspace.content.Bitstream bs, org.jdom.Element mfile, org.dspace.content.packager.METSManifest manifest, org.dspace.content.packager.PackageParameters params) Nothing extra to do to bitstream after ingestion.
void	finishObject(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params) Last change to fix up a DSpace Object.
String	getConfigurationName() Name used to distinguish DSpace Configuration entries for this subclass.
int	getObjectType(org.dspace.content.packager.METSManifest manifest) Return the type of DSpaceObject in this package; it is in the TYPE attribute of the mets:mets element.
String	getParameterHelp() Returns a user help string which should describe the additional valid command-line options that this packager implementation will accept when using the -o or --option flags with the Packager script.
org.dspace.content.DSpaceObject	replace(org.dspace.core.Context context, org.dspace.content.DSpaceObject dsoToReplace, File pkgFile, org.dspace.content.packager.PackageParameters params) Replace an existing DSpace object with the contents of a METS-based package.
org.dspace.content.Bitstream	resolveBitstream(org.dspace.core.Context context, org.jdom.Element mfile, org.dspace.content.packager.PackageParameters params, String path) Interpret a Bitstream URI in the manifest.

Methods inherited from class org.dspace.content.packager.AbstractInternalMETSIngester

addContainerLogo, addManifestBitstream, addTemplateItem, decodeHandleURN, getFileInputStream, getManifestBitstreamFormat, getObjectHandle, getParentObject, ingest, ingestObject, parsePackage, preserveManifest, removeObject, replaceObject, useCollectionTemplate

Methods inherited from class org.dspace.content.packager.AbstractPackageIngester

addPackageReference, addToIngestedList, getIngestedList, getPackageReferences, ingestAll, replaceAll

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalDSpaceAIPIngester

public InternalDSpaceAIPIngester()

Method Detail

crosswalkObjectDmd

public void crosswalkObjectDmd(org.dspace.core.Context context,
                      org.dspace.content.DSpaceObject dso,
                      org.dspace.content.packager.METSManifest manifest,
                      AbstractInternalMETSIngester.MdrefManager callback,
                      org.jdom.Element[] dmds,
                      org.dspace.content.packager.PackageParameters params)
                        throws org.dspace.content.crosswalk.CrosswalkException,
                               org.dspace.content.packager.PackageValidationException,
                               org.dspace.authorize.AuthorizeException,
                               SQLException,
                               IOException

Choose DMD section(s) to crosswalk.

The algorithm is:
1. Use whatever the dmd parameter specifies as the primary DMD.
2. If (1) is unspecified, find DIM (preferably) or MODS as primary DMD.
3. If (1) or (2) succeeds, crosswalk it and ignore all other DMDs with same GROUPID
4. Crosswalk remaining DMDs not eliminated already.

Specified by:

crosswalkObjectDmd in class AbstractInternalMETSIngester

Parameters:

context - the DSpace context

manifest - the METSManifest

callback - the MdrefManager (manages all external metadata files referenced by METS mdref elements)

dmds - array of Elements, each a METS dmdSec that applies to the Item as a whole.

Throws:

org.dspace.content.crosswalk.CrosswalkException

org.dspace.content.packager.PackageValidationException

org.dspace.authorize.AuthorizeException

SQLException

IOException

addLicense

public void addLicense(org.dspace.core.Context context,
              org.dspace.content.Item item,
              String license,
              org.dspace.content.Collection collection,
              org.dspace.content.packager.PackageParameters params)
                throws org.dspace.content.packager.PackageValidationException,
                       org.dspace.authorize.AuthorizeException,
                       SQLException,
                       IOException

Ignore license when restoring an manifest-only AIP, since it should be a bitstream in the AIP already. Otherwise: Check item for license first; then, take deposit license supplied by explicit argument next, else use collection's default deposit license. Normally the rightsMD crosswalks should provide a license.

Specified by:

addLicense in class AbstractInternalMETSIngester

Parameters:

context - the DSpace context

license - optional user-supplied Deposit License text (may be null)

collection - DSpace Collection to which the item is being submitted.

Throws:

org.dspace.content.packager.PackageValidationException

org.dspace.authorize.AuthorizeException

SQLException

IOException

finishObject

public void finishObject(org.dspace.core.Context context,
                org.dspace.content.DSpaceObject dso,
                org.dspace.content.packager.PackageParameters params)
                  throws org.dspace.content.packager.PackageValidationException,
                         org.dspace.content.crosswalk.CrosswalkException,
                         org.dspace.authorize.AuthorizeException,
                         SQLException,
                         IOException

Last change to fix up a DSpace Object.

For AIPs, if the object is an Item, we may want to make sure all of its metadata fields already exist in the database (otherwise, the database will throw errors when we attempt to save/update the Item)

Specified by:

finishObject in class AbstractInternalMETSIngester

Parameters:

context - DSpace Context

dso - DSpace object

params - Packager Parameters

Throws:

org.dspace.content.packager.PackageValidationException

org.dspace.content.crosswalk.CrosswalkException

org.dspace.authorize.AuthorizeException

SQLException

IOException

finishBitstream

public void finishBitstream(org.dspace.core.Context context,
                   org.dspace.content.Bitstream bs,
                   org.jdom.Element mfile,
                   org.dspace.content.packager.METSManifest manifest,
                   org.dspace.content.packager.PackageParameters params)
                     throws org.dspace.content.crosswalk.MetadataValidationException,
                            SQLException,
                            org.dspace.authorize.AuthorizeException,
                            IOException

Nothing extra to do to bitstream after ingestion.

Specified by:

finishBitstream in class AbstractInternalMETSIngester

Throws:

org.dspace.content.crosswalk.MetadataValidationException

SQLException

org.dspace.authorize.AuthorizeException

IOException

getObjectType

public int getObjectType(org.dspace.content.packager.METSManifest manifest)
                  throws org.dspace.content.packager.PackageValidationException

Return the type of DSpaceObject in this package; it is in the TYPE attribute of the mets:mets element.

Specified by:

getObjectType in class AbstractInternalMETSIngester

Returns:

one of the object types in Constants.

Throws:

org.dspace.content.packager.PackageValidationException

getConfigurationName

public String getConfigurationName()

Name used to distinguish DSpace Configuration entries for this subclass.

Specified by:

getConfigurationName in class AbstractInternalMETSIngester

createMissingMetadataFields

protected static void createMissingMetadataFields(org.dspace.core.Context context,
                               org.dspace.content.Item item)
                                           throws org.dspace.content.packager.PackageValidationException,
                                                  org.dspace.authorize.AuthorizeException,
                                                  IOException,
                                                  SQLException

Verifies that all the unsaved, crosswalked metadata fields that have been added to an Item actually exist in our Database. If they don't exist, they are created within the proper database tables.

This method must be called *before* item.update(), as the call to update() will throw a SQLException when attempting to save any fields which don't already exist in the database.

NOTE: This will NOT create a missing Metadata Schema (e.g. "dc" schema), as we do not have enough info to create schemas on the fly.

Parameters:

context - - DSpace Context

item - - Item whose unsaved metadata fields we are testing

Throws:

org.dspace.authorize.AuthorizeException - if a metadata field doesn't exist and current user is not authorized to create it (i.e. not an Admin)

PackageValidationException - if a metadata schema doesn't exist, as we cannot autocreate a schema

IOException

SQLException

getParameterHelp

public String getParameterHelp()

Returns a user help string which should describe the additional valid command-line options that this packager implementation will accept when using the -o or --option flags with the Packager script.

Specified by:

getParameterHelp in interface org.dspace.content.packager.PackageIngester

Overrides:

getParameterHelp in class AbstractInternalMETSIngester

Returns:

a string describing additional command-line options available with this packager

addBitstreams

protected void addBitstreams(org.dspace.core.Context context,
                 org.dspace.content.Item item,
                 org.dspace.content.packager.METSManifest manifest,
                 File pkgFile,
                 org.dspace.content.packager.PackageParameters params,
                 AbstractInternalMETSIngester.MdrefManager mdRefCallback)
                      throws SQLException,
                             IOException,
                             org.dspace.authorize.AuthorizeException,
                             org.dspace.content.crosswalk.MetadataValidationException,
                             org.dspace.content.crosswalk.CrosswalkException,
                             org.dspace.content.packager.PackageValidationException

Add Bitstreams to an Item, based on the files listed in the METS Manifest

Overrides:

addBitstreams in class AbstractInternalMETSIngester

Parameters:

context - DSpace Context

item - DSpace Item

manifest - METS Manifest

pkgFile - the full package file (which may include content files if a zip)

params - Ingestion Parameters

mdRefCallback - MdrefManager storing info about mdRefs in manifest

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

org.dspace.content.crosswalk.MetadataValidationException

org.dspace.content.crosswalk.CrosswalkException

PackageValidationException

resolveBitstream

public org.dspace.content.Bitstream resolveBitstream(org.dspace.core.Context context,
                                            org.jdom.Element mfile,
                                            org.dspace.content.packager.PackageParameters params,
                                            String path)
                                              throws SQLException,
                                                     org.dspace.content.packager.PackageValidationException

Interpret a Bitstream URI in the manifest. If this is an "internal" AIP, it refers directly to a file in the assetstore. Otherwise, it will be match the relative path of an entry in the package.

Throws:

SQLException

org.dspace.content.packager.PackageValidationException

replace

public org.dspace.content.DSpaceObject replace(org.dspace.core.Context context,
                                      org.dspace.content.DSpaceObject dsoToReplace,
                                      File pkgFile,
                                      org.dspace.content.packager.PackageParameters params)
                                        throws org.dspace.content.packager.PackageValidationException,
                                               org.dspace.content.crosswalk.CrosswalkException,
                                               org.dspace.authorize.AuthorizeException,
                                               SQLException,
                                               IOException

Replace an existing DSpace object with the contents of a METS-based package. All contents are dictated by the METS manifest. Package is a ZIP archive (or optionally bare manifest XML document). In a Zip, all files relative to top level and the manifest (as per spec) in mets.xml.

This method is similar to ingest(), except that if the object already exists in DSpace, it is emptied of files and metadata. The METS-based package is then used to ingest new values for these.

Specified by:

replace in interface org.dspace.content.packager.PackageIngester

Overrides:

replace in class AbstractInternalMETSIngester

Parameters:

context - DSpace Context

dsoToReplace - DSpace Object to be replaced (may be null if it will be specified in the METS manifest itself)

pkgFile - The package file to ingest

params - Parameters passed from the packager script

Returns:

DSpaceObject created by ingest.

Throws:

PackageValidationException - if package is unacceptable or there is a fatal error turning it into a DSpace Object.

IOException

SQLException

org.dspace.authorize.AuthorizeException

org.dspace.content.crosswalk.CrosswalkException