Jakarta Data Sample

This sample shows how to store and retrieve data using Jakarta Data. Jakarta Data is planned to release in Jakarta EE 11, and is currently in beta in Open Liberty.

Environment Setup

To run this sample, first download or clone this repo - to clone:

git clone git@github.com:OpenLiberty/sample-jakarta-data.git

Set Up PostgreSQL

You will need a PostgreSQL instance to use this sample. If you have Docker installed, you can run the following from inside the sample-jakarta-data directory:

docker build -t liberty_postgres postgres
docker run --name liberty_postgres -d -p 5432:5432 liberty_postgres

If you are not using Docker, you will need to create a user with the name sampleUser and password openliberty with access to a database named testdb

Running the Sample

From inside the sample-jakarta-data directory, build and start the application in Open Liberty with the following command:

./mvnw liberty:dev

Once the server has started, the application is availible at http://localhost:9080

Try it out

Give the sample a try by registering a crew member. Enter a name (a String), an ID Number (an Integer), and select a Rank from the menu, then click 'Register Crew Member'.

The new crew member will appear in the Crew Members box. Continue to add crew members, choosing a variety of ranks for the crew members. In the Queries box, click the findByRank button. The crew members will appear in a Crew Members by Rank box, sorted into columns by rank.

How it works

This application provides a few REST endpoints to demonstrate some of the capabilities of Jakarta Data. There are two classes which are used for Jakarta Data, a Jakarta Persistence Entity (CrewMember) and a Jakarta Data Repository (CrewMembers). CrewMembers is annotated with @Repository and extends the Jakarta Data DataRepository interface, adding save, delete, and query methods. When the repository is injected into another object using CDI, Jakarta Data will provide an implementation of the interface, including implementations of the save, delete, and query methods.

The CrewMembers repository is injected into the REST application using CDI

public class CrewService {
//[...]
@Inject
CrewMembers crewMembers;

The first endpoint persists a CrewMember in the database by calling crewMembers.save()

public String add(CrewMember crewMember) {
    crewMembers.save(crewMember);

    //Jakarta Validation[...]

To remove an individual CrewMember from the database based on the ID, you can use crewMembers.deleteByCrewID

public void remove(@PathParam("id") int id) {
    crewMembers.deleteByCrewID(id);

In order to display all of our CrewMembers, you can get all of them easily by calling crewMembers.findAll()

public String retrieve() {
    Iterable<CrewMember> crewMembersIterable = crewMembers.findAll()::iterator;

In the CrewMembers.java file we can see that these will be returned sorted alphabetically, using @OrderBy("name")

public interface CrewMembers {
//[...]
@Find
@OrderBy("name")
Stream<CrewMember> findAll();

Finally, for a slightly more complex operation, we can ask for a subset of the crew members with a given Rank, using crewMembers.findByRank()

public String retrieveByRank(@PathParam("rank") String rank) {
    List<CrewMember> crewMembersList = crewMembers.findByRank(Rank.fromString(rank));

Data Source configuration

The application makes use of Open Liberty's built in Jakarta Data implementation, backed by Jakarta Persistence. The connection to the database is defined as a DataSource, which is configured in the server.xml.

Stop Postgres

When you are done trying out the sample application, you can stop the Postgres container with:

docker stop liberty_postgres

Where to go next

Check out the Jakarta Data Specification on GitHub: https://github.com/jakartaee/data. You can make suggestions or report bugs by opening an issue, or star the repository to show you're interested.

arctic1106 / sample-jakarta-data