BagConfig (bagit-support 1.0.0 API)

java.lang.Object
- org.duraspace.bagit.BagConfig

```
public class BagConfig
extends Object
```
A convenience class for parsing and storing bagit-config.yml information. The bagit-config.yml represents user-defined properties to be included in the bag-info.txt.

Since:

Dec 14, 2016

Author:

dbernstein

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BagConfig.AccessTypes

Nested Classes
Modifier and Type	Class and Description
`static class`	`BagConfig.AccessTypes`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_KEY`
`static String`	`BAG_GROUP_IDENTIFIER`
`static String`	`BAG_INFO_KEY`
`static String`	`BAG_SIZE_KEY`
`static String`	`BAGGING_DATE_KEY`
`static String`	`CONTACT_EMAIL_KEY`
`static String`	`CONTACT_NAME_KEY`
`static String`	`CONTACT_PHONE_KEY`
`static String`	`EXTERNAL_DESCRIPTION_KEY`
`static String`	`EXTERNAL_IDENTIFIER_KEY`
`static String`	`INTERNAL_SENDER_DESCRIPTION_KEY`
`static String`	`INTERNAL_SENDER_IDENTIFIER_KEY`
`static String`	`ORGANIZATION_ADDRESS_KEY`
`static String`	`PAYLOAD_OXUM_KEY`
`static String`	`SOURCE_ORGANIZATION_KEY`
`static String`	`TITLE_KEY`

Constructor Summary

Constructors
Constructor and Description

BagConfig(File bagConfigFile)
Default constructor

Constructors
Constructor and Description
`BagConfig(File bagConfigFile)` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAPTrustInfo()` Returns an immutable map of aptrust info properties.
`Map<String,String>`	`getBagInfo()` Returns an immutable map of bag info properties.
`Map<String,String>`	`getFieldsForTagFile(String tagFile)` Returns an immutable map of custom tags for a tag file
`Set<String>`	`getTagFiles()` Returns all the tag files from the config
`boolean`	`hasTagFile(String tagFile)` Check if a tag file is listed in bag config

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BAG_INFO_KEY
```
public static final String BAG_INFO_KEY
```
    See Also:
    
    Constant Field Values
  - SOURCE_ORGANIZATION_KEY
```
public static final String SOURCE_ORGANIZATION_KEY
```
    See Also:
    
    Constant Field Values
  - ORGANIZATION_ADDRESS_KEY
```
public static final String ORGANIZATION_ADDRESS_KEY
```
    See Also:
    
    Constant Field Values
  - CONTACT_NAME_KEY
```
public static final String CONTACT_NAME_KEY
```
    See Also:
    
    Constant Field Values
  - CONTACT_PHONE_KEY
```
public static final String CONTACT_PHONE_KEY
```
    See Also:
    
    Constant Field Values
  - CONTACT_EMAIL_KEY
```
public static final String CONTACT_EMAIL_KEY
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_DESCRIPTION_KEY
```
public static final String EXTERNAL_DESCRIPTION_KEY
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_IDENTIFIER_KEY
```
public static final String EXTERNAL_IDENTIFIER_KEY
```
    See Also:
    
    Constant Field Values
  - INTERNAL_SENDER_DESCRIPTION_KEY
```
public static final String INTERNAL_SENDER_DESCRIPTION_KEY
```
    See Also:
    
    Constant Field Values
  - INTERNAL_SENDER_IDENTIFIER_KEY
```
public static final String INTERNAL_SENDER_IDENTIFIER_KEY
```
    See Also:
    
    Constant Field Values
  - BAGGING_DATE_KEY
```
public static final String BAGGING_DATE_KEY
```
    See Also:
    
    Constant Field Values
  - BAG_SIZE_KEY
```
public static final String BAG_SIZE_KEY
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_OXUM_KEY
```
public static final String PAYLOAD_OXUM_KEY
```
    See Also:
    
    Constant Field Values
  - BAG_GROUP_IDENTIFIER
```
public static final String BAG_GROUP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - TITLE_KEY
```
public static final String TITLE_KEY
```
    See Also:
    
    Constant Field Values
  - ACCESS_KEY
```
public static final String ACCESS_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BagConfig
```
public BagConfig(File bagConfigFile)
```
    Default constructor
    
    Parameters:
    
    bagConfigFile - a bagit config yaml file (see src/test/resources/bagit-config.yml)
- Method Detail
  - getBagInfo
```
public Map<String,String> getBagInfo()
```
    Returns an immutable map of bag info properties.
    
    Returns:
    
    a map of bag info properties
  - getAPTrustInfo
```
public Map<String,String> getAPTrustInfo()
```
    Returns an immutable map of aptrust info properties.
    
    Returns:
    
    a map of aptrust info properties
  - getTagFiles
```
public Set<String> getTagFiles()
```
    Returns all the tag files from the config
    
    Returns:
    
    set of tag filenames
  - hasTagFile
```
public boolean hasTagFile(String tagFile)
```
    Check if a tag file is listed in bag config
    
    Parameters:
    
    tagFile - the tag filename
    
    Returns:
    
    true if it is list, false if not
  - getFieldsForTagFile
```
public Map<String,String> getFieldsForTagFile(String tagFile)
```
    Returns an immutable map of custom tags for a tag file
    
    Parameters:
    
    tagFile - name of the tag file to get fields for
    
    Returns:
    
    a map of filenames to key-value property maps

Class BagConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BAG_INFO_KEY

SOURCE_ORGANIZATION_KEY

ORGANIZATION_ADDRESS_KEY

CONTACT_NAME_KEY

CONTACT_PHONE_KEY

CONTACT_EMAIL_KEY

EXTERNAL_DESCRIPTION_KEY

EXTERNAL_IDENTIFIER_KEY

INTERNAL_SENDER_DESCRIPTION_KEY

INTERNAL_SENDER_IDENTIFIER_KEY

BAGGING_DATE_KEY

BAG_SIZE_KEY

PAYLOAD_OXUM_KEY

BAG_GROUP_IDENTIFIER

TITLE_KEY

ACCESS_KEY

Constructor Detail

BagConfig

Method Detail

getBagInfo

getAPTrustInfo

getTagFiles

hasTagFile

getFieldsForTagFile