Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
EclipseLink/Development/JPA-RS
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.
Planned Features/Bugs
| 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. | not started | 2.4.1 |
| 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 |
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. |
| 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 :
{ "code":"1245", "description":"invalid query" }
HTTP Status 404 - Not Foundtype Status report messageNot Found descriptionThe requested resource (Not Found) is not available. GlassFish Server Open Source Edition 3.1.2</body></html> |
| 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) |
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 "/peristence/...".
- 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.