org.duraspace.bagit

Class BagWriter

java.lang.Object

org.duraspace.bagit.BagWriter

public class BagWriter
extends Object

Utility to write BagIt bags.

Since:

2016-12-15

Author:

escowles

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAGIT_VERSION Version of the BagIt specification implemented

Constructor Summary

Constructors

Constructor and Description
BagWriter(File bagDir, Set<String> algorithms) Create a new, empty Bag

Method Summary

Modifier and Type	Method and Description
void	addTags(String key, Map<String,String> values) Add tags (metadata) to the Bag
File	getRootDir() Get the Bag's root directory
Map<String,String>	getTags(String key) Get the current tag (metadata) of the Bag
void	registerChecksums(String algorithm, Map<File,String> filemap) Register checksums of payload (data) files
void	write() Write metadata and finalize Bag

Methods inherited from class java.lang.Object

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

Field Detail

BAGIT_VERSION

public static String BAGIT_VERSION

Version of the BagIt specification implemented

Constructor Detail

BagWriter

public BagWriter(File bagDir,
                 Set<String> algorithms)

Create a new, empty Bag

Parameters:

bagDir - The base directory for the Bag (will be created if it doesn't exist)

algorithms - Set of digest algorithms to use for manifests (e.g., "md5", "sha1", or "sha256")

Method Detail

getRootDir

public File getRootDir()

Get the Bag's root directory

Returns:

File object for the directory

registerChecksums

public void registerChecksums(String algorithm,
                              Map<File,String> filemap)

Register checksums of payload (data) files

Parameters:

algorithm - Checksum digest algorithm name (e.g., "SHA-1")

filemap - Map of Files to checksum values

addTags

public void addTags(String key,
                    Map<String,String> values)

Add tags (metadata) to the Bag

Parameters:

key - Filename of the tag file (e.g., "bag-info.txt")

values - Map containing field/value pairs

getTags

public Map<String,String> getTags(String key)

Get the current tag (metadata) of the Bag

Parameters:

key - Filename of the tag file (e.g., "bag-info.txt")

Returns:

Map of field/value pairs

write

public void write()
           throws IOException

Write metadata and finalize Bag

Throws:

IOException - when an I/O error occurs