HashStore-java 1.1.0 Release

[doulikecookiedough]

Prepare HashStore-java for 1.1.0 Release

To Do:

• Add some human-ness to CONTRIBUTING.md
• Update and review README.md
  • Finalize citation.xml
    • Confirm if we are to issue separate citations for python and java libraries
    • Request a DOI via Jing
    • Revise date
• Update pom.xml version (1.1.0)
  • Updated to 1.1.0-SNAPSHOT
  • Update README.md example for using the HashStoreClient
    • (This has been completed in advance) The .jar file names will have changed. Additional, there are two jar files built when installling with mvn - one which contains dependencies (shaded) which should be used when executing public API calls via the client. Example:

      java -cp /home/mok/hashstore-java/target/hashstore-1.0-SNAPSHOT-shaded.jar org.dataone.hashstore.HashStoreClient -store /home/mok/testing/knbvm_testlargeobj -storeobject -path /var/metacat/data/autogen.2020101211495571744.1 -pid annagian.10000.12

    • Update "How do I delete an object if I have the pid?" section which is inaccurate (still references idTypes)
    • Public API method list is inaccurate (deleteInvalidObject should be deleteIfInvalidObject)

[doulikecookiedough]

README.md and CONTRIBUTING.md have been updated via Feature-106: Release Prep Part 1

Citation to use, updated 2024-11-13

• Added release date
• Added Missing DOI

DataCite XML for HashStore-java 1.1.0 (datacite.xml)

<?xml version="1.0"?>
<resource xmlns="http://datacite.org/schema/kernel-4" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4/metadata.xsd">
  <identifier identifierType="DOI">doi:10.18739/A2QF8JM59</identifier>
  <creators>
    <creator>
      <creatorName>Dou Mok</creatorName>
      <givenName>DouMing</givenName>
      <familyName>Mok</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0002-6076-8092</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Matthew Brooke</creatorName>
      <givenName>Matthew</givenName>
      <familyName>Brooke</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0002-1472-913X</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Jing Tao</creatorName>
      <givenName>Jing</givenName>
      <familyName>Tao</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0002-1209-5268</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Matthew B. Jones</creatorName>
      <givenName>Matthew B.</givenName>
      <familyName>Jones</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0003-0077-4738</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
  </creators>
  <titles>
    <title>HashStore-java - Object Storage System</title>
  </titles>
  <publisher>Arctic Data Center</publisher>
  <publicationYear>2024</publicationYear>
  <resourceType resourceTypeGeneral="Software">Software</resourceType>
  <dates>
    <date dateType="Created">2024-11-21</date>
  </dates>
  <alternateIdentifiers>
    <alternateIdentifier alternateIdentifierType="https://registry.identifiers.org/registry/swh">swh:1:dir:2c9c3ee12f79bf4c37d293f6a9f4e22f726a8c41;
    origin=https://github.com/DataONEorg/hashstore-java;
    visit=swh:1:snp:099accc0526cfeb4b8d74fd9af9ab21cc7dc62b1;
    anchor=swh:1:rev:99dbd785344895ac41c35d8acaa2957d2bcb55f4</alternateIdentifier>
  </alternateIdentifiers>
  <version>1.1.0</version>
  <rightsList>
    <rights rightsURI="https://spdx.org/licenses/Apache-2.0.html">Apache-2.0</rights>
  </rightsList>
  <fundingReferences>
    <fundingReference>
      <funderName>National Science Foundation</funderName>
      <funderIdentifier funderIdentifierType="Crossref Funder ID">https://doi.org/10.13039/100000001</funderIdentifier>
      <awardNumber awardURI="https://www.nsf.gov/awardsearch/showAward?AWD_ID=2042102">2042102</awardNumber>
      <awardTitle>Advancing Arctic research and education through data preservation and reuse at the Arctic Data Center</awardTitle>
    </fundingReference>
    <fundingReference>
      <funderName>U.S. Department of Energy</funderName>
      <funderIdentifier funderIdentifierType="Crossref Funder ID">https://doi.org/10.13039/100000015</funderIdentifier>
      <awardTitle>The Environmental System Science Data Infrastructure for a Virtual Ecosystem (ESS-DIVE 2020)</awardTitle>
    </fundingReference>
  </fundingReferences>
</resource>

[doulikecookiedough]

This has been completed via HashStore-java 1.1.0 Release

For reference, steps to publish the citation:

• Additional reference: Issue new DOI for MetacatUI 2.30.0 NCEAS/metacatui#2468

1. Get and mint a DOI (with ADC shoulder). This can be used to update a README.md file with the citation information.
2. Update a datacite.xml document with the DOI
3. Ensure that software heritage page is found for the repo you're trying to release it for
   • Example: https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://github.com/DataONEorg/hashstore-java
   • If it's the first time we're doing it for a repo, we must request that it gets added:
     • https://archive.softwareheritage.org/save/
4. Once the page has been established if it hasn't already, on the righthand side you should see a permalinks button. This is where you will find the contents necessary for a new section to be added (alternateIdentifier). This can be added below the dates section in datacite.xml.

   <alternateIdentifiers>
     <alternateIdentifier alternateIdentifierType="https://registry.identifiers.org/registry/swh">swh:1:dir:2c9c3ee12f79bf4c37d293f6a9f4e22f726a8c41;
     origin=https://github.com/DataONEorg/hashstore-java;
     visit=swh:1:snp:099accc0526cfeb4b8d74fd9af9ab21cc7dc62b1;
     anchor=swh:1:rev:99dbd785344895ac41c35d8acaa2957d2bcb55f4</alternateIdentifier>
   </alternateIdentifiers>
   

5. Once the datacite.xml has been updated, this new document is updated through the EZID process ($ python3 ...). This pushes the contents/datacite.xml to the EZID URL for the DOI (ex. https://ezid.cdlib.org/id/doi:10.18739/A2QF8JM59)
6. To complete the process, get the updated software heritage URL to replace the Location (URL) in the EZID online interface. This is where a DOI link (ex. `https://doi.org/10.18739/A2ZG6G87Q) will redirect to.
   • Log into EZID, replace the Location (URL) parameter, set it to public (from reserved)
     • Example URL: https://archive.softwareheritage.org/swh:1:dir:2c9c3ee12f79bf4c37d293f6a9f4e22f726a8c41