Uses of Class
org.dspace.content.packager.PackageParameters

Packages that use PackageParameters

Package	Description
org.dspace.app.packager	Tools for exporting and importing DSpace objects (Community, Collection, Item, etc.) wrapped in various kinds of packaging.
org.dspace.content.crosswalk	Provides an API and implementations of metadata crosswalks, which are directional mappings from one schema to another, performed in the context of Item ingestion or dissemination.
org.dspace.content.packager	Provides an API and implementations of content packages, used in the context of ingest (SIP), or dissemination (DIP)

Uses of PackageParameters in org.dspace.app.packager

Methods in org.dspace.app.packager with parameters of type PackageParameters

Modifier and Type	Method	Description
protected void	Packager.disseminate(Context context, PackageDisseminator dip, DSpaceObject dso, PackageParameters pkgParams, String outputFile)	Disseminate one or more DSpace objects into package(s) based on the options passed to the 'packager' script
protected void	Packager.ingest(Context context, PackageIngester sip, PackageParameters pkgParams, String sourceFile, DSpaceObject[] parentObjs)	Ingest one or more DSpace objects from package(s) based on the options passed to the 'packager' script.
protected void	Packager.replace(Context context, PackageIngester sip, PackageParameters pkgParams, String sourceFile, DSpaceObject objToReplace)	Replace an one or more existing DSpace objects with the contents of specified package(s) based on the options passed to the 'packager' script.

Uses of PackageParameters in org.dspace.content.crosswalk

Methods in org.dspace.content.crosswalk that return PackageParameters

Modifier and Type	Method	Description
PackageParameters	AbstractPackagerWrappingCrosswalk.getPackagingParameters()	Get custom packaging parameters for this Crosswalk.

Methods in org.dspace.content.crosswalk with parameters of type PackageParameters

Modifier and Type	Method	Description
void	AbstractPackagerWrappingCrosswalk.setPackagingParameters(PackageParameters pparams)	Set custom packaging parameters for this Crosswalk.

Uses of PackageParameters in org.dspace.content.packager

Fields in org.dspace.content.packager declared as PackageParameters

Modifier and Type	Field	Description
protected PackageParameters	DSpaceAIPDisseminator.disseminateParams

Methods in org.dspace.content.packager that return PackageParameters

Modifier and Type	Method	Description
static PackageParameters	PackageParameters.create(jakarta.servlet.ServletRequest request)	Creates new parameters object with the parameter values from a servlet request object.

Methods in org.dspace.content.packager with parameters of type PackageParameters

Modifier and Type	Method	Description
protected String	AbstractMETSDisseminator.addAmdSec(Context context, DSpaceObject dso, PackageParameters params, edu.harvard.hul.ois.mets.Mets mets, AbstractMETSDisseminator.MdStreamCache extraStreams)
protected void	AbstractMETSIngester.addBitstreams(Context context, Item item, METSManifest manifest, File pkgFile, PackageParameters params, AbstractMETSIngester.MdrefManager mdRefCallback)	Add Bitstreams to an Item, based on the files listed in the METS Manifest
protected void	AbstractMETSDisseminator.addBitstreamsToZip(Context context, DSpaceObject dso, PackageParameters params, ZipOutputStream zip)	Add Bitstreams associated with a given DSpace Object into an existing ZipOutputStream
protected void	AbstractMETSIngester.addContainerLogo(Context context, DSpaceObject dso, METSManifest manifest, File pkgFile, PackageParameters params)	Add a Logo to a Community or Collection container object based on a METS Manifest.
abstract void	AbstractMETSIngester.addLicense(Context context, Item item, String license, Collection collection, PackageParameters params)	Add license(s) to Item based on contents of METS and other policies.
void	DSpaceAIPIngester.addLicense(Context context, Item item, String license, Collection collection, PackageParameters params)	Ignore license when restoring an manifest-only AIP, since it should be a bitstream in the AIP already.
void	DSpaceMETSIngester.addLicense(Context context, Item item, String license, Collection collection, PackageParameters params)	Policy: For DSpace deposit license, take deposit license supplied by explicit argument first, else use collection's default deposit license.
protected void	AbstractMETSDisseminator.addLogoBitstream(Context context, Bitstream logoBs, edu.harvard.hul.ois.mets.FileSec fileSec, edu.harvard.hul.ois.mets.Div div0, PackageParameters params)
abstract void	AbstractMETSDisseminator.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.
void	DSpaceAIPDisseminator.addStructMap(Context context, DSpaceObject dso, 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.
void	DSpaceMETSDisseminator.addStructMap(Context context, DSpaceObject dso, PackageParameters params, edu.harvard.hul.ois.mets.Mets mets)
protected void	AbstractMETSIngester.addTemplateItem(Context context, DSpaceObject dso, METSManifest manifest, File pkgFile, PackageParameters params, AbstractMETSIngester.MdrefManager callback)	Add a Template Item to a Collection container object based on a METS Manifest.
protected void	AbstractMETSDisseminator.addToAmdSec(edu.harvard.hul.ois.mets.AmdSec fAmdSec, String[] mdTypes, Class mdSecClass, Context context, DSpaceObject dso, PackageParameters params, AbstractMETSDisseminator.MdStreamCache extraStreams)
static DSpaceObject	PackageUtils.createDSpaceObject(Context context, DSpaceObject parent, int type, String handle, UUID uuid, PackageParameters params)	Create the specified DSpace Object, based on the passed in Package Parameters (along with other basic info required to create the object)
void	METSManifest.crosswalkBitstream(Context context, PackageParameters params, Bitstream bitstream, String fileId, METSManifest.Mdref callback)	Crosswalk the metadata associated with a particular file element into the bitstream it corresponds to.
void	METSManifest.crosswalkBundle(Context context, PackageParameters params, Bundle bundle, String fileId, METSManifest.Mdref callback)
void	METSManifest.crosswalkItemDmd(Context context, PackageParameters params, DSpaceObject dso, org.jdom2.Element dmdSec, METSManifest.Mdref callback)	Invokes appropriate crosswalks on Item-wide descriptive metadata.
abstract void	AbstractMETSIngester.crosswalkObjectDmd(Context context, DSpaceObject dso, METSManifest manifest, AbstractMETSIngester.MdrefManager callback, org.jdom2.Element[] dmds, PackageParameters params)	Select the dmdSec element(s) to apply to the Item.
void	DSpaceAIPIngester.crosswalkObjectDmd(Context context, DSpaceObject dso, METSManifest manifest, AbstractMETSIngester.MdrefManager callback, org.jdom2.Element[] dmds, PackageParameters params)	Choose DMD section(s) to crosswalk.
void	DSpaceMETSIngester.crosswalkObjectDmd(Context context, DSpaceObject dso, METSManifest manifest, AbstractMETSIngester.MdrefManager callback, org.jdom2.Element[] dmds, PackageParameters params)	Choose DMD section(s) to crosswalk.
void	METSManifest.crosswalkObjectOtherAdminMD(Context context, PackageParameters params, DSpaceObject dso, METSManifest.Mdref callback)	Crosswalk all technical and source metadata sections that belong to the whole object.
boolean	METSManifest.crosswalkObjectSourceMD(Context context, PackageParameters params, DSpaceObject dso, METSManifest.Mdref callback)	Just crosswalk the sourceMD sections; used to set the handle and parent of AIP.
protected void	METSManifest.crosswalkXmd(Context context, PackageParameters params, DSpaceObject dso, org.jdom2.Element xmd, METSManifest.Mdref callback, boolean createMissingMetadataFields)
void	AbstractMETSDisseminator.disseminate(Context context, DSpaceObject dso, PackageParameters params, File pkgFile)	Export the object (Item, Collection, or Community) as a "package" on the indicated OutputStream.
void	DSpaceAIPDisseminator.disseminate(Context context, DSpaceObject dso, PackageParameters params, File pkgFile)
void	PackageDisseminator.disseminate(Context context, DSpaceObject object, PackageParameters params, File pkgFile)	Export the object (Item, Collection, or Community) as a "package" on the indicated OutputStream.
void	PDFPackager.disseminate(Context context, DSpaceObject dso, PackageParameters params, File pkgFile)	VERY crude dissemination: just look for the first bitstream with the PDF package type, and toss it out.
void	RoleDisseminator.disseminate(Context context, DSpaceObject object, PackageParameters params, File pkgFile)
List<File>	AbstractPackageDisseminator.disseminateAll(Context context, DSpaceObject dso, PackageParameters params, File pkgFile)	Recursively export one or more DSpace Objects as a series of packages.
List<File>	PackageDisseminator.disseminateAll(Context context, DSpaceObject dso, PackageParameters params, File pkgFile)	Recursively export one or more DSpace Objects as a series of packages.
List<File>	PDFPackager.disseminateAll(Context context, DSpaceObject dso, PackageParameters params, File pkgFile)	disseminateAll() cannot be implemented for a PDF disseminator, because there's only one PDF to disseminate
List<File>	RoleDisseminator.disseminateAll(Context context, DSpaceObject dso, PackageParameters params, File pkgFile)
abstract void	AbstractMETSIngester.finishBitstream(Context context, Bitstream bs, org.jdom2.Element mfile, METSManifest manifest, PackageParameters params)	Subclass-dependent final processing on a Bitstream; could include fixing up the name, bundle, other attributes.
void	DSpaceAIPIngester.finishBitstream(Context context, Bitstream bs, org.jdom2.Element mfile, METSManifest manifest, PackageParameters params)	Nothing extra to do to bitstream after ingestion.
void	DSpaceMETSIngester.finishBitstream(Context context, Bitstream bs, org.jdom2.Element mfile, METSManifest manifest, PackageParameters params)	Take a second pass over files to correct names of derived files (e.g. thumbnails, extracted text) to what DSpace expects:
static Item	PackageUtils.finishCreateItem(Context context, WorkspaceItem wsi, String handle, PackageParameters params)	Perform any final tasks on a newly created WorkspaceItem in order to finish ingestion of an Item.
abstract void	AbstractMETSIngester.finishObject(Context context, DSpaceObject dso, PackageParameters params)	Hook for final "finishing" operations on the new Object.
void	DSpaceAIPIngester.finishObject(Context context, DSpaceObject dso, PackageParameters params)	Last change to fix up a DSpace Object.
void	DSpaceMETSIngester.finishObject(Context context, DSpaceObject dso, PackageParameters params)
abstract String[]	AbstractMETSDisseminator.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.
String[]	DSpaceAIPDisseminator.getDigiprovMdTypes(Context context, DSpaceObject dso, PackageParameters params)	Return the name of all crosswalks to run for the digiprovMD section of the METS Manifest.
String[]	DSpaceMETSDisseminator.getDigiprovMdTypes(Context context, DSpaceObject dso, PackageParameters params)
abstract String[]	AbstractMETSDisseminator.getDmdTypes(Context context, DSpaceObject dso, PackageParameters params)	Get the types of Item-wide DMD to include in package.
String[]	DSpaceAIPDisseminator.getDmdTypes(Context context, DSpaceObject dso, PackageParameters params)	Return the name of all crosswalks to run for the dmdSec section of the METS Manifest.
String[]	DSpaceMETSDisseminator.getDmdTypes(Context context, DSpaceObject dso, PackageParameters params)	Get DMD choice for Item.
protected static InputStream	AbstractMETSIngester.getFileInputStream(File pkgFile, PackageParameters params, String path)	Retrieve the inputStream for a File referenced from a specific path within a METS package.
String	AbstractMETSDisseminator.getMIMEType(PackageParameters params)
String	PackageDisseminator.getMIMEType(PackageParameters params)	Identifies the MIME-type of this package, e.g.
String	PDFPackager.getMIMEType(PackageParameters params)	Identifies the MIME-type of this package, i.e.
String	RoleDisseminator.getMIMEType(PackageParameters params)
abstract String[]	AbstractMETSDisseminator.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.
String[]	DSpaceAIPDisseminator.getRightsMdTypes(Context context, DSpaceObject dso, PackageParameters params)	Return the name of all crosswalks to run for the rightsMD section of the METS Manifest.
String[]	DSpaceMETSDisseminator.getRightsMdTypes(Context context, DSpaceObject dso, PackageParameters params)	Add rights MD (licenses) for DSpace item.
abstract String[]	AbstractMETSDisseminator.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.
String[]	DSpaceAIPDisseminator.getSourceMdTypes(Context context, DSpaceObject dso, PackageParameters params)	Return the name of all crosswalks to run for the sourceMD section of the METS Manifest.
String[]	DSpaceMETSDisseminator.getSourceMdTypes(Context context, DSpaceObject dso, PackageParameters params)
abstract String[]	AbstractMETSDisseminator.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.
String[]	DSpaceAIPDisseminator.getTechMdTypes(Context context, DSpaceObject dso, PackageParameters params)	Return the name of all crosswalks to run for the techMD section of the METS Manifest.
String[]	DSpaceMETSDisseminator.getTechMdTypes(Context context, DSpaceObject dso, PackageParameters params)	Get name of technical metadata crosswalk for Bitstreams.
DSpaceObject	AbstractMETSIngester.ingest(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)	Create a new DSpace object out of a METS content package.
DSpaceObject	PackageIngester.ingest(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)	Create new DSpaceObject out of the ingested package.
DSpaceObject	PDFPackager.ingest(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)	Create new Item out of the ingested package, in the indicated collection.
DSpaceObject	RoleIngester.ingest(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)
List<String>	AbstractPackageIngester.ingestAll(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)	Recursively create one or more DSpace Objects out of the contents of the ingested package (and all other referenced packages).
List<String>	PackageIngester.ingestAll(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)	Recursively create one or more DSpace Objects out of the contents of the ingested package (and all other referenced packages).
List<String>	PDFPackager.ingestAll(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)	IngestAll() cannot be implemented for a PDF ingester, because there's only one PDF to ingest
List<String>	RoleIngester.ingestAll(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)
protected DSpaceObject	AbstractMETSIngester.ingestObject(Context context, DSpaceObject parent, METSManifest manifest, File pkgFile, PackageParameters params, String license)	Ingest/import a single DSpace Object, based on the associated METS Manifest and the parameters passed to the METSIngester
void	RoleIngester.ingestStream(Context context, DSpaceObject parent, PackageParameters params, InputStream stream)	Ingest roles from an InputStream.
protected void	AbstractMETSDisseminator.linkLicenseRefsToBitstreams(Context context, PackageParameters params, DSpaceObject dso, edu.harvard.hul.ois.mets.MdRef mdRef)	Cleanup our license file reference links, as Deposit Licenses and 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)
String	AbstractMETSDisseminator.makeBitstreamURL(Context context, 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	AbstractMETSDisseminator.makeChildDiv(String type, DSpaceObject dso, PackageParameters params)	Create a <div> element with <mptr> 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.Mets	AbstractMETSDisseminator.makeManifest(Context context, DSpaceObject dso, PackageParameters params, AbstractMETSDisseminator.MdStreamCache extraStreams)	Write out a METS manifest.
protected edu.harvard.hul.ois.mets.helper.MdSec	AbstractMETSDisseminator.makeMdSec(Context context, DSpaceObject dso, Class mdSecClass, String typeSpec, PackageParameters params, AbstractMETSDisseminator.MdStreamCache extraStreams)	Create an element wrapped around a metadata reference (either mdWrap or mdRef); i.e.dmdSec, techMd, sourceMd, etc.
abstract edu.harvard.hul.ois.mets.MetsHdr	AbstractMETSDisseminator.makeMetsHdr(Context context, DSpaceObject dso, PackageParameters params)	Create metsHdr element - separate so subclasses can override.
edu.harvard.hul.ois.mets.MetsHdr	DSpaceAIPDisseminator.makeMetsHdr(Context context, DSpaceObject dso, PackageParameters params)	Create the metsHdr element for the AIP METS Manifest.
edu.harvard.hul.ois.mets.MetsHdr	DSpaceMETSDisseminator.makeMetsHdr(Context context, DSpaceObject dso, PackageParameters params)	Create metsHdr element - separate so subclasses can override.
protected METSManifest	AbstractMETSIngester.parsePackage(Context context, File pkgFile, PackageParameters params)	Parse a given input package, ultimately returning the METS manifest out of the package.
boolean	DSpaceMETSIngester.probe(Context context, InputStream in, PackageParameters params)
DSpaceObject	AbstractMETSIngester.replace(Context context, DSpaceObject dsoToReplace, File pkgFile, PackageParameters params)	Replace an existing DSpace object with the contents of a METS-based package.
DSpaceObject	PackageIngester.replace(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)	Replace an existing DSpace Object with contents of the ingested package.
DSpaceObject	PDFPackager.replace(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)	Replace is not implemented.
DSpaceObject	RoleIngester.replace(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)
List<String>	AbstractPackageIngester.replaceAll(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)	Recursively replace one or more DSpace Objects out of the contents of the ingested package (and all other referenced packages).
List<String>	PackageIngester.replaceAll(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)	Recursively replace one or more DSpace Objects out of the contents of the ingested package (and all other referenced packages).
List<String>	PDFPackager.replaceAll(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)	ReplaceAll() cannot be implemented for a PDF ingester, because there's only one PDF to ingest
List<String>	RoleIngester.replaceAll(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)
protected DSpaceObject	AbstractMETSIngester.replaceObject(Context context, DSpaceObject dso, METSManifest manifest, File pkgFile, PackageParameters params, String license)	Replace the contents of a single DSpace Object, based on the associated METS Manifest and the parameters passed to the METSIngester.
protected void	AbstractMETSDisseminator.writeZipPackage(Context context, DSpaceObject dso, PackageParameters params, OutputStream pkg)	Make a Zipped up METS package for the given DSpace Object