Skip to content

Revise hashstore config yaml order and/or construction #107

@doulikecookiedough

Description

@doulikecookiedough

To match the changes made in the python library for generating yaml content, re-order the hashstore config yaml created in the Java library so that the comments come first (revised comments at the end of this issue).

In addition, investigate the use of a java library to prevent possible yaml gotchas, as described here in the equivalent hashstore python issue.

Note: I have confirmed that the changes made to the python hashstore config are compatible with the java library as it stands without any changes.

 # Default configuration variables for HashStore

 ############### HashStore Config Notes ###############
 ############### Directory Structure ###############
 # store_depth
 # - Desired amount of directories when sharding an object to form the permanent address
 # - **WARNING**: DO NOT CHANGE UNLESS SETTING UP NEW HASHSTORE
 #
 # store_width
 # - Width of directories created when sharding an object to form the permanent address
 # - **WARNING**: DO NOT CHANGE UNLESS SETTING UP NEW HASHSTORE
 #
 # Example:
 # Below, objects are shown listed in directories that are 3 levels deep (DIR_DEPTH=3),
 # with each directory consisting of 2 characters (DIR_WIDTH=2).
 #    /var/filehashstore/objects
 #    ├── 7f
 #    │   └── 5c
 #    │       └── c1
 #    │           └── 8f0b04e812a3b4c8f686ce34e6fec558804bf61e54b176742a7f6368d6

 ############### Format of the Metadata ###############
 # store_metadata_namespace
 # - The default metadata format (ex. system metadata)

 ############### Hash Algorithms ###############
 # store_algorithm
 # - Hash algorithm to use when calculating object's hex digest for the permanent address
 #
 # store_default_algo_list
 # - Algorithm values supported by Java's MessageDigest library
 # - The default algorithm list includes the hash algorithms calculated when storing an
 # - object to disk and returned to the caller after successful storage.

 store_depth: %d
 store_width: %d
 store_metadata_namespace: "%s"
 store_algorithm: "%s"
 store_default_algo_list:
 - "MD5"
 - "SHA-1"
 - "SHA-256"
 - "SHA-384"
 - "SHA-512"

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions