Helidon Data SE Declarative example

Signed-off-by: Tomáš Kraus <[email protected]>

Author: Tomáš Kraus

examples/data/pom.xml

@@ -36,6 +36,7 @@
 
     <modules>
         <module>basics</module>
+        <module>se-declarative</module>
         <module>se-imperative</module>
     </modules>
 </project>

examples/data/se-declarative/README.md

@@ -0,0 +1,133 @@
+Helidon Data SE Declarative Example
+----
+
+This example demonstrates a Java SE declarative application that utilizes Helidon Data, WebServer,
+and a MySQL database.
+
+> **NOTE:** Database tables are initialized with ID auto increment to supply primary key values
+>           by the database. MySQL database default String comparisons are case-insensitive.
+
+## Start the Database
+
+To run the application, a MySQL database is required. You can start the database with the necessary
+configuration using the following Docker command:
+
+```shell
+docker run --name mysql \
+       -p 3306:3306 \
+       -e MYSQL_DATABASE='pets' \
+       -e MYSQL_RANDOM_ROOT_PASSWORD='yes' \
+       -e MYSQL_USER='user' \
+       -e MYSQL_PASSWORD='P4ssw0rd' \
+       -d mysql
+```
+
+### Database Schema and Content
+
+The application's Jakarta Persistence API implementation automatically creates the database schema
+using the `resources/init.sql` script. The schema consists of three main entities: `Pet`, `Owner`
+and `Breed`. The initialization script populates the database with a basic set of records.
+
+## Build and Run
+
+1. Build the application using Maven:
+
+```shell
+mvn package
+```
+
+2. Run the application:
+
+```shell
+java -jar target/helidon-examples-data-se-declarative.jar
+```
+
+> **NOTE:** The default username and password from this example should never be used in a production environment!
+
+## Test Example
+
+The application provides the following endpoints:
+- http://localhost:8080/pet - Pet entity endpoint
+- http://localhost:8080/owner - Owner entity endpoint
+- http://localhost:8080/breed - Breed entity endpoint
+
+### Pet Endpoint
+
+**Retrieve Pet entity endpoint information:**
+```shell
+curl http://localhost:8080/pet
+```
+
+**List all pets:**
+```shell
+curl http://localhost:8080/pet/all
+```
+
+**List all dogs:**
+```shell
+curl http://localhost:8080/pet/breed/Dog
+```
+
+**Retrieve a Pet by name (`Max`):**
+```shell
+curl http://localhost:8080/pet/get/Max
+```
+
+**Insert new pet:**
+```shell
+curl -i -X POST -H 'Content-type: application/json' -d '{"name":"Ken","weight":3.5,"birth":"2023-05-10","owner":"Betty","breed":"Dog"}' http://localhost:8080/pet
+```
+
+**Delete existing pet by ID (`20`):**
+```shell
+curl -i -X DELETE http://localhost:8080/pet/20
+```
+
+### Owner Endpoint
+
+**Retrieve Owner entity endpoint information:**
+```shell
+curl http://localhost:8080/owner
+```
+
+**List all owners:**
+```shell
+curl http://localhost:8080/owner/all
+```
+
+**List all names of owners who own a cat:**
+```shell
+curl http://localhost:8080/owner/names/Cat
+```
+
+**Insert new owner:**
+```shell
+curl -i -X POST http://localhost:8080/owner/Alice
+```
+
+**Delete existing owner by ID (`10`):**
+```shell
+curl -i -X DELETE http://localhost:8080/owner/10
+```
+
+### Breed Endpoint
+
+**Retrieve Breed entity endpoint information:**
+```shell
+curl http://localhost:8080/breed
+```
+
+**List all breeds:**
+```shell
+curl http://localhost:8080/breed/all
+```
+
+**Insert new breed:**
+```shell
+curl -i -X POST http://localhost:8080/breed/Hamster
+```
+
+**Delete existing breed by ID (`10`):**
+```shell
+curl -i -X DELETE http://localhost:8080/breed/10
+```

examples/data/se-declarative/pom.xml

@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2025 Oracle and/or its affiliates.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.helidon.applications</groupId>
+        <artifactId>helidon-se</artifactId>
+        <version>4.3.0-SNAPSHOT</version>
+        <relativePath/>
+    </parent>
+
+    <groupId>io.helidon.examples.data</groupId>
+    <artifactId>helidon-examples-data-se-declarative</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <name>Helidon Examples Data Repository SE Declarative</name>
+
+    <description>
+        The simplest example shows how to use Data Repository.
+    </description>
+
+    <properties>
+        <mainClass>io.helidon.examples.data.se.declarative.Main</mainClass>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config-yaml</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.data</groupId>
+            <artifactId>helidon-data</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.data.jakarta.persistence</groupId>
+            <artifactId>helidon-data-jakarta-persistence</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.webserver</groupId>
+            <artifactId>helidon-webserver</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.http.media</groupId>
+            <artifactId>helidon-http-media-jsonb</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.logging</groupId>
+            <artifactId>helidon-logging-jul</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.persistence</groupId>
+            <artifactId>jakarta.persistence-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.persistence</groupId>
+            <artifactId>org.eclipse.persistence.jpa</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.persistence</groupId>
+            <artifactId>org.eclipse.persistence.core</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.mysql</groupId>
+            <artifactId>mysql-connector-j</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>io.helidon.bundles</groupId>
+                            <artifactId>helidon-bundles-apt</artifactId>
+                            <version>${helidon.version}</version>
+                        </path>
+                        <path>
+                            <groupId>io.helidon.data.jakarta.persistence</groupId>
+                            <artifactId>helidon-data-jakarta-persistence-codegen</artifactId>
+                            <version>${helidon.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>copy-libs</id>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>io.helidon.service</groupId>
+                <artifactId>helidon-service-maven-plugin</artifactId>
+                <version>${helidon.version}</version>
+                <executions>
+                    <execution>
+                        <id>create-application</id>
+                        <goals>
+                            <goal>create-application</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

examples/data/se-declarative/src/main/java/io/helidon/examples/data/se/declarative/Main.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2025 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.helidon.examples.data.se.declarative;
+
+import io.helidon.logging.common.LogConfig;
+import io.helidon.service.registry.Service;
+import io.helidon.service.registry.ServiceRegistryManager;
+import io.helidon.service.registry.Services;
+import io.helidon.webserver.WebServer;
+
+/**
+ * The Main class serves as the entry point for the application.
+ * It demonstrates the usage of Helidon Data in an SE imperative application.
+ */
+@Service.GenerateBinding
+public class Main {
+
+    static {
+        LogConfig.initClass();
+    }
+
+    private Main() {
+        throw new UnsupportedOperationException("Instances of Main class are not allowed");
+    }
+
+    /**
+     * Entry point for the SE application.
+     *
+     * @param args command-line arguments passed to the application
+     */
+    public static void main(String... args) {
+
+        // load logging configuration
+        LogConfig.configureRuntime();
+
+        ServiceRegistryManager.start(ApplicationBinding.create());
+
+        WebServer webServer = Services.get(WebServer.class);
+        System.out.println("Server started on: http://localhost:" + webServer.port());
+
+    }
+
+}