4.x coherence example for Helidon MP (#85)

* Add basic Helidon MP coherence example
helidon-io · Sep 3, 2024 · 6dcfc84 · 6dcfc84
1 parent 2c4f60c
commit 6dcfc84
Show file tree

Hide file tree

Showing 11 changed files with 430 additions and 0 deletions.
diff --git a/examples/microprofile/coherence/README.md b/examples/microprofile/coherence/README.md
@@ -0,0 +1,23 @@
+# helidon-creditscore-mp
+
+Sample Helidon MP applications that uses Coherence CE as a cache for application data.
+
+## Build and run
+
+```shell
+mvn package
+java -jar target/helidon-examples-microprofile-coherence.jar
+```
+
+## Exercise the application
+
+```shell
+curl -X POST -H "Content-Type: application/json" \
+ -d '{"ssn" : "123-45-6789", "firstName" : "Frank", "lastName" : "Helidon", "dateOfBirth" : "02/14/2019"}' \
+  http://localhost:8080/creditscore
+```
+
+You'll notice a short delay as the application computes the credit score.
+Now repeat the same request. You'll see the score is returned instantly
+as it is retrieved from the cache.
+
diff --git a/examples/microprofile/coherence/pom.xml b/examples/microprofile/coherence/pom.xml
@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2024 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-mp</artifactId>
+        <version>4.1.0-SNAPSHOT</version>
+        <relativePath/>
+    </parent>
+
+    <properties>
+        <version.lib.coherence>24.03.1</version.lib.coherence>
+    </properties>
+
+    <groupId>io.helidon.examples.microprofile</groupId>
+    <artifactId>helidon-examples-microprofile-coherence</artifactId>
+    <name>Helidon Examples Microprofile Coherence</name>
+    <version>1.0.0-SNAPSHOT</version>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>com.oracle.coherence.ce</groupId>
+                <artifactId>coherence-bom</artifactId>
+                <version>${version.lib.coherence}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.helidon.microprofile.bundles</groupId>
+            <artifactId>helidon-microprofile-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.json.bind</groupId>
+            <artifactId>jakarta.json.bind-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.oracle.coherence.ce</groupId>
+            <artifactId>coherence-cdi-server</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.oracle.coherence.ce</groupId>
+            <artifactId>coherence-mp-config</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.media</groupId>
+            <artifactId>jersey-media-json-binding</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.logging</groupId>
+            <artifactId>helidon-logging-jul</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.smallrye</groupId>
+            <artifactId>jandex</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.microprofile.testing</groupId>
+            <artifactId>helidon-microprofile-testing-junit5</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>copy-libs</id>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>io.smallrye</groupId>
+                <artifactId>jandex-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>make-index</id>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/...oherence/src/main/java/io/helidon/examples/microprofile/coherence/CreditscoreService.java b/...oherence/src/main/java/io/helidon/examples/microprofile/coherence/CreditscoreService.java
@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2024 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.microprofile.coherence;
+
+import com.oracle.coherence.cdi.Name;
+import com.tangosol.net.NamedCache;
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+
+import static java.lang.System.Logger.Level.INFO;
+
+/**
+ * Credit score application.
+ */
+@ApplicationScoped
+@Path("/creditscore")
+public class CreditscoreService {
+
+    private static final System.Logger LOGGER = System.getLogger(CreditscoreService.class.getName());
+    private static final String CACHE_NAME = "creditScoreCache";
+
+    private static final int SCORE_MAX = 800;
+    private static final int SCORE_MIN = 550;
+
+    @Inject
+    @Name(CACHE_NAME)
+    private NamedCache<String, Integer> creditScoreCache;
+
+    /**
+     * Generate a credit score.
+     * @param person Person to generate score for
+     * @return Person with score populated and ssn redacted
+     */
+    @POST
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Produces(MediaType.APPLICATION_JSON)
+    public Response postMethodCreditScore(Person person) {
+
+        if (person.firstName() == null || person.lastName() == null || person.dateOfBirth() == null || person.ssn() == null) {
+            return Response.status(Response.Status.BAD_REQUEST).entity("Bad request").build();
+        }
+
+        LOGGER.log(INFO, "Computing credit score for " + person.firstName() + " " + person.lastName());
+
+        String ssn = person.ssn();
+        Integer creditScore = creditScoreCache.get(ssn);
+
+        if (creditScore == null) {
+            creditScore = calculateCreditScore(person);
+            creditScoreCache.put(ssn, creditScore);
+        }
+        return Response.ok(
+                new Person(person.firstName(), person.lastName(), person.dateOfBirth(), "NNN-NN-NNNN", creditScore))
+                .build();
+    }
+
+    private int calculateCreditScore(Person p) {
+        int score = Math.abs(p.hashCode()) % SCORE_MAX;
+        while (score < SCORE_MIN) {
+            score = score + 100;
+        }
+        // Pause for dramatic effect
+        sleep();
+        return score;
+    }
+
+    private void sleep() {
+        try {
+            Thread.sleep(2 * 1_000L);
+        } catch (InterruptedException ignored) {
+        }
+    }
+}
diff --git a/...croprofile/coherence/src/main/java/io/helidon/examples/microprofile/coherence/Person.java b/...croprofile/coherence/src/main/java/io/helidon/examples/microprofile/coherence/Person.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2024 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.microprofile.coherence;
+
+public record Person(
+    String firstName,
+    String lastName,
+    String dateOfBirth,
+    String ssn,
+    int creditScore) {}
diff --git a/...file/coherence/src/main/java/io/helidon/examples/microprofile/coherence/package-info.java b/...file/coherence/src/main/java/io/helidon/examples/microprofile/coherence/package-info.java
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2024 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.microprofile.coherence;
diff --git a/examples/microprofile/coherence/src/main/resources/META-INF/beans.xml b/examples/microprofile/coherence/src/main/resources/META-INF/beans.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2024 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.
+
+-->
+<beans xmlns="https://jakarta.ee/xml/ns/jakartaee"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee
+                           https://jakarta.ee/xml/ns/jakartaee/beans_4_0.xsd"
+        version="3.0"
+        bean-discovery-mode="annotated">
+</beans>
diff --git a/examples/microprofile/coherence/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/coherence/src/main/resources/META-INF/microprofile-config.properties
@@ -0,0 +1,24 @@
+#
+# Copyright (c) 2024 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.
+#
+
+# Microprofile server properties
+server.port=8080
+server.host=0.0.0.0
+
+# Coherence configuration
+coherence.ttl=0
+coherence.localhost=127.0.0.1
+coherence.wka=127.0.0.1
diff --git a/examples/microprofile/coherence/src/main/resources/logging.properties b/examples/microprofile/coherence/src/main/resources/logging.properties
@@ -0,0 +1,30 @@
+#
+# Copyright (c) 2021, 2024 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.
+#
+
+# Example Logging Configuration File
+# For more information see $JAVA_HOME/jre/lib/logging.properties
+
+# Send messages to the console
+handlers=io.helidon.logging.jul.HelidonConsoleHandler
+
+# HelidonConsoleHandler uses a SimpleFormatter subclass that replaces "!thread!" with the current thread
+java.util.logging.SimpleFormatter.format=%1$tY.%1$tm.%1$td %1$tH:%1$tM:%1$tS %4$s %3$s !thread!: %5$s%6$s%n
+
+# Global logging level. Can be overridden by specific loggers
+.level=INFO
+
+# Quiet Weld
+org.jboss.level=WARNING