New UniversalResourceSingleProvider to support more RDF formats #9

berezovskyi · 2018-05-27T20:35:38Z

So I wanted to have a "quick" refactoring of the current JAX-RS providers. The reason for that being that all of them subclass from the RDF/XML abstract provider class.

Naturally, I began the refactoring by abstracting parts of the abstract class itself AbstractOslcRdfXmlProvider extends AbstractRdfProvider. But then, as I was digging into the functionality, I found that there were three main things that kept bothering me:

Extra checks on MIME types, checking the HTTP headers etc. I trust JAX-RS engine such as Wink to invoke my provide only when the headers match the annotated types (spoiler: in the end, Wink indeed refused to invoke my provider w/o the corresponding annotations on the service method).
Extra handling of RDF/XML-ABBREV serialisation. As I understand, our code defines a custom Jena writer in order to produce such serialisation. I think we still need to support it, but this patch is a demo of some fresh work that does away with hacking the hacked format.
Special treatment of the OSLC Query. It is everywhere: in the providers, in the JMH; there is a special class org.eclipse.lyo.oslc4j.core.model.ResponseInfo for OSLC Query response handling. Just so that you understand, everywhere as mentioned above the following is taking place: the RDFS container is constructed and manipulated in a very specific way. I am 100% sure this is not the responsibility of these classes (providers & JMH). Maybe there was no other way to craft the right Jena model, but we gotta find a solution. Jad suggested to me long time ago to allow returning a Jena Model from a service method. Then a provider simply serialises it w/o hitting JMH. I might envision some specific annotations, but it will still be a lot of work, because Providers look at the HTTP request headers to generate nav links!

Anyway, this patch presents:

AbstractRdfProvider, which is an abstraction of the AbstractOslcRdfXmlProvider
UniversalResourceSingleProvider, a universal provider for all formats handled by Jena for individual resources. Support for collections would require 1 or 2 more classes, but that's easy.

I modified a JSON-LD unit test and did a hand test for Turtle & N-Triples on the SPC – all work. RDF/XML can still be handled by the old providers to handle problem no. 2.

Does not treat OSLC Query resources in a special way; does not do all the hacks necessary to perform ABBREV support. Change-Id: I125188a77230fca013bd9f94a7471c2e8a4099fe Signed-off-by: Andrew Berezovskyi <[email protected]>

berezovskyi · 2018-05-27T20:37:09Z

Oh yes, and I also tested RDF/JSON support in Jena. Seems good. That now really means we can deprecate our own RDF/JSON library unless OSLC products again require some tweaks.

jadelkhoury · 2018-05-28T09:01:10Z

Suggest keeping this patch until after the release of 2.4.0. that is, 2.5.0

This new provider is meant to be available in parrallel with the existing Providers. So no harm done.
This Provider does not deal with Query responses. But that is probably a good thing, since we should expect the adaptors to create the Query resources. Current providers hide too much of that.

Instead of transparently creating the Query responses, we should provide a library method that allows developer to create a proper query response out of the set of resources to be returned.

2nd try, #9 has too many merge conflicts Signed-off-by: Andrew Berezovskyi <[email protected]>

berezovskyi · 2019-02-15T17:37:56Z

Due to the amount of merge conflicts will be closed in favour of #76

berezovskyi · 2019-02-15T16:33:24Z

...c4j.provider.jena/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/OslcJsonLdProvider.java

@@ -13,6 +12,6 @@
 * @since 0.0.1
 */
 @Provider
-@Produces({OslcMediaType.JSON_LD})
-@Consumes({OslcMediaType.JSON_LD})
+@Produces({"ld+json"})


Use a MIME type and a const

berezovskyi · 2019-02-15T16:33:39Z

...jena/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/UniversalResourceSingleProvider.java

+ *
+ * @author Andrew Berezovskyi ([email protected])
+ * @version $version-stub$
+ * @since 0.0.1


since 4.0.0

berezovskyi · 2019-02-15T16:33:54Z

...jena/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/UniversalResourceSingleProvider.java

@@ -0,0 +1,80 @@
+package org.eclipse.lyo.oslc4j.provider.jena;


berezovskyi · 2019-02-15T16:34:01Z

...oslc4j.provider.jena/src/test/java/org/eclipse/lyo/oslc4j/provider/jena/test/JsonLdTest.java

@@ -6,6 +6,7 @@
 import org.eclipse.lyo.oslc4j.core.model.OslcMediaType;
 import org.eclipse.lyo.oslc4j.core.model.ServiceProvider;
 import org.eclipse.lyo.oslc4j.provider.jena.OslcJsonLdProvider;
+import org.eclipse.lyo.oslc4j.provider.jena.UniversalResourceSingleProvider;


berezovskyi · 2019-02-15T16:34:09Z

...4j.provider.jena/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractRdfProvider.java

@@ -0,0 +1,114 @@
+package org.eclipse.lyo.oslc4j.provider.jena;


berezovskyi · 2019-02-15T16:34:16Z

...4j.provider.jena/src/main/java/org/eclipse/lyo/oslc4j/provider/jena/AbstractRdfProvider.java

+ *
+ * @author Andrew Berezovskyi ([email protected])
+ * @version $version-stub$
+ * @since 0.0.1


since 4.0.0

berezovskyi · 2019-02-15T17:01:47Z

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

-	private static final Annotation[] ANNOTATIONS_EMPTY_ARRAY = new Annotation[0];
-	private static final Class<Error> CLASS_OSLC_ERROR		  = Error.class;
-	private static final ErrorHandler ERROR_HANDLER			  = new ErrorHandler();
+	protected static final Annotation[] ANNOTATIONS_EMPTY_ARRAY = new Annotation[0];


berezovskyi requested review from jamsden, yashkhatri and jadelkhoury May 27, 2018 20:35

berezovskyi added the Status: On Hold label May 28, 2018

berezovskyi mentioned this pull request Jun 30, 2018

Switch to 2.3.0-SNAPSHOT in the RM adaptor OSLC/lyo-adaptor-sample-modelling#12

Closed

berezovskyi closed this Nov 13, 2018

berezovskyi changed the base branch from b531949-jsonld to master November 15, 2018 22:45

berezovskyi reopened this Nov 15, 2018

berezovskyi mentioned this pull request Nov 15, 2018

OslcJsonLdProvider never called when trying to write to 'application/ld+json' #44

Closed

berezovskyi added Xtra: Fix Verified Type: Enhancement Status: Review Needed and removed Status: On Hold labels Feb 14, 2019

berezovskyi added a commit that referenced this pull request Feb 15, 2019

New UniversalResourceSingleProvider to support more RDF formats

1c48526

2nd try, #9 has too many merge conflicts Signed-off-by: Andrew Berezovskyi <[email protected]>

berezovskyi mentioned this pull request Feb 15, 2019

New UniversalResourceSingleProvider to support more RDF formats #76

Open

3 tasks

berezovskyi commented Feb 15, 2019

View reviewed changes

berezovskyi closed this Feb 15, 2019

berezovskyi deleted the universalprovider branch July 11, 2019 17:28

berezovskyi mentioned this pull request Oct 18, 2024

Deprecated Json4J Providers still registered. Usage by default cannot be prevented eclipse-lyo/lyo#636

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New UniversalResourceSingleProvider to support more RDF formats #9

New UniversalResourceSingleProvider to support more RDF formats #9

berezovskyi commented May 27, 2018

berezovskyi commented May 27, 2018

jadelkhoury commented May 28, 2018 •

edited

Loading

berezovskyi commented Feb 15, 2019

berezovskyi Feb 15, 2019

berezovskyi Feb 15, 2019

berezovskyi Feb 15, 2019

berezovskyi Feb 15, 2019

berezovskyi Feb 15, 2019

berezovskyi Feb 15, 2019

berezovskyi Feb 15, 2019

		@@ -0,0 +1,80 @@
		package org.eclipse.lyo.oslc4j.provider.jena;

		@@ -0,0 +1,114 @@
		package org.eclipse.lyo.oslc4j.provider.jena;

New UniversalResourceSingleProvider to support more RDF formats #9

New UniversalResourceSingleProvider to support more RDF formats #9

Conversation

berezovskyi commented May 27, 2018

berezovskyi commented May 27, 2018

jadelkhoury commented May 28, 2018 • edited Loading

berezovskyi commented Feb 15, 2019

berezovskyi Feb 15, 2019

Choose a reason for hiding this comment

berezovskyi Feb 15, 2019

Choose a reason for hiding this comment

berezovskyi Feb 15, 2019

Choose a reason for hiding this comment

berezovskyi Feb 15, 2019

Choose a reason for hiding this comment

berezovskyi Feb 15, 2019

Choose a reason for hiding this comment

berezovskyi Feb 15, 2019

Choose a reason for hiding this comment

berezovskyi Feb 15, 2019

Choose a reason for hiding this comment

jadelkhoury commented May 28, 2018 •

edited

Loading