Package org.dspace.content.packager

Interface PackageIngester

All Known Implementing Classes:

AbstractMETSIngester, AbstractPackageIngester, DSpaceAIPIngester, DSpaceMETSIngester, PDFPackager, RoleIngester

public interface PackageIngester

Plugin Interface to interpret a Submission Information Package (SIP) and create (or replace) a DSpace Object from its contents.

A package is a single data stream containing enough information to construct an Object (i.e. an Item, Collection, or Community). It can be anything from an archive like a Zip file with a manifest and metadata, to a simple manifest containing external references to the content, to a self-contained file such as a PDF. The interpretation of the package is entirely at the discretion of the implementing class.

The ingest methods are also given an attribute-value list of "parameters" which may modify their actions. The parameters list is a generalized mechanism to pass parameters from the requestor to the packager, since different packagers will understand different sets of parameters.

Version:

$Revision$

Author:

Larry Stone, Tim Donohue

See Also:

PackageParameters, AbstractPackageIngester

Method Summary

Modifier and Type	Method	Description
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.
DSpaceObject	ingest(Context context, DSpaceObject parent, File pkgFile, PackageParameters params, String license)	Create new DSpaceObject out of the ingested package.
List<String>	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).
DSpaceObject	replace(Context context, DSpaceObject dso, File pkgFile, PackageParameters params)	Replace an existing DSpace Object with contents of the ingested package.
List<String>	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).

Method Detail

ingest

DSpaceObject ingest(Context context,
                    DSpaceObject parent,
                    File pkgFile,
                    PackageParameters params,
                    String license)
             throws PackageException,
                    CrosswalkException,
                    AuthorizeException,
                    SQLException,
                    IOException,
                    WorkflowException

Create new DSpaceObject out of the ingested package. The object is created under the indicated parent. This creates a DSpaceObject. For Items, it is up to the caller to decide whether to install it or submit it to normal DSpace Workflow.

The deposit license (Only significant for Item) is passed explicitly as a string since there is no place for it in many package formats. It is optional and may be given as null.

Use ingestAll method to perform a recursive ingest of all packages which are referenced by an initial package.

Parameters:

context - DSpace context.

parent - parent under which to create new object (may be null -- in which case ingester must determine parent from package or throw an error).

pkgFile - The package file to ingest

params - Properties-style list of options (interpreted by each packager).

license - may be null, which takes default license.

Returns:

DSpaceObject created by ingest.

Throws:

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

CrosswalkException - if crosswalk error

AuthorizeException - if authorization error

SQLException - if database error

IOException - if IO error

WorkflowException - if workflow error

PackageException

ingestAll

List<String> ingestAll(Context context,
                       DSpaceObject parent,
                       File pkgFile,
                       PackageParameters params,
                       String license)
                throws PackageException,
                       UnsupportedOperationException,
                       CrosswalkException,
                       AuthorizeException,
                       SQLException,
                       IOException,
                       WorkflowException

Recursively create one or more DSpace Objects out of the contents of the ingested package (and all other referenced packages). The initial object is created under the indicated parent. All other objects are created based on their relationship to the initial object.

For example, a scenario may be to create a Collection based on a collection-level package, and also create an Item for every item-level package referenced by the collection-level package.

The output of this method is one or more newly created DSpaceObject Identifiers (i.e. Handles).

The packager may choose not to implement ingestAll, or simply forward the call to ingest if it is unable to support recursive ingestion.

The deposit license (Only significant for Item) is passed explicitly as a string since there is no place for it in many package formats. It is optional and may be given as null.

Parameters:

context - DSpace context.

parent - parent under which to create the initial object (may be null -- in which case ingester must determine parent from package or throw an error).

pkgFile - The initial package file to ingest

params - Properties-style list of options (interpreted by each packager).

license - may be null, which takes default license.

Returns:

List of Identifiers of DSpaceObjects created

Throws:

PackageValidationException - if initial package (or any referenced package) is unacceptable or there is a fatal error in creating a DSpaceObject

UnsupportedOperationException - if this packager does not implement ingestAll

CrosswalkException - if crosswalk error

AuthorizeException - if authorization error

SQLException - if database error

IOException - if IO error

WorkflowException - if workflow error

PackageException

replace

DSpaceObject replace(Context context,
                     DSpaceObject dso,
                     File pkgFile,
                     PackageParameters params)
              throws PackageException,
                     UnsupportedOperationException,
                     CrosswalkException,
                     AuthorizeException,
                     SQLException,
                     IOException,
                     WorkflowException

Replace an existing DSpace Object with contents of the ingested package. The packager may choose not to implement replace, since it somewhat contradicts the archival nature of DSpace. The exact function of this method is highly implementation-dependent.

Use replaceAll method to perform a recursive replace of objects referenced by a set of packages.

Parameters:

context - DSpace context.

dso - existing DSpace Object to be replaced, may be null if object to replace can be determined from package

pkgFile - The package file to ingest.

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

Returns:

DSpaceObject with contents replaced

Throws:

PackageValidationException - if package is unacceptable or there is a fatal error turning it into an Item.

UnsupportedOperationException - if this packager does not implement replace.

CrosswalkException - if crosswalk error

AuthorizeException - if authorization error

SQLException - if database error

IOException - if IO error

WorkflowException - if workflow error

PackageException

replaceAll

List<String> replaceAll(Context context,
                        DSpaceObject dso,
                        File pkgFile,
                        PackageParameters params)
                 throws PackageException,
                        UnsupportedOperationException,
                        CrosswalkException,
                        AuthorizeException,
                        SQLException,
                        IOException,
                        WorkflowException

Recursively replace one or more DSpace Objects out of the contents of the ingested package (and all other referenced packages). The initial object to replace is indicated by dso. All other objects are replaced based on information provided in the referenced packages.

For example, a scenario may be to replace a Collection based on a collection-level package, and also replace *every* Item in that collection based on the item-level packages referenced by the collection-level package.

Please note that since the dso input only specifies the initial object to replace, any additional objects to replace must be determined based on the referenced packages (or initial package itself).

The output of this method is one or more replaced DSpaceObject Identifiers (i.e. Handles).

The packager may choose not to implement replaceAll, since it somewhat contradicts the archival nature of DSpace. It also may choose to forward the call to replace if it is unable to support recursive replacement.

Parameters:

context - DSpace context.

dso - initial existing DSpace Object to be replaced, may be null if object to replace can be determined from package

pkgFile - The package file to ingest.

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

Returns:

List of Identifiers of DSpaceObjects replaced

Throws:

PackageValidationException - if initial package (or any referenced package) is unacceptable or there is a fatal error in creating a DSpaceObject

UnsupportedOperationException - if this packager does not implement replaceAll

CrosswalkException - if crosswalk error

AuthorizeException - if authorization error

SQLException - if database error

IOException - if IO error

WorkflowException - if workflow error

PackageException

getParameterHelp

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