Package org.dspace.pack.bagit

Class BagItAipWriter

java.lang.Object

org.dspace.pack.bagit.BagItAipWriter

public class BagItAipWriter
extends Object

The BagItAipWriter handles the packaging of DSpaceObjects into their respective bags. It processes the metadata and bitstreams given to it by the various Packers in order to write the object.properties, metadata.xml, etc for each AIP.

Since:

2020-03-02

Author:

mikejritter

Field Summary

Fields

Modifier and Type	Field	Description
static String	BAG_AIP
static String	BAG_MAN
static String	METADATA_XML
static String	OBJ_TYPE_COLLECTION
static String	OBJ_TYPE_COMMUNITY
static String	OBJ_TYPE_DELETION
static String	OBJ_TYPE_ITEM
static String	POLICY_XML
static String	PROPERTIES_DELIMITER
static String	ROLES_XML
static String	TEMPLATE_XML

Constructor Summary

Constructors

Constructor	Description
BagItAipWriter(org.dspace.core.Context context, File directory, String archFmt, Map<String,List<String>> properties)	Constructor for a BagItAipWriter.

Method Summary

Modifier and Type	Method	Description
File	packageAip()	Create a serialized BagIt bag using the parameters the BagItAipWriter was instantiated with
BagItAipWriter	withBitstreams(List<BagBitstream> bitstreams)
BagItAipWriter	withDSpaceRoles(DSpaceRoles dSpaceRoles)
BagItAipWriter	withItemTemplate(Metadata itemTemplate)
BagItAipWriter	withLogo(org.dspace.content.Bitstream logo)
BagItAipWriter	withMetadata(Metadata metadata)
BagItAipWriter	withPolicies(Policies policies)

Methods inherited from class java.lang.Object

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

Field Detail

BAG_AIP

public static final String BAG_AIP

See Also:

Constant Field Values

BAG_MAN

public static final String BAG_MAN

See Also:

Constant Field Values

OBJ_TYPE_ITEM

public static final String OBJ_TYPE_ITEM

See Also:

Constant Field Values

OBJ_TYPE_DELETION

public static final String OBJ_TYPE_DELETION

See Also:

Constant Field Values

OBJ_TYPE_COMMUNITY

public static final String OBJ_TYPE_COMMUNITY

See Also:

Constant Field Values

OBJ_TYPE_COLLECTION

public static final String OBJ_TYPE_COLLECTION

See Also:

Constant Field Values

PROPERTIES_DELIMITER

public static final String PROPERTIES_DELIMITER

See Also:

Constant Field Values

ROLES_XML

public static final String ROLES_XML

See Also:

Constant Field Values

POLICY_XML

public static final String POLICY_XML

See Also:

Constant Field Values

METADATA_XML

public static final String METADATA_XML

See Also:

Constant Field Values

TEMPLATE_XML

public static final String TEMPLATE_XML

See Also:

Constant Field Values

Constructor Detail

BagItAipWriter

public BagItAipWriter(org.dspace.core.Context context,
                      File directory,
                      String archFmt,
                      Map<String,List<String>> properties)

Constructor for a BagItAipWriter. Takes a minimal set of information needed in order to write an AIP as a BagIt bag for dspace consumption.

Parameters:

context - the context to use

directory - the root File which the bag will be written to

archFmt - the serialization format when archiving the bag to a single file

properties - a Map which maps a filename with a list of lines to write to the file

Method Detail

withLogo

public BagItAipWriter withLogo(org.dspace.content.Bitstream logo)

Parameters:

logo - the Bitstream of the logo, or null

Returns:

the BagItAipWriter used for creating the aip

withPolicies

public BagItAipWriter withPolicies(Policies policies)

Parameters:

policies - the Policies to write to the bags data/policy.xml

Returns:

the BagItAipWriter used for creating the aip

withMetadata

public BagItAipWriter withMetadata(Metadata metadata)

Parameters:

metadata - the Metadata to write to the bags data/metadata.xml

Returns:

the BagItAipWriter used for creating the aip

withItemTemplate

public BagItAipWriter withItemTemplate(Metadata itemTemplate)

Parameters:

itemTemplate - the Metadata for an Item Template

Returns:

the BagItAipWriter

withDSpaceRoles

public BagItAipWriter withDSpaceRoles(DSpaceRoles dSpaceRoles)

Parameters:

dSpaceRoles - the DSpaceRoles to write to the bags data/roles.xml

Returns:

the BagItAipWriter used for creating the aip

withBitstreams

public BagItAipWriter withBitstreams(List<BagBitstream> bitstreams)

Parameters:

bitstreams - a List of BagBitstreams which should be written as payload files for the bag

Returns:

the BagItAipWriter used for creating the aip

packageAip

public File packageAip()
                throws IOException,
                       SQLException,
                       org.dspace.authorize.AuthorizeException

Create a serialized BagIt bag using the parameters the BagItAipWriter was instantiated with

Returns:

the location of the serialized bag, as a File

Throws:

IOException - if there are any errors writing to the bag

SQLException - if there is a problem querying BitstreamService.retrieve(Context, Bitstream)

org.dspace.authorize.AuthorizeException - if there is a problem querying BitstreamService.retrieve(Context, Bitstream)