<dependency>
  <groupId>org.apache.daffodil</groupId>
  <artifactId>daffodil-japi_2.12</artifactId>
  <version>3.8.0</version>
</dependency>

libraryDependencies += "org.apache.daffodil" %% "daffodil-sapi" % "3.8.0"

[apache-daffodil]
name=Apache Daffodil
baseurl=https://apache.jfrog.io/artifactory/daffodil-rpm/
enabled=1
gpgkey=https://downloads.apache.org/daffodil/KEYS
gpgcheck=1
repo_gpgcheck=0

sudo dnf install apache-daffodil

Release Notes

This release focused on providing a supported API for creating Daffodil Layers.

Layers Feature

A layer is an algorithmic transformation of the data stream that cannot be expressed using regular DFDL properties. Daffodil provides a DFDL language extension using the property name dfdlx:layer to invoke these layer transformations when parsing or unparsing. Layers can encode/decode data as well as can verify/recompute checksums/CRCs.

See the Layers documentation which has links to the javadoc for the new API as well as a description and examples of the built-in layers that are available to use.

This supported API is incompatible with the experimental and unsupported prior version layering APIs. See the Deprecation/Compatibility section for more details.

New Features

• [DAFFODIL-2569] - document how to write layer transforms
• [DAFFODIL-2903] - Allow inputValueCalc to apear in a hidden group
• [DAFFODIL-2825] - Define supported layering API
• [DAFFODIL-2844] - LayerNotEnoughDataException doesn't propagate Throwable Error
• [DAFFODIL-2845] - Layer improvements
• [DAFFODIL-2841] - Layers do not support (or poorly documented) creating SDE or Parse/UnparseErrors

Miscellaneous Bugs

• [DAFFODIL-2900] - enable javadoc and scaladoc for runtime1 api
• [DAFFODIL-2905] - add error parameter to N-byte-swap layer
• [DAFFODIL-2907] - Improve documentation for building/testing the release candidate container
• [DAFFODIL-2104] - TDML runner - throws exception if test has neither <tdml:errors> nor <tdml:infoset>
• [DAFFODIL-2843] - Unclear how to create Parse/UnparseError from ParseOrUnparseState
• [DAFFODIL-2883] - Pre-existing PUA characters in data cause SDE
• [DAFFODIL-2887] - Choice branch array with discriminator or direct dispatch broken
• [DAFFODIL-2890] - Set SOURCE_DATE_EPOCH when creating releases
• [DAFFODIL-2891] - Abort: Invariant broken: minReps.==(0L) when unparsing
• [DAFFODIL-2892] - JAR file URI processing does not allow for JARs within JARs
• [DAFFODIL-2893] - Unable to initialise
• [DAFFODIL-2895] - Runtime SDE in ElementCombinator parser with validation causes "Expression Evaluation Error: Element does not have a value"
• [DAFFODIL-2897] - change scalafmt back to rewrite.trailingCommas.style 'never'
• [DAFFODIL-2898] - Compilation error with Java 21, add to CI

Deprecation/Compatibility

This release removes the unsupported/experimental APIs for creating layer plug-ins that were present in releases 3.7.0 and prior. These are replaced with a new supported and documented API which is much easier to use and maintain and has more functionality. All layers written to the older 3.7.0 unsupported APIs will be broken and must be rewritten to use the new API in 3.8.0.

See the Layers documentation which has links to the javadoc for the new API.

[DAFFODIL-2825] Define supported layering API

Dependency Changes

The following dependencies have been added or updated:

Core

• Apache Commons IO 2.16.1 (update)
• FasterXML Jackson Core 2.16.1 (update)
• FasterXML Woodstox Core 6.6.2 (update)
• ICU4J 75.1 (update)
• Scala Parser Combinators 2.4.0 (update)
• Scala XML 2.3.0 (update)
• Typesafe Config 1.4.3 (update)
• XML Resolver 1.2 (update)

CLI

• JLine 3.26.1 (update)

Code Generator

• OS Lib 0.10.2 (update)

Logging

• SLF4J API 2.0.13 (update)

Schematron Validator

• Saxon-HE 12.4 (update)

Changes to Transitive Dependencies

• Woodstox Stax2 API 4.2.2 (update, used by Woodstox Core)
• XML Resolver & Data 5.2.2 (update, used by Saxon-HE)