org.dspace.content.packager

Class AbstractMETSDisseminator

java.lang.Object

org.dspace.content.packager.AbstractPackageDisseminator

org.dspace.content.packager.AbstractMETSDisseminator

All Implemented Interfaces:

PackageDisseminator

Direct Known Subclasses:

DSpaceAIPDisseminator, DSpaceMETSDisseminator

public abstract class AbstractMETSDisseminator
extends AbstractPackageDisseminator

Base class for disseminator of METS (Metadata Encoding & Transmission Standard) Package.
See http://www.loc.gov/standards/mets/

This is a generic packager framework intended to be subclassed to create packagers for more specific METS "profiles". METS is an abstract and flexible framework that can encompass many different kinds of metadata and inner package structures.

Package Parameters:

• manifestOnly -- if true, generate a standalone XML document of the METS manifest instead of a complete package. Any other metadata (such as licenses) will be encoded inline. Default is false.
• unauthorized -- this determines what is done when the packager encounters a Bundle or Bitstream it is not authorized to read. By default, it just quits with an AuthorizeException. If this option is present, it must be one of the following values:
  • skip -- simply exclude unreadable content from package.
  • zero -- include unreadable bitstreams as 0-length files; unreadable Bundles will still cause authorize errors.

Version:

$Revision$

Author:

Larry Stone, Robert Tansley, Tim Donohue

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractMETSDisseminator.MdStreamCache Wrapper for a table of streams to add to the package, such as mdRef'd metadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	TEMPLATE_TYPE_SUFFIX Suffix for Template objects (e.g.

Constructor Summary

Constructors

Constructor and Description
AbstractMETSDisseminator()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	addAmdSec(Context context, DSpaceObject dso, PackageParameters params, edu.harvard.hul.ois.mets.Mets mets, AbstractMETSDisseminator.MdStreamCache extraStreams)
protected void	addBitstreamsToZip(Context context, DSpaceObject dso, PackageParameters params, java.util.zip.ZipOutputStream zip) Add Bitstreams associated with a given DSpace Object into an existing ZipOutputStream
protected void	addLogoBitstream(Bitstream logoBs, edu.harvard.hul.ois.mets.FileSec fileSec, edu.harvard.hul.ois.mets.Div div0, PackageParameters params)
abstract void	addStructMap(Context context, DSpaceObject dso, PackageParameters params, edu.harvard.hul.ois.mets.Mets mets) Add any additional structMap elements to the METS document, as required by this subclass.
protected void	addToAmdSec(edu.harvard.hul.ois.mets.AmdSec fAmdSec, java.lang.String[] mdTypes, java.lang.Class mdSecClass, Context context, DSpaceObject dso, PackageParameters params, AbstractMETSDisseminator.MdStreamCache extraStreams)
abstract java.lang.String	bundleToFileGrp(java.lang.String bname) Returns fileGrp's USE attribute value corresponding to a DSpace bundle name.
void	disseminate(Context context, DSpaceObject dso, PackageParameters params, java.io.File pkgFile) Export the object (Item, Collection, or Community) as a "package" on the indicated OutputStream.
protected static Bitstream	findOriginalBitstream(Item item, Bitstream derived) For a bitstream that's a thumbnail or extracted text, find the corresponding bitstream it was derived from, in the ORIGINAL bundle.
protected java.lang.String	gensym(java.lang.String prefix) Make a new unique ID symbol with specified prefix.
abstract java.lang.String[]	getDigiprovMdTypes(Context context, DSpaceObject dso, PackageParameters params) Get the type string of the "digiprov" (digital provenance) metadata to create for each object and each Bitstream in an Item.
abstract java.lang.String[]	getDmdTypes(Context context, DSpaceObject dso, PackageParameters params) Get the types of Item-wide DMD to include in package.
protected java.lang.String	getHandleURN(java.lang.String handle)
java.lang.String	getMIMEType(PackageParameters params) Identifies the MIME-type of this package, e.g.
java.lang.String	getObjectTypeString(DSpaceObject dso) Build a string which will be used as the "Type" of this object in the METS manifest.
java.lang.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.
abstract java.lang.String	getProfile() Returns name of METS profile to which this package conforms, e.g.
abstract java.lang.String[]	getRightsMdTypes(Context context, DSpaceObject dso, PackageParameters params) Get the type string of the "rights" (permission and/or license) metadata to create for each object and each Bitstream in an Item.
abstract java.lang.String[]	getSourceMdTypes(Context context, DSpaceObject dso, PackageParameters params) Get the type string of the source metadata to create for each object and each Bitstream in an Item.
abstract java.lang.String[]	getTechMdTypes(Context context, DSpaceObject dso, PackageParameters params) Get the type string of the technical metadata to create for each object and each Bitstream in an Item.
abstract boolean	includeBundle(Bundle bundle)
protected void	linkLicenseRefsToBitstreams(Context context, PackageParameters params, DSpaceObject dso, edu.harvard.hul.ois.mets.MdRef mdRef) Cleanup our license file reference links, as Deposit Licenses & CC Licenses can be added two ways (and we only want to add them to zip package *once*): (1) Added as a normal Bitstream (assuming LICENSE and CC_LICENSE bundles will be included in pkg) (2) Added via a 'rightsMD' crosswalk (as they are rights information/metadata on an Item)
java.lang.String	makeBitstreamURL(Bitstream bitstream, PackageParameters params) Get the URL by which the METS manifest refers to a Bitstream member within the same package.
protected edu.harvard.hul.ois.mets.Div	makeChildDiv(java.lang.String type, DSpaceObject dso, PackageParameters params) Create a element with which references a child object via its handle (and via a local file name, when recursively disseminating all child objects).
protected edu.harvard.hul.ois.mets.Div	makeFileDiv(java.lang.String fileID, java.lang.String type)
protected edu.harvard.hul.ois.mets.Mets	makeManifest(Context context, DSpaceObject dso, PackageParameters params, AbstractMETSDisseminator.MdStreamCache extraStreams) Write out a METS manifest.
protected edu.harvard.hul.ois.mets.helper.MdSec	makeMdSec(Context context, DSpaceObject dso, java.lang.Class mdSecClass, java.lang.String typeSpec, PackageParameters params, AbstractMETSDisseminator.MdStreamCache extraStreams) Create an element wrapped around a metadata reference (either mdWrap or mdRef); i.e.
abstract edu.harvard.hul.ois.mets.MetsHdr	makeMetsHdr(Context context, DSpaceObject dso, PackageParameters params) Create metsHdr element - separate so subclasses can override.
protected java.lang.String	makePersistentID(DSpaceObject dso)
protected void	resetCounter() Resets the unique ID counter used by gensym() method to determine the @ID values of METS tags.
protected void	setMdType(edu.harvard.hul.ois.mets.MdRef mdRef, java.lang.String mdtype)
protected void	setMdType(edu.harvard.hul.ois.mets.MdWrap mdWrap, java.lang.String mdtype)
protected void	writeZipPackage(Context context, DSpaceObject dso, PackageParameters params, java.io.OutputStream pkg) Make a Zipped up METS package for the given DSpace Object

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

TEMPLATE_TYPE_SUFFIX

protected static final java.lang.String TEMPLATE_TYPE_SUFFIX

Suffix for Template objects (e.g. Item Templates)

See Also:

Constant Field Values

Constructor Detail

AbstractMETSDisseminator

public AbstractMETSDisseminator()

Method Detail

gensym

protected java.lang.String gensym(java.lang.String prefix)

Make a new unique ID symbol with specified prefix.

Parameters:

prefix - the prefix of the identifier, constrained to XML ID schema

Returns:

a new string identifier unique in this session (instance).

resetCounter

protected void resetCounter()

Resets the unique ID counter used by gensym() method to determine the @ID values of METS tags.

getMIMEType

public java.lang.String getMIMEType(PackageParameters params)

Description copied from interface: PackageDisseminator

Identifies the MIME-type of this package, e.g. "application/zip". Required when sending the package via HTTP, to provide the Content-Type header.

Returns:

the MIME type (content-type header) of the package to be returned

disseminate

public void disseminate(Context context,
               DSpaceObject dso,
               PackageParameters params,
               java.io.File pkgFile)
                 throws PackageValidationException,
                        CrosswalkException,
                        AuthorizeException,
                        java.sql.SQLException,
                        java.io.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

pkgFile - File where export package should be written

Throws:

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

CrosswalkException

AuthorizeException

java.sql.SQLException

java.io.IOException

writeZipPackage

protected void writeZipPackage(Context context,
                   DSpaceObject dso,
                   PackageParameters params,
                   java.io.OutputStream pkg)
                        throws PackageValidationException,
                               CrosswalkException,
                               edu.harvard.hul.ois.mets.helper.MetsException,
                               AuthorizeException,
                               java.sql.SQLException,
                               java.io.IOException

Make a Zipped up METS package for the given DSpace Object

Parameters:

context - DSpace Context

dso - The DSpace Object

params - Parameters to the Packager script

pkg - Package output stream

Throws:

PackageValidationException

AuthorizeException

java.sql.SQLException

java.io.IOException

CrosswalkException

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

addBitstreamsToZip

protected void addBitstreamsToZip(Context context,
                      DSpaceObject dso,
                      PackageParameters params,
                      java.util.zip.ZipOutputStream zip)
                           throws PackageValidationException,
                                  AuthorizeException,
                                  java.sql.SQLException,
                                  java.io.IOException

Add Bitstreams associated with a given DSpace Object into an existing ZipOutputStream

Parameters:

context - DSpace Context

dso - The DSpace Object

params - Parameters to the Packager script

zip - Zip output

Throws:

PackageValidationException

AuthorizeException

java.sql.SQLException

java.io.IOException

setMdType

protected void setMdType(edu.harvard.hul.ois.mets.MdWrap mdWrap,
             java.lang.String mdtype)

setMdType

protected void setMdType(edu.harvard.hul.ois.mets.MdRef mdRef,
             java.lang.String mdtype)

makeMdSec

protected edu.harvard.hul.ois.mets.helper.MdSec makeMdSec(Context context,
                                              DSpaceObject dso,
                                              java.lang.Class mdSecClass,
                                              java.lang.String typeSpec,
                                              PackageParameters params,
                                              AbstractMETSDisseminator.MdStreamCache extraStreams)
                                                   throws java.sql.SQLException,
                                                          PackageValidationException,
                                                          CrosswalkException,
                                                          java.io.IOException,
                                                          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.

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:

java.sql.SQLException

PackageValidationException

CrosswalkException

java.io.IOException

AuthorizeException

addToAmdSec

protected void addToAmdSec(edu.harvard.hul.ois.mets.AmdSec fAmdSec,
               java.lang.String[] mdTypes,
               java.lang.Class mdSecClass,
               Context context,
               DSpaceObject dso,
               PackageParameters params,
               AbstractMETSDisseminator.MdStreamCache extraStreams)
                    throws java.sql.SQLException,
                           PackageValidationException,
                           CrosswalkException,
                           java.io.IOException,
                           AuthorizeException

Throws:

java.sql.SQLException

PackageValidationException

CrosswalkException

java.io.IOException

AuthorizeException

addAmdSec

protected java.lang.String addAmdSec(Context context,
                         DSpaceObject dso,
                         PackageParameters params,
                         edu.harvard.hul.ois.mets.Mets mets,
                         AbstractMETSDisseminator.MdStreamCache extraStreams)
                              throws java.sql.SQLException,
                                     PackageValidationException,
                                     CrosswalkException,
                                     java.io.IOException,
                                     AuthorizeException

Throws:

java.sql.SQLException

PackageValidationException

CrosswalkException

java.io.IOException

AuthorizeException

makePersistentID

protected java.lang.String makePersistentID(DSpaceObject dso)

makeManifest

protected edu.harvard.hul.ois.mets.Mets makeManifest(Context context,
                                         DSpaceObject dso,
                                         PackageParameters params,
                                         AbstractMETSDisseminator.MdStreamCache extraStreams)
                                              throws edu.harvard.hul.ois.mets.helper.MetsException,
                                                     PackageValidationException,
                                                     CrosswalkException,
                                                     AuthorizeException,
                                                     java.sql.SQLException,
                                                     java.io.IOException

Write out a METS manifest. Mostly lifted from Rob Tansley's METS exporter.

Throws:

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

PackageValidationException

CrosswalkException

AuthorizeException

java.sql.SQLException

java.io.IOException

addLogoBitstream

protected void addLogoBitstream(Bitstream logoBs,
                    edu.harvard.hul.ois.mets.FileSec fileSec,
                    edu.harvard.hul.ois.mets.Div div0,
                    PackageParameters params)

makeFileDiv

protected edu.harvard.hul.ois.mets.Div makeFileDiv(java.lang.String fileID,
                                       java.lang.String type)

makeChildDiv

protected edu.harvard.hul.ois.mets.Div makeChildDiv(java.lang.String type,
                                        DSpaceObject dso,
                                        PackageParameters params)

Create a

element with which references a child object via its handle (and via a local file name, when recursively disseminating all child objects).

Parameters:

type - - type attr value for the

dso - - object for which to create the div

params -

Returns:

a new Div with dso as child.

getHandleURN

protected java.lang.String getHandleURN(java.lang.String handle)

findOriginalBitstream

protected static Bitstream findOriginalBitstream(Item item,
                              Bitstream derived)
                                          throws java.sql.SQLException

For a bitstream that's a thumbnail or extracted text, find the corresponding bitstream it was derived from, in the ORIGINAL bundle.

Parameters:

item - the item we're dealing with

derived - the derived bitstream

Returns:

the corresponding original bitstream (or null)

Throws:

java.sql.SQLException

linkLicenseRefsToBitstreams

protected void linkLicenseRefsToBitstreams(Context context,
                               PackageParameters params,
                               DSpaceObject dso,
                               edu.harvard.hul.ois.mets.MdRef mdRef)
                                    throws java.sql.SQLException,
                                           java.io.IOException,
                                           AuthorizeException

Cleanup our license file reference links, as Deposit Licenses & CC Licenses can be added two ways (and we only want to add them to zip package *once*): (1) Added as a normal Bitstream (assuming LICENSE and CC_LICENSE bundles will be included in pkg) (2) Added via a 'rightsMD' crosswalk (as they are rights information/metadata on an Item)

So, if they are being added by *both*, then we want to just link the rightsMD entry so that it points to the Bitstream location. This implementation is a bit 'hackish', but it's the best we can do, as the Harvard METS API doesn't allow us to go back and crawl an entire METS file to look for these inconsistencies/duplications.

Parameters:

context - current DSpace Context

params - current Packager Parameters

dso - current DSpace Object

mdRef - the rightsMD element

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getObjectTypeString

public java.lang.String getObjectTypeString(DSpaceObject dso)

Build a string which will be used as the "Type" of this object in the METS manifest.

Default format is "DSpace [Type-as-string]".

Parameters:

dso - DSpaceObject to create type-string for

Returns:

a string which will represent this object Type in METS

See Also:

Constants

getParameterHelp

public java.lang.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.

Returns:

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

makeBitstreamURL

public java.lang.String makeBitstreamURL(Bitstream bitstream,
                                PackageParameters params)

Get the URL by which the METS manifest refers to a Bitstream member within the same package. In other words, this is generally a relative path link to where the Bitstream file is within the Zipped up package.

For a manifest-only METS, this is a reference to an HTTP URL where the bitstream should be able to be downloaded from.

Parameters:

bitstream - the Bitstream

params - Packager Parameters

Returns:

String in URL format naming path to bitstream.

makeMetsHdr

public abstract edu.harvard.hul.ois.mets.MetsHdr makeMetsHdr(Context context,
                                           DSpaceObject dso,
                                           PackageParameters params)

Create metsHdr element - separate so subclasses can override.

getProfile

public abstract java.lang.String getProfile()

Returns name of METS profile to which this package conforms, e.g. "DSpace METS DIP Profile 1.0"

Returns:

string name of profile.

bundleToFileGrp

public abstract java.lang.String bundleToFileGrp(java.lang.String bname)

Returns fileGrp's USE attribute value corresponding to a DSpace bundle name.

Parameters:

bname - name of DSpace bundle.

Returns:

string name of fileGrp

getDmdTypes

public abstract java.lang.String[] getDmdTypes(Context context,
                             DSpaceObject dso,
                             PackageParameters params)
                                        throws java.sql.SQLException,
                                               java.io.IOException,
                                               AuthorizeException

Get the types of Item-wide DMD to include in package. Each element of the returned array is a String, which MAY be just a simple name, naming both the Crosswalk Plugin and the METS "MDTYPE", or a colon-separated pair consisting of the METS name followed by a colon and the Crosswalk Plugin name. E.g. the type string "DC:qualifiedDublinCore" tells it to create a METS section with MDTYPE="DC" and use the plugin named "qualifiedDublinCore" to obtain the data.

Parameters:

params - the PackageParameters passed to the disseminator.

Returns:

array of metadata type strings, never null.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getTechMdTypes

public abstract java.lang.String[] getTechMdTypes(Context context,
                                DSpaceObject dso,
                                PackageParameters params)
                                           throws java.sql.SQLException,
                                                  java.io.IOException,
                                                  AuthorizeException

Get the type string of the technical metadata to create for each object and each Bitstream in an Item. The type string may be a simple name or colon-separated compound as specified for getDmdTypes() above.

Parameters:

params - the PackageParameters passed to the disseminator.

Returns:

array of metadata type strings, never null.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getSourceMdTypes

public abstract java.lang.String[] getSourceMdTypes(Context context,
                                  DSpaceObject dso,
                                  PackageParameters params)
                                             throws java.sql.SQLException,
                                                    java.io.IOException,
                                                    AuthorizeException

Get the type string of the source metadata to create for each object and each Bitstream in an Item. The type string may be a simple name or colon-separated compound as specified for getDmdTypes() above.

Parameters:

params - the PackageParameters passed to the disseminator.

Returns:

array of metadata type strings, never null.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getDigiprovMdTypes

public abstract java.lang.String[] getDigiprovMdTypes(Context context,
                                    DSpaceObject dso,
                                    PackageParameters params)
                                               throws java.sql.SQLException,
                                                      java.io.IOException,
                                                      AuthorizeException

Get the type string of the "digiprov" (digital provenance) metadata to create for each object and each Bitstream in an Item. The type string may be a simple name or colon-separated compound as specified for getDmdTypes() above.

Parameters:

params - the PackageParameters passed to the disseminator.

Returns:

array of metadata type strings, never null.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getRightsMdTypes

public abstract java.lang.String[] getRightsMdTypes(Context context,
                                  DSpaceObject dso,
                                  PackageParameters params)
                                             throws java.sql.SQLException,
                                                    java.io.IOException,
                                                    AuthorizeException

Get the type string of the "rights" (permission and/or license) metadata to create for each object and each Bitstream in an Item. The type string may be a simple name or colon-separated compound as specified for getDmdTypes() above.

Parameters:

params - the PackageParameters passed to the disseminator.

Returns:

array of metadata type strings, never null.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

addStructMap

public abstract void addStructMap(Context context,
                DSpaceObject dso,
                PackageParameters params,
                edu.harvard.hul.ois.mets.Mets mets)
                           throws java.sql.SQLException,
                                  java.io.IOException,
                                  AuthorizeException,
                                  edu.harvard.hul.ois.mets.helper.MetsException

Add any additional structMap elements to the METS document, as required by this subclass. A simple default structure map which fulfills the minimal DSpace METS DIP/SIP requirements is already present, so this does not need to do anything.

Parameters:

mets - the METS document to which to add structMaps

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

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

includeBundle

public abstract boolean includeBundle(Bundle bundle)

Returns:

true when this bundle should be included as "content" in the package.. e.g. DSpace SIP does not include metadata bundles.