Package org.dspace.content.packager

Provides an API and implementations of content packages, used in the context of ingest (SIP), or dissemination (DIP)

See: Description

Interface Summary

Interface	Description
METSManifest.Mdref	Callback interface to retrieve data streams in mdRef elements.
PackageDisseminator	Plugin Interface to produce Dissemination Information Package (DIP) of a DSpace object.
PackageIngester	Plugin Interface to interpret a Submission Information Package (SIP) and create (or replace) a DSpace Object from its contents.

Class Summary

Class	Description
AbstractMETSDisseminator	Base class for disseminator of METS (Metadata Encoding & Transmission Standard) Package. See http://www.loc.gov/standards/mets/
AbstractMETSDisseminator.MdStreamCache	Wrapper for a table of streams to add to the package, such as mdRef'd metadata.
AbstractMETSIngester	Base class for package ingester of METS (Metadata Encoding & Transmission Standard) Packages. See http://www.loc.gov/standards/mets/.
AbstractMETSIngester.MdrefManager	An instance of ZipMdrefManager holds the state needed to retrieve the contents of an external metadata stream referenced by an mdRef element in a Zipped up METS manifest.
AbstractPackageDisseminator	An abstract implementation of a DSpace Package Disseminator, which implements a few helper/utility methods that most (all?) PackageDisseminators may find useful.
AbstractPackageIngester	An abstract implementation of a DSpace Package Ingester, which implements a few helper/utility methods that most (all?) PackageIngesters may find useful.
DSpaceAIPDisseminator	Subclass of the METS packager framework to disseminate a DSpace Archival Information Package (AIP).
DSpaceAIPIngester	Subclass of the METS packager framework to ingest a DSpace Archival Information Package (AIP).
DSpaceMETSDisseminator	Packager plugin to produce a METS (Metadata Encoding & Transmission Standard) package that is accepted as a DSpace METS SIP (Submission Information Package).
DSpaceMETSIngester	Packager plugin to ingest a METS (Metadata Encoding & Transmission Standard) package that conforms to the DSpace METS SIP (Submission Information Package) Profile.
METSManifest	Manage the METS manifest document for METS importer classes, such as the package importer org.dspace.content.packager.MetsSubmission and the federated importer org.dspace.app.mets.FederatedMETSImport
PackageParameters	Parameter list for SIP and DIP packagers.
PackageUtils	Container class for code that is useful to many packagers.
PackageUtils.UnclosableInputStream	Stream wrapper that does not allow its wrapped stream to be closed.
PDFPackager	Accept a PDF file by itself as a SIP.
RoleDisseminator	Plugin to export all Group and EPerson objects in XML, perhaps for reloading.
RoleIngester	Create EPersons and Groups from a file of external representations.

Exception Summary

Exception	Description
PackageException	This is a superclass for exceptions representing a failure when importing or exporting a package.
PackageValidationException	This represents a failure when importing or exporting a package caused by invalid unacceptable package format or contents; for example, missing files that were mentioned in the manifest, or extra files not in manifest, or lack of a manifest.

Package org.dspace.content.packager Description

Provides an API and implementations of content packages, used in the context of ingest (SIP), or dissemination (DIP)

Packaging Interfaces

The principle interfaces are for ingesters and disseminators. The PackageIngester interface consists of the method:

WorkspaceItem ingest(Context context, Collection collection, InputStream in, PackageParameters params, String license)

There is also a 'replace' method, but this is not implemented consistently.

The PackageDisseminator interface consists of the method:

void disseminate(Context context, DSpaceObject object, PackageParameters params, OutputStream out)

Packaging Implementations

Ingester and disseminator implementations exist for METs and PDF packages, and the classes are designed to be extended for different profiles.

See Also:

AbstractMETSIngester, AbstractMETSDisseminator