gov.loc.repository.bagit.creator

Class BagCreator

java.lang.Object

gov.loc.repository.bagit.creator.BagCreator

public final class BagCreator
extends java.lang.Object

Responsible for creating a bag in place.

Method Summary

Modifier and Type	Method and Description
static Bag	bagInPlace(java.nio.file.Path root, java.util.Collection<SupportedAlgorithm> algorithms, boolean includeHidden) Creates a bag in place for version 0.97.
static Bag	bagInPlace(java.nio.file.Path root, java.util.Collection<SupportedAlgorithm> algorithms, boolean includeHidden, Metadata metadata) Creates a bag in place for version 0.97.
static Bag	createDotBagit(java.nio.file.Path root, java.util.Collection<SupportedAlgorithm> algorithms, boolean includeHidden) Creates a basic(only required elements) .bagit bag in place.
static Bag	createDotBagit(java.nio.file.Path root, java.util.Collection<SupportedAlgorithm> algorithms, boolean includeHidden, Metadata metadata) Creates a basic(only required elements) .bagit bag in place.

Methods inherited from class java.lang.Object

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

Method Detail

bagInPlace

public static Bag bagInPlace(java.nio.file.Path root,
                             java.util.Collection<SupportedAlgorithm> algorithms,
                             boolean includeHidden)
                      throws java.security.NoSuchAlgorithmException,
                             java.io.IOException

Creates a bag in place for version 0.97. This method moves and creates files, thus if an error is thrown during operation it may leave the filesystem in an unknown state of transition. Thus this is not thread safe

Parameters:

root - the directory that will become the base of the bag and where to start searching for content

algorithms - an collection of SupportedAlgorithm implementations

includeHidden - to include hidden files when generating the bagit files, like the manifests

Returns:

a Bag object representing the newly created bagit bag

Throws:

java.security.NoSuchAlgorithmException - if MessageDigest can't find the algorithm

java.io.IOException - if there is a problem writing or moving file(s)

bagInPlace

public static Bag bagInPlace(java.nio.file.Path root,
                             java.util.Collection<SupportedAlgorithm> algorithms,
                             boolean includeHidden,
                             Metadata metadata)
                      throws java.security.NoSuchAlgorithmException,
                             java.io.IOException

Creates a bag in place for version 0.97. This method moves and creates files, thus if an error is thrown during operation it may leave the filesystem in an unknown state of transition. Thus this is not thread safe

Parameters:

root - the directory that will become the base of the bag and where to start searching for content

algorithms - an collection of SupportedAlgorithm implementations

includeHidden - to include hidden files when generating the bagit files, like the manifests

metadata - the metadata to include when creating the bag. Payload-Oxum and Bagging-Date will be overwritten

Returns:

a Bag object representing the newly created bagit bag

Throws:

java.security.NoSuchAlgorithmException - if MessageDigest can't find the algorithm

java.io.IOException - if there is a problem writing or moving file(s)

createDotBagit

@Incubating
public static Bag createDotBagit(java.nio.file.Path root,
                                             java.util.Collection<SupportedAlgorithm> algorithms,
                                             boolean includeHidden)
                                      throws java.security.NoSuchAlgorithmException,
                                             java.io.IOException

Creates a basic(only required elements) .bagit bag in place. This creates files and directories, thus if an error is thrown during operation it may leave the filesystem in an unknown state of transition. Thus this is not thread safe

Parameters:

root - the directory that will become the base of the bag and where to start searching for content

algorithms - an collection of SupportedAlgorithm implementations

includeHidden - to include hidden files when generating the bagit files, like the manifests

Returns:

a Bag object representing the newly created bagit bag

Throws:

java.security.NoSuchAlgorithmException - if MessageDigest can't find the algorithm

java.io.IOException - if there is a problem writing files or .bagit directory

createDotBagit

@Incubating
public static Bag createDotBagit(java.nio.file.Path root,
                                             java.util.Collection<SupportedAlgorithm> algorithms,
                                             boolean includeHidden,
                                             Metadata metadata)
                                      throws java.security.NoSuchAlgorithmException,
                                             java.io.IOException

Creates a basic(only required elements) .bagit bag in place. This creates files and directories, thus if an error is thrown during operation it may leave the filesystem in an unknown state of transition. Thus this is not thread safe

Parameters:

root - the directory that will become the base of the bag and where to start searching for content

algorithms - an collection of SupportedAlgorithm implementations

includeHidden - to include hidden files when generating the bagit files, like the manifests

metadata - the metadata to include when creating the bag. Payload-Oxum and Bagging-Date will be overwritten

Returns:

a Bag object representing the newly created bagit bag

Throws:

java.security.NoSuchAlgorithmException - if MessageDigest can't find the algorithm

java.io.IOException - if there is a problem writing files or .bagit directory