org.dspace.content.packager

Class InternalDSpaceAIPDisseminator

java.lang.Object

org.dspace.content.packager.AbstractPackageDisseminator

org.dspace.content.packager.AbstractMETSDisseminator

org.dspace.content.packager.InternalDSpaceAIPDisseminator

All Implemented Interfaces:

org.dspace.content.packager.PackageDisseminator

public class InternalDSpaceAIPDisseminator
extends org.dspace.content.packager.AbstractMETSDisseminator

Subclass of the METS packager framework to disseminate a DSpace Archival Information Package (AIP). The AIP is intended to be, foremost, a _complete_ and _accurate_ representation of one object in the DSpace object model. An AIP contains all of the information needed to restore the object precisely in another DSpace archive instance.

Configuration keys:

The following take as values a space-and-or-comma-separated list of plugin names that name *either* a DisseminationCrosswalk or StreamDisseminationCrosswalk plugin. Shown are the default values. The value may be a simple crosswalk name, or a METS MDsec-name followed by a colon and the crosswalk name e.g. "DSpaceDepositLicense:DSPACE_DEPLICENSE" # MD types to put in the sourceMD section of the object. aip.disseminate.sourceMD = AIP-TECHMD # MD types to put in the techMD section of the object (and member Bitstreams if an Item) aip.disseminate.techMD = PREMIS # MD types to put in digiprovMD section of the object. #aip.disseminate.digiprovMD = # MD types to put in the rightsMD section of the object. aip.disseminate.rightsMD = DSpaceDepositLicense:DSPACE_DEPLICENSE, \ CreativeCommonsRDF:DSPACE_CCRDF, CreativeCommonsText:DSPACE_CCTXT, METSRights # MD types to put in dmdSec's corresponding the object. aip.disseminate.dmd = MODS, DIM

Version:

$Revision: 1.1 $

Author:

Larry Stone, Tim Donohue, Mark Diggory

See Also:

AbstractMETSDisseminator, AbstractPackageDisseminator

Nested Class Summary

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

org.dspace.content.packager.AbstractMETSDisseminator.MdStreamCache

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARENT_DIV_TYPE TYPE of the div containing AIP's parent handle in its mptr.
static String	PROFILE_1_0 Unique identifier for the profile of the METS document.

Fields inherited from class org.dspace.content.packager.AbstractMETSDisseminator

TEMPLATE_TYPE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
InternalDSpaceAIPDisseminator()

Method Summary

Methods

Modifier and Type	Method and Description
void	addStructMap(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params, edu.harvard.hul.ois.mets.Mets mets) Adds another structMap element to contain the "parent link" that is an essential part of every AIP.
String	bundleToFileGrp(String bname) Returns name of METS fileGrp corresponding to a DSpace bundle name.
void	disseminate(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params, File pkgFile)
void	disseminate(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params, OutputStream outStream) Export the object (Item, Collection, or Community) as a "package" on the indicated OutputStream.
protected List<String>	getBundleList() Get our list of bundles to include/exclude in this AIP, based on the passed in parameters
String[]	getDigiprovMdTypes(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params) Return the name of all crosswalks to run for the digiprovMD section of the METS Manifest.
String[]	getDmdTypes(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params) Return the name of all crosswalks to run for the dmdSec section of the METS Manifest.
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.
String	getProfile() Return identifier string for the METS profile this produces.
String[]	getRightsMdTypes(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params) Return the name of all crosswalks to run for the rightsMD section of the METS Manifest.
String[]	getSourceMdTypes(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params) Return the name of all crosswalks to run for the sourceMD section of the METS Manifest.
String[]	getTechMdTypes(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params) Return the name of all crosswalks to run for the techMD section of the METS Manifest.
boolean	includeBundle(org.dspace.content.Bundle bundle) By default, include all bundles in AIP as content.
String	makeBitstreamURL(org.dspace.content.Bitstream bitstream, org.dspace.content.packager.PackageParameters params) Get the URL by which the METS manifest refers to a Bitstream member of an Item the "package".
protected edu.harvard.hul.ois.mets.helper.MdSec	makeMdSec(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, Class mdSecClass, String typeSpec, org.dspace.content.packager.PackageParameters params, org.dspace.content.packager.AbstractMETSDisseminator.MdStreamCache extraStreams) Create an element wrapped around a metadata reference (either mdWrap or mdRef); i.e.
edu.harvard.hul.ois.mets.MetsHdr	makeMetsHdr(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.content.packager.PackageParameters params) Create the metsHdr element for the AIP METS Manifest.

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

addAmdSec, addBitstreamsToZip, addLogoBitstream, addToAmdSec, findOriginalBitstream, gensym, getHandleURN, getMIMEType, getObjectTypeString, linkLicenseRefsToBitstreams, makeChildDiv, makeFileDiv, makeManifest, makePersistentID, resetCounter, setMdType, setMdType, writeZipPackage

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

addToPackageList, disseminateAll, getPackageList

Methods inherited from class java.lang.Object

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

Field Detail

PROFILE_1_0

public static final String PROFILE_1_0

Unique identifier for the profile of the METS document. To ensure uniqueness, it is the URL that the XML schema document would have _if_ there were to be one. There is no schema at this time.

See Also:

Constant Field Values

PARENT_DIV_TYPE

public static final String PARENT_DIV_TYPE

TYPE of the div containing AIP's parent handle in its mptr.

See Also:

Constant Field Values

Constructor Detail

InternalDSpaceAIPDisseminator

public InternalDSpaceAIPDisseminator()

Method Detail

makeBitstreamURL

public String makeBitstreamURL(org.dspace.content.Bitstream bitstream,
                      org.dspace.content.packager.PackageParameters params)

Get the URL by which the METS manifest refers to a Bitstream member of an Item the "package". Note that this ONLY has to work for the Bitstreams belonging to a Bunde in an Item, NOT for the other associated Bitstreams containing metadata streams, or logo of a Community/Collection, etc.

For an internal AIP, this is a reference to a file in the asset store. An external AIP names a file in the package with a relative URL, that is, relative pathname.

Overrides:

makeBitstreamURL in class org.dspace.content.packager.AbstractMETSDisseminator

Returns:

String in URL format naming path to bitstream.

disseminate

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

Export the object (Item, Collection, or Community) as a "package" on the indicated OutputStream. Package is any serialized representation of the item, at the discretion of the implementing class. It does not have to include content bitstreams.

Use the params parameter list to adjust the way the package is made, e.g. including a "metadataOnly" parameter might make the package a bare manifest in XML instead of a Zip file including manifest and contents.

Throws an exception of the chosen object is not acceptable or there is a failure creating the package.

Parameters:

context - DSpace context.

dso - DSpace object (item, collection, etc)

params - Properties-style list of options specific to this packager

outStream - File where export package should be written

Throws:

PackageValidationException - if package cannot be created or there is a fatal error in creating it.

org.dspace.content.crosswalk.CrosswalkException

org.dspace.authorize.AuthorizeException

SQLException

IOException

disseminate

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

Specified by:

disseminate in interface org.dspace.content.packager.PackageDisseminator

Overrides:

disseminate in class org.dspace.content.packager.AbstractMETSDisseminator

Throws:

org.dspace.content.packager.PackageValidationException

org.dspace.content.crosswalk.CrosswalkException

org.dspace.authorize.AuthorizeException

SQLException

IOException

getProfile

public String getProfile()

Return identifier string for the METS profile this produces.

Specified by:

getProfile in class org.dspace.content.packager.AbstractMETSDisseminator

Returns:

string name of profile.

bundleToFileGrp

public String bundleToFileGrp(String bname)

Returns name of METS fileGrp corresponding to a DSpace bundle name. For AIP the mapping is direct.

Specified by:

bundleToFileGrp in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

bname - name of DSpace bundle.

Returns:

string name of fileGrp

makeMetsHdr

public edu.harvard.hul.ois.mets.MetsHdr makeMetsHdr(org.dspace.core.Context context,
                                           org.dspace.content.DSpaceObject dso,
                                           org.dspace.content.packager.PackageParameters params)

Create the metsHdr element for the AIP METS Manifest.

CREATEDATE is time at which the package (i.e. this manifest) was created. LASTMODDATE is last-modified time of the target object, if available. Agent describes the archive this belongs to.

Specified by:

makeMetsHdr in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace Context

dso - current DSpace Object

params - Packager Parameters

Returns:

List of crosswalk names to run

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

getDmdTypes

public String[] getDmdTypes(org.dspace.core.Context context,
                   org.dspace.content.DSpaceObject dso,
                   org.dspace.content.packager.PackageParameters params)
                     throws SQLException,
                            IOException,
                            org.dspace.authorize.AuthorizeException

Return the name of all crosswalks to run for the dmdSec section of the METS Manifest.

Default is DIM (DSpace Internal Metadata) and MODS.

Specified by:

getDmdTypes in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace Context

dso - current DSpace Object

params - Packager Parameters

Returns:

List of crosswalk names to run

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

getTechMdTypes

public String[] getTechMdTypes(org.dspace.core.Context context,
                      org.dspace.content.DSpaceObject dso,
                      org.dspace.content.packager.PackageParameters params)
                        throws SQLException,
                               IOException,
                               org.dspace.authorize.AuthorizeException

Return the name of all crosswalks to run for the techMD section of the METS Manifest.

Default is PREMIS.

Specified by:

getTechMdTypes in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace Context

dso - current DSpace Object

params - Packager Parameters

Returns:

List of crosswalk names to run

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

getSourceMdTypes

public String[] getSourceMdTypes(org.dspace.core.Context context,
                        org.dspace.content.DSpaceObject dso,
                        org.dspace.content.packager.PackageParameters params)
                          throws SQLException,
                                 IOException,
                                 org.dspace.authorize.AuthorizeException

Return the name of all crosswalks to run for the sourceMD section of the METS Manifest.

Default is AIP-TECHMD.

In an AIP, the sourceMD element MUST include the original persistent identifier (Handle) of the object, and the original persistent ID (Handle) of its parent in the archive, so that it can be restored.

Specified by:

getSourceMdTypes in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace Context

dso - current DSpace Object

params - Packager Parameters

Returns:

List of crosswalk names to run

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

getDigiprovMdTypes

public String[] getDigiprovMdTypes(org.dspace.core.Context context,
                          org.dspace.content.DSpaceObject dso,
                          org.dspace.content.packager.PackageParameters params)
                            throws SQLException,
                                   IOException,
                                   org.dspace.authorize.AuthorizeException

Return the name of all crosswalks to run for the digiprovMD section of the METS Manifest.

By default, none are returned

Specified by:

getDigiprovMdTypes in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace Context

dso - current DSpace Object

params - Packager Parameters

Returns:

List of crosswalk names to run

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

getRightsMdTypes

public String[] getRightsMdTypes(org.dspace.core.Context context,
                        org.dspace.content.DSpaceObject dso,
                        org.dspace.content.packager.PackageParameters params)
                          throws SQLException,
                                 IOException,
                                 org.dspace.authorize.AuthorizeException

Return the name of all crosswalks to run for the rightsMD section of the METS Manifest.

By default, Deposit Licenses and CC Licenses will be added for Items. Also, by default METSRights info will be added for all objects.

Specified by:

getRightsMdTypes in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace Context

dso - current DSpace Object

params - Packager Parameters

Returns:

List of crosswalk names to run

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

addStructMap

public void addStructMap(org.dspace.core.Context context,
                org.dspace.content.DSpaceObject dso,
                org.dspace.content.packager.PackageParameters params,
                edu.harvard.hul.ois.mets.Mets mets)
                  throws SQLException,
                         IOException,
                         org.dspace.authorize.AuthorizeException,
                         edu.harvard.hul.ois.mets.helper.MetsException

Adds another structMap element to contain the "parent link" that is an essential part of every AIP. This is a structmap of one div, which contains an mptr indicating the Handle of the parent of this object in the archive. The div has a unique TYPE attribute value, "AIP Parent Link", and the mptr has a LOCTYPE of "HANDLE" and an xlink:href containing the raw Handle value.

Note that the parent Handle has to be stored here because the parent is needed to create a DSpace Object when restoring the AIP; it cannot be determined later once the ingester parses it out of the metadata when the crosswalks are run. So, since the crosswalks require an object to operate on, and creating the object requires a parent, we cannot depend on metadata processed by crosswalks (e.g. AIP techMd) for the parent, it has to be at a higher level in the AIP manifest. The structMap is an obvious and standards-compliant location for it.

Specified by:

addStructMap in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace context

dso - Current DSpace object

params - Packager Parameters

mets - METS manifest

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

edu.harvard.hul.ois.mets.helper.MetsException

includeBundle

public boolean includeBundle(org.dspace.content.Bundle bundle)

By default, include all bundles in AIP as content.

However, if the user specified a comma separated list of bundle names via the "filterBundles" (or "includeBundles") option, then check if this bundle is in that list. If it is, return true. If it is not, return false.

Specified by:

includeBundle in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

bundle - Bundle to check for

Returns:

true if bundle should be disseminated when disseminating Item AIPs

getBundleList

protected List<String> getBundleList()

Get our list of bundles to include/exclude in this AIP, based on the passed in parameters

Returns:

List of bundles to filter on

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.PackageDisseminator

Overrides:

getParameterHelp in class org.dspace.content.packager.AbstractMETSDisseminator

Returns:

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

makeMdSec

protected edu.harvard.hul.ois.mets.helper.MdSec makeMdSec(org.dspace.core.Context context,
                                              org.dspace.content.DSpaceObject dso,
                                              Class mdSecClass,
                                              String typeSpec,
                                              org.dspace.content.packager.PackageParameters params,
                                              org.dspace.content.packager.AbstractMETSDisseminator.MdStreamCache extraStreams)
                                                   throws SQLException,
                                                          org.dspace.content.packager.PackageValidationException,
                                                          org.dspace.content.crosswalk.CrosswalkException,
                                                          IOException,
                                                          org.dspace.authorize.AuthorizeException

Create an element wrapped around a metadata reference (either mdWrap or mdRef); i.e. dmdSec, techMd, sourceMd, etc. Checks for XML-DOM oriented crosswalk first, then if not found looks for stream crosswalk of the same name.

Overrides:

makeMdSec in class org.dspace.content.packager.AbstractMETSDisseminator

Parameters:

context - DSpace Context

dso - DSpace Object we are generating METS manifest for

mdSecClass - class of mdSec (TechMD, RightsMD, DigiProvMD, etc)

typeSpec - Type of metadata going into this mdSec (e.g. MODS, DC, PREMIS, etc)

params - the PackageParameters

extraStreams - list of extra files which need to be added to final dissemination package

Returns:

mdSec element or null if xwalk returns empty results.

Throws:

SQLException

PackageValidationException

org.dspace.content.crosswalk.CrosswalkException

IOException

org.dspace.authorize.AuthorizeException