edu.jhu.library.pass.deposit.provider.bagit

Class BagItPackageProvider

java.lang.Object

edu.jhu.library.pass.deposit.provider.bagit.BagItPackageProvider

All Implemented Interfaces:

org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

public class BagItPackageProvider
extends Object
implements org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BAGINFO_TEMPLATE Package options key that contains the classpath resource path of the bag-info.txt Handlebars template
protected static String	BAGINFO_TXT bag-info.txt file (optional) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.2.2
protected static String	BAGIT_TXT bagit.txt file (required) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.1
protected BagItVersion	bagItVersion Supported BagIT version https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.1
protected BagAlgo	defaultAlgo Default checksum calculation algorithm when generating new Bags.
protected static String	FETCH_TXT fetch.txt (optional) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.2.3
protected FetchStrategy	fetchStrategy Whether or not this implementation will produce incomplete Bags.
protected static org.slf4j.Logger	LOG
protected Map<String,Object>	packageOpts Runtime options provided to the Packager/Assembler
protected Parameterizer	parameterizer Handlebars parameterization of Bag metadata
protected org.dataconservancy.pass.client.PassClient	passClient PASS Repository client, used for resolving URI references in the Submission
protected static String	PAYLOAD_DIR Payload directory https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.2
protected static String	PAYLOAD_MANIFEST_TMPL Payload manifest (at least one) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.3
protected static String	TAG_MANIFEST_TMPL Tagfile manifest (optional) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.2.1
protected Charset	tagFileEncoding Tag file encoding https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.1
protected static UnsupportedOperationException	UOE
protected BagItWriter	writer Writer for Bag-related files

Constructor Summary

Constructors

Constructor and Description
BagItPackageProvider(BagItWriter writer, Parameterizer parameterizer, org.dataconservancy.pass.client.PassClient passClient)

Method Summary

Modifier and Type	Method and Description
List<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource>	finish(org.dataconservancy.pass.deposit.model.DepositSubmission submission, List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources)
String	packagePath(org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource custodialResource) Answers a path for the custodial resource subordinate to the BagIt payload directory.
protected static MessageDigest	resolveMessageDigest(org.dataconservancy.pass.deposit.assembler.PackageOptions.Checksum.OPTS checksumAlgo)
void	start(org.dataconservancy.pass.deposit.model.DepositSubmission submission, List<org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource> custodialResources, Map<String,Object> packageOptions)
protected org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource	writeBagDeclaration() Answers a Bag Declaration according to version 1.0 of the BagIt specification.
protected org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource	writeBagInfo(org.dataconservancy.pass.deposit.model.DepositSubmission submission, List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources, InputStream bagInfoMustacheTemplate)
protected Collection<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource>	writePayloadManifests(org.dataconservancy.pass.deposit.model.DepositSubmission submission, List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources, Map<String,Object> packageOptions) Writes a payload manifest for each checksum supplied in the packager options.
protected Collection<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource>	writeTagfileManifests(org.dataconservancy.pass.deposit.model.DepositSubmission submission, List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources, Map<String,Object> packageOptions, Collection<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource> tagFiles)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

UOE

protected static final UnsupportedOperationException UOE

BAGINFO_TEMPLATE

protected static final String BAGINFO_TEMPLATE

Package options key that contains the classpath resource path of the bag-info.txt Handlebars template

See Also:

Constant Field Values

PAYLOAD_DIR

protected static final String PAYLOAD_DIR

Payload directory https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.2

See Also:

Constant Field Values

PAYLOAD_MANIFEST_TMPL

protected static final String PAYLOAD_MANIFEST_TMPL

Payload manifest (at least one) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.3

See Also:

Constant Field Values

TAG_MANIFEST_TMPL

protected static final String TAG_MANIFEST_TMPL

Tagfile manifest (optional) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.2.1

See Also:

Constant Field Values

BAGIT_TXT

protected static final String BAGIT_TXT

bagit.txt file (required) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.1

See Also:

Constant Field Values

BAGINFO_TXT

protected static final String BAGINFO_TXT

bag-info.txt file (optional) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.2.2

See Also:

Constant Field Values

FETCH_TXT

protected static final String FETCH_TXT

fetch.txt (optional) https://www.rfc-editor.org/rfc/rfc8493.html#section-2.2.3

See Also:

Constant Field Values

tagFileEncoding

protected Charset tagFileEncoding

Tag file encoding https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.1

bagItVersion

protected BagItVersion bagItVersion

Supported BagIT version https://www.rfc-editor.org/rfc/rfc8493.html#section-2.1.1

defaultAlgo

protected BagAlgo defaultAlgo

Default checksum calculation algorithm when generating new Bags. https://www.rfc-editor.org/rfc/rfc8493.html#section-2.4

fetchStrategy

protected FetchStrategy fetchStrategy

Whether or not this implementation will produce incomplete Bags.

writer

protected BagItWriter writer

Writer for Bag-related files

packageOpts

protected Map<String,Object> packageOpts

Runtime options provided to the Packager/Assembler

passClient

protected org.dataconservancy.pass.client.PassClient passClient

PASS Repository client, used for resolving URI references in the Submission

parameterizer

protected Parameterizer parameterizer

Handlebars parameterization of Bag metadata

Constructor Detail

BagItPackageProvider

public BagItPackageProvider(BagItWriter writer,
                            Parameterizer parameterizer,
                            org.dataconservancy.pass.client.PassClient passClient)

Method Detail

start

public void start(org.dataconservancy.pass.deposit.model.DepositSubmission submission,
                  List<org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource> custodialResources,
                  Map<String,Object> packageOptions)

Specified by:

start in interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

packagePath

public String packagePath(org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource custodialResource)

Answers a path for the custodial resource subordinate to the BagIt payload directory.

The existing path of the custodial resource is preserved, and prefixed with "data/".

Specified by:

packagePath in interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

Parameters:

custodialResource - the custodial resource (i.e. a resource that is part of the Bag payload)

Returns:

the path of the resource prefixed with "data/"

Throws:

RuntimeException - if there is an error obtaining the path of the custodial resource

finish

public List<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource> finish(org.dataconservancy.pass.deposit.model.DepositSubmission submission,
                                                                                                           List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources)

Specified by:

finish in interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

writePayloadManifests

protected Collection<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource> writePayloadManifests(org.dataconservancy.pass.deposit.model.DepositSubmission submission,
                                                                                                                                   List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources,
                                                                                                                                   Map<String,Object> packageOptions)

Writes a payload manifest for each checksum supplied in the packager options.

Parameters:

submission - the submission in the Deposit Services model

packageResources - the custodial files being streamed in the package

packageOptions - the options supplied to the Assembler when creating the package

Returns:

the BagIt payload manifests

writeTagfileManifests

protected Collection<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource> writeTagfileManifests(org.dataconservancy.pass.deposit.model.DepositSubmission submission,
                                                                                                                                   List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources,
                                                                                                                                   Map<String,Object> packageOptions,
                                                                                                                                   Collection<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource> tagFiles)

writeBagInfo

protected org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource writeBagInfo(org.dataconservancy.pass.deposit.model.DepositSubmission submission,
                                                                                                              List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources,
                                                                                                              InputStream bagInfoMustacheTemplate)

writeBagDeclaration

protected org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource writeBagDeclaration()

Answers a Bag Declaration according to version 1.0 of the BagIt specification.

Returns:

the Bag Declaration

Throws:

RuntimeException - if there is an error writing the declaration

resolveMessageDigest

protected static MessageDigest resolveMessageDigest(org.dataconservancy.pass.deposit.assembler.PackageOptions.Checksum.OPTS checksumAlgo)