Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
EclipseLink/DesignDocs/326663
Design Specification: JPA RESTful Service
Document History
Date | Author | Version Description & Notes |
---|---|---|
Project overview
Overview of the project/feature. Why is it desired, what are its goals.
Goals:
- goal 1
- goal 2
Concepts
The following example demonstrates how JPA can be used to implement a RESTful web service:
Requirements
The following sections will expand the goals of this project into more concrete requirements.
Design Constraints
Design / Functionality
URI Representation
Data in a RESTful service is referenced through URIs.
Unary Key
Composite Keys
Named Queries
@NamedQuery(name = "findCustomerByName", query = "SELECT c " + "FROM Customer c " + "WHERE c.firstName = :firstName AND " + " c.lastName = :lastName")
- http://localhost/customers/findCustomerByName/singleResult?firstName=Jane&lastName=Doe
- http://localhost/customers/findCustomerByName/resultList?firstName=Jane&lastName=Doe
REST (CRUD) Operations
POST - Create Operation
@POST @Consumes(MediaType.APPLICATION_XML) public void create(Customer customer) { entityManager.persist(customer); }
GET - Read Operation
Get is a read-only operation. It is used to query resources.
@GET @Produces(MediaType.APPLICATION_XML) @Path("{id}") public Customer read(@PathParam("id") long id) { return entityManager.find(Customer.class, id); }
PUT - Update Operation
The put operation updates the underlying resource. When using put the client knows the identity of the resource being updated.
@PUT @Consumes(MediaType.APPLICATION_XML) public void update(Customer customer) { entityManager.merge(customer); }
DELETE - Delete Operation
The delete operation is used to remove resources. It is not an error to remove a non-existent resource.
@DELETE @Path("{id}") public void delete(@PathParam("id") long id) { Customer customer = read(id); if (null != customer) { entityManager.remove(customer); } }
Testing
API
GUI
Config files
Documentation
Open Issues
This section lists the open issues that are still pending that must be decided prior to fully implementing this project's requirements.
Issue # | Owner | Description / Notes |
---|---|---|
Decisions
This section lists decisions made. These are intended to document the resolution of open issues or constraints added to the project that are important.
Issue # | Description / Notes | Decision |
---|---|---|
Future Considerations
During the research for this project the following items were identified as out of scope but are captured here as potential future enhancements. If agreed upon during the review process these should be logged in the bug system.