Package org.dspace.content.crosswalk

Class AbstractPackagerWrappingCrosswalk

java.lang.Object

org.dspace.content.crosswalk.AbstractPackagerWrappingCrosswalk

Direct Known Subclasses:

RoleCrosswalk

public abstract class AbstractPackagerWrappingCrosswalk
extends Object

Packager Wrapping Crosswalk plugin

A Packager Wrapping Crosswalk is a crosswalk which works with or wraps an existing Packager for all or some of its crosswalking functionality.

Crosswalks which utilize Packagers for ingestion/dissemination do not always have enough information to call a Packager (org.dspace.content.packager.*) with the proper parameters. This abstract class allows the crosswalk to store its own PackageParameters and deposit license, which can then be used by the Crosswalk to call a PackageIngester or PackagerDisseminator with all the proper parameters.

Version:

$Revision: 3761 $

Author:

Tim Donohue

See Also:

IngestionCrosswalk, DisseminationCrosswalk, PackageIngester, PackageDisseminator, PackageParameters

Constructor Summary

Constructors

Constructor	Description
AbstractPackagerWrappingCrosswalk()

Method Summary

Modifier and Type	Method	Description
String	getIngestionLicense()	Get custom ingestion license for this Crosswalk.
PackageParameters	getPackagingParameters()	Get custom packaging parameters for this Crosswalk.
void	setIngestionLicense(String license)	Set custom ingestion license for this Crosswalk.
void	setPackagingParameters(PackageParameters pparams)	Set custom packaging parameters for this Crosswalk.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPackagerWrappingCrosswalk

public AbstractPackagerWrappingCrosswalk()

Method Detail

setPackagingParameters

public void setPackagingParameters(PackageParameters pparams)

Set custom packaging parameters for this Crosswalk.

These PackageParameters can be used to pass on to a Packager Plugin to actually perform the dissemination/ingestion required by this crosswalk.

The crosswalk itself can choose how to utilize or obey these PackageParameters. this method just provides the crosswalk access to these parameters, so that it can make smarter decisions about how to call a particular Packager.

Parameters:

pparams - PackageParameters to make available to the Crosswalk

getPackagingParameters

public PackageParameters getPackagingParameters()

Get custom packaging parameters for this Crosswalk.

These PackageParameters can be used to pass on to a Packager Plugin to actually perform the dissemination/ingestion required by this crosswalk.

The crosswalk itself can choose how to utilize or obey these PackageParameters. this method just provides the crosswalk access to these parameters, so that it can make smarter decisions about how to call a particular Packager.

Returns:

PackageParameters previously made available to the Crosswalk or null

setIngestionLicense

public void setIngestionLicense(String license)

Set custom ingestion license for this Crosswalk.

This license can be used by the crosswalk when calling a PackageIngester

Parameters:

license - the full text of the ingestion license

See Also:

PackageIngester

getIngestionLicense

public String getIngestionLicense()

Get custom ingestion license for this Crosswalk.

This license can be used by the crosswalk when calling a PackageIngester

Returns:

the full text of the ingestion license as a String

See Also:

PackageIngester