Skip to main content
Jump to: navigation, search

Difference between revisions of "EclipseLink/Development/JPA-RS"

Line 6: Line 6:
See the [  API in Development] here.
See the [  API in Development] here.
== Planned Features/Bugs ==
== Project Planning ==
See [ BugDB] for a prioritized list of features and bugs along with their target releases.
Line 29: Line 31:
== Proposed Features ==
== Proposed Features ==
See [ BugDB].

Revision as of 10:58, 3 October 2012

EclipseLink JPA-RS Development

The EclipseLink 2.4.0 release introduced JPA-RS allowing developers to easily expose persistence units over REST (JAX-RS). The intent was to allow clients (HTML5/JS, Mobile, JavaSE/JavaFX) to easily access persistent data over REST with JSON or XML. This page tracks the ongoing feature development of JPA-RS including planned features for upcoming releases as well as a back-log of future enhancements. The details of each item will be tracked within its bug and associated wiki pages or documents.

See the API in Development here.

Project Planning

See BugDB for a prioritized list of features and bugs along with their target releases.

Bug Issue Description Status Target Release
bug 387313 PUT/POST Cannot create an entity containing reference (1-to-1) to another entity, using JPA-RS with static PU Fixed 2.4.1
bug 387636 POST Swallowed exception in PersistenceContext::updateOrAddAttribute Fixed 2.4.1
bug 389295 JPA-RS: Disable EJB invocation by default The current implementation enables EJB invocation all the time. We should make that functionality configurable and "off" by default. document for 2.4.1 2.4.2
bug 389888 JPA-RS: Pass-by-Reference, Pass-by-value allow JPA_RS objects to be passed by value for relationships in progress 2.4.1
bug 390004 JPA-RS: Interaction with model classes with or without JAXB annotations By default JPA-RS should respect existing JAXB annotations in applications' model classes. If the application model is not (JAXB) annotated, especially for cylic references, the JPA-RS should detect these from mappings and implement XMLInverseReference behaviour. not started 2.4.1

Proposed Features

Bug Issue Description
bug 389881 Config File Add an optional XML configuration which when provided controls which persistence units are made available through JPA_RS and what operations within each persistence unit are made available. This configuration file will also control extended functionality where any existing or custom JPA-RS operation can have a custom handler specified or a handler can be specified to intercept all operations or all unsupported requests.

There are also some other configurable properties that are required to be set during the deployment of an application using JPA-RS. These properties include (but might not be limited to):

  • base URI of the service,
  • datasource properties/name, etc...

The application developer will also need a way (some sort of API) to pass these properties to the JPA-RS, perhaps as part of bootstrapPersistenceContext ???

bug 387218 Pagination Support pagination (count, first, max, getNext<N>) using URI query parameters.
bug 389883 Partial Entities Add support for clients being able to request partial entities and graphs that will reduce the payload size or reduce the number of requests required to retrieve and to pass back an entity graph.
bug 389884 Detailed error response Add support for clients being able to get more information in an error response. Please note that this is an addition to the HTTP error/status code that is currently being returned in response. The JPA-RS would return an error message in the body of the response that would contain an (EclipseLink specific) error code and description. As an example, an error response would look like :


 "description":"invalid query"


With the existing implementation, you will get following error response if you try to read a non-existing entity, even if you want the response back in JSON format. I think returning error in the format suggested above will make the error handling easier.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" ""><html xmlns=""><head><title>GlassFish Server Open Source Edition 3.1.2 - Error report</title><style type="text/css"></style> </head><body>

HTTP Status 404 - Not Found

type Status report

messageNot Found

descriptionThe requested resource (Not Found) is not available.

GlassFish Server Open Source Edition 3.1.2

bug 389889 HATEOAS Enhancements Improve support for discovery of available operations in JPA-RS application
bug 389890 Refactor JPA-RS jar to minimize contents Move the majority of JPA-RS functionality into one of our main bundles (e.g. the org.eclipse.persistence.jpa bundle)
bug 390492 Support JSONP (JSON PADDING) JSONP support
bug 390786 ClassCastException retrieving metadata for Composite Persistence Unit Our metadata functionality is not currently accounting for composite PUs.
bug 390785 Composite Persistence Unit Components should not be visible Our metadata functionality currently shows even PUs that are not directly accessible because they are exclusive to a composite PU

Open Issues

  • Fully Qualified vs. Relative URIs in responses - Should we return a fully qualified URL starting with "http://", or should we use a relative URL that omits the application path like "/persistence/...".
  • Bidirectional relationships and cycles - how do we pass bidirectional relationships in JSON/XML. There are limitations related to how you can expect to see responses in JSON/XML - e.g. XMLInverseReference needs to be specified somewhere for bidirecitonal relationships.
  • Can we remove the need for client to send the name of the attribute that makes up the opposite side of the relationship in the JPA-RS POST message (EclipseLink/Development/2.4.0/JPA-RS/REST-API#ADD) for adding a member to a collection and let the JAP-RS to figure it out on the server side ?
  • ManyToMany mappings are complex to map in JAXB. They will not marshall correctly in JPA-RS without being JAXB mapped with either annotations of xml
  • The REST API to setOrAddAttributes will not work when using FIELD access with Weaved Change Tracking and Internal Weaving, because there is no way to have EclipseLink set the value field and have changes tracked.
  • The REST API to create(PUT) will not set both sides of bidirectional(one-to-many, one-to-one) relationships.

Back to the top