From f3281712eb7290e1a68f521e2fe0e99ce9dedad7 Mon Sep 17 00:00:00 2001 From: Matt Jones Date: Mon, 6 Jul 2026 13:09:55 -0800 Subject: [PATCH 1/4] Change version to 2.5.0-SNAPSHOT --- .github/ISSUE_TEMPLATE/release_checklist.md | 3 +++ pom.xml | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 69261fc..98a6e17 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -8,6 +8,9 @@ assignees: [] hidden: true # do NOT show in template picker every time someone creates a new issue --- +> [!TIP] +> Create an [issue from this template](https://github.com/DataONEorg/d1_common_java/issues/new?template=release_checklist.md) + ## Release checklist - [ ] Create a branch named `task--release--prep`, and do the following: diff --git a/pom.xml b/pom.xml index 8b9156f..4074488 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.dataone d1_common_java jar - 2.4.3-SNAPSHOT + 2.5.0-SNAPSHOT DataONE_Common_Java https://dataone.org DataONE Common Code with Service Interface Definitions From 3924d46844260f3352cd36020b652758272a3a96 Mon Sep 17 00:00:00 2001 From: Matt Jones Date: Mon, 6 Jul 2026 13:48:04 -0800 Subject: [PATCH 2/4] Add new release notes summarizing all releases to date. --- RELEASE-NOTES.md | 105 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 RELEASE-NOTES.md diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md new file mode 100644 index 0000000..db67576 --- /dev/null +++ b/RELEASE-NOTES.md @@ -0,0 +1,105 @@ +# d1_common_java Release Notes + +## 2.5.0 (2026-07-06) + +- Intent: Deliver a modernization and maintenance release focused on Java 17/21/25 compatibility, security hardening, and release pipeline updates. +- Security fixes: Fixed XML External Entity (XXE) vulnerabilities caused by external DTD references and external ENTITY references during XML parsing; all users should upgrade to `2.5.0` or later. +- New features: Java runtime/build modernization for current LTS and current-feature JVMs (issue `#4`), refreshed build and deploy workflow defaults, migration to `maven.dataone.org` release/snapshot distribution, updated format bundle (`formats 1.28`), and adoption of released `d1_test_resources 2.4.0`. +- Bug fixes: Fixed unescaped semicolon handling in URL query/fragment parsing (issue `#8`, PR `#9`) and resolved marshalling/styleSheet-era compatibility pain points from post-Java 8 behavior (issue `#3`). +- Dependency and tooling updates: Upgraded core dependencies and plugins including `log4j`, `commons-lang3`, `commons-io`, servlet compatibility updates, and modern Maven compiler/jar plugin versions. + +## 2.4.2 (2020-12-01) + +- Intent: Improve object-format publication pipeline and finalize another patch release. +- New features: Added XSL transformation to derive v1 list from v2 and generated object format list from source as part of release flow. +- Bug fixes: Release/version bump consistency and POM formatting cleanup tied to merged feature/release branches. + +## 2.4.1 (2020-11-30) + +- Intent: Deliver a security-focused maintenance patch release off 2.4.0. +- New features: Dependency hardening rollout via merged security patch branch and release branch workflow. +- Bug fixes: Updated vulnerable dependency set including `commons-fileupload`, `commons-beanutils`, and `commons-collections4`; included release/publish workflow corrections and formatting cleanup. + +## 2.4.0 (2020-11-30) + +- Intent: Aggregate long-running trunk/2.3-era functional updates into a 2.4 baseline and formal release branch. +- New features: Expanded object format catalog substantially (R/SAS/MATLAB, EML 2.2.0, additional metacat-aligned formats, and MDQ/gzip updates; refs include #8239 and #8754); improved authorization-subject lookup behavior; relaxed redirect filtering to support broader 3xx handling when redirects are allowed. +- Bug fixes: Exception deserialization now prioritizes `identifier` attribute and includes related tests; improved HTML exception response condensation/configuration (#8227); upgraded servlet alignment with Tomcat 7 expectations (#8086); fixed duplicate BaseException string-writer behavior and reduced noisy configuration stack traces. + +## 2.3.0 (2016-11-08) + +- Intent: Complete marshalling modernization from JiBX toward JAXB and clean obsolete build dependencies. +- New features: Added JAXB annotations/object factories and refactored `TypeMarshaller` to JAXB-based operation; introduced marshaller/unmarshaller caching and validation/schema updates; added `MarshallingException` and removed JiBX exceptions from method signatures (#7836, #7844, #7845, #7846, #7852, #7832). +- Bug fixes: Added null safety in equals/hashCode for JAXB workflows; removed obsolete ant/JiBX/BCEL build dependencies; fixed build and dependency issues (including missing `log4j` direct dependency). + +## 2.2.0 (2016-06-14) + +- Intent: Deliver object-format list updates and continue release stream progression. +- New features: Added TSV/object-format inventory updates copied from CN metacat context; refreshed schema-generation source settings. +- Bug fixes: Corrected object-format totals/count metadata and release prep updates (including #7693/#7745 references). + +## 2.1.0 (2016-02-24) + +- Intent: Stabilize the v2 line and prep 2.1 release artifacts. +- New features: Updated schema-generation source and API documentation references; branch prep toward 2.1 release stream (#7493, #7648 context). +- Bug fixes: Added regression coverage for `AuthUtils` stack-overflow subject-info scenario (#7604); release engineering corrections during branch/tag process. + +## 2.0.0 (2015-11-24) + +- Intent: Introduce the major v2 API/type generation line and deprecation strategy for mutable system metadata workflows. +- New features: Added v2 schemas/types and v2 service interfaces (`CNView`, `MNView`, `MNPackage`, v2 `SystemMetadata`, v2 object format/log types); introduced capability APIs (`getNodeCapabilities`/`getCapabilities`); added node property extensions and updateSystemMetadata patterns (issues including #3729, #3744, #4029, #4030, #4173, #4258). +- Bug fixes: Resource leak removal in multipart resolver path (#2211); broad code cleanup/import maintenance; dependency and build compatibility improvements for v2 generation. + +## 1.2.2 (2014-11-26) + +- Intent: Correct version lineage and modernize dependency declarations. +- New features: Updated `d1_test_resources` dependency target (to upcoming 1.3.0 at the time) and improved dependency declaration clarity. +- Bug fixes: Cleaned undeclared transitive dependencies; updated Apache HttpComponents versions; corrected release sequencing mismatch where a downstream artifact referenced an untagged 1.2.1 revision. + +## 1.2.1 (2014-10-27) + +- Intent: Perform point-release progression after 1.2.0. +- New features: No major functional additions documented in-range. +- Bug fixes: Primarily version increment/tag consistency for branch maintenance. + +## 1.2.0 (2014-05-02) + +- Intent: Grow utility robustness, type-comparison capabilities, and dependency hygiene for the 1.2 line. +- New features: Added checksum comparison helper (`areChecksumsEqual`); expanded `TypeCompareUtil` capabilities (including subtype reporting/sorting); promoted select utility visibility and comparator support. +- Bug fixes: Resource-leak fix noted in tag metadata (#5311); null handling fixes in `AuthUtils` and encoding utilities; dependency scope and javadoc/reporting build stabilization. + +## 1.1.3 (2013-07-01) + +- Intent: Prepare for CCI-1.2 release and improve administrator authorization behavior. +- New features: Included `cn.administrators` subjects in service-method restriction evaluation (Redmine #3845). +- Bug fixes: Corrected related debug logging for administrator-subject augmentation and finalized branch versioning for 1.1.3 (#3822/#3840). + +## 1.1.2 (2013-06-04) + +- Intent: Reduce dependency footprint for downstream users. +- New features: Dependency scope adjustments to minimize transitive dependency exposure. +- Bug fixes: Build/dependency hygiene improvements; no major runtime defect called out. + +## 1.1.1 (2013-02-22) + +- Intent: Provide a targeted compatibility patch for temporary-file handling. +- New features: Portable temp-file strategy that allows OS-managed temp directory selection. +- Bug fixes: Eliminated hard-coded `/tmp` behavior to resolve Windows interoperability issue (Bugzilla #5869). + +## 1.1.0 (2013-01-08) + +- Intent: Advance to schema/API 1.1 capabilities and broaden supported formats/utilities. +- New features: Added query interfaces/types and v1.1 schema alignment; expanded object format metadata (MIME type/extensions, issue set including #1861/#2995/#2996/#2997/#3135); added object-format CSV/XLS transformation assets; cloning utilities in `AccessUtil`. +- Bug fixes: Stream/resource cleanup moved into `finally` blocks; improved subject/group validation rules (for example no group-in-group nesting, Redmine #2833); retained and propagated prior NodeList utility fix. + +## 1.0.2 (2012-07-03) + +- Intent: Deliver a focused post-1.0.1 maintenance release. +- New features: No major new API features. +- Bug fixes: Fixed `NodelistUtil.selectNode(..)` runtime incompatibility by replacing `TreeSet` usage with `HashSet` where `Node` was not `Comparable`. + +## 1.0.1 (2012-06-05) + +- Intent: Cut the 1.0.1 general-availability release from the RC line. +- New features: GA packaging of accumulated RC changes. +- Bug fixes: Release/version/dependency alignment for final 1.0.1 artifacts. From 8b6b6d53314b4ec5e7ecb5342d9de858222bc3ab Mon Sep 17 00:00:00 2001 From: Matt Jones Date: Mon, 6 Jul 2026 13:48:40 -0800 Subject: [PATCH 3/4] Update format of LICENSE file to conform to standard layout --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE.txt | 19 ----- README.md | 4 +- 3 files changed, 203 insertions(+), 21 deletions(-) create mode 100644 LICENSE delete mode 100755 LICENSE.txt diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100755 index 111fe86..0000000 --- a/LICENSE.txt +++ /dev/null @@ -1,19 +0,0 @@ -==== - This work was created by participants in the DataONE project, and is - jointly copyrighted by participating institutions in DataONE. For - more information on DataONE, see our web site at http://dataone.org. - - Copyright ${year} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -==== diff --git a/README.md b/README.md index 03bd2e0..2b88fcb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -DataONE Java Service API +DataONE Java Common Service API and Types ------------------------ ![Java Build SNAPSHOT and push to Maven Central](https://github.com/DataONEorg/d1_common_java/workflows/Java%20Build%20SNAPSHOT%20and%20push%20to%20Maven%20Central/badge.svg) ![Publish package on release](https://github.com/DataONEorg/d1_common_java/workflows/Publish%20package%20on%20release/badge.svg) @@ -11,7 +11,7 @@ definitions and class definitions for types and exceptions. See the test classes under `src/test` for example usage. -See LICENSE.txt for the details of distributing this software. +See LICENSE for the details of distributing this software. ``` From 6f834e451ad59a78b0004fc9c0affabaf26d8369 Mon Sep 17 00:00:00 2001 From: Matt Jones Date: Mon, 6 Jul 2026 13:49:22 -0800 Subject: [PATCH 4/4] Bump version to 2.5.0 --- pom.xml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/pom.xml b/pom.xml index 4074488..0256d69 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.dataone d1_common_java jar - 2.5.0-SNAPSHOT + 2.5.0 DataONE_Common_Java https://dataone.org DataONE Common Code with Service Interface Definitions @@ -174,8 +174,9 @@ - Apache License, Version 2.0 - LICENSE.txt + The Apache License, Version 2.0 + https://www.apache.org/licenses/LICENSE-2.0.txt + repo @@ -201,4 +202,4 @@ - + \ No newline at end of file