feat: Control the RDF output format manually #277

berezovskyi · 2022-06-25T20:40:55Z

Description

Map RDF language to an exact format needed by https://jena.apache.org/documentation/io/rdf-output.html. This PR maps regular XML/RDF to RDFXML_PLAIN, which is NOT rdf/xml-ABBREV, unless ABBREV is chosen specifically:

https://github.com/eclipse/lyo/blob/b-jena-format-spec/core/oslc4j-jena-provider/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractOslcRdfXmlProvider.java#L152-L158

Potentially, allow for more RDF/XML config as per https://jena.apache.org/documentation/io/rdfxml_howto.html

Checklist

This PR adds an entry to the CHANGELOG. See https://keepachangelog.com/en/1.0.0/ for instructions. Minor edits are exempt.
This PR was tested on at least one Lyo OSLC server or adds unit/integration tests.
This PR does NOT break the API

Issues

https://forum.open-services.net/t/doors-lyo-incompatibility/631/5

berezovskyi · 2023-04-14T19:51:37Z

@jadelkhoury need your help here.

I just tested this PR on both refimpl and lyo-samples (against two live Jazz servers, which is relevant because this PR was trying to fix an issue for DNG).

lyo-samples build went just fine: https://github.com/OSLC/lyo-samples/actions/runs/4703021261/jobs/8341007496

But the refimpl fails in https://github.com/oslc-op/refimpl/actions/runs/4703012037/jobs/8340986025#step:7:224 due to a bunch of class-not-found errors:

There is no way this PR introduces this problem. Could you please check if this should be happening and where the fix is needed?

berezovskyi · 2023-04-14T20:09:04Z

Scratch that, I just realized this branch has not been rebased for quite a while and master works just fine.

Refimpl test against lyo@b-jena-format-spec works fine after rebase: https://github.com/oslc-op/refimpl/actions/runs/4703438070/jobs/8341937611

The sample code for lyo-client still tests fine against 2 ELM installs: https://github.com/OSLC/lyo-samples/actions/runs/4703456458/jobs/8341977320

But hey, it was a good test of my new semi-automatic PR testing flow!

berezovskyi · 2023-06-13T14:57:03Z

While I didn't see any breaking effect from the PR (labelling Breaking anyway, in case someone depends on this, cf. Hyrum's law), let's keep it until Lyo 6.0. I think we can aim for 6.0 release around Christmas because Jena plans to drop JDK 11 support in the fall and we will likely have to catch up before 2024.

berezovskyi · 2023-06-13T15:04:01Z

Additionally, I think it would be good to add a switch (JVM property, potentially) to control pretty/fast output format. E.g. we could use RDFXML_PLAIN for performance/production and RDFXML_PRETTY for debug (same for TURTLE_BLOCKS vs TURTLE_PRETTY). I had this thought before but didn't want to consider breaking changes but now it's worth to revisit since we retarget the PR for 6.0.

Signed-off-by: Andrew Berezovskyi <andriib@kth.se>

berezovskyi · 2025-07-16T21:33:13Z

@oslc-bot /test-all

oslc-bot · 2025-07-16T21:33:28Z

Downstream Build Status

Repository	Lyo CI	Job state	Workflow
`oslc-op/refimpl`	✅ Pass	`completed`	Link
`oslc/lyo-samples`	✅ Pass	`completed`	Link
`oslc/promcode-lyo-server`	✅ Pass	`completed`	Link

# Conflicts: # core/oslc4j-jena-provider/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractOslcRdfXmlProvider.java

Signed-off-by: Andrew Berezovskyi <andriib@kth.se>

berezovskyi · 2025-11-29T13:08:26Z

@oslc-bot /test-all

oslc-bot · 2025-11-29T13:08:38Z

Downstream Build Status

Repository	Lyo CI	Job state	Workflow
`oslc-op/refimpl`	🔴 Fail	`completed`	Link
`oslc/lyo-samples`	✅ Pass	`completed`	Link
`oslc/promcode-lyo-server`	🔴 Fail	`completed`	Link

Copilot

Pull request overview

This PR adds manual control over RDF output format by mapping RDF serialization languages to specific Jena RDFFormat types. The key change maps regular RDF/XML to RDFXML_PLAIN (not abbreviated) unless the abbreviated format is explicitly requested, addressing compatibility issues with IBM DOORS.

Key changes:

Introduces a resolveFormat() method to map serialization language strings to specific RDFFormat constants
Modifies the write path to use RDFDataMgr.write() with explicit formats for non-abbreviated serializations
Preserves the existing abbreviated RDF/XML behavior through conditional branching

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-13T17:06:58Z

...-provider/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractOslcRdfXmlProvider.java

+            if (writer instanceof RdfXmlAbbreviatedWriter) {
+                writer.write(model,
+                    outputStream,
+                    null);
+            } else {
+                RDFDataMgr.write(outputStream, model, resolveFormat(serializationLanguage));
+            }


The indentation of this code block is inconsistent with the rest of the file. The if-else block should use consistent indentation matching the surrounding code style (typically 2 or 4 spaces per level).

Suggested change

if (writer instanceof RdfXmlAbbreviatedWriter) {

writer.write(model,

outputStream,

null);

} else {

RDFDataMgr.write(outputStream, model, resolveFormat(serializationLanguage));

}

if (writer instanceof RdfXmlAbbreviatedWriter) {

writer.write(model,

outputStream,

null);

} else {

RDFDataMgr.write(outputStream, model, resolveFormat(serializationLanguage));

}

Copilot · 2025-12-13T17:06:59Z

...-provider/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractOslcRdfXmlProvider.java

+    private RDFFormat resolveFormat(String serializationLanguage) {
+        switch (serializationLanguage) {
+            case RDFLanguages.strLangRDFXML:
+                return RDFFormat.RDFXML_PLAIN;
+            case RDFLanguages.strLangTurtle:
+                return RDFFormat.TURTLE_PRETTY;
+            case RDFLanguages.strLangNTriples:
+                return RDFFormat.NTRIPLES_UTF8;
+            case RDFLanguages.strLangJSONLD:
+                return RDFFormat.JSONLD;
+            default:
+                throw new IllegalArgumentException();
+        }
+    }


The indentation of this method is inconsistent with the rest of the file. The method body and switch statement should use consistent indentation matching the surrounding code style (typically 2 or 4 spaces per level).

Suggested change

private RDFFormat resolveFormat(String serializationLanguage) {

switch (serializationLanguage) {

case RDFLanguages.strLangRDFXML:

return RDFFormat.RDFXML_PLAIN;

case RDFLanguages.strLangTurtle:

return RDFFormat.TURTLE_PRETTY;

case RDFLanguages.strLangNTriples:

return RDFFormat.NTRIPLES_UTF8;

case RDFLanguages.strLangJSONLD:

return RDFFormat.JSONLD;

default:

throw new IllegalArgumentException();

}

}

private RDFFormat resolveFormat(String serializationLanguage) {

switch (serializationLanguage) {

case RDFLanguages.strLangRDFXML:

return RDFFormat.RDFXML_PLAIN;

case RDFLanguages.strLangTurtle:

return RDFFormat.TURTLE_PRETTY;

case RDFLanguages.strLangNTriples:

return RDFFormat.NTRIPLES_UTF8;

case RDFLanguages.strLangJSONLD:

return RDFFormat.JSONLD;

default:

throw new IllegalArgumentException();

}

}

Copilot · 2025-12-13T17:06:59Z

...-provider/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractOslcRdfXmlProvider.java

+                    outputStream,
+                    null);
+            } else {
+                RDFDataMgr.write(outputStream, model, resolveFormat(serializationLanguage));


When using RDFDataMgr.write() with RDFXML_PLAIN format, Jena may write its own XML declaration. Combined with the manual XML declaration written at lines 151-152 (for XML formats), this could result in duplicate XML declarations in the output. Consider either removing the manual XML declaration for non-abbreviated cases that use RDFDataMgr.write(), or configuring RDFDataMgr to suppress its XML declaration.

Copilot · 2025-12-13T17:06:59Z

...-provider/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractOslcRdfXmlProvider.java

+            case RDFLanguages.strLangJSONLD:
+                return RDFFormat.JSONLD;
+            default:
+                throw new IllegalArgumentException();


The default case throws an IllegalArgumentException with no error message. This makes it difficult to debug when an unsupported serialization language is passed. Consider adding a descriptive error message that includes the unsupported serialization language value to help with troubleshooting.

Suggested change

throw new IllegalArgumentException();

throw new IllegalArgumentException("Unsupported serialization language: " + serializationLanguage);

berezovskyi · 2025-12-22T12:43:06Z

@oslc-bot /test-all

oslc-bot · 2025-12-22T12:43:11Z

Downstream Build Status

Repository	Lyo CI	Job state	Workflow
`oslc-op/refimpl`	✅ Pass	`completed`	Link
`oslc/lyo-samples`	✅ Pass	`completed`	Link
`oslc/promcode-lyo-server`	✅ Pass	`completed`	Link

berezovskyi · 2026-02-06T16:16:18Z

In the current Lyo code, this should be enough to get things working with most Jazz tools, e.g. RRC:

System.setProperty("org.eclipse.lyo.oslc4j.alwaysXMLAbbrev", "true");

We will hold this patch until we are sure that the new approach still works with abbrev-dependent systems like Jazz.

berezovskyi force-pushed the b-jena-format-spec branch from 1c84cfd to fba9e1d Compare April 14, 2023 19:53

berezovskyi added this to the 5.1 milestone Apr 14, 2023

berezovskyi changed the title ~~Control the output format manually~~ Control the RDF output format manually Apr 14, 2023

github-actions bot force-pushed the b-jena-format-spec branch 6 times, most recently from 3e44a71 to 14fee00 Compare May 2, 2023 07:43

github-actions bot force-pushed the b-jena-format-spec branch 2 times, most recently from dddd698 to fae096f Compare May 24, 2023 07:43

github-actions bot force-pushed the b-jena-format-spec branch from fae096f to 98fd159 Compare June 13, 2023 07:43

berezovskyi modified the milestones: 5.1, 6.0 Jun 13, 2023

berezovskyi added Type: Enhancement New feature or request Xtra: Breaking labels Jun 13, 2023

github-actions bot force-pushed the b-jena-format-spec branch 4 times, most recently from 9b1d7ba to 60946b8 Compare June 21, 2023 07:43

github-actions bot force-pushed the b-jena-format-spec branch from 60946b8 to 94223a7 Compare June 30, 2023 07:44

berezovskyi changed the title ~~Control the RDF output format manually~~ feat: Control the RDF output format manually Jun 30, 2023

github-actions bot force-pushed the b-jena-format-spec branch 2 times, most recently from 4ef534e to 51cb26d Compare July 14, 2023 07:43

github-actions bot force-pushed the b-jena-format-spec branch 2 times, most recently from b2cfc91 to 3a3f805 Compare August 5, 2023 07:43

berezovskyi mentioned this pull request Oct 18, 2024

Deprecated Json4J Providers still registered. Usage by default cannot be prevented #636

Closed

berezovskyi force-pushed the b-jena-format-spec branch from a82bdb6 to 91a11f8 Compare November 16, 2024 10:25

berezovskyi force-pushed the b-jena-format-spec branch from 91a11f8 to 1906c43 Compare January 9, 2025 16:28

Control the output format manually

1698fa6

Signed-off-by: Andrew Berezovskyi <andriib@kth.se>

berezovskyi force-pushed the b-jena-format-spec branch from b7fe205 to 1698fa6 Compare June 18, 2025 18:21

Merge branch 'master' into b-jena-format-spec

ddbe7df

berezovskyi added 5 commits July 22, 2025 01:22

Merge branch 'master' into b-jena-format-spec

545e544

Merge branch 'master' into b-jena-format-spec

e5f1d12

Merge branch 'master' into b-jena-format-spec

5df2d8a

# Conflicts: # core/oslc4j-jena-provider/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractOslcRdfXmlProvider.java

fix: tests

b47a5d7

Signed-off-by: Andrew Berezovskyi <andriib@kth.se>

Merge branch 'master' into b-jena-format-spec

72e7289

Merge branch 'master' into b-jena-format-spec

dc167fe

Copilot AI review requested due to automatic review settings December 13, 2025 17:00

Copilot started reviewing on behalf of berezovskyi December 13, 2025 17:00 View session

Copilot AI reviewed Dec 13, 2025

View reviewed changes

berezovskyi added 2 commits December 20, 2025 17:01

Merge branch 'master' into b-jena-format-spec

63a6180

Merge branch 'master' into b-jena-format-spec

e04be2e

berezovskyi added 3 commits January 31, 2026 13:07

Merge branch 'master' into b-jena-format-spec

479fa23

Merge branch 'master' into b-jena-format-spec

2f38a36

Merge branch 'master' into b-jena-format-spec

7eec1fb

berezovskyi added the Status: Needs verification label Feb 6, 2026

berezovskyi added 2 commits February 6, 2026 20:27

Merge branch 'master' into b-jena-format-spec

7d8459c

Merge branch 'master' into b-jena-format-spec

33fc892

	throw new IllegalArgumentException();
	throw new IllegalArgumentException("Unsupported serialization language: " + serializationLanguage);

feat: Control the RDF output format manually #277

Are you sure you want to change the base?

feat: Control the RDF output format manually #277

Conversation

berezovskyi commented Jun 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Issues

Uh oh!

berezovskyi commented Apr 14, 2023

Uh oh!

berezovskyi commented Apr 14, 2023

Uh oh!

berezovskyi commented Jun 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

berezovskyi commented Jun 13, 2023

Uh oh!

berezovskyi commented Jul 16, 2025

Uh oh!

oslc-bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Downstream Build Status

Uh oh!

berezovskyi commented Nov 29, 2025

Uh oh!

oslc-bot commented Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Downstream Build Status

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 13, 2025

Choose a reason for hiding this comment

Uh oh!

berezovskyi commented Dec 22, 2025

Uh oh!

oslc-bot commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Downstream Build Status

Uh oh!

berezovskyi commented Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

berezovskyi commented Jun 25, 2022 •

edited

Loading

berezovskyi commented Jun 13, 2023 •

edited

Loading

oslc-bot commented Jul 16, 2025 •

edited

Loading

oslc-bot commented Nov 29, 2025 •

edited

Loading

oslc-bot commented Dec 22, 2025 •

edited

Loading