diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index e47d6233..5bb6310e 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -63,7 +63,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Download Maven Artifacts - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: io-helidon-maven-artifacts path: ~/.m2/repository/io/helidon @@ -82,7 +82,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Download Maven Artifacts - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: io-helidon-maven-artifacts path: ~/.m2/repository/io/helidon @@ -104,7 +104,7 @@ jobs: runs-on: ${{ matrix.os }} steps: - name: Download Maven Artifacts - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: io-helidon-maven-artifacts path: ~/.m2/repository/io/helidon diff --git a/README.md b/README.md index ebc85642..a3a54264 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # Helidon Examples -Examples for Helidon 3. +Examples for Helidon 2. [Helidon 4 Examples](https://github.com/helidon-io/helidon/tree/main/examples) and [Helidon 2 Examples](https://github.com/helidon-io/helidon/tree/helidon-2.x/examples) are in the primary Helidon repository. ## How to Run -To build and run Helidon 3 examples you need: +To build and run Helidon 2 examples you need: -* Java 17 or later +* Java 11 or later * Maven 3.6.1 or later Then: @@ -17,7 +17,7 @@ Then: ``` git clone https://github.com/helidon-io/helidon-examples.git cd helidon-examples -git checkout helidon-3.x +git checkout helidon-2.x mvn clean install ``` @@ -26,22 +26,24 @@ mvn clean install | Branch | Description | | ------------- |-------------| | helidon-3.x | Examples for the current release of Helidon 3 | +| helidon-2.x | Examples for the current release of Helidon 2 | | dev-3.x | Development branch for Helidon 3 release currently under development | +| dev-2.x | Development branch for Helidon 2 release currently under development | | Tags | Description | | ------------- |-------------| | N.N.N | Examples for a specific version of Helion | -To checkout examples for the most recent release of Helidon 3: +To checkout examples for the most recent release of Helidon 2: ``` -git checkout helidon-3.x +git checkout helidon-2.x ``` To checkout examples for a specific release of Helidon: ``` -git checkout tags/3.2.5 +git checkout tags/2.X.Y ``` ## Documentation diff --git a/etc/checkstyle-suppressions.xml b/etc/checkstyle-suppressions.xml index 227144ca..e2a0d475 100644 --- a/etc/checkstyle-suppressions.xml +++ b/etc/checkstyle-suppressions.xml @@ -1,7 +1,7 @@ + + + + + + + + + diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..6720e2a3 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,38 @@ +

+ +

+ +# Helidon Examples + +Welcome to the Helidon Examples! If this is your first experience with +Helidon we recommend you start with our +[quickstart](https://helidon.io/docs/v2/#/about/03_prerequisites) +That will quickly get you going with your first Helidon application. + +After that you can come back here and dig into the examples. + +Our examples are Maven projects and can be built and run with +Java 11 or newer -- so make sure you have those: + +``` +java -version +mvn -version +``` + +# Building an Example + +Each example has a `README` that you will follow. To build most examples +just `cd` to the directory and run `mvn package`: + +``` +cd examples/microprofile/hello-world-explicit +mvn package +``` + +Usually the example will produce an application jar file that you can run: + +``` +java -jar target/example-name.jar +``` + +But always see the example's `README` for details. diff --git a/examples/config/README.md b/examples/config/README.md new file mode 100644 index 00000000..01555f33 --- /dev/null +++ b/examples/config/README.md @@ -0,0 +1,5 @@ + +# Helidon SE Config Examples + +Each subdirectory contains example code that highlights specific aspects of +Helidon configuration. \ No newline at end of file diff --git a/examples/config/basics/README.md b/examples/config/basics/README.md new file mode 100644 index 00000000..e9478efd --- /dev/null +++ b/examples/config/basics/README.md @@ -0,0 +1,16 @@ +# Helidon Config Basic Example + +This example shows the basics of using Helidon SE Config. The +[Main.java](./src/main/java/io/helidon/config/examples/basics/Main.java) class shows: + +* loading configuration from a resource +[`application.conf`](./src/main/resources/application.conf) on the classpath +containing config in HOCON (Human-Optimized Config Object Notation) format +* getting configuration values of various types + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-config-basics.jar +``` diff --git a/examples/config/basics/pom.xml b/examples/config/basics/pom.xml new file mode 100644 index 00000000..b1c0a168 --- /dev/null +++ b/examples/config/basics/pom.xml @@ -0,0 +1,66 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-basics + 1.0.0-SNAPSHOT + Helidon Config Examples Basics + + + The simplest example shows how to use Configuration API. + + + + io.helidon.config.examples.basics.Main + + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-hocon + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/basics/src/main/java/io/helidon/config/examples/basics/Main.java b/examples/config/basics/src/main/java/io/helidon/config/examples/basics/Main.java new file mode 100644 index 00000000..cdd3a179 --- /dev/null +++ b/examples/config/basics/src/main/java/io/helidon/config/examples/basics/Main.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2017, 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.config.examples.basics; + +import java.nio.file.Path; +import java.util.List; + +import io.helidon.config.Config; + +import static io.helidon.config.ConfigSources.classpath; + +/** + * Basics example. + */ +public class Main { + + private Main() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String... args) { + Config config = Config.create(classpath("application.conf")); + + int pageSize = config.get("app.page-size").asInt().get(); + + boolean storageEnabled = config.get("app.storageEnabled").asBoolean().orElse(false); + + List basicRange = config.get("app.basic-range").asList(Integer.class).get(); + + Path loggingOutputPath = config.get("logging.outputs.file.name").as(Path.class).get(); + + System.out.println(pageSize); + System.out.println(storageEnabled); + System.out.println(basicRange); + System.out.println(loggingOutputPath); + } + +} diff --git a/examples/config/basics/src/main/java/io/helidon/config/examples/basics/package-info.java b/examples/config/basics/src/main/java/io/helidon/config/examples/basics/package-info.java new file mode 100644 index 00000000..e0abe866 --- /dev/null +++ b/examples/config/basics/src/main/java/io/helidon/config/examples/basics/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * The simplest example shows how to use Configuration API. + */ +package io.helidon.config.examples.basics; diff --git a/examples/config/basics/src/main/resources/application.conf b/examples/config/basics/src/main/resources/application.conf new file mode 100644 index 00000000..8f283613 --- /dev/null +++ b/examples/config/basics/src/main/resources/application.conf @@ -0,0 +1,69 @@ +# +# Copyright (c) 2017, 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. +# + +app { + greeting = "Hello" + name = "Demo" + page-size = 20 + basic-range = [ -20, 20 ] + storagePassphrase = "${AES=thisIsEncriptedPassphrase}" +} + +logging { + outputs { + console { + pattern = simple.colored + level = INFO + } + file { + pattern = verbose.colored + level = DEBUG + name = target/root.log + } + } + level = INFO + app.level = DEBUG + com.oracle.prime.level = WARN +} + +# (this is snippet of complex configuration of security component) +security { + providers: [ # First provider in the list is the default one + { + name = "BMCS" + class = "com.oracle.prime.security.bmcs.BmcsProvider" + BmcsProvider { + # Configuration of OPC (Bare metal) security provider + # (configuration cleaned to be short ...) + + # targets for outbound configuration + targets: [ + { + name = "s2s" + transports = ["http"] + hosts = ["127.0.0.1"] + s2sType = "S2S" + } + #, other targets ... + ] + } + }, + { + name = "ForEndUsers" + class = "com.oracle.prime.examples.security.primeruntime.bmcs.ExampleSecurityProvider" + } + ] +} diff --git a/examples/config/basics/src/main/resources/logging.properties b/examples/config/basics/src/main/resources/logging.properties new file mode 100644 index 00000000..721cc5fc --- /dev/null +++ b/examples/config/basics/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +handlers = java.util.logging.ConsoleHandler + +java.util.logging.ConsoleHandler.level = FINEST +java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter +java.util.logging.SimpleFormatter.format = [%1$tc] %4$s: %2$s - %5$s %6$s%n + +.level = INFO +io.helidon.config.level = WARNING +io.helidon.config.examples.level = FINEST diff --git a/examples/config/changes/README.md b/examples/config/changes/README.md new file mode 100644 index 00000000..0b955c80 --- /dev/null +++ b/examples/config/changes/README.md @@ -0,0 +1,29 @@ +# Helidon Config Changes Example + +This example shows how an application can deal with changes to +configuration. + +## Change notification + +[`OnChangeExample.java`](./src/main/java/io/helidon/config/examples/changes/OnChangeExample.java): +uses `Config.onChange`, passing either a method reference (a lambda expression +would also work) which the config system invokes when the config source changes +) + +## Latest-value supplier + +Recall that once your application obtains a `Config` instance, its config values +do not change. The +[`AsSupplierExample.java`](./src/main/java/io/helidon/config/examples/changes/AsSupplierExample.java) +example shows how your application can get a config _supplier_ that always reports +the latest config value for a key, including any changes made after your +application obtained the `Config` object. Although this approach does not notify +your application _when_ changes occur, it _does_ permit your code to always use +the most up-to-date value. Sometimes that is all you need. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-config-changes.jar +``` diff --git a/examples/config/changes/conf/config.yaml b/examples/config/changes/conf/config.yaml new file mode 100644 index 00000000..69d8030e --- /dev/null +++ b/examples/config/changes/conf/config.yaml @@ -0,0 +1,21 @@ +# +# Copyright (c) 2017, 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. +# + +# In config.yaml we are going to override default configuration. +# It is supposed to be deployment dependent configuration. + +app: + greeting: Hello diff --git a/examples/config/changes/conf/dev.yaml b/examples/config/changes/conf/dev.yaml new file mode 100644 index 00000000..f2166b73 --- /dev/null +++ b/examples/config/changes/conf/dev.yaml @@ -0,0 +1,25 @@ +# +# Copyright (c) 2017, 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. +# + +# In dev.yaml we are going to override all lower layer configuration files. +# It is supposed to be development specific configuration. + +# IT SHOULD NOT BE PLACED IN VCS. EACH DEVELOPER CAN CUSTOMIZE THE FILE AS NEEDED. +# I.e. for example with GIT place following line into .gitignore file: +#*/conf/dev.yaml + +app: + name: Developer diff --git a/examples/config/changes/conf/secrets/password b/examples/config/changes/conf/secrets/password new file mode 100644 index 00000000..5bbaf875 --- /dev/null +++ b/examples/config/changes/conf/secrets/password @@ -0,0 +1 @@ +changeit \ No newline at end of file diff --git a/examples/config/changes/conf/secrets/username b/examples/config/changes/conf/secrets/username new file mode 100644 index 00000000..1ce97e36 --- /dev/null +++ b/examples/config/changes/conf/secrets/username @@ -0,0 +1 @@ +libor \ No newline at end of file diff --git a/examples/config/changes/pom.xml b/examples/config/changes/pom.xml new file mode 100644 index 00000000..5dddeced --- /dev/null +++ b/examples/config/changes/pom.xml @@ -0,0 +1,70 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-changes + 1.0.0-SNAPSHOT + Helidon Config Examples Changes + + + The example shows how to use Configuration Changes API. + + + + io.helidon.config.examples.changes.Main + + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + io.helidon.common + helidon-common-reactive + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/changes/src/main/java/io/helidon/config/examples/changes/AsSupplierExample.java b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/AsSupplierExample.java new file mode 100644 index 00000000..4b980863 --- /dev/null +++ b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/AsSupplierExample.java @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2017, 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.config.examples.changes; + +import java.time.Duration; +import java.util.Objects; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.Supplier; +import java.util.logging.Logger; + +import io.helidon.config.Config; +import io.helidon.config.FileSystemWatcher; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; +import static io.helidon.config.PollingStrategies.regular; + +/** + * Example shows how to use Config accessor methods that return {@link Supplier}. + * {@link Supplier} returns always the last loaded config value. + *

+ * The feature is based on using {@link io.helidon.config.spi.PollingStrategy} with + * selected config source(s) to check for changes. + */ +public class AsSupplierExample { + + private static final Logger LOGGER = Logger.getLogger(AsSupplierExample.class.getName()); + + private final AtomicReference lastPrinted = new AtomicReference<>(); + private final ScheduledExecutorService executor = initExecutor(); + + /** + * Executes the example. + */ + public void run() { + Config config = Config + .create(file("conf/dev.yaml") + .optional() + // change watcher is a standalone component that watches for + // changes and notifies the config system when a change occurs + .changeWatcher(FileSystemWatcher.create()), + file("conf/config.yaml") + .optional() + // polling strategy triggers regular checks on the source to check + // for changes, utilizing a concept of "stamp" of the data that is provided + // and validated by the source + .pollingStrategy(regular(Duration.ofSeconds(2))), + classpath("default.yaml")); + + // greeting.get() always return up-to-date value + final Supplier greeting = config.get("app.greeting").asString().supplier(); + // name.get() always return up-to-date value + final Supplier name = config.get("app.name").asString().supplier(); + + // first greeting + printIfChanged(greeting.get() + " " + name.get() + "."); + + // use same Supplier instances to get up-to-date value + executor.scheduleWithFixedDelay( + () -> printIfChanged(greeting.get() + " " + name.get() + "."), + // check every 1 second for changes + 0, 1, TimeUnit.SECONDS); + } + + /** + * Utility to print same message just once. + */ + private void printIfChanged(String message) { + lastPrinted.accumulateAndGet(message, (origValue, newValue) -> { + //print MESSAGE only if changed since the last print + if (!Objects.equals(origValue, newValue)) { + LOGGER.info("[AsSupplier] " + newValue); + } + return newValue; + }); + } + + private static ScheduledExecutorService initExecutor() { + ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor(); + Runtime.getRuntime().addShutdownHook(new Thread(executor::shutdown)); + return executor; + } + + /** + * Shutdowns executor. + */ + public void shutdown() { + executor.shutdown(); + } + +} diff --git a/examples/config/changes/src/main/java/io/helidon/config/examples/changes/Main.java b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/Main.java new file mode 100644 index 00000000..1a0fd510 --- /dev/null +++ b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/Main.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2017, 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.config.examples.changes; + +import java.io.IOException; +import java.util.concurrent.TimeUnit; +import java.util.logging.Logger; + +/** + * Config changes examples. + */ +public class Main { + + private static final Logger LOGGER = Logger.getLogger(Main.class.getName()); + + private Main() { + } + + /** + * Executes the example. + * + * @param args arguments + * @throws InterruptedException in case you cannot sleep + * @throws IOException in case of IO error + */ + public static void main(String... args) throws IOException, InterruptedException { + // subscribe using simple onChange function + new OnChangeExample().run(); + // use same Supplier instances to get up-to-date value + AsSupplierExample asSupplier = new AsSupplierExample(); + asSupplier.run(); + + // waiting for user made changes in config files + long sleep = 60; + LOGGER.info("Application is waiting " + sleep + " seconds for change..."); + TimeUnit.SECONDS.sleep(sleep); + + asSupplier.shutdown(); + LOGGER.info("Goodbye."); + } + +} diff --git a/examples/config/changes/src/main/java/io/helidon/config/examples/changes/OnChangeExample.java b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/OnChangeExample.java new file mode 100644 index 00000000..fd024a63 --- /dev/null +++ b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/OnChangeExample.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2017, 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.config.examples.changes; + +import java.util.logging.Logger; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.config.PollingStrategies; + +import static java.time.Duration.ofSeconds; + +/** + * Example shows how to listen on Config node changes using simplified API, {@link Config#onChange(java.util.function.Consumer)}. + * The Function is invoked with new instance of Config. + *

+ * The feature is based on using {@link io.helidon.config.spi.PollingStrategy} with + * selected config source(s) to check for changes. + */ +public class OnChangeExample { + + private static final Logger LOGGER = Logger.getLogger(OnChangeExample.class.getName()); + + /** + * Executes the example. + */ + public void run() { + Config secrets = Config + .builder(ConfigSources.directory("conf/secrets") + .pollingStrategy(PollingStrategies.regular(ofSeconds(5)))) + .disableEnvironmentVariablesSource() + .disableSystemPropertiesSource() + .build(); + + logSecrets(secrets); + + // subscribe using simple onChange consumer -- could be a lambda as well + secrets.onChange(OnChangeExample::logSecrets); + } + + private static void logSecrets(Config secrets) { + LOGGER.info("Loaded secrets are u: " + secrets.get("username").asString().get() + + ", p: " + secrets.get("changeit").asString().get()); + } + +} diff --git a/examples/config/changes/src/main/java/io/helidon/config/examples/changes/package-info.java b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/package-info.java new file mode 100644 index 00000000..af0290d4 --- /dev/null +++ b/examples/config/changes/src/main/java/io/helidon/config/examples/changes/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * The example shows how to use Configuration Changes API. + */ +package io.helidon.config.examples.changes; diff --git a/examples/config/changes/src/main/resources/default.yaml b/examples/config/changes/src/main/resources/default.yaml new file mode 100644 index 00000000..32f1207f --- /dev/null +++ b/examples/config/changes/src/main/resources/default.yaml @@ -0,0 +1,24 @@ +# +# Copyright (c) 2017, 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. +# + +# In default.yaml we are going to configure application default values. +# It is expected it is overridden in: +# - conf/config.yaml in production environment +# - conf/dev.yaml by developer on local machine + +app: + greeting: Hi + name: Example diff --git a/examples/config/changes/src/main/resources/logging.properties b/examples/config/changes/src/main/resources/logging.properties new file mode 100644 index 00000000..1e6cab22 --- /dev/null +++ b/examples/config/changes/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +handlers = java.util.logging.ConsoleHandler + +java.util.logging.ConsoleHandler.level = FINEST +java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter +java.util.logging.SimpleFormatter.format = [%1$tc] %5$s %6$s%n + +.level = INFO +io.helidon.config.level = WARNING +io.helidon.config.examples.level = FINEST diff --git a/examples/config/git/README.md b/examples/config/git/README.md new file mode 100644 index 00000000..b808ffd7 --- /dev/null +++ b/examples/config/git/README.md @@ -0,0 +1,28 @@ +# Helidon Config Git Example + +This example shows how to load configuration from a Git repository +and switch which branch to load from at runtime. + +## Prerequisites + +The example assumes that the GitHub repository +has a branch named `test` that contains `application.conf` which sets the key +`greeting` to value `hello`. (The Helidon team has created and populated this +repository.) + +The code in [`Main.java`](./src/main/java/io/helidon/config/examples/git/Main.java) +uses the environment variable `ENVIRONMENT_NAME` to fetch the branch name +in the GitHub repository to use; it uses `master` by default (which does _not_ +contain the expected value). + +The example application constructs a `Config` instance from that file in the +GitHub repository and branch, prints out the value for key `greeting`, and +checks to make sure the value is the expected `hello`. + +## Build and run + +```shell +mvn package +export ENVIRONMENT_NAME=test +java -jar target/helidon-examples-config-git.jar +``` diff --git a/examples/config/git/pom.xml b/examples/config/git/pom.xml new file mode 100644 index 00000000..c1885143 --- /dev/null +++ b/examples/config/git/pom.xml @@ -0,0 +1,83 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-git + 1.0.0-SNAPSHOT + Helidon Config Examples Git + + + The example shows how to use GitConfigSource. + + + + io.helidon.config.examples.git.Main + + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-hocon + + + io.helidon.config + helidon-config-git + + + org.slf4j + slf4j-jdk14 + + + + + + + org.codehaus.mojo + exec-maven-plugin + + + test + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/git/src/main/java/io/helidon/config/examples/git/Main.java b/examples/config/git/src/main/java/io/helidon/config/examples/git/Main.java new file mode 100644 index 00000000..34298d59 --- /dev/null +++ b/examples/config/git/src/main/java/io/helidon/config/examples/git/Main.java @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2017, 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.config.examples.git; + +import java.io.IOException; +import java.net.URI; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.config.git.GitConfigSource; + +/** + * Git source example. + *

+ * This example expects: + *

    + *
  1. a Git repository {@code helidonrobot/test-config} which contains: + *
      + *
    1. the branch {@code test} containing {@code application.conf} which sets + * {@code greeting} to {@code hello}, + *
    2. the branch {@code main} containing the file {@code application.conf} + * which sets the property {@code greeting} to any value other than + * {@code hello}, + *
    3. optionally, any other branch in which {@code application.conf} sets + * {@code greeting} to {@code hello}. + *
    + *
  2. the environment variable {@code ENVIRONMENT_NAME} set to: + *
      + *
    1. {@code test}, or + *
    2. the name of the optional additional branch described above. + *
    + *
+ */ +public class Main { + + private static final String ENVIRONMENT_NAME_PROPERTY = "ENVIRONMENT_NAME"; + + private Main() { + } + + /** + * Executes the example. + * + * @param args arguments + * @throws IOException when some git repo operation failed + */ + public static void main(String... args) throws IOException { + + // we expect a name of the current environment in envvar ENVIRONMENT_NAME + // in this example we just set envvar in maven plugin 'exec', but can be set in k8s pod via ConfigMap + Config env = Config.create(ConfigSources.environmentVariables()); + + String branch = env.get(ENVIRONMENT_NAME_PROPERTY).asString().orElse("master"); + + System.out.println("Loading from branch " + branch); + + Config config = Config.create( + GitConfigSource.builder() + .path("application.conf") + .uri(URI.create("https://github.com/helidonrobot/test-config.git")) + .branch(branch) + .build()); + + System.out.println("Greeting is " + config.get("greeting").asString().get()); + assert config.get("greeting").asString().get().equals("hello"); + } + +} diff --git a/examples/config/git/src/main/java/io/helidon/config/examples/git/package-info.java b/examples/config/git/src/main/java/io/helidon/config/examples/git/package-info.java new file mode 100644 index 00000000..04d3cd41 --- /dev/null +++ b/examples/config/git/src/main/java/io/helidon/config/examples/git/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * The example shows how to use GitConfigSource. + */ +package io.helidon.config.examples.git; diff --git a/examples/config/git/src/main/resources/logging.properties b/examples/config/git/src/main/resources/logging.properties new file mode 100644 index 00000000..721cc5fc --- /dev/null +++ b/examples/config/git/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +handlers = java.util.logging.ConsoleHandler + +java.util.logging.ConsoleHandler.level = FINEST +java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter +java.util.logging.SimpleFormatter.format = [%1$tc] %4$s: %2$s - %5$s %6$s%n + +.level = INFO +io.helidon.config.level = WARNING +io.helidon.config.examples.level = FINEST diff --git a/examples/config/mapping/README.md b/examples/config/mapping/README.md new file mode 100644 index 00000000..8acf17ad --- /dev/null +++ b/examples/config/mapping/README.md @@ -0,0 +1,23 @@ +# Helidon Config Mapping Example + +This example shows how to implement mappers that convert configuration +to POJOs. + +1. [`BuilderExample.java`](./src/main/java/io/helidon/config/examples/mapping/BuilderExample.java) +shows how you can add a `builder()` method to a POJO. That method returns a `Builder` +object which the config system uses to update with various key settings and then, +finally, invoke `build()` so the builder can instantiate the POJO with the +assigned values. +2. [`DeserializationExample.java`](./src/main/java/io/helidon/config/examples/mapping/DeserializationExample.java) +uses the config system's support for automatic mapping to POJOs that have bean-style +setter methods. +3. [`FactoryMethodExample.java`](./src/main/java/io/helidon/config/examples/mapping/FactoryMethodExample.java) +illustrates how you can add a static factory method `create` to a POJO to tell the config +system how to construct a POJO instance. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-config-mapping.jar +``` diff --git a/examples/config/mapping/pom.xml b/examples/config/mapping/pom.xml new file mode 100644 index 00000000..be11a743 --- /dev/null +++ b/examples/config/mapping/pom.xml @@ -0,0 +1,70 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-mapping + 1.0.0-SNAPSHOT + Helidon Config Examples Mapping + + + The example shows how to use Config Mapping functionality. + + + + io.helidon.config.examples.mapping.Main + + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-hocon + + + io.helidon.config + helidon-config-object-mapping + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/BuilderExample.java b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/BuilderExample.java new file mode 100644 index 00000000..1d281668 --- /dev/null +++ b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/BuilderExample.java @@ -0,0 +1,184 @@ +/* + * Copyright (c) 2017, 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.config.examples.mapping; + +import java.util.List; +import java.util.function.Supplier; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.config.objectmapping.Value; + +/** + * This example shows how to automatically deserialize configuration instance into POJO beans + * using Builder pattern. + */ +public class BuilderExample { + + private BuilderExample() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String... args) { + Config config = Config.create(ConfigSources.classpath("application.conf")); + + AppConfig appConfig = config + // get "app" sub-node + .get("app") + // let config automatically deserialize the node to new AppConfig instance + // note that this requires additional dependency - config-beans + .as(AppConfig.class) + .get(); + + System.out.println(appConfig); + + // assert values loaded from application.conf + + assert appConfig.getGreeting().equals("Hello"); + + assert appConfig.getPageSize() == 20; + + assert appConfig.getBasicRange().size() == 2; + assert appConfig.getBasicRange().get(0) == -20; + assert appConfig.getBasicRange().get(1) == 20; + } + + /** + * POJO representing an application configuration. + * Class is initialized from {@link Config} instance. + * During deserialization {@link #builder()} builder method} is invoked + * and {@link Builder} is used to initialize properties from configuration. + */ +public static class AppConfig { + private final String greeting; + private final int pageSize; + private final List basicRange; + + private AppConfig(String greeting, int pageSize, List basicRange) { + this.greeting = greeting; + this.pageSize = pageSize; + this.basicRange = basicRange; + } + + public String getGreeting() { + return greeting; + } + + public int getPageSize() { + return pageSize; + } + + public List getBasicRange() { + return basicRange; + } + + @Override + public String toString() { + return "AppConfig:\n" + + " greeting = " + greeting + "\n" + + " pageSize = " + pageSize + "\n" + + " basicRange= " + basicRange; + } + + /** + * Creates new Builder instance used to be initialized from configuration. + * + * @return new Builder instance + */ + public static Builder builder() { + return new Builder(); + } + + /** + * {@link AppConfig} Builder used to be initialized from configuration. + */ + public static class Builder { + private String greeting; + private int pageSize; + private List basicRange; + + private Builder() { + } + + /** + * Set greeting property. + *

+ * POJO property and config key are same, no need to customize it. + * {@link Value} is used just to specify default value + * in case configuration does not contain appropriate value. + * + * @param greeting greeting value + */ + @Value(withDefault = "Hi") + public void setGreeting(String greeting) { + this.greeting = greeting; + } + + /** + * Set a page size. + *

+ * {@link Value} is used to specify correct config key and default value + * in case configuration does not contain appropriate value. + * Original string value is mapped to target int using appropriate + * {@link io.helidon.config.ConfigMappers ConfigMapper}. + * + * @param pageSize page size + */ + @Value(key = "page-size", withDefault = "10") + public void setPageSize(int pageSize) { + this.pageSize = pageSize; + } + + /** + * Set a basic range. + *

+ * {@link Value} is used to specify correct config key and default value supplier + * in case configuration does not contain appropriate value. + * Supplier already returns default value in target type of a property. + * + * @param basicRange basic range + */ + @Value(key = "basic-range", withDefaultSupplier = DefaultBasicRangeSupplier.class) + public void setBasicRange(List basicRange) { + this.basicRange = basicRange; + } + + /** + * Creates new instance of {@link AppConfig} using values provided by configuration. + * + * @return new instance of {@link AppConfig}. + */ + public AppConfig build() { + return new AppConfig(greeting, pageSize, basicRange); + } + } + + /** + * Supplier of default value for {@link Builder#setBasicRange(List) basic-range} property. + */ + public static class DefaultBasicRangeSupplier implements Supplier> { + @Override + public List get() { + return List.of(-10, 10); + } + } + } +} diff --git a/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/DeserializationExample.java b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/DeserializationExample.java new file mode 100644 index 00000000..d17de4e0 --- /dev/null +++ b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/DeserializationExample.java @@ -0,0 +1,146 @@ +/* + * Copyright (c) 2017, 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.config.examples.mapping; + +import java.util.List; +import java.util.function.Supplier; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.config.objectmapping.Value; + +/** + * This example shows how to automatically deserialize configuration instance into POJO beans + * using setters. + */ +public class DeserializationExample { + + private DeserializationExample() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String... args) { + Config config = Config.create(ConfigSources.classpath("application.conf")); + + AppConfig appConfig = config + // get "app" sub-node + .get("app") + // let config automatically deserialize the node to new AppConfig instance + .as(AppConfig.class) + .get(); + + System.out.println(appConfig); + + // assert values loaded from application.conf + + assert appConfig.getGreeting().equals("Hello"); + + assert appConfig.getPageSize() == 20; + + assert appConfig.getBasicRange().size() == 2; + assert appConfig.getBasicRange().get(0) == -20; + assert appConfig.getBasicRange().get(1) == 20; + } + + /** + * POJO representing an application configuration. + * Class is initialized from {@link Config} instance. + * During deserialization setter methods are invoked. + */ + public static class AppConfig { + private String greeting; + private int pageSize; + private List basicRange; + + public String getGreeting() { + return greeting; + } + + /** + * Set greeting property. + *

+ * POJO property and config key are same, no need to customize it. + * {@link Value} is used just to specify default value + * in case configuration does not contain appropriate value. + * + * @param greeting greeting value + */ + @Value(withDefault = "Hi") + public void setGreeting(String greeting) { + this.greeting = greeting; + } + + public int getPageSize() { + return pageSize; + } + + /** + * Set a page size. + *

+ * {@link Value} is used to specify correct config key and default value + * in case configuration does not contain appropriate value. + * Original string value is mapped to target int using appropriate + * {@link io.helidon.config.ConfigMappers ConfigMapper}. + * + * @param pageSize page size + */ + @Value(key = "page-size", withDefault = "10") + public void setPageSize(int pageSize) { + this.pageSize = pageSize; + } + + public List getBasicRange() { + return basicRange; + } + + /** + * Set a basic range. + *

+ * {@link Value} is used to specify correct config key and default value supplier + * in case configuration does not contain appropriate value. + * Supplier already returns default value in target type of a property. + * + * @param basicRange basic range + */ + @Value(key = "basic-range", withDefaultSupplier = DefaultBasicRangeSupplier.class) + public void setBasicRange(List basicRange) { + this.basicRange = basicRange; + } + + @Override + public String toString() { + return "AppConfig:\n" + + " greeting = " + greeting + "\n" + + " pageSize = " + pageSize + "\n" + + " basicRange= " + basicRange; + } + + /** + * Supplier of default value for {@link #setBasicRange(List) basic-range} property. + */ + public static class DefaultBasicRangeSupplier implements Supplier> { + @Override + public List get() { + return List.of(-10, 10); + } + } + } +} diff --git a/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/FactoryMethodExample.java b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/FactoryMethodExample.java new file mode 100644 index 00000000..64ef361a --- /dev/null +++ b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/FactoryMethodExample.java @@ -0,0 +1,129 @@ +/* + * Copyright (c) 2017, 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.config.examples.mapping; + +import java.util.List; +import java.util.function.Supplier; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.config.objectmapping.Value; + +/** + * This example shows how to automatically deserialize configuration instance into POJO beans + * using factory method. + */ +public class FactoryMethodExample { + + private FactoryMethodExample() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String... args) { + Config config = Config.create(ConfigSources.classpath("application.conf")); + + AppConfig appConfig = config + // get "app" sub-node + .get("app") + // let config automatically deserialize the node to new AppConfig instance + .as(AppConfig.class) + .get(); + + System.out.println(appConfig); + + // assert values loaded from application.conf + + assert appConfig.getGreeting().equals("Hello"); + + assert appConfig.getPageSize() == 20; + + assert appConfig.getBasicRange().size() == 2; + assert appConfig.getBasicRange().get(0) == -20; + assert appConfig.getBasicRange().get(1) == 20; + } + + /** + * POJO representing an application configuration. + * Class is initialized from {@link Config} instance. + * During deserialization {@link #create(String, int, List) factory method} is invoked. + */ + public static class AppConfig { + private final String greeting; + private final int pageSize; + private final List basicRange; + + private AppConfig(String greeting, int pageSize, List basicRange) { + this.greeting = greeting; + this.pageSize = pageSize; + this.basicRange = basicRange; + } + + public String getGreeting() { + return greeting; + } + + public int getPageSize() { + return pageSize; + } + + public List getBasicRange() { + return basicRange; + } + + @Override + public String toString() { + return "AppConfig:\n" + + " greeting = " + greeting + "\n" + + " pageSize = " + pageSize + "\n" + + " basicRange= " + basicRange; + } + + /** + * Creates new {@link AppConfig} instances. + *

+ * {@link Value} is used to specify config keys + * and default values in case configuration does not contain appropriate value. + * + * @param greeting greeting + * @param pageSize page size + * @param basicRange basic range + * @return new instance of {@link AppConfig}. + */ + public static AppConfig create(@Value(key = "greeting", withDefault = "Hi") + String greeting, + @Value(key = "page-size", withDefault = "10") + int pageSize, + @Value(key = "basic-range", withDefaultSupplier = DefaultBasicRangeSupplier.class) + List basicRange) { + return new AppConfig(greeting, pageSize, basicRange); + } + + /** + * Supplier of default value for {@code basic-range} property, see {@link #create(String, int, List)}. + */ + public static class DefaultBasicRangeSupplier implements Supplier> { + @Override + public List get() { + return List.of(-10, 10); + } + } + } +} diff --git a/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/Main.java b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/Main.java new file mode 100644 index 00000000..7e704669 --- /dev/null +++ b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/Main.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2017, 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.config.examples.mapping; + +/** + * Runs every example main class in this module/package. + */ +public class Main { + + private Main() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String[] args) { + DeserializationExample.main(args); + FactoryMethodExample.main(args); + BuilderExample.main(args); + } + +} diff --git a/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/package-info.java b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/package-info.java new file mode 100644 index 00000000..ab515f0b --- /dev/null +++ b/examples/config/mapping/src/main/java/io/helidon/config/examples/mapping/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * The example shows how to use Config Mapping functionality. + */ +package io.helidon.config.examples.mapping; diff --git a/examples/config/mapping/src/main/resources/application.conf b/examples/config/mapping/src/main/resources/application.conf new file mode 100644 index 00000000..3699dcd8 --- /dev/null +++ b/examples/config/mapping/src/main/resources/application.conf @@ -0,0 +1,21 @@ +# +# Copyright (c) 2017, 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. +# + +app { + greeting = "Hello" + page-size = 20 + basic-range = [ -20, 20 ] +} diff --git a/examples/config/mapping/src/main/resources/logging.properties b/examples/config/mapping/src/main/resources/logging.properties new file mode 100644 index 00000000..721cc5fc --- /dev/null +++ b/examples/config/mapping/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +handlers = java.util.logging.ConsoleHandler + +java.util.logging.ConsoleHandler.level = FINEST +java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter +java.util.logging.SimpleFormatter.format = [%1$tc] %4$s: %2$s - %5$s %6$s%n + +.level = INFO +io.helidon.config.level = WARNING +io.helidon.config.examples.level = FINEST diff --git a/examples/config/metadata/README.md b/examples/config/metadata/README.md new file mode 100644 index 00000000..7057c721 --- /dev/null +++ b/examples/config/metadata/README.md @@ -0,0 +1,24 @@ +# Configuration metadata usage example + +This example reads configuration metadata from the classpath and creates a full +`application.yaml` content with all possible configuration. + +## Setup + +This application does not have any root configuration on classpath, so it would generate an empty file. +Add at least one module to `pom.xml` that can be configured to see the output. + +Example: +```xml + + io.helidon.security.providers + helidon-security-providers-oidc + +``` + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-config-metadata.jar > application.yaml +``` diff --git a/examples/config/metadata/pom.xml b/examples/config/metadata/pom.xml new file mode 100644 index 00000000..2f30e19c --- /dev/null +++ b/examples/config/metadata/pom.xml @@ -0,0 +1,67 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-metadata + 1.0.0-SNAPSHOT + Helidon Config Examples Metadata + + + This example shows possibilities with configuration metadata. To test this, add a configurable library on the classpath + and run the example. + + + + io.helidon.config.examples.metadata.ConfigMetadataMain + + + + + org.glassfish + jakarta.json + + + io.helidon.config + helidon-config-metadata + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/ConfigMetadataMain.java b/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/ConfigMetadataMain.java new file mode 100644 index 00000000..a7b244d9 --- /dev/null +++ b/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/ConfigMetadataMain.java @@ -0,0 +1,462 @@ +/* + * 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. + */ + +package io.helidon.config.examples.metadata; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.nio.charset.StandardCharsets; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; + +import javax.json.Json; +import javax.json.JsonArray; +import javax.json.JsonObject; +import javax.json.JsonReader; +import javax.json.JsonReaderFactory; +import javax.json.JsonValue; + +import io.helidon.config.examples.metadata.ConfiguredType.ConfiguredProperty; +import io.helidon.config.metadata.ConfiguredOption; + +/** + * Reads configuration metadata and prints a full configuration example. + */ +public final class ConfigMetadataMain { + private static final Map TYPED_VALUES = Map.of("java.lang.Integer", + new TypedValue("1"), + "java.lang.Boolean", + new TypedValue("true"), + "java.lang.Long", + new TypedValue("1000"), + "java.lang.Short", + new TypedValue("0"), + "java.lang.String", + new TypedValue("value", true), + "java.net.URI", + new TypedValue("https://www.example.net", true), + "java.lang.Class", + new TypedValue("net.example.SomeClass", true), + "java.time.ZoneId", + new TypedValue("UTC", true)); + + private ConfigMetadataMain() { + } + + /** + * Start the example. + * @param args ignored + */ + public static void main(String[] args) throws IOException { + JsonReaderFactory readerFactory = Json.createReaderFactory(Map.of()); + + Enumeration files = ConfigMetadataMain.class.getClassLoader().getResources("META-INF/helidon/config-metadata.json"); + List configuredTypes = new LinkedList<>(); + Map typesMap = new HashMap<>(); + + while (files.hasMoreElements()) { + URL url = files.nextElement(); + try (InputStream is = url.openStream()) { + JsonReader reader = readerFactory.createReader(is, StandardCharsets.UTF_8); + processMetadataJson(configuredTypes, typesMap, reader.readArray()); + } + } + for (ConfiguredType configuredType : configuredTypes) { + if (configuredType.standalone()) { + printType(configuredType, typesMap); + } + } + } + + private static void printType(ConfiguredType configuredType, Map typesMap) { + String prefix = configuredType.prefix(); + System.out.println("# " + configuredType.description()); + System.out.println("# " + configuredType.targetClass()); + System.out.println(prefix + ":"); + printType(configuredType, typesMap, 1, false); + } + + private static void printType(ConfiguredType configuredType, + Map typesMap, + int nesting, + boolean listStart) { + String spaces = " ".repeat(nesting * 2); + Set properties = configuredType.properties(); + boolean isListStart = listStart; + + for (ConfiguredProperty property : properties) { + if (property.key() != null && property.key().contains(".*.")) { + // this is a nested key, must be resolved by the parent list node + continue; + } + + printProperty(property, properties, typesMap, nesting, isListStart); + isListStart = false; + } + + List inherited = configuredType.inherited(); + for (String inheritedTypeName : inherited) { + ConfiguredType inheritedType = typesMap.get(inheritedTypeName); + if (inheritedType == null) { + System.out.println(spaces + "# Missing inherited type: " + inheritedTypeName); + } else { + printType(inheritedType, typesMap, nesting, false); + } + } + } + + private static void printProperty(ConfiguredProperty property, + Set properties, + Map typesMap, + int nesting, + boolean listStart) { + String spaces = " ".repeat(nesting * 2); + + printDocs(property, spaces, listStart); + + if (property.kind() == ConfiguredOption.Kind.LIST) { + printListProperty(property, properties, typesMap, nesting, spaces); + return; + } + + if (property.kind() == ConfiguredOption.Kind.MAP) { + printMapProperty(property, typesMap, nesting, spaces); + return; + } + + TypedValue typed = TYPED_VALUES.get(property.type()); + if (typed == null) { + // this is a nested type, or a missing type + ConfiguredType nestedType = typesMap.get(property.type()); + if (nestedType == null) { + // either we have a list of allowed values, default value, or this is really a missing type + printAllowedValuesOrMissing(property, typesMap, nesting, spaces); + } else { + // proper nested type + if (property.merge()) { + printType(nestedType, typesMap, nesting, false); + } else { + System.out.println(spaces + property.outputKey() + ":"); + printType(nestedType, typesMap, nesting + 1, false); + } + } + } else { + // this is a "leaf" node + if (property.defaultValue() == null) { + System.out.println(spaces + "# Generated value (property does not have a configured default)"); + } + System.out.println(spaces + property.outputKey() + ": " + toTypedValue(property, typed)); + } + } + + private static void printMapProperty(ConfiguredProperty property, + Map typesMap, + int nesting, + String spaces) { + System.out.print(spaces); + System.out.println(property.outputKey() + ":"); + TypedValue typedValue = TYPED_VALUES.get(property.type()); + + String mySpaces = " ".repeat((nesting + 1) * 2); + if (typedValue == null) { + System.out.println(mySpaces + "key: \"Unsupported map value type: " + property.type() + "\""); + } else { + System.out.println(mySpaces + "key-1: " + output(typedValue, typedValue.defaultsDefault())); + System.out.println(mySpaces + "key-2: " + output(typedValue, typedValue.defaultsDefault())); + } + } + + private static void printListProperty(ConfiguredProperty property, + Set properties, + Map typesMap, + int nesting, + String spaces) { + System.out.print(spaces); + System.out.print(property.outputKey() + ":"); + ConfiguredType listType = typesMap.get(property.type()); + + if (listType == null) { + if (property.provider()) { + listFromProvider(property, typesMap, nesting, spaces); + } else { + listFromTypes(property, properties, typesMap, nesting, spaces); + } + } else { + System.out.println(); + System.out.print(spaces + "- "); + printType(listType, typesMap, nesting + 1, true); + } + } + + private static void listFromProvider(ConfiguredProperty property, + Map typesMap, + int nesting, + String spaces) { + // let's find all supported providers + List providers = new LinkedList<>(); + for (ConfiguredType value : typesMap.values()) { + if (value.provides().contains(property.type())) { + providers.add(value); + } + } + + System.out.println(); + if (providers.isEmpty()) { + System.out.print(spaces + "- # There are no modules on classpath providing " + property.type()); + return; + } + for (ConfiguredType provider : providers) { + System.out.print(spaces + "- "); + if (provider.prefix() != null) { + System.out.println("# " + provider.description()); + System.out.println(spaces + " " + provider.prefix() + ":"); + printType(provider, typesMap, nesting + 2, false); + } else { + printType(provider, typesMap, nesting + 1, true); + } + } + } + + private static void fromProvider(ConfiguredProperty property, + Map typesMap, + int nesting) { + String spaces = " ".repeat(nesting + 1); + // let's find all supported providers + List providers = new LinkedList<>(); + for (ConfiguredType value : typesMap.values()) { + if (value.provides().contains(property.type())) { + providers.add(value); + } + } + + if (providers.isEmpty()) { + System.out.println(spaces + " # There are no modules on classpath providing " + property.type()); + return; + } + + for (ConfiguredType provider : providers) { + System.out.println(spaces + " # ****** Provider Configuration ******"); + System.out.println(spaces + " # " + provider.description()); + System.out.println(spaces + " # " + provider.targetClass()); + System.out.println(spaces + " # ************************************"); + if (provider.prefix() != null) { + System.out.println(spaces + " " + provider.prefix() + ":"); + printType(provider, typesMap, nesting + 2, false); + } else { + printType(provider, typesMap, nesting + 1, false); + } + } + } + + private static void listFromTypes(ConfiguredProperty property, + Set properties, + Map typesMap, + int nesting, + String spaces) { + // this may be a list defined in configuration itself (*) + String prefix = property.outputKey() + ".*."; + Map children = new HashMap<>(); + for (ConfiguredProperty configuredProperty : properties) { + if (configuredProperty.outputKey().startsWith(prefix)) { + children.put(configuredProperty.outputKey().substring(prefix.length()), configuredProperty); + } + } + if (children.isEmpty()) { + // this may be an array of primitive types / String + TypedValue typedValue = TYPED_VALUES.get(property.type()); + if (typedValue == null) { + List allowedValues = property.allowedValues(); + if (allowedValues.isEmpty()) { + System.out.println(); + System.out.println(spaces + "# Missing type: " + property.type()); + } else { + System.out.println(); + typedValue = new TypedValue("", true); + for (ConfiguredType.AllowedValue allowedValue : allowedValues) { + // # Description + // # This is the default value + // actual value + System.out.print(spaces + " - "); + String nextLinePrefix = spaces + " "; + boolean firstLine = true; + + if (allowedValue.description() != null && !allowedValue.description().isBlank()) { + firstLine = false; + System.out.println("#" + allowedValue.description()); + } + if (allowedValue.value().equals(property.defaultValue())) { + if (firstLine) { + firstLine = false; + } else { + System.out.print(nextLinePrefix); + } + System.out.println("# This is the default value"); + } + if (!firstLine) { + System.out.print(nextLinePrefix); + } + System.out.println(output(typedValue, allowedValue.value())); + } + } + } else { + printArray(typedValue); + } + } else { + System.out.println(); + System.out.print(spaces + "- "); + boolean listStart = true; + for (var entry : children.entrySet()) { + ConfiguredProperty element = entry.getValue(); + // we must modify the key + element.key(entry.getKey()); + printProperty(element, properties, typesMap, nesting + 1, listStart); + listStart = false; + } + } + } + + private static void printDocs(ConfiguredProperty property, String spaces, boolean firstLineNoSpaces) { + String description = property.description(); + description = (description == null || description.isBlank()) ? null : description; + + // type + System.out.print((firstLineNoSpaces ? "" : spaces)); + System.out.print("# "); + System.out.println(property.type()); + + // description + if (description != null) { + description = description.replace('\n', ' '); + System.out.print(spaces); + System.out.print("# "); + System.out.println(description); + } + + // required + if (!property.optional()) { + System.out.print(spaces); + System.out.println("# *********** REQUIRED ***********"); + } + } + + private static void printArray(TypedValue typedValue) { + String element = output(typedValue, typedValue.defaultsDefault()); + String toPrint = " [" + element + "," + element + "]"; + System.out.println(toPrint); + } + + private static String output(TypedValue typed, String value) { + if (typed.escaped()) { + return "\"" + value + "\""; + } + return value; + } + + private static void printAllowedValuesOrMissing(ConfiguredProperty property, + Map typesMap, + int nesting, String spaces) { + if (property.provider()) { + System.out.println(spaces + property.outputKey() + ":"); + fromProvider(property, typesMap, nesting); + return; + } + + List allowedValues = property.allowedValues(); + if (allowedValues.isEmpty()) { + if (property.defaultValue() == null) { + System.out.println(spaces + property.outputKey() + ": \"Missing nested type: " + property.type() + "\""); + } else { + System.out.println(spaces + property.outputKey() + ": " + toTypedValue(property, + new TypedValue(property.defaultValue(), + true))); + } + } else { + List values = allowedValues.stream() + .map(ConfiguredType.AllowedValue::value) + .collect(Collectors.toList()); + for (ConfiguredType.AllowedValue allowedValue : allowedValues) { + System.out.println(spaces + "# " + allowedValue.value() + ": " + allowedValue.description() + .replace("\n", " ")); + } + if (property.defaultValue() == null) { + System.out.println(spaces + property.outputKey() + ": \"One of: " + values + "\""); + } else { + System.out.println(spaces + property.outputKey() + ": \"" + property.defaultValue() + "\""); + } + } + } + + private static String toTypedValue(ConfiguredProperty property, + TypedValue typed) { + String value = property.defaultValue(); + + if (value == null) { + value = typed.defaultsDefault; + } + + return output(typed, value); + } + + private static void processMetadataJson(List configuredTypes, + Map typesMap, + JsonArray jsonArray) { + for (JsonValue jsonValue : jsonArray) { + processTypeArray(configuredTypes, typesMap, jsonValue.asJsonObject().getJsonArray("types")); + } + } + + private static void processTypeArray(List configuredTypes, + Map typesMap, + JsonArray jsonArray) { + if (jsonArray == null) { + return; + } + for (JsonValue jsonValue : jsonArray) { + JsonObject type = jsonValue.asJsonObject(); + ConfiguredType configuredType = ConfiguredType.create(type); + configuredTypes.add(configuredType); + typesMap.put(configuredType.targetClass(), configuredType); + } + } + + private static final class TypedValue { + private final String defaultsDefault; + private final boolean escaped; + + private TypedValue(String defaultsDefault) { + this(defaultsDefault, false); + } + + private TypedValue(String defaultsDefault, boolean escaped) { + this.defaultsDefault = defaultsDefault; + this.escaped = escaped; + } + + String defaultsDefault() { + return defaultsDefault; + } + + boolean escaped() { + return escaped; + } + } +} diff --git a/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/ConfiguredType.java b/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/ConfiguredType.java new file mode 100644 index 00000000..c36f64b0 --- /dev/null +++ b/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/ConfiguredType.java @@ -0,0 +1,361 @@ +/* + * 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. + */ + +package io.helidon.config.examples.metadata; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashSet; +import java.util.LinkedList; +import java.util.List; +import java.util.Objects; +import java.util.Set; + +import javax.json.JsonArray; +import javax.json.JsonObject; +import javax.json.JsonString; +import javax.json.JsonValue; + +import io.helidon.config.metadata.ConfiguredOption; + +final class ConfiguredType { + private final Set allProperties = new HashSet<>(); + private final List producerMethods = new LinkedList<>(); + /** + * The type that is built by a builder, or created using create method. + */ + private final String targetClass; + private final boolean standalone; + private final String prefix; + private final String description; + private final List provides; + private final List inherited = new LinkedList<>(); + + ConfiguredType(String targetClass, boolean standalone, String prefix, String description, List provides) { + this.targetClass = targetClass; + this.standalone = standalone; + this.prefix = prefix; + this.description = description; + this.provides = provides; + } + + private static String paramsToString(String[] params) { + String result = Arrays.toString(params); + if (result.startsWith("[") && result.endsWith("]")) { + return result.substring(1, result.length() - 1); + } + return result; + } + + String description() { + return description; + } + + static ConfiguredType create(JsonObject type) { + ConfiguredType ct = new ConfiguredType( + type.getString("type"), + type.getBoolean("standalone", false), + type.getString("prefix", null), + type.getString("description", null), + toList(type.getJsonArray("provides")) + ); + + List producers = toList(type.getJsonArray("producers")); + for (String producer : producers) { + ct.addProducer(ProducerMethod.parse(producer)); + } + List inherits = toList(type.getJsonArray("inherits")); + for (String inherit : inherits) { + ct.addInherited(inherit); + } + + JsonArray options = type.getJsonArray("options"); + for (JsonValue option : options) { + ct.addProperty(ConfiguredProperty.create(option.asJsonObject())); + } + + return ct; + } + + private static List toList(JsonArray array) { + if (array == null) { + return List.of(); + } + List result = new ArrayList<>(array.size()); + + for (JsonValue jsonValue : array) { + result.add(((JsonString) jsonValue).getString()); + } + + return result; + } + + ConfiguredType addProducer(ProducerMethod producer) { + producerMethods.add(producer); + return this; + } + + ConfiguredType addProperty(ConfiguredProperty property) { + allProperties.add(property); + return this; + } + + List producers() { + return producerMethods; + } + + Set properties() { + return allProperties; + } + + String targetClass() { + return targetClass; + } + + boolean standalone() { + return standalone; + } + + String prefix() { + return prefix; + } + + List provides() { + return provides; + } + + @Override + public String toString() { + return targetClass; + } + + void addInherited(String classOrIface) { + inherited.add(classOrIface); + } + + List inherited() { + return inherited; + } + + static final class ProducerMethod { + private final boolean isStatic; + private final String owningClass; + private final String methodName; + private final String[] methodParams; + + ProducerMethod(boolean isStatic, String owningClass, String methodName, String[] methodParams) { + this.isStatic = isStatic; + this.owningClass = owningClass; + this.methodName = methodName; + this.methodParams = methodParams; + } + + public static ProducerMethod parse(String producer) { + int methodSeparator = producer.indexOf('#'); + String owningClass = producer.substring(0, methodSeparator); + int paramBraceStart = producer.indexOf('(', methodSeparator); + String methodName = producer.substring(methodSeparator + 1, paramBraceStart); + int paramBraceEnd = producer.indexOf(')', paramBraceStart); + String parameters = producer.substring(paramBraceStart + 1, paramBraceEnd); + String[] methodParams = parameters.split(","); + + return new ProducerMethod(false, + owningClass, + methodName, + methodParams); + } + + @Override + public String toString() { + return owningClass + + "#" + + methodName + "(" + + paramsToString(methodParams) + ")"; + } + } + + static final class ConfiguredProperty { + private final String builderMethod; + private final String key; + private final String description; + private final String defaultValue; + private final String type; + private final boolean experimental; + private final boolean optional; + private final ConfiguredOption.Kind kind; + private final List allowedValues; + private final boolean provider; + private final boolean merge; + + // if this is a nested type + private ConfiguredType configuredType; + private String outputKey; + + ConfiguredProperty(String builderMethod, + String key, + String description, + String defaultValue, + String type, + boolean experimental, + boolean optional, + ConfiguredOption.Kind kind, + boolean provider, + boolean merge, + List allowedValues) { + this.builderMethod = builderMethod; + this.key = key; + this.description = description; + this.defaultValue = defaultValue; + this.type = type; + this.experimental = experimental; + this.optional = optional; + this.kind = kind; + this.allowedValues = allowedValues; + this.outputKey = key; + this.provider = provider; + this.merge = merge; + } + + public static ConfiguredProperty create(JsonObject json) { + return new ConfiguredProperty( + json.getString("method", null), + json.getString("key", null), + json.getString("description"), + json.getString("defaultValue", null), + json.getString("type", "java.lang.String"), + json.getBoolean("experimental", false), + !json.getBoolean("required", false), + toKind(json.getString("kind", null)), + json.getBoolean("provider", false), + json.getBoolean("merge", false), + toAllowedValues(json.getJsonArray("allowedValues")) + ); + } + + private static ConfiguredOption.Kind toKind(String kind) { + if (kind == null) { + return ConfiguredOption.Kind.VALUE; + } + return ConfiguredOption.Kind.valueOf(kind); + } + + List allowedValues() { + return allowedValues; + } + + private static List toAllowedValues(JsonArray allowedValues) { + if (allowedValues == null) { + return List.of(); + } + List result = new ArrayList<>(allowedValues.size()); + + for (JsonValue allowedValue : allowedValues) { + JsonObject json = allowedValue.asJsonObject(); + result.add(new AllowedValue(json.getString("value"), json.getString("description", null))); + } + + return result; + } + + String builderMethod() { + return builderMethod; + } + + String outputKey() { + return outputKey; + } + + String key() { + return key; + } + + void key(String key) { + this.outputKey = key; + } + + String description() { + return description; + } + + String defaultValue() { + return defaultValue; + } + + String type() { + return type; + } + + boolean experimental() { + return experimental; + } + + boolean optional() { + return optional; + } + + ConfiguredOption.Kind kind() { + return kind; + } + + boolean merge() { + return merge; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ConfiguredProperty that = (ConfiguredProperty) o; + return key.equals(that.key); + } + + @Override + public int hashCode() { + return Objects.hash(key); + } + + @Override + public String toString() { + return key; + } + + boolean provider() { + return provider; + } + } + + static final class AllowedValue { + private final String value; + private final String description; + + private AllowedValue(String value, String description) { + this.value = value; + this.description = description; + } + + String value() { + return value; + } + + String description() { + return description; + } + } +} diff --git a/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/package-info.java b/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/package-info.java new file mode 100644 index 00000000..4c8928eb --- /dev/null +++ b/examples/config/metadata/src/main/java/io/helidon/config/examples/metadata/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of processing configuration metadata. + */ +package io.helidon.config.examples.metadata; diff --git a/examples/config/overrides/README.md b/examples/config/overrides/README.md new file mode 100644 index 00000000..966a6435 --- /dev/null +++ b/examples/config/overrides/README.md @@ -0,0 +1,27 @@ +# Helidon Config Overrides Example + +This example shows how to load configuration from multiple +configuration sources, specifically where one of the sources _overrides_ other +sources. + +The application treats +[`resources/application.yaml`](./src/main/resources/application.yaml) and +[`conf/priority-config.yaml`](./conf/priority-config.yaml) +as the config sources for the its configuration. + +The `application.yaml` file is packaged along with the application code, while +the files in `conf` would be provided during deployment to tailor the behavior +of the application to that specific environment. + +The application also loads +[`conf/overrides.properties`](./conf/overrides.properties) but as an +_override_ config +source. This file contains key _expressions_ (including wildcards) and values which +take precedence over the settings in the original config sources. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-config-overrides.jar +``` diff --git a/examples/config/overrides/conf/overrides.properties b/examples/config/overrides/conf/overrides.properties new file mode 100644 index 00000000..3ff3dbc0 --- /dev/null +++ b/examples/config/overrides/conf/overrides.properties @@ -0,0 +1,29 @@ +# +# Copyright (c) 2017, 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. +# + +# Overrides provides central place for +# managing app configuration across envs. + +# key format: $env.$pod... + +# override selected pod (abcdef) logging level +prod.abcdef.logging.level = FINEST + +# "production" environment, any pod +prod.*.logging.level = WARNING + +# "test" environment, any pod +test.*.logging.level = FINE diff --git a/examples/config/overrides/conf/priority-config.yaml b/examples/config/overrides/conf/priority-config.yaml new file mode 100644 index 00000000..70b33f38 --- /dev/null +++ b/examples/config/overrides/conf/priority-config.yaml @@ -0,0 +1,29 @@ +# +# Copyright (c) 2017, 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. +# + +# set context + +env: prod +pod: abcdef + +$env: + $pod: + logging: + level: ERROR + + app: + greeting: Ahoy + page-size: 42 diff --git a/examples/config/overrides/pom.xml b/examples/config/overrides/pom.xml new file mode 100644 index 00000000..b716bcdf --- /dev/null +++ b/examples/config/overrides/pom.xml @@ -0,0 +1,62 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-overrides + 1.0.0-SNAPSHOT + Helidon Config Examples Overrides + + + The example shows how to use Overrides in Configuration API. + + + + io.helidon.config.examples.overrides.Main + + + + + io.helidon.bundles + helidon-bundles-config + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/overrides/src/main/java/io/helidon/config/examples/overrides/Main.java b/examples/config/overrides/src/main/java/io/helidon/config/examples/overrides/Main.java new file mode 100644 index 00000000..278b9ff4 --- /dev/null +++ b/examples/config/overrides/src/main/java/io/helidon/config/examples/overrides/Main.java @@ -0,0 +1,109 @@ +/* + * Copyright (c) 2017, 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.config.examples.overrides; + +import java.time.Duration; +import java.util.concurrent.TimeUnit; + +import io.helidon.config.Config; +import io.helidon.config.OverrideSources; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; +import static io.helidon.config.PollingStrategies.regular; + +/** + * Overrides example. + *

+ * Shows the Overrides feature where values from config sources might be overridden by override source. + *

+ * In this example, {@code application.yaml} is meant to be default application configuration distributed with an app, containing + * a wildcard configuration nodes representing the defaults for every environment and pod as well as a default definition of + * these values. The source {@code conf/priority-config.yaml} is a higher priority configuration source which can be in a real + * app dynamically changed (i.e. {@code Kubernetes ConfigMap} mapped as the file) and contains the current {@code env} and {@code + * pod} values ({@code prod} and {@code abcdef} in this example) and higher priority default configuration. So far the current + * configuration looks like this: + * 

+ * prod:
+ *   abcdef:
+ *     logging:
+ *     level: ERROR
+ *     app:
+ *       greeting:  Ahoy
+ *       page-size: 42
+ *       basic-range:
+ *         - -20
+ *         -  20
+ *
+ * But the override source just overrides values for environment: {@code prod} and pod: {@code abcdef} (it is the first + * overriding rule found) and value for key {@code prod.abcdef.logging.level = FINEST}. For completeness, we would say that the + * other pods in {@code prod} environment has overridden config value {@code prod.*.logging.level} to {@code WARNING} and all + * pods + * {@code test.*.logging.level} to {@code FINE}. + */ +public final class Main { + + private Main() { + } + + /** + * Executes the example. + * + * @param args arguments + * @throws InterruptedException when a sleeper awakes + */ + public static void main(String... args) throws InterruptedException { + Config config = Config + .builder() + // specify config sources + .sources(file("conf/priority-config.yaml").pollingStrategy(regular(Duration.ofSeconds(1))), + classpath("application.yaml")) + // specify overrides source + .overrides(OverrideSources.file("conf/overrides.properties") + .pollingStrategy(regular(Duration.ofSeconds(1)))) + .build(); + + // Resolve current runtime context + String env = config.get("env").asString().get(); + String pod = config.get("pod").asString().get(); + + // get logging config for the current runtime + Config loggingConfig = config + .get(env) + .get(pod) + .get("logging"); + + // initialize logging from config + initLogging(loggingConfig); + + // react on changes of logging configuration + loggingConfig.onChange(Main::initLogging); + + TimeUnit.MINUTES.sleep(1); + } + + /** + * Initialize logging from config. + */ + private static void initLogging(Config loggingConfig) { + String level = loggingConfig.get("level").asString().orElse("WARNING"); + //e.g. initialize logging using configured level... + + System.out.println("Set logging level to " + level + "."); + } + +} diff --git a/examples/config/overrides/src/main/java/io/helidon/config/examples/overrides/package-info.java b/examples/config/overrides/src/main/java/io/helidon/config/examples/overrides/package-info.java new file mode 100644 index 00000000..6cc89740 --- /dev/null +++ b/examples/config/overrides/src/main/java/io/helidon/config/examples/overrides/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * The example shows how to use Overrides in Configuration API. + */ +package io.helidon.config.examples.overrides; diff --git a/examples/config/overrides/src/main/resources/application.yaml b/examples/config/overrides/src/main/resources/application.yaml new file mode 100644 index 00000000..b13e7ad0 --- /dev/null +++ b/examples/config/overrides/src/main/resources/application.yaml @@ -0,0 +1,35 @@ +# +# Copyright (c) 2017, 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. +# + +# default context + +env: dev +pod: local + +# app config +# key format: $env.$pod... + +$env: + $pod: + logging: + level: CONFIG + + app: + greeting: Hello + page-size: 20 + basic-range: + - -20 + - 20 diff --git a/examples/config/overrides/src/main/resources/logging.properties b/examples/config/overrides/src/main/resources/logging.properties new file mode 100644 index 00000000..721cc5fc --- /dev/null +++ b/examples/config/overrides/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +handlers = java.util.logging.ConsoleHandler + +java.util.logging.ConsoleHandler.level = FINEST +java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter +java.util.logging.SimpleFormatter.format = [%1$tc] %4$s: %2$s - %5$s %6$s%n + +.level = INFO +io.helidon.config.level = WARNING +io.helidon.config.examples.level = FINEST diff --git a/examples/config/pom.xml b/examples/config/pom.xml new file mode 100644 index 00000000..232d4f28 --- /dev/null +++ b/examples/config/pom.xml @@ -0,0 +1,44 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.config + helidon-examples-config-project + pom + Helidon Config Examples + + + basics + changes + git + mapping + overrides + sources + profiles + metadata + + + diff --git a/examples/config/profiles/README.md b/examples/config/profiles/README.md new file mode 100644 index 00000000..8c98e330 --- /dev/null +++ b/examples/config/profiles/README.md @@ -0,0 +1,31 @@ +# Helidon Config Profiles Example + +This example shows how to load configuration from multiple +configuration sources using profiles. + +This example contains the following profiles: + +1. no profile - if you start the application with no profile, the usual `src/main/resources/application.yaml` will be used +2. `local` - `src/main/resources/application-local.yaml` will be used +3. `dev` - has an explicit profile file `config-profile-dev.yaml` on classpath that defines an inlined configuration +4. `stage` - has an explicit profile file `config-profile-stage.yaml` on classpath that defines a classpath config source +4. `prod` - has an explicit profile file `config-profile-prod.yaml` on file system that defines a path config source + +To switch profiles +- either use a system property `config.profile` +- or use an environment variable `HELIDON_CONFIG_PROFILE` + + +## How to run this example: + +Build the application +```shell +mvn clean package +``` + +Run it with a profile +```shell +java -Dconfig.profile=prod -jar target/helidon-examples-config-profiles.jar +``` + +Changing the profile name should use different configuration. \ No newline at end of file diff --git a/examples/config/profiles/config-profile-prod.yaml b/examples/config/profiles/config-profile-prod.yaml new file mode 100644 index 00000000..f0cf375c --- /dev/null +++ b/examples/config/profiles/config-profile-prod.yaml @@ -0,0 +1,22 @@ +# +# Copyright (c) 2021 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. +# + +sources: + - type: "environment-variables" + - type: "system-properties" + - type: "file" + properties: + path: "config/config-prod.yaml" diff --git a/examples/config/profiles/config/config-prod.yaml b/examples/config/profiles/config/config-prod.yaml new file mode 100644 index 00000000..ee020122 --- /dev/null +++ b/examples/config/profiles/config/config-prod.yaml @@ -0,0 +1,17 @@ +# +# Copyright (c) 2021 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. +# + +message: "config/config-prod.yaml" diff --git a/examples/config/profiles/pom.xml b/examples/config/profiles/pom.xml new file mode 100644 index 00000000..41046355 --- /dev/null +++ b/examples/config/profiles/pom.xml @@ -0,0 +1,66 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-profiles + 1.0.0-SNAPSHOT + Helidon Config Examples Profiles + + + The example shows how to use Config Profiles (meta configuration). + + + + io.helidon.examples.config.profiles.Main + + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/profiles/src/main/java/io/helidon/examples/config/profiles/Main.java b/examples/config/profiles/src/main/java/io/helidon/examples/config/profiles/Main.java new file mode 100644 index 00000000..0077a169 --- /dev/null +++ b/examples/config/profiles/src/main/java/io/helidon/examples/config/profiles/Main.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2021 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.config.profiles; + +import io.helidon.config.Config; + +/** + * Example main class. + */ +public final class Main { + private Main() { + } + + /** + * Main method. + * + * @param args ignored + */ + public static void main(String[] args) { + Config config = Config.create(); + + System.out.println("Configured message: " + config.get("message").asString().orElse("MISSING")); + } +} diff --git a/examples/config/profiles/src/main/java/io/helidon/examples/config/profiles/package-info.java b/examples/config/profiles/src/main/java/io/helidon/examples/config/profiles/package-info.java new file mode 100644 index 00000000..bb7cb9ee --- /dev/null +++ b/examples/config/profiles/src/main/java/io/helidon/examples/config/profiles/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2021 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 showing usage of configuration profiles in Helidon SE. + */ +package io.helidon.examples.config.profiles; diff --git a/examples/config/profiles/src/main/resources/application-local.yaml b/examples/config/profiles/src/main/resources/application-local.yaml new file mode 100644 index 00000000..f54597e9 --- /dev/null +++ b/examples/config/profiles/src/main/resources/application-local.yaml @@ -0,0 +1,17 @@ +# +# Copyright (c) 2021 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. +# + +message: "src/main/resources/application-local.yaml" diff --git a/examples/config/profiles/src/main/resources/application-stage.yaml b/examples/config/profiles/src/main/resources/application-stage.yaml new file mode 100644 index 00000000..7343ff57 --- /dev/null +++ b/examples/config/profiles/src/main/resources/application-stage.yaml @@ -0,0 +1,17 @@ +# +# Copyright (c) 2021 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. +# + +message: "src/main/resources/application-stage.yaml" diff --git a/examples/config/profiles/src/main/resources/application.yaml b/examples/config/profiles/src/main/resources/application.yaml new file mode 100644 index 00000000..3eee73c1 --- /dev/null +++ b/examples/config/profiles/src/main/resources/application.yaml @@ -0,0 +1,17 @@ +# +# Copyright (c) 2021 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. +# + +message: "src/main/resources/application.yaml" diff --git a/examples/config/profiles/src/main/resources/config-profile-dev.yaml b/examples/config/profiles/src/main/resources/config-profile-dev.yaml new file mode 100644 index 00000000..345d2f00 --- /dev/null +++ b/examples/config/profiles/src/main/resources/config-profile-dev.yaml @@ -0,0 +1,20 @@ +# +# Copyright (c) 2021 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. +# + +sources: + - type: "inlined" + properties: + message: "inlined in dev profile" diff --git a/examples/config/profiles/src/main/resources/config-profile-stage.yaml b/examples/config/profiles/src/main/resources/config-profile-stage.yaml new file mode 100644 index 00000000..9740180c --- /dev/null +++ b/examples/config/profiles/src/main/resources/config-profile-stage.yaml @@ -0,0 +1,20 @@ +# +# Copyright (c) 2021 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. +# + +sources: + - type: "classpath" + properties: + resource: "application-stage.yaml" diff --git a/examples/config/sources/README.md b/examples/config/sources/README.md new file mode 100644 index 00000000..e7afc2db --- /dev/null +++ b/examples/config/sources/README.md @@ -0,0 +1,23 @@ +# Helidon Config Sources Example + +This example shows how to load configuration from multiple +configuration sources. + +1. [`DirectorySourceExample.java`](./src/main/java/io/helidon/config/examples/sources/DirectorySourceExample.java) +reads configuration from multiple files in a directory by specifying only the directory. +2. [`LoadSourcesExample.java`](./src/main/java/io/helidon/config/examples/sources/LoadSourcesExample.java) +uses _meta-configuration_ files [`conf/meta-config.yaml`](./conf/meta-config.yaml) +and [`src/main/resources/meta-config.yaml`](./src/main/resources/meta-config.yaml) +which contain not the configuration itself but +_instructions for loading_ the configuration: what type, from where, etc. It also +applies a filter to modify config values whose keys match a certain pattern. +3. [`WithSourcesExample.java`](./src/main/java/io/helidon/config/examples/sources/WithSourcesExample.java) +combines multiple config sources into a single configuration instance (and adds a +filter. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-config-sources.jar +``` diff --git a/examples/config/sources/conf/config.yaml b/examples/config/sources/conf/config.yaml new file mode 100644 index 00000000..4b08deac --- /dev/null +++ b/examples/config/sources/conf/config.yaml @@ -0,0 +1,25 @@ +# +# Copyright (c) 2017, 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. +# + +# In config.yaml we are going to override default configuration. +# It is supposed to be deployment dependent configuration. + +meta: + env: PROD + +app: + page-size: 10 + diff --git a/examples/config/sources/conf/dev.yaml b/examples/config/sources/conf/dev.yaml new file mode 100644 index 00000000..312f8d84 --- /dev/null +++ b/examples/config/sources/conf/dev.yaml @@ -0,0 +1,30 @@ +# +# Copyright (c) 2017, 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. +# + +# In dev.yaml we are going to override all lower layer configuration files. +# It is supposed to be development specific configuration. + +# IT SHOULD NOT BE PLACED IN VCS. EACH DEVELOPER CAN CUSTOMIZE THE FILE AS NEEDED. +# I.e. for example with GIT place following line into .gitignore file: +#*/conf/dev.yaml + +meta: + env: DEV + +component: + audit: + logging: + level: fine diff --git a/examples/config/sources/conf/meta-config.yaml b/examples/config/sources/conf/meta-config.yaml new file mode 100644 index 00000000..31e31fe2 --- /dev/null +++ b/examples/config/sources/conf/meta-config.yaml @@ -0,0 +1,30 @@ +# +# Copyright (c) 2017, 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. +# + +sources: + - type: "environment-variables" + - type: "system-properties" + - type: "file" + properties: + path: "conf/dev.yaml" + optional: true + - type: "file" + properties: + path: "conf/config.yaml" + optional: true + - type: "classpath" + properties: + resource: "default.yaml" diff --git a/examples/config/sources/conf/secrets/password b/examples/config/sources/conf/secrets/password new file mode 100644 index 00000000..5bbaf875 --- /dev/null +++ b/examples/config/sources/conf/secrets/password @@ -0,0 +1 @@ +changeit \ No newline at end of file diff --git a/examples/config/sources/conf/secrets/username b/examples/config/sources/conf/secrets/username new file mode 100644 index 00000000..1ce97e36 --- /dev/null +++ b/examples/config/sources/conf/secrets/username @@ -0,0 +1 @@ +libor \ No newline at end of file diff --git a/examples/config/sources/pom.xml b/examples/config/sources/pom.xml new file mode 100644 index 00000000..76778642 --- /dev/null +++ b/examples/config/sources/pom.xml @@ -0,0 +1,66 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.config + helidon-examples-config-sources + 1.0.0-SNAPSHOT + Helidon Config Examples Sources + + + This example shows how to merge the configuration from different sources. + + + + io.helidon.config.examples.sources.Main + + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/config/sources/src/main/java/io/helidon/config/examples/sources/DirectorySourceExample.java b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/DirectorySourceExample.java new file mode 100644 index 00000000..9dbf5249 --- /dev/null +++ b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/DirectorySourceExample.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2017, 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.config.examples.sources; + +import io.helidon.config.Config; + +import static io.helidon.config.ConfigSources.directory; + +/** + * This example shows how to read configuration from several files placed in selected directory. + */ +public class DirectorySourceExample { + + private DirectorySourceExample() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String... args) { + /* + Creates a config from files from specified directory. + E.g. Kubernetes Secrets: + */ + + Config secrets = Config.builder(directory("conf/secrets")) + .disableEnvironmentVariablesSource() + .disableSystemPropertiesSource() + .build(); + + String username = secrets.get("username").asString().get(); + System.out.println("Username: " + username); + assert username.equals("libor"); + + String password = secrets.get("changeit").asString().get(); + System.out.println("Password: " + password); + assert password.equals("changeit"); + } + +} diff --git a/examples/config/sources/src/main/java/io/helidon/config/examples/sources/LoadSourcesExample.java b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/LoadSourcesExample.java new file mode 100644 index 00000000..8655c722 --- /dev/null +++ b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/LoadSourcesExample.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2017, 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.config.examples.sources; + +import io.helidon.config.Config; +import io.helidon.config.ConfigValue; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * This example shows how to merge the configuration from different sources + * loaded from meta configuration. + * + * @see WithSourcesExample + */ +public class LoadSourcesExample { + + private LoadSourcesExample() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String... args) { + /* + Creates a configuration from list of config sources loaded from meta sources: + - conf/meta-config.yaml - - deployment dependent meta-config file, loaded from file on filesystem; + - meta-config.yaml - application default meta-config file, loaded form classpath; + with a filter which convert values with keys ending with "level" to upper case + */ + + Config metaConfig = Config.create(file("conf/meta-config.yaml").optional(), + classpath("meta-config.yaml")); + + Config config = Config.builder() + .config(metaConfig) + .addFilter((key, stringValue) -> key.name().equals("level") ? stringValue.toUpperCase() : stringValue) + .build(); + + // Optional environment type, from dev.yaml: + ConfigValue env = config.get("meta.env").asString(); + env.ifPresent(e -> System.out.println("Environment: " + e)); + assert env.get().equals("DEV"); + + // Default value (default.yaml): Config Sources Example + String appName = config.get("app.name").asString().get(); + System.out.println("Name: " + appName); + assert appName.equals("Config Sources Example"); + + // Page size, from config.yaml: 10 + int pageSize = config.get("app.page-size").asInt().get(); + System.out.println("Page size: " + pageSize); + assert pageSize == 10; + + // Applied filter (uppercase logging level), from dev.yaml: finest -> FINEST + String level = config.get("component.audit.logging.level").asString().get(); + System.out.println("Level: " + level); + assert level.equals("FINE"); + } + +} diff --git a/examples/config/sources/src/main/java/io/helidon/config/examples/sources/Main.java b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/Main.java new file mode 100644 index 00000000..d6321102 --- /dev/null +++ b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/Main.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2017, 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.config.examples.sources; + +/** + * Runs every example main class in this module/package. + */ +public class Main { + + private Main() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String[] args) { + WithSourcesExample.main(args); + LoadSourcesExample.main(args); + DirectorySourceExample.main(args); + } + +} diff --git a/examples/config/sources/src/main/java/io/helidon/config/examples/sources/WithSourcesExample.java b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/WithSourcesExample.java new file mode 100644 index 00000000..5508b492 --- /dev/null +++ b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/WithSourcesExample.java @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2017, 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.config.examples.sources; + +import io.helidon.config.Config; +import io.helidon.config.ConfigValue; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * This example shows how to merge the configuration from different sources. + * + * @see LoadSourcesExample + */ +public class WithSourcesExample { + + private WithSourcesExample() { + } + + /** + * Executes the example. + * + * @param args arguments + */ + public static void main(String... args) { + /* + Creates a config source composed of following sources: + - conf/dev.yaml - developer specific configuration, should not be placed in VCS; + - conf/config.yaml - deployment dependent configuration, for example prod, stage, etc; + - default.yaml - application default values, loaded form classpath; + with a filter which convert values with keys ending with "level" to upper case + */ + + Config config = Config + .builder(file("conf/dev.yaml").optional(), + file("conf/config.yaml").optional(), + classpath("default.yaml")) + .addFilter((key, stringValue) -> key.name().equals("level") ? stringValue.toUpperCase() : stringValue) + .build(); + + // Environment type, from dev.yaml: + ConfigValue env = config.get("meta.env").asString(); + env.ifPresent(e -> System.out.println("Environment: " + e)); + assert env.get().equals("DEV"); + + // Default value (default.yaml): Config Sources Example + String appName = config.get("app.name").asString().get(); + System.out.println("Name: " + appName); + assert appName.equals("Config Sources Example"); + + // Page size, from config.yaml: 10 + int pageSize = config.get("app.page-size").asInt().get(); + System.out.println("Page size: " + pageSize); + assert pageSize == 10; + + // Applied filter (uppercase logging level), from dev.yaml: finest -> FINEST + String level = config.get("component.audit.logging.level").asString().get(); + System.out.println("Level: " + level); + assert level.equals("FINE"); + } + +} diff --git a/examples/config/sources/src/main/java/io/helidon/config/examples/sources/package-info.java b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/package-info.java new file mode 100644 index 00000000..16f4904f --- /dev/null +++ b/examples/config/sources/src/main/java/io/helidon/config/examples/sources/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * This example shows how to merge the configuration from different sources. + */ +package io.helidon.config.examples.sources; diff --git a/examples/config/sources/src/main/resources/default.yaml b/examples/config/sources/src/main/resources/default.yaml new file mode 100644 index 00000000..b1dfac98 --- /dev/null +++ b/examples/config/sources/src/main/resources/default.yaml @@ -0,0 +1,32 @@ +# +# Copyright (c) 2017, 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. +# + +# In default.yaml we are going to configure application default values. +# It is expected it is overridden in: +# - conf/config.yaml in production environment +# - conf/dev.yaml by developer on local machine + +app: + name: Config Sources Example + page-size: 20 + +component: + audit: + logging: + level: info + monitoring: + logging: + level: warning diff --git a/examples/config/sources/src/main/resources/logging.properties b/examples/config/sources/src/main/resources/logging.properties new file mode 100644 index 00000000..721cc5fc --- /dev/null +++ b/examples/config/sources/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +handlers = java.util.logging.ConsoleHandler + +java.util.logging.ConsoleHandler.level = FINEST +java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter +java.util.logging.SimpleFormatter.format = [%1$tc] %4$s: %2$s - %5$s %6$s%n + +.level = INFO +io.helidon.config.level = WARNING +io.helidon.config.examples.level = FINEST diff --git a/examples/config/sources/src/main/resources/meta-config.yaml b/examples/config/sources/src/main/resources/meta-config.yaml new file mode 100644 index 00000000..c0b1365f --- /dev/null +++ b/examples/config/sources/src/main/resources/meta-config.yaml @@ -0,0 +1,21 @@ +# +# Copyright (c) 2017, 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. +# + +# ordered list of sources +sources: + - type: "classpath" + properties: + resource: "default.yaml" diff --git a/examples/config/sources/src/main/resources/overrides.properties b/examples/config/sources/src/main/resources/overrides.properties new file mode 100644 index 00000000..a2046d7a --- /dev/null +++ b/examples/config/sources/src/main/resources/overrides.properties @@ -0,0 +1,17 @@ +# +# Copyright (c) 2017, 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. +# + +component.*.logging.level = finest diff --git a/examples/cors/README.md b/examples/cors/README.md new file mode 100644 index 00000000..e03d005c --- /dev/null +++ b/examples/cors/README.md @@ -0,0 +1,173 @@ + +# Helidon SE CORS Example + +This example shows a simple greeting application, similar to the one from the +Helidon SE QuickStart, enhanced with CORS support. + +Look at the `resources/application.yaml` file and notice the `restrictive-cors` +section. (We'll come back to the `cors` section later.) The `Main#corsSupportForGreeting` method loads this +configuration and uses it to set up CORS for the application's endpoints. + +Near the end of the `resources/logging.properties` file, a commented line would turn on `FINE +` logging that would reveal how the Helidon CORS support makes it decisions. To see that logging, +uncomment that line and then package and run the application. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-cors.jar +``` + +## Using the app endpoints as with the "classic" greeting app + +These normal greeting app endpoints work just as in the original greeting app: + +```shell +curl -X GET http://localhost:8080/greet +#Output: {"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#Output: {"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#Output: {"message":"Hola Jose!"} +``` + +## Using CORS + +### Sending "simple" CORS requests + +The following requests illustrate the CORS protocol with the example app. + +By setting `Origin` and `Host` headers that do not indicate the same system we trigger CORS processing in the + server: + +```shell +# Follow the CORS protocol for GET +curl -i -X GET -H "Origin: http://foo.com" -H "Host: here.com" http://localhost:8080/greet +``` +```text +HTTP/1.1 200 OK +Access-Control-Allow-Origin: * +Content-Type: application/json +Date: Thu, 30 Apr 2020 17:25:51 -0500 +Vary: Origin +connection: keep-alive +content-length: 26 + +{"greeting":"Hola World!"} +``` +Note the new headers `Access-Control-Allow-Origin` and `Vary` in the response. + +The same happens for a `GET` requesting a personalized greeting (by passing the name of the + person to be greeted): +```shell +curl -i -X GET -H "Origin: http://foo.com" -H "Host: here.com" http://localhost:8080/greet/Joe +#Output: {"greeting":"Hola Joe!"} +``` +These two `GET` requests work because the `Main#corsSupportForGreeting` method adds a default `CrossOriginConfig` to the +`CorsSupport.Builder` it sets up. This is in addition to adding a `CrossOriginConfig` based on the `restrictive-cors` +configuration in `application.yaml` we looked at earlier. + +These are what CORS calls "simple" requests; the CORS protocol for these adds headers to the request and response which +the client and server exchange anyway. + +### "Non-simple" CORS requests + +The CORS protocol requires the client to send a _pre-flight_ request before sending a request + that changes state on the server, such as `PUT` or `DELETE`, and to check the returned status + and headers to make sure the server is willing to accept the actual request. CORS refers to such `PUT` and `DELETE` + requests as "non-simple" ones. + +This command sends a pre-flight `OPTIONS` request to see if the server will accept a subsequent `PUT` request from the +specified origin to change the greeting: +```shell +curl -i -X OPTIONS \ + -H "Access-Control-Request-Method: PUT" \ + -H "Origin: http://foo.com" \ + -H "Host: here.com" \ + http://localhost:8080/greet/greeting +``` +```text +HTTP/1.1 200 OK +Access-Control-Allow-Methods: PUT +Access-Control-Allow-Origin: http://foo.com +Date: Thu, 30 Apr 2020 17:30:59 -0500 +transfer-encoding: chunked +connection: keep-alive +``` +The successful status and the returned `Access-Control-Allow-xxx` headers indicate that the + server accepted the pre-flight request. That means it is OK for us to send `PUT` request to perform the actual change + of greeting. (See below for how the server rejects a pre-flight request.) +```shell +curl -i -X PUT \ + -H "Origin: http://foo.com" \ + -H "Host: here.com" \ + -H "Access-Control-Allow-Methods: PUT" \ + -H "Access-Control-Allow-Origin: http://foo.com" \ + -H "Content-Type: application/json" \ + -d "{ \"greeting\" : \"Cheers\" }" \ + http://localhost:8080/greet/greeting +``` +```text +HTTP/1.1 204 No Content +Access-Control-Allow-Origin: http://foo.com +Date: Thu, 30 Apr 2020 17:32:55 -0500 +Vary: Origin +connection: keep-alive +``` +And we run one more `GET` to observe the change in the greeting: +```shell +curl -i -X GET -H "Origin: http://foo.com" -H "Host: here.com" http://localhost:8080/greet/Joe +#Output: {"greeting":"Cheers Joe!"} +``` +Note that the tests in the example `MainTest` class follow these same steps. + +## Using overrides + +The `Main#corsSupportForGreeting` method loads override settings for any other CORS set-up if the config contains a +"cors" section. (That section is initially commented out in the example `application.yaml` file.) Not all applications +need this feature, but the example shows how easy it is to add. + +With the same server running, repeat the `OPTIONS` request from above, but change the `Origin` header to refer to +`other.com`: +```shell +curl -i -X OPTIONS \ + -H "Access-Control-Request-Method: PUT" \ + -H "Origin: http://other.com" \ + -H "Host: here.com" \ + http://localhost:8080/greet/greeting +``` +```text +HTTP/1.1 403 CORS origin is not in allowed list +Date: Mon, 4 May 2020 10:49:41 -0500 +transfer-encoding: chunked +connection: keep-alive +``` +This fails because the app set up CORS using the "restrictive-cors" configuration in `application.yaml` which allows +sharing only with `foo.com` and `there.com`, not with `other.com`. + +Stop the running app, uncomment the commented section at the end of `application.yaml`, and build and run the app again. +```shell +mvn package +java -jar target/helidon-examples-cors.jar +``` +Send the previous `OPTIONS` request again and note the successful result: +```text +HTTP/1.1 200 OK +Access-Control-Allow-Methods: PUT +Access-Control-Allow-Origin: http://other.com +Access-Control-Max-Age: 3600 +Date: Mon, 4 May 2020 18:52:54 -0500 +transfer-encoding: chunked +connection: keep-alive +``` +The application uses the now-uncommented portion of the config file to override the rest of the CORS set-up. You can +choose whatever key name you want for the override. Just make sure you tell your end users whatever the key is your app +uses for overrides. + +A real application might read the normal configuration (`restrictive-cors`) from one config source and any overrides +from another. This example combines them in one config source just for simplicity. \ No newline at end of file diff --git a/examples/cors/pom.xml b/examples/cors/pom.xml new file mode 100644 index 00000000..c6fba24f --- /dev/null +++ b/examples/cors/pom.xml @@ -0,0 +1,97 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples + helidon-examples-cors + 1.0.0-SNAPSHOT + Helidon SE Examples CORS + + + Basic illustration of CORS support in Helidon SE + + + + io.helidon.examples.cors.Main + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.webserver + helidon-webserver-cors + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + diff --git a/examples/cors/src/main/java/io/helidon/examples/cors/GreetService.java b/examples/cors/src/main/java/io/helidon/examples/cors/GreetService.java new file mode 100644 index 00000000..08d0bc55 --- /dev/null +++ b/examples/cors/src/main/java/io/helidon/examples/cors/GreetService.java @@ -0,0 +1,125 @@ +/* + * Copyright (c) 2020, 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.cors; + +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.json.JsonReaderFactory; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private String greeting; + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + + private static final JsonReaderFactory JSON_RF = Json.createReaderFactory(Collections.emptyMap()); + + GreetService(Config config) { + this.greeting = config.get("app.greeting").asString().orElse("Ciao"); + } + + /** + * A service registers itself by updating the routine rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + GreetingMessage msg = new GreetingMessage(String.format("%s %s!", greeting, name)); + response.send(msg.forRest()); + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey(GreetingMessage.JSON_LABEL)) { + JsonObject jsonErrorObject = JSON_BF.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting = GreetingMessage.fromRest(jo).getMessage(); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class).thenAccept(jo -> updateGreetingFromJson(jo, response)); + } +} diff --git a/examples/cors/src/main/java/io/helidon/examples/cors/GreetingMessage.java b/examples/cors/src/main/java/io/helidon/examples/cors/GreetingMessage.java new file mode 100644 index 00000000..ac687c37 --- /dev/null +++ b/examples/cors/src/main/java/io/helidon/examples/cors/GreetingMessage.java @@ -0,0 +1,87 @@ +/* + * Copyright (c) 2020, 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.cors; + +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.json.JsonObjectBuilder; + +/** + * POJO for the greeting message exchanged between the server and the client. + */ +public class GreetingMessage { + + /** + * Label for tagging a {@code GreetingMessage} instance in JSON. + */ + public static final String JSON_LABEL = "greeting"; + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + + private String message; + + /** + * Create a new greeting with the specified message content. + * + * @param message the message to store in the greeting + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Returns the message value. + * + * @return the message + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message value to be set + */ + public void setMessage(String message) { + this.message = message; + } + + /** + * Converts a JSON object (typically read from the request payload) + * into a {@code GreetingMessage}. + * + * @param jsonObject the {@link JsonObject} to convert. + * @return {@code GreetingMessage} set according to the provided object + */ + public static GreetingMessage fromRest(JsonObject jsonObject) { + return new GreetingMessage(jsonObject.getString(JSON_LABEL)); + } + + /** + * Prepares a {@link JsonObject} corresponding to this instance. + * + * @return {@code JsonObject} representing this {@code GreetingMessage} instance + */ + public JsonObject forRest() { + JsonObjectBuilder builder = JSON_BF.createObjectBuilder(); + return builder.add(JSON_LABEL, message) + .build(); + } +} diff --git a/examples/cors/src/main/java/io/helidon/examples/cors/Main.java b/examples/cors/src/main/java/io/helidon/examples/cors/Main.java new file mode 100644 index 00000000..599da87b --- /dev/null +++ b/examples/cors/src/main/java/io/helidon/examples/cors/Main.java @@ -0,0 +1,138 @@ +/* + * Copyright (c) 2020, 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.cors; + +import java.io.IOException; +import java.util.logging.Logger; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.cors.CorsSupport; +import io.helidon.webserver.cors.CrossOriginConfig; + +/** + * Simple Hello World rest application. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + * @throws IOException if there are problems reading logging properties + */ + public static void main(final String[] args) throws IOException { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + * @throws IOException if there are problems reading logging properties + */ + static Single startServer() throws IOException { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // Get webserver config from the "server" section of application.yaml + Single server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build() + .start(); + + server.thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + return server; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + GreetService greetService = new GreetService(config); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + // Note: Add the CORS routing *before* registering the GreetService routing. + return Routing.builder() + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register("/greet", corsSupportForGreeting(config), greetService) + .build(); + } + + private static CorsSupport corsSupportForGreeting(Config config) { + + // The default CorsSupport object (obtained using CorsSupport.create()) allows sharing for any HTTP method and with any + // origin. Using CorsSupport.create(Config) with a missing config node yields a default CorsSupport, which might not be + // what you want. This example warns if either expected config node is missing and then continues with the default. + + Config restrictiveConfig = config.get("restrictive-cors"); + if (!restrictiveConfig.exists()) { + Logger.getLogger(Main.class.getName()) + .warning("Missing restrictive config; continuing with default CORS support"); + } + + CorsSupport.Builder corsBuilder = CorsSupport.builder(); + + // Use possible overrides first. + config.get("cors") + .ifExists(c -> { + Logger.getLogger(Main.class.getName()).info("Using the override configuration"); + corsBuilder.mappedConfig(c); + }); + corsBuilder + .config(restrictiveConfig) // restricted sharing for PUT, DELETE + .addCrossOrigin(CrossOriginConfig.create()) // open sharing for other methods + .build(); + + return corsBuilder.build(); + } +} diff --git a/examples/cors/src/main/java/io/helidon/examples/cors/package-info.java b/examples/cors/src/main/java/io/helidon/examples/cors/package-info.java new file mode 100644 index 00000000..46b0ef2c --- /dev/null +++ b/examples/cors/src/main/java/io/helidon/examples/cors/package-info.java @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2020, 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 application showing CORS support in Helidon SE + *

+ * Start with {@link io.helidon.examples.cors.Main} class. + * + * @see io.helidon.examples.cors.Main + */ +package io.helidon.examples.cors; diff --git a/examples/cors/src/main/resources/META-INF/openapi.yml b/examples/cors/src/main/resources/META-INF/openapi.yml new file mode 100644 index 00000000..7e04d640 --- /dev/null +++ b/examples/cors/src/main/resources/META-INF/openapi.yml @@ -0,0 +1,83 @@ +# +# Copyright (c) 2019, 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. +# +--- +openapi: 3.0.0 +info: + title: Helidon SE Quickstart Example + description: A very simple application to reply with friendly greetings + version: 1.0.0 + +servers: + - url: http://localhost:8000 + description: Local test server + +paths: + /greet: + get: + summary: Returns a generic greeting + description: Greets the user generically + responses: + default: + description: Simple JSON containing the greeting + content: + application/json: + schema: + $ref: '#/components/schemas/GreetingMessage' + /greet/greeting: + put: + summary: Set the greeting prefix + description: Permits the client to set the prefix part of the greeting ("Hello") + requestBody: + description: Conveys the new greeting prefix to use in building greetings + content: + application/json: + schema: + $ref: '#/components/schemas/GreetingUpdateMessage' + examples: + greeting: + summary: Example greeting message to update + value: {"greeting": "New greeting message"} + responses: + "200": + description: OK + content: + application/json: {} + /greet/{name}: + get: + summary: Returns a personalized greeting + parameters: + - name: name + in: path + required: true + schema: + type: string + responses: + default: + description: Simple JSON containing the greeting + content: + application/json: + schema: + $ref: '#/components/schemas/GreetingMessage' +components: + schemas: + GreetingMessage: + properties: + message: + type: string + GreetingUpdateMessage: + properties: + greeting: + type: string diff --git a/examples/cors/src/main/resources/application.yaml b/examples/cors/src/main/resources/application.yaml new file mode 100644 index 00000000..dc4b4102 --- /dev/null +++ b/examples/cors/src/main/resources/application.yaml @@ -0,0 +1,34 @@ +# +# Copyright (c) 2020, 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 + +restrictive-cors: + allow-origins: ["http://foo.com", "http://there.com"] + allow-methods: ["PUT", "DELETE"] + +# The the example app uses the following for overriding other settings. +#cors: +# paths: +# - path-pattern: /greeting +# allow-origins: ["http://foo.com", "http://there.com", "http://other.com"] +# allow-methods: ["PUT", "DELETE"] + diff --git a/examples/cors/src/main/resources/logging.properties b/examples/cors/src/main/resources/logging.properties new file mode 100644 index 00000000..57b07980 --- /dev/null +++ b/examples/cors/src/main/resources/logging.properties @@ -0,0 +1,30 @@ +# +# Copyright (c) 2020, 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.common.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 + +# Uncomment the following to see CORS-related decision-making +# io.helidon.webserver.cors.level=FINE diff --git a/examples/cors/src/test/java/io/helidon/examples/cors/MainTest.java b/examples/cors/src/test/java/io/helidon/examples/cors/MainTest.java new file mode 100644 index 00000000..62e4f0e2 --- /dev/null +++ b/examples/cors/src/test/java/io/helidon/examples/cors/MainTest.java @@ -0,0 +1,246 @@ +/* + * Copyright (c) 2020, 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.cors; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.TimeUnit; + +import javax.json.JsonObject; + +import io.helidon.common.http.Headers; +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientRequestBuilder; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.cors.CrossOriginConfig; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.MethodOrderer; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestMethodOrder; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.hasItem; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.collection.IsEmptyCollection.empty; + +@TestMethodOrder(MethodOrderer.OrderAnnotation.class) +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + + @BeforeAll + public static void start() throws Exception { + // the port is only available if the server started already! + // so we need to wait + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + + long timeout = 2000; // 2 seconds should be enough to start the server + long now = System.currentTimeMillis(); + + while (!webServer.isRunning()) { + Thread.sleep(100); + if ((System.currentTimeMillis() - now) > timeout) { + Assertions.fail("Failed to start webserver"); + } + } + } + + @AfterAll + public static void stop() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Order(1) // Make sure this runs before the greeting message changes so responses are deterministic. + @Test + public void testHelloWorld() { + + WebClientResponse r = getResponse("/greet"); + + assertThat("HTTP response1", r.status().code(), is(200)); + assertThat("default message", fromPayload(r).getMessage(), + is("Hello World!")); + + r = getResponse("/greet/Joe"); + assertThat("HTTP response2", r.status().code(), is(200)); + assertThat("hello Joe message", fromPayload(r).getMessage(), + is("Hello Joe!")); + + r = putResponse("/greet/greeting", new GreetingMessage("Hola")); + assertThat("HTTP response3", r.status().code(), is(204)); + + r = getResponse("/greet/Jose"); + assertThat( "HTTP response4", r.status().code(), is(200)); + assertThat("hola Jose message", fromPayload(r).getMessage(), + is("Hola Jose!")); + + r = getResponse("/health"); + assertThat("HTTP response2", r.status().code(), is(200)); + + r = getResponse("/metrics"); + assertThat( "HTTP response2", r.status().code(), is(200)); + } + + @Order(10) // Run after the non-CORS tests (so the greeting is Hola) but before the CORS test that changes the greeting again. + @Test + void testAnonymousGreetWithCors() { + WebClientRequestBuilder builder = webClient.get(); + Headers headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + + WebClientResponse r = getResponse("/greet", builder); + assertThat("HTTP response", r.status().code(), is(200)); + String payload = fromPayload(r).getMessage(); + assertThat("HTTP response payload was " + payload, payload, containsString("Hola World")); + headers = r.headers(); + Optional allowOrigin = headers.value(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("Expected CORS header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN + " is absent", + allowOrigin.isPresent(), is(true)); + assertThat(allowOrigin.get(), is("*")); + } + + @Order(11) // Run after the non-CORS tests but before other CORS tests. + @Test + void testGreetingChangeWithCors() { + + // Send the pre-flight request and check the response. + + WebClientRequestBuilder builder = webClient.options(); + Headers headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + headers.add("Access-Control-Request-Method", "PUT"); + + WebClientResponse r = builder.path("/greet/greeting") + .submit() + .await(); + + Headers preflightResponseHeaders = r.headers(); + List allowMethods = preflightResponseHeaders.values(CrossOriginConfig.ACCESS_CONTROL_ALLOW_METHODS); + assertThat("pre-flight response does not include " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_METHODS, + allowMethods, not(empty())); + assertThat(allowMethods, hasItem("PUT")); + List allowOrigins = preflightResponseHeaders.values(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("pre-flight response does not include " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN, + allowOrigins, not(empty())); + assertThat("Header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN + + " should contain '*' but does not; " + allowOrigins, + allowOrigins, hasItem("http://foo.com")); + + // Send the follow-up request. + + builder = webClient.put(); + headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + headers.addAll(preflightResponseHeaders); + + r = putResponse("/greet/greeting", new GreetingMessage("Cheers"), builder); + assertThat("HTTP response3", r.status().code(), is(204)); + headers = r.headers(); + allowOrigins = headers.values(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("Expected CORS header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN + " has no value(s)", + allowOrigins, not(empty())); + assertThat("Header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN + + " should contain '*' but does not; " + allowOrigins, + allowOrigins, hasItem("http://foo.com")); + } + + @Order(12) // Run after CORS test changes greeting to Cheers. + @Test + void testNamedGreetWithCors() { + WebClientRequestBuilder builder = webClient.get(); + Headers headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + + WebClientResponse r = getResponse("/greet/Maria", builder); + assertThat("HTTP response", r.status().code(), is(200)); + assertThat(fromPayload(r).getMessage(), containsString("Cheers Maria")); + headers = r.headers(); + Optional allowOrigin = headers.value(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("Expected CORS header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN + " is absent", + allowOrigin.isPresent(), is(true)); + assertThat(allowOrigin.get(), is("*")); + } + + @Order(100) // After all other tests so we can rely on deterministic greetings. + @Test + void testGreetingChangeWithCorsAndOtherOrigin() { + WebClientRequestBuilder builder = webClient.put(); + Headers headers = builder.headers(); + headers.add("Origin", "http://other.com"); + headers.add("Host", "here.com"); + + WebClientResponse r = putResponse("/greet/greeting", new GreetingMessage("Ahoy"), builder); + // Result depends on whether we are using overrides or not. + boolean isOverriding = Config.create().get("cors").exists(); + assertThat("HTTP response3", r.status().code(), is(isOverriding ? 204 : 403)); + } + + private static WebClientResponse getResponse(String path) { + return getResponse(path, webClient.get()); + } + + private static WebClientResponse getResponse(String path, WebClientRequestBuilder builder) { + return builder + .accept(MediaType.APPLICATION_JSON) + .path(path) + .submit() + .await(); + } + + private static WebClientResponse putResponse(String path, GreetingMessage payload) { + return putResponse(path, payload, webClient.put()); + } + + private static WebClientResponse putResponse(String path, GreetingMessage payload, WebClientRequestBuilder builder) { + return builder + .accept(MediaType.APPLICATION_JSON) + .path(path) + .submit(payload.forRest()) + .await(); + } + + private static GreetingMessage fromPayload(WebClientResponse response) { + JsonObject json = response + .content() + .as(JsonObject.class) + .await(); + + return GreetingMessage.fromRest(json); + } +} diff --git a/examples/dbclient/README.md b/examples/dbclient/README.md new file mode 100644 index 00000000..8dbf2d25 --- /dev/null +++ b/examples/dbclient/README.md @@ -0,0 +1,14 @@ +# Helidon DB Client Examples + +Each subdirectory contains example code that highlights specific aspects of +Helidon DB Client. + +build examples in all folders (including the common folder) by +```shell +mvn package +``` +in the current folder. + +--- + +Pokémon, and Pokémon character names are trademarks of Nintendo. diff --git a/examples/dbclient/common/README.md b/examples/dbclient/common/README.md new file mode 100644 index 00000000..bc79a50a --- /dev/null +++ b/examples/dbclient/common/README.md @@ -0,0 +1,22 @@ +# Common library for the DB Client examples + +shall be built using + +```shell + +mvn install + +``` + +to be accessible for the DB Client examples + +or make the whole pack of DB Client examples at the level above by + +```shell + +cd ../ +mvn package + +``` + +and get all DB Client examples compiled at once. \ No newline at end of file diff --git a/examples/dbclient/common/pom.xml b/examples/dbclient/common/pom.xml new file mode 100644 index 00000000..ef7242a7 --- /dev/null +++ b/examples/dbclient/common/pom.xml @@ -0,0 +1,45 @@ + + + + + 4.0.0 + + io.helidon.examples.dbclient + helidon-examples-dbclient-project + 1.0.0-SNAPSHOT + + + helidon-examples-dbclient-common + Helidon Examples DB Client Common + + + + io.helidon.dbclient + helidon-dbclient + + + io.helidon.webserver + helidon-webserver + + + io.helidon.media + helidon-media-jsonp + + + diff --git a/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/AbstractPokemonService.java b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/AbstractPokemonService.java new file mode 100644 index 00000000..cbd7fffb --- /dev/null +++ b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/AbstractPokemonService.java @@ -0,0 +1,240 @@ +/* + * Copyright (c) 2019, 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.dbclient.common; + +import java.util.concurrent.CompletionException; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.common.reactive.Multi; +import io.helidon.common.reactive.Single; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.DbRow; +import io.helidon.webserver.Handler; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Common methods that do not differ between JDBC and MongoDB. + */ +public abstract class AbstractPokemonService implements Service { + private static final Logger LOGGER = Logger.getLogger(AbstractPokemonService.class.getName()); + + private final DbClient dbClient; + + /** + * Create a new pokemon service with a DB client. + * + * @param dbClient DB client to use for database operations + */ + protected AbstractPokemonService(DbClient dbClient) { + this.dbClient = dbClient; + } + + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::listPokemons) + // create new + .put("/", Handler.create(Pokemon.class, this::insertPokemon)) + // update existing + .post("/{name}/type/{type}", this::insertPokemonSimple) + // delete all + .delete("/", this::deleteAllPokemons) + // get one + .get("/{name}", this::getPokemon) + // delete one + .delete("/{name}", this::deletePokemon) + // example of transactional API (local transaction only!) + .put("/transactional", Handler.create(Pokemon.class, this::transactional)) + // update one (TODO this is intentionally wrong - should use JSON request, just to make it simple we use path) + .put("/{name}/type/{type}", this::updatePokemonType); + } + + /** + * The DB client associated with this service. + * + * @return DB client instance + */ + protected DbClient dbClient() { + return dbClient; + } + + /** + * This method is left unimplemented to show differences between native statements that can be used. + * + * @param request Server request + * @param response Server response + */ + protected abstract void deleteAllPokemons(ServerRequest request, ServerResponse response); + + /** + * Insert new pokemon with specified name. + * + * @param request the server request + * @param response the server response + */ + private void insertPokemon(ServerRequest request, ServerResponse response, Pokemon pokemon) { + dbClient.execute(exec -> exec + .createNamedInsert("insert2") + .namedParam(pokemon) + .execute()) + .thenAccept(count -> response.send("Inserted: " + count + " values")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Insert new pokemon with specified name. + * + * @param request the server request + * @param response the server response + */ + private void insertPokemonSimple(ServerRequest request, ServerResponse response) { + // Test Pokemon POJO mapper + Pokemon pokemon = new Pokemon(request.path().param("name"), request.path().param("type")); + + dbClient.execute(exec -> exec + .createNamedInsert("insert2") + .namedParam(pokemon) + .execute()) + .thenAccept(count -> response.send("Inserted: " + count + " values")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Get a single pokemon by name. + * + * @param request server request + * @param response server response + */ + private void getPokemon(ServerRequest request, ServerResponse response) { + String pokemonName = request.path().param("name"); + + dbClient.execute(exec -> exec.namedGet("select-one", pokemonName)) + .thenAccept(opt -> opt.ifPresentOrElse(it -> sendRow(it, response), + () -> sendNotFound(response, "Pokemon " + + pokemonName + + " not found"))) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Return JsonArray with all stored pokemons or pokemons with matching attributes. + * + * @param request the server request + * @param response the server response + */ + private void listPokemons(ServerRequest request, ServerResponse response) { + Multi rows = dbClient.execute(exec -> exec.namedQuery("select-all")) + .map(it -> it.as(JsonObject.class)); + + response.send(rows, JsonObject.class); + } + + /** + * Update a pokemon. + * Uses a transaction. + * + * @param request the server request + * @param response the server response + */ + private void updatePokemonType(ServerRequest request, ServerResponse response) { + final String name = request.path().param("name"); + final String type = request.path().param("type"); + + dbClient.execute(exec -> exec + .createNamedUpdate("update") + .addParam("name", name) + .addParam("type", type) + .execute()) + .thenAccept(count -> response.send("Updated: " + count + " values")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + private void transactional(ServerRequest request, ServerResponse response, Pokemon pokemon) { + + dbClient.inTransaction(tx -> tx + .createNamedGet("select-for-update") + .namedParam(pokemon) + .execute() + .flatMapSingle(maybeRow -> maybeRow.map(dbRow -> tx.createNamedUpdate("update") + .namedParam(pokemon).execute()) + .orElseGet(() -> Single.just(0L))) + ).thenAccept(count -> response.send("Updated " + count + " records")); + + } + + /** + * Delete pokemon with specified name (key). + * + * @param request the server request + * @param response the server response + */ + private void deletePokemon(ServerRequest request, ServerResponse response) { + final String name = request.path().param("name"); + + dbClient.execute(exec -> exec.namedDelete("delete", name)) + .thenAccept(count -> response.send("Deleted: " + count + " values")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Send a 404 status code. + * + * @param response the server response + * @param message entity content + */ + protected void sendNotFound(ServerResponse response, String message) { + response.status(Http.Status.NOT_FOUND_404); + response.send(message); + } + + /** + * Send a single DB row as JSON object. + * + * @param row row as read from the database + * @param response server response + */ + protected void sendRow(DbRow row, ServerResponse response) { + response.send(row.as(JsonObject.class)); + } + + /** + * Send a 500 response code and a few details. + * + * @param throwable throwable that caused the issue + * @param response server response + * @param type of expected response, will be always {@code null} + * @return {@code Void} so this method can be registered as a lambda + * with {@link java.util.concurrent.CompletionStage#exceptionally(java.util.function.Function)} + */ + protected T sendError(Throwable throwable, ServerResponse response) { + Throwable realCause = throwable; + if (throwable instanceof CompletionException) { + realCause = throwable.getCause(); + } + response.status(Http.Status.INTERNAL_SERVER_ERROR_500); + response.send("Failed to process request: " + realCause.getClass().getName() + "(" + realCause.getMessage() + ")"); + LOGGER.log(Level.WARNING, "Failed to process request", throwable); + return null; + } + +} diff --git a/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/Pokemon.java b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/Pokemon.java new file mode 100644 index 00000000..39382258 --- /dev/null +++ b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/Pokemon.java @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2019, 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.dbclient.common; + +import io.helidon.common.Reflected; + +/** + * POJO representing a very simplified Pokemon. + */ +@Reflected +public class Pokemon { + private String name; + private String type; + + /** + * Default constructor. + */ + public Pokemon() { + // JSON-B + } + + /** + * Create pokemon with name and type. + * + * @param name name of the beast + * @param type type of the beast + */ + public Pokemon(String name, String type) { + this.name = name; + this.type = type; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } +} diff --git a/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/PokemonMapper.java b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/PokemonMapper.java new file mode 100644 index 00000000..9ac55a12 --- /dev/null +++ b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/PokemonMapper.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2019, 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.dbclient.common; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import io.helidon.dbclient.DbColumn; +import io.helidon.dbclient.DbMapper; +import io.helidon.dbclient.DbRow; + +/** + * Maps database statements to {@link io.helidon.examples.dbclient.common.Pokemon} class. + */ +public class PokemonMapper implements DbMapper { + + @Override + public Pokemon read(DbRow row) { + DbColumn name = row.column("name"); + // we know that in mongo this is not true + if (null == name) { + name = row.column("_id"); + } + + DbColumn type = row.column("type"); + return new Pokemon(name.as(String.class), type.as(String.class)); + } + + @Override + public Map toNamedParameters(Pokemon value) { + Map map = new HashMap<>(1); + map.put("name", value.getName()); + map.put("type", value.getType()); + return map; + } + + @Override + public List toIndexedParameters(Pokemon value) { + List list = new ArrayList<>(2); + list.add(value.getName()); + list.add(value.getType()); + return list; + } +} diff --git a/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/PokemonMapperProvider.java b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/PokemonMapperProvider.java new file mode 100644 index 00000000..fe613392 --- /dev/null +++ b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/PokemonMapperProvider.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2019, 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.dbclient.common; + +import java.util.Optional; + +import javax.annotation.Priority; + +import io.helidon.dbclient.DbMapper; +import io.helidon.dbclient.spi.DbMapperProvider; + +/** + * Provides pokemon mappers. + */ +@Priority(1000) +public class PokemonMapperProvider implements DbMapperProvider { + private static final PokemonMapper MAPPER = new PokemonMapper(); + + @SuppressWarnings("unchecked") + @Override + public Optional> mapper(Class type) { + if (type.equals(Pokemon.class)) { + return Optional.of((DbMapper) MAPPER); + } + return Optional.empty(); + } +} diff --git a/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/package-info.java b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/package-info.java new file mode 100644 index 00000000..78d7f668 --- /dev/null +++ b/examples/dbclient/common/src/main/java/io/helidon/examples/dbclient/common/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2019, 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. + */ +/** + * Common classes shared by JDBC and MongoDB examples. + */ +package io.helidon.examples.dbclient.common; diff --git a/examples/dbclient/common/src/main/resources/META-INF/services/io.helidon.dbclient.spi.DbMapperProvider b/examples/dbclient/common/src/main/resources/META-INF/services/io.helidon.dbclient.spi.DbMapperProvider new file mode 100644 index 00000000..b2927909 --- /dev/null +++ b/examples/dbclient/common/src/main/resources/META-INF/services/io.helidon.dbclient.spi.DbMapperProvider @@ -0,0 +1,17 @@ +# +# Copyright (c) 2019, 2021 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. +# + +io.helidon.examples.dbclient.common.PokemonMapperProvider diff --git a/examples/dbclient/jdbc/README.md b/examples/dbclient/jdbc/README.md new file mode 100644 index 00000000..00e4f311 --- /dev/null +++ b/examples/dbclient/jdbc/README.md @@ -0,0 +1,82 @@ +# Helidon DB Client JDBC Example + +This example shows how to run Helidon DB Client over JDBC. + +Examples are given for H2, Oracle, or MySQL databases (note that MySQL is currently not supported for GraalVM native image) + +Uncomment the appropriate dependencies in the pom.xml for the desired database (H2, Oracle, or MySQL) and insure others are commented. + +Uncomment the appropriate configuration in the application.xml for the desired database (H2, Oracle, or MySQL) and insure others are commented. + +## Build + +```shell +mvn package +``` + +This example may also be run as a GraalVM native image in which case can be built using the following: + +```shell +mvn package -Pnative-image +``` + + +## Run + +This example requires a database. + +Instructions for H2 can be found here: http://www.h2database.com/html/cheatSheet.html + +Instructions for Oracle can be found here: https://github.com/oracle/docker-images/tree/master/OracleDatabase/SingleInstance + +MySQL can be run as a docker container with the following command: + +``` +docker run --rm --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=pokemon -e MYSQL_USER=user -e MYSQL_PASSWORD=changeit mysql:5.7 +``` + + +Then run the application: + +```shell +java -jar target/helidon-examples-dbclient-jdbc.jar +``` +or in the case of native image +```shell +./target/helidon-examples-dbclient-jdbc +``` + +## Exercise + +The application has the following endpoints: + +- http://localhost:8079/db - the main business endpoint (see `curl` commands below) +- http://localhost:8079/metrics - the metrics endpoint (query adds application metrics) +- http://localhost:8079/health - has a custom database health check + +Application also connects to zipkin on default address. +The query operation adds database trace. + +`curl` commands: + +```shell +# - list all Pokemon in the database + +curl http://localhost:8079/db +``` +```shell +# - add a new pokemon + +curl -i -X PUT -d '{"name":"Squirtle","type":"water"}' http://localhost:8079/db +``` +```shell +# - get a single pokemon + +curl http://localhost:8079/db/Squirtle +``` + +The application also supports update and delete - see `PokemonService.java` for bound endpoints. + +--- + +Pokémon, and Pokémon character names are trademarks of Nintendo. diff --git a/examples/dbclient/jdbc/pom.xml b/examples/dbclient/jdbc/pom.xml new file mode 100644 index 00000000..000aab7b --- /dev/null +++ b/examples/dbclient/jdbc/pom.xml @@ -0,0 +1,134 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.dbclient + helidon-examples-dbclient-jdbc + 1.0.0-SNAPSHOT + Helidon Examples DB Client JDBC + + + io.helidon.examples.dbclient.jdbc.JdbcExampleMain + + + + + io.helidon.health + helidon-health + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.tracing + helidon-tracing + + + io.helidon.tracing + helidon-tracing-zipkin + + + io.helidon.dbclient + helidon-dbclient-jdbc + + + io.helidon.dbclient + helidon-dbclient-tracing + + + io.helidon.dbclient + helidon-dbclient-metrics + + + io.helidon.dbclient + helidon-dbclient-metrics-jdbc + + + io.helidon.dbclient + helidon-dbclient-health + + + io.helidon.dbclient + helidon-dbclient-jsonp + + + + + + io.helidon.integrations.db + ojdbc + + + + org.slf4j + slf4j-jdk14 + + + io.helidon.media + helidon-media-jsonb + + + io.helidon.config + helidon-config-yaml + + + io.helidon.examples.dbclient + helidon-examples-dbclient-common + ${project.version} + + + io.helidon.metrics + helidon-metrics + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/JdbcExampleMain.java b/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/JdbcExampleMain.java new file mode 100644 index 00000000..7f007b1a --- /dev/null +++ b/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/JdbcExampleMain.java @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2019, 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.dbclient.jdbc; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.health.DbClientHealthCheck; +import io.helidon.health.HealthSupport; +import io.helidon.media.jsonb.JsonbSupport; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Simple Hello World rest application. + */ +public final class JdbcExampleMain { + + /** + * Cannot be instantiated. + */ + private JdbcExampleMain() { + } + + /** + * Application main entry point. + * + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * + * @return the created {@link io.helidon.webserver.WebServer} instance + */ + static WebServer startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // Prepare routing for the server + WebServer server = WebServer.builder() + .routing(createRouting(config)) + // Get webserver config from the "server" section of application.yaml + .config(config.get("server")) + .tracer(TracerBuilder.create(config.get("tracing"))) + .addMediaSupport(JsonpSupport.create()) + .addMediaSupport(JsonbSupport.create()) + .build(); + + // Start the server and print some info. + server.start().thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/"); + }); + + // Server threads are not daemon. NO need to block. Just react. + server.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + + return server; + } + + /** + * Creates new {@link io.helidon.webserver.Routing}. + * + * @param config configuration of this server + * @return routing configured with JSON support, a health check, and a service + */ + private static Routing createRouting(Config config) { + Config dbConfig = config.get("db"); + + // Client services are added through a service loader - see mongoDB example for explicit services + DbClient dbClient = DbClient.builder(dbConfig) + .build(); + + // Some relational databases do not support DML statement as ping so using query which works for all of them + HealthSupport health = HealthSupport.builder() + .addLiveness( + DbClientHealthCheck.create(dbClient, dbConfig.get("health-check"))) + .build(); + + return Routing.builder() + .register(health) // Health at "/health" + .register(MetricsSupport.create()) // Metrics at "/metrics" + .register("/db", new PokemonService(dbClient)) + .build(); + } +} diff --git a/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/PokemonService.java b/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/PokemonService.java new file mode 100644 index 00000000..51283494 --- /dev/null +++ b/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/PokemonService.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2019, 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.dbclient.jdbc; + +import java.util.logging.Level; +import java.util.logging.Logger; + +import io.helidon.dbclient.DbClient; +import io.helidon.examples.dbclient.common.AbstractPokemonService; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; + +/** + * Example service using a database. + */ +public class PokemonService extends AbstractPokemonService { + private static final Logger LOGGER = Logger.getLogger(PokemonService.class.getName()); + + PokemonService(DbClient dbClient) { + super(dbClient); + + // dirty hack to prepare database for our POC + // MySQL init + dbClient.execute(handle -> handle.namedDml("create-table")) + .thenAccept(System.out::println) + .exceptionally(throwable -> { + LOGGER.log(Level.WARNING, "Failed to create table, maybe it already exists?", throwable); + return null; + }); + } + + /** + * Delete all pokemons. + * + * @param request the server request + * @param response the server response + */ + @Override + protected void deleteAllPokemons(ServerRequest request, ServerResponse response) { + dbClient().execute(exec -> exec + // this is to show how ad-hoc statements can be executed (and their naming in Tracing and Metrics) + .createDelete("DELETE FROM pokemons") + .execute()) + .thenAccept(count -> response.send("Deleted: " + count + " values")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + + + + +} diff --git a/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/package-info.java b/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/package-info.java new file mode 100644 index 00000000..f54ce8e1 --- /dev/null +++ b/examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Quick start demo application. + */ +package io.helidon.examples.dbclient.jdbc; diff --git a/examples/dbclient/jdbc/src/main/resources/application.yaml b/examples/dbclient/jdbc/src/main/resources/application.yaml new file mode 100644 index 00000000..78ea8605 --- /dev/null +++ b/examples/dbclient/jdbc/src/main/resources/application.yaml @@ -0,0 +1,108 @@ +# +# Copyright (c) 2019, 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. +# + +server: + port: 8079 + host: 0.0.0.0 + features: + print-details: true + +tracing: + service: jdbc-db + +db: + source: jdbc + connection: + # + # H2 configuration + # + # Embedded mode (does not work with native image) +# url: jdbc:h2:~/test + # Server mode, run: docker run --rm --name h2 -p 9092:9082 -p 8082:8082 nemerosa/h2 +# url: "jdbc:h2:tcp://localhost:9092/~test" +# username: sa +# password: +# poolName: h2 + # + # MySQL configuration + # + # docker run --rm --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root \ + # -e MYSQL_DATABASE=pokemon -e MYSQL_USER=user -e MYSQL_PASSWORD=changeit mysql:5.7 +# url: jdbc:mysql://127.0.0.1:3306/pokemon?useSSL=false +# username: user +# password: changeit +# poolName: mysql + # + # Oracle configuration + # + # docker run --rm --name xe -p 1521:1521 -p 8888:8080 -e ORACLE_PWD=oracle wnameless/oracle-xe-11g-r2 + url: jdbc:oracle:thin:@localhost:1521/XE + username: system + password: oracle + poolName: oracle + initializationFailTimeout: -1 + connectionTimeout: 2000 + helidon: + pool-metrics: + enabled: true + # name prefix defaults to "db.pool." - if you have more than one client within a JVM, you may want to distinguish between them + name-prefix: "hikari." + health-check: + type: "query" + statementName: "health-check" + services: + tracing: + # would trace all statement names that start with select- + - statement-names: ["select-.*"] + # would trace all delete statements + - statement-types: ["DELETE"] + metrics: + - type: METER + name-format: "db.meter.overall" + - type: METER + # meter per statement name (default name format) + - type: METER + # meter per statement type + name-format: "db.meter.%1$s" + - type: TIMER + errors: false + statement-names: ["select-.*"] + description: "Timer for successful selects" + - type: COUNTER + errors: false + statement-types: ["DELETE", "UPDATE", "INSERT", "DML"] + name-format: "db.counter.%s.success" + description: "Counter of successful DML statements" + - type: COUNTER + statement-types: ["DELETE", "UPDATE", "INSERT", "DML"] + success: false + name-format: "db.counter.%s.error" + description: "Counter of failed DML statements" + statements: + # Health check query statement for MySQL and H2 databases +# health-check: "SELECT 0" + # Health check query statement for Oracle database + health-check: "SELECT 1 FROM DUAL" + # Insert new pokemon + create-table: "CREATE TABLE pokemons (name VARCHAR(64) NOT NULL PRIMARY KEY, type VARCHAR(32))" + insert1: "INSERT INTO pokemons VALUES(?, ?)" + insert2: "INSERT INTO pokemons VALUES(:name, :type)" + select-by-type: "SELECT * FROM pokemons WHERE type = ?" + select-one: "SELECT * FROM pokemons WHERE name = ?" + select-all: "SELECT * FROM pokemons" + select-for-update: "SELECT * FROM pokemons WHERE name = :name for UPDATE" + update: "UPDATE pokemons SET type = :type WHERE name = :name" + delete: "DELETE FROM pokemons WHERE name = ?" diff --git a/examples/dbclient/jdbc/src/main/resources/logging.properties b/examples/dbclient/jdbc/src/main/resources/logging.properties new file mode 100644 index 00000000..bdbfedcb --- /dev/null +++ b/examples/dbclient/jdbc/src/main/resources/logging.properties @@ -0,0 +1,36 @@ +# +# Copyright (c) 2019, 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.common.HelidonConsoleHandler + +# Global default logging level. Can be overriden by specific handlers and loggers +.level=INFO + +# Helidon Web Server has a custom log formatter that extends SimpleFormatter. +# It replaces "!thread!" with the current thread name +io.helidon.common.HelidonConsoleHandler.level=ALL +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 + +#Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/dbclient/mongodb/README.md b/examples/dbclient/mongodb/README.md new file mode 100644 index 00000000..83f37495 --- /dev/null +++ b/examples/dbclient/mongodb/README.md @@ -0,0 +1,70 @@ +# Helidon DB Client mongoDB Example + +This example shows how to run Helidon DB over mongoDB. + + +## Build + +```shell +mvn package +``` + +## Run + +This example requires a mongoDB database, start it using docker: + +```shell +docker run --rm --name mongo -p 27017:27017 mongo +``` + +Then run the application: + +```shell +java -jar target/helidon-examples-dbclient-mongodb.jar +``` + + +## Exercise + +The application has the following endpoints: + +- http://localhost:8079/db - the main business endpoint (see `curl` commands below) +- http://localhost:8079/metrics - the metrics endpoint (query adds application metrics) +- http://localhost:8079/health - has a custom database health check + +Application also connects to zipkin on default address. +The query operation adds database trace. + +`curl` commands: + +```shell +# - list all Pokemon in the database + +curl http://localhost:8079/db +``` +```shell +# - add a new pokemon + +curl -i -X PUT -d '{"name":"Squirtle","type":"water"}' http://localhost:8079/db +``` +```shell +# - get a single pokemon + +curl http://localhost:8079/db/Squirtle +``` +```shell +# - delete a single pokemon + +curl -i -X DELETE http://localhost:8079/db/Squirtle +``` +```shell +# - delete all pokemon + +curl -i -X DELETE http://localhost:8079/db +``` + +The application also supports update and delete - see `PokemonService.java` for bound endpoints. + +--- + +Pokémon, and Pokémon character names are trademarks of Nintendo. diff --git a/examples/dbclient/mongodb/pom.xml b/examples/dbclient/mongodb/pom.xml new file mode 100644 index 00000000..4eb88956 --- /dev/null +++ b/examples/dbclient/mongodb/pom.xml @@ -0,0 +1,117 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.dbclient + helidon-examples-dbclient-mongodb + 1.0.0-SNAPSHOT + Helidon Examples DB Client MongoDB + + + io.helidon.examples.dbclient.mongo.MongoDbExampleMain + + + + + io.helidon.common + helidon-common + + + io.helidon.common + helidon-common-mapper + + + io.helidon.dbclient + helidon-dbclient-mongodb + + + io.helidon.dbclient + helidon-dbclient-tracing + + + io.helidon.dbclient + helidon-dbclient-metrics + + + io.helidon.dbclient + helidon-dbclient-health + + + io.helidon.dbclient + helidon-dbclient-jsonp + + + io.helidon.health + helidon-health + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.tracing + helidon-tracing + + + io.helidon.tracing + helidon-tracing-zipkin + + + io.helidon.media + helidon-media-jsonb + + + io.helidon.config + helidon-config-yaml + + + io.helidon.examples.dbclient + helidon-examples-dbclient-common + ${project.version} + + + io.helidon.metrics + helidon-metrics + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/MongoDbExampleMain.java b/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/MongoDbExampleMain.java new file mode 100644 index 00000000..79eb38f3 --- /dev/null +++ b/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/MongoDbExampleMain.java @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2019, 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.dbclient.mongo; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.DbStatementType; +import io.helidon.dbclient.health.DbClientHealthCheck; +import io.helidon.dbclient.metrics.DbClientMetrics; +import io.helidon.dbclient.tracing.DbClientTracing; +import io.helidon.health.HealthSupport; +import io.helidon.media.jsonb.JsonbSupport; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Simple Hello World rest application. + */ +public final class MongoDbExampleMain { + + /** + * Cannot be instantiated. + */ + private MongoDbExampleMain() { + } + + /** + * Application main entry point. + * + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * + * @return the created {@link io.helidon.webserver.WebServer} instance + */ + static WebServer startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .tracer(TracerBuilder.create("mongo-db").build()) + .addMediaSupport(JsonpSupport.create()) + .addMediaSupport(JsonbSupport.create()) + .build(); + + // Start the server and print some info. + server.start().thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/"); + }); + + // Server threads are not daemon. NO need to block. Just react. + server.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + + return server; + } + + /** + * Creates new {@link io.helidon.webserver.Routing}. + * + * @param config configuration of this server + * @return routing configured with JSON support, a health check, and a service + */ + private static Routing createRouting(Config config) { + Config dbConfig = config.get("db"); + + DbClient dbClient = DbClient.builder(dbConfig) + // add an interceptor to named statement(s) + .addService(DbClientMetrics.counter().statementNames("select-all", "select-one")) + // add an interceptor to statement type(s) + .addService(DbClientMetrics.timer() + .statementTypes(DbStatementType.DELETE, DbStatementType.UPDATE, DbStatementType.INSERT)) + // add an interceptor to all statements + .addService(DbClientTracing.create()) + .build(); + + HealthSupport health = HealthSupport.builder() + .addLiveness( + DbClientHealthCheck.create(dbClient, dbConfig.get("health-check"))) + .build(); + + return Routing.builder() + .register(health) // Health at "/health" + .register(MetricsSupport.create()) // Metrics at "/metrics" + .register("/db", new PokemonService(dbClient)) + .build(); + } + + private static IllegalStateException noConfigError(String key) { + return new IllegalStateException("Attempting to create a Pokemon service with no configuration" + + ", config key: " + key); + } + +} diff --git a/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/PokemonService.java b/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/PokemonService.java new file mode 100644 index 00000000..0b0abbd3 --- /dev/null +++ b/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/PokemonService.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2019, 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.dbclient.mongo; + +import io.helidon.dbclient.DbClient; +import io.helidon.examples.dbclient.common.AbstractPokemonService; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT http://localhost:8080/greet/greeting/Hola + * + * The message is returned as a JSON object + */ + +public class PokemonService extends AbstractPokemonService { + + PokemonService(DbClient dbClient) { + super(dbClient); + } + + /** + * Delete all pokemons. + * + * @param request the server request + * @param response the server response + */ + @Override + protected void deleteAllPokemons(ServerRequest request, ServerResponse response) { + dbClient().execute(exec -> exec + .createNamedDelete("delete-all") + .execute()) + .thenAccept(count -> response.send("Deleted: " + count + " values")) + .exceptionally(throwable -> sendError(throwable, response)); + } +} diff --git a/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/package-info.java b/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/package-info.java new file mode 100644 index 00000000..699f9ba3 --- /dev/null +++ b/examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Quick start demo application. + */ +package io.helidon.examples.dbclient.mongo; diff --git a/examples/dbclient/mongodb/src/main/resources/application.yaml b/examples/dbclient/mongodb/src/main/resources/application.yaml new file mode 100644 index 00000000..09658cbd --- /dev/null +++ b/examples/dbclient/mongodb/src/main/resources/application.yaml @@ -0,0 +1,75 @@ +# +# Copyright (c) 2019, 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. +# + +server: + port: 8079 + host: 0.0.0.0 + features: + print-details: true + +# docker run --rm --name mongo -p 27017:27017 mongo +db: + source: "mongoDb" + connection: + url: "mongodb://127.0.0.1:27017/pokemon" + health-check: + type: "query" + statementName: "health-check" + statements: + # Health check statement. HealthCheck statement type must be query. + health-check: '{ + "operation": "command", + "query": { ping: 1 } + }' + # Insert operation contains collection name, operation type and data to be inserted. + # Name variable is stored as MongoDB primary key attribute _id + insert2: '{ + "collection": "pokemons", + "value": { + "_id": $name, + "type": $type + } + }' + select-all: '{ + "collection": "pokemons", + "query": {} + }' + select-one: '{ + "collection": "pokemons", + "query": { + "_id": ? + } + }' + delete-all: '{ + "collection": "pokemons", + "operation": "delete" + }' + update: '{ + "collection": "pokemons", + "query": { + "_id": $name + }, + "value": { + $set: { "type": $type } + } + }' + delete: '{ + "collection": "pokemons", + "query": { + "_id": ? + } + }' + diff --git a/examples/dbclient/mongodb/src/main/resources/logging.properties b/examples/dbclient/mongodb/src/main/resources/logging.properties new file mode 100644 index 00000000..bdbfedcb --- /dev/null +++ b/examples/dbclient/mongodb/src/main/resources/logging.properties @@ -0,0 +1,36 @@ +# +# Copyright (c) 2019, 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.common.HelidonConsoleHandler + +# Global default logging level. Can be overriden by specific handlers and loggers +.level=INFO + +# Helidon Web Server has a custom log formatter that extends SimpleFormatter. +# It replaces "!thread!" with the current thread name +io.helidon.common.HelidonConsoleHandler.level=ALL +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 + +#Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/dbclient/pokemons/README.md b/examples/dbclient/pokemons/README.md new file mode 100644 index 00000000..ab2fc170 --- /dev/null +++ b/examples/dbclient/pokemons/README.md @@ -0,0 +1,155 @@ +# Helidon DB Client Pokemon Example with JDBC + +This example shows how to run Helidon DB Client over JDBC. + +Application provides REST service endpoint with CRUD operations on Pokemnons +database. + +## Database + +Database model contains two tables: + +**Types** + +| Column | Type | Integrity | +|--------|---------|-------------| +| id | integer | Primary key | +| name | varchar |   | + +**Pokemons** + +| Column | Type | Integrity | +|---------|---------|-------------| +| id | integer | Primary key | +| name | varchar |   | +| id_type | integer | Type(id) | + +with 1:N relationship between *Types* and *Pokemons* + +Examples are given for H2, Oracle, or MySQL databases (note that MySQL is currently not supported for GraalVM native image) + +To switch between JDBC drivers: + +- Uncomment the appropriate dependency in `pom.xml` +- Uncomment the configuration section in `application.yaml` and comment out the current one + +## Build + +To build a jar file +```shell +mvn package +``` + +To build a native image (supported only with Oracle, MongoDB, or H2 databases) +```shell +mvn package -Pnative-image +``` + +## Database +This example can run with any JDBC supported database. +In the `pom.xml` and `application.yaml` we provide configuration needed for Oracle database, MySQL and H2 database. +Start your database before running this example. + +Example docker commands to start databases in temporary containers: + +Oracle: +```shell +docker run --rm --name xe -p 1521:1521 -p 8888:8080 wnameless/oracle-xe-11g-r2 +``` +For details on an Oracle Docker image, see https://github.com/oracle/docker-images/tree/master/OracleDatabase/SingleInstance + +H2: +```shell +docker run --rm --name h2 -p 9092:9082 -p 8082:8082 nemerosa/h2 +``` +For details, see http://www.h2database.com/html/cheatSheet.html + +MySQL: +```shell +docker run --rm --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root \ + -e MYSQL_DATABASE=pokemon -e MYSQL_USER=user -e MYSQL_PASSWORD=changeit mysql:5.7 +``` + + +## Run + +Then run the `io.helidon.examples.dbclient.pokemons.PokemonMain` class: +```shell +java -jar target/helidon-examples-dbclient-pokemons.jar +``` + +Or run the native image: +```shell +./target/helidon-examples-dbclient-pokemons +``` + +### Run with MongoDB + +It's possible to run example with MongoDB database. Start it using docker: +```shell +docker run --rm --name mongo -p 27017:27017 mongo +``` + +Then run the `io.helidon.examples.dbclient.pokemons.PokemonMain` class with `mongo` argument: +```shell +java -jar target/helidon-examples-dbclient-pokemons.jar mongo +``` + +## Test Example + +The application has the following endpoints: + +- http://localhost:8079/db - the main business endpoint (see `curl` commands below) +- http://localhost:8079/metrics - the metrics endpoint (query adds application metrics) +- http://localhost:8079/health - has a custom database health check + +Application also connects to zipkin on default address. +The query operation adds database trace. + +`curl` commands: + +```shell +# - list all pokemons in the database + +curl http://localhost:8079/db/pokemon | json_pp +``` +```shell +# - list all pokemon types in the database + +curl http://localhost:8079/db/type | json_pp +``` +```shell +# - get a single pokemon by id + +curl http://localhost:8079/db/pokemon/2 | json_pp +``` +```shell +# - get a single pokemon by name + +curl http://localhost:8079/db/pokemon/name/Squirtle | json_pp +``` +```shell +# - add a new pokemon Rattata + +curl -i -X POST -d '{"id":7,"name":"Rattata","idType":1}' http://localhost:8079/db/pokemon +``` +```shell +# - rename pokemon with id 7 to Raticate +curl -i -X PUT -d '{"id":7,"name":"Raticate","idType":2}' http://localhost:8079/db/pokemon +``` +```shell +# - delete pokemon with id 7 + +curl -i -X DELETE http://localhost:8079/db/pokemon/7 +``` + +### Proxy + +Make sure that `localhost` is not being accessed trough proxy when proxy is configured on your system: +```shell +export NO_PROXY='localhost' +``` + +--- + +Pokémon, and Pokémon character names are trademarks of Nintendo. diff --git a/examples/dbclient/pokemons/pom.xml b/examples/dbclient/pokemons/pom.xml new file mode 100644 index 00000000..d11d7473 --- /dev/null +++ b/examples/dbclient/pokemons/pom.xml @@ -0,0 +1,141 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.dbclient + helidon-examples-dbclient-pokemons + 1.0.0-SNAPSHOT + Helidon Examples DB Client: Pokemons Database + + + io.helidon.examples.dbclient.pokemons.PokemonMain + jdbc + + + + + io.helidon.health + helidon-health + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.tracing + helidon-tracing + + + io.helidon.tracing + helidon-tracing-zipkin + + + io.helidon.dbclient + helidon-dbclient-jdbc + + + io.helidon.dbclient + helidon-dbclient-mongodb + + + io.helidon.dbclient + helidon-dbclient-tracing + + + io.helidon.dbclient + helidon-dbclient-metrics + + + io.helidon.dbclient + helidon-dbclient-metrics-jdbc + + + io.helidon.dbclient + helidon-dbclient-health + + + io.helidon.dbclient + helidon-dbclient-jsonp + + + io.helidon.integrations.db + ojdbc + + + + + org.slf4j + slf4j-jdk14 + + + io.helidon.webserver + helidon-webserver + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.media + helidon-media-jsonb + + + io.helidon.config + helidon-config-yaml + + + io.helidon.metrics + helidon-metrics + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/InitializeDb.java b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/InitializeDb.java new file mode 100644 index 00000000..012cccfe --- /dev/null +++ b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/InitializeDb.java @@ -0,0 +1,155 @@ +/* + * Copyright (c) 2019, 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.dbclient.pokemons; + +import io.helidon.common.reactive.Single; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.DbExecute; + +/** + * Initialize JDBC database schema and populate it with sample data. + */ +public class InitializeDb { + + /** Pokemon types source file. */ + private static final String TYPES = "/Types.json"; + /** Pokemons source file. */ + private static final String POKEMONS = "/Pokemons.json"; + + /** + * Initialize JDBC database schema and populate it with sample data. + * @param dbClient database client + */ + static void init(DbClient dbClient) { + try { + if (!PokemonMain.isMongo()) { + initSchema(dbClient); + } + initData(dbClient); + } catch (Exception ex) { + System.out.printf("Could not initialize database: %s\n", ex.getMessage()); + } + } + + /** + * Initializes database schema (tables). + * + * @param dbClient database client + */ + private static void initSchema(DbClient dbClient) { + try { + dbClient.execute(exec -> exec + .namedDml("create-types") + .flatMapSingle(result -> exec.namedDml("create-pokemons"))) + .await(); + } catch (Exception ex1) { + System.out.printf("Could not create tables: %s", ex1.getMessage()); + try { + deleteData(dbClient); + } catch (Exception ex2) { + System.out.printf("Could not delete tables: %s", ex2.getMessage()); + } + } + } + + /** + * InitializeDb database content (rows in tables). + * + * @param dbClient database client + */ + private static void initData(DbClient dbClient) { + // Init pokemon types + dbClient.execute(exec + -> initTypes(exec) + .flatMapSingle(count -> initPokemons(exec))) + .await(); + } + + /** + * Delete content of all tables. + * + * @param dbClient database client + */ + private static void deleteData(DbClient dbClient) { + dbClient.execute(exec -> exec + .namedDelete("delete-all-pokemons") + .flatMapSingle(count -> exec.namedDelete("delete-all-types"))) + .await(); + } + + /** + * Initialize pokemon types. + * Source data file is JSON file containing array of type objects: + *
+     * [
+     *   { "id": , "name":  },
+     *   ...
+     * ]
+     *
+ * where {@code id} is JSON number and {@ocde name} is JSON String. + * + * @param exec database client executor + * @return executed statements future + */ + private static Single initTypes(DbExecute exec) { + Single stage = Single.just(0L); + try (javax.json.JsonReader reader = javax.json.Json.createReader(InitializeDb.class.getResourceAsStream(TYPES))) { + javax.json.JsonArray types = reader.readArray(); + for (javax.json.JsonValue typeValue : types) { + javax.json.JsonObject type = typeValue.asJsonObject(); + stage = stage.flatMapSingle(it -> exec.namedInsert( + "insert-type", type.getInt("id"), type.getString("name"))); + } + } + return stage; + } + + /** + * Initialize pokemos. + * Source data file is JSON file containing array of type objects: + *
+     * [
+     *   { "id": , "name": , "type": [, , ...] },
+     *   ...
+     * ]
+     *
+ * where {@code id} is JSON number and {@ocde name} is JSON String. + * + * @param exec database client executor + * @return executed statements future + */ + private static Single initPokemons(DbExecute exec) { + Single stage = Single.just(0L); + try (javax.json.JsonReader reader = javax.json.Json.createReader(InitializeDb.class.getResourceAsStream(POKEMONS))) { + javax.json.JsonArray pokemons = reader.readArray(); + for (javax.json.JsonValue pokemonValue : pokemons) { + javax.json.JsonObject pokemon = pokemonValue.asJsonObject(); + stage = stage.flatMapSingle(result -> exec + .namedInsert("insert-pokemon", + pokemon.getInt("id"), pokemon.getString("name"), pokemon.getInt("idType"))); + } + } + return stage; + } + + /** + * Creates an instance of database initialization. + */ + private InitializeDb() { + throw new UnsupportedOperationException("Instances of InitializeDb utility class are not allowed"); + } + +} diff --git a/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/Pokemon.java b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/Pokemon.java new file mode 100644 index 00000000..8e3f01f2 --- /dev/null +++ b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/Pokemon.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2019, 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.dbclient.pokemons; + +import io.helidon.common.Reflected; + +/** + * POJO representing Pokemon. + */ +@Reflected +public class Pokemon { + private int id; + private String name; + private int idType; + + /** + * Default constructor. + */ + public Pokemon() { + // JSON-B + } + + /** + * Create pokemon with name and type. + * + * @param id id of the beast + * @param name name of the beast + * @param idType id of beast type + */ + public Pokemon(int id, String name, int idType) { + this.name = name; + this.idType = idType; + } + + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public int getIdType() { + return idType; + } + + public void setIdType(int idType) { + this.idType = idType; + } +} diff --git a/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMain.java b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMain.java new file mode 100644 index 00000000..72fc03d0 --- /dev/null +++ b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMain.java @@ -0,0 +1,130 @@ +/* + * Copyright (c) 2019, 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.dbclient.pokemons; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.health.DbClientHealthCheck; +import io.helidon.health.HealthSupport; +import io.helidon.media.jsonb.JsonbSupport; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Simple Hello World rest application. + */ +public final class PokemonMain { + + /** MongoDB configuration. Default configuration file {@code appliaction.yaml} contains JDBC configuration. */ + private static final String MONGO_CFG = "mongo.yaml"; + + /** Whether MongoDB support is selected. */ + private static boolean mongo; + + static boolean isMongo() { + return mongo; + } + + /** + * Cannot be instantiated. + */ + private PokemonMain() { + } + + /** + * Application main entry point. + * + * @param args Command line arguments. Run with MongoDB support when 1st argument is mongo, run with JDBC support otherwise. + */ + public static void main(final String[] args) { + if (args != null && args.length > 0 && args[0] != null && "mongo".equals(args[0].toLowerCase())) { + System.out.println("MongoDB database selected"); + mongo = true; + } else { + System.out.println("JDBC database selected"); + mongo = false; + } + startServer(); + } + + /** + * Start the server. + * + * @return the created {@link io.helidon.webserver.WebServer} instance + */ + static WebServer startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = isMongo() ? Config.create(ConfigSources.classpath(MONGO_CFG)) : Config.create(); + + // Prepare routing for the server + Routing routing = createRouting(config); + + WebServer server = WebServer.builder(routing) + .addMediaSupport(JsonpSupport.create()) + .addMediaSupport(JsonbSupport.create()) + .config(config.get("server")) + .tracer(TracerBuilder.create(config.get("tracing")).build()) + .build(); + + // Start the server and print some info. + server.start() + .thenAccept(ws -> System.out.println("WEB server is up! http://localhost:" + ws.port() + "/")); + + // Server threads are not daemon. NO need to block. Just react. + server.whenShutdown() + .thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + + return server; + } + + /** + * Creates new {@link io.helidon.webserver.Routing}. + * + * @param config configuration of this server + * @return routing configured with JSON support, a health check, and a service + */ + private static Routing createRouting(Config config) { + Config dbConfig = config.get("db"); + + // Client services are added through a service loader - see mongoDB example for explicit services + DbClient dbClient = DbClient.builder(dbConfig) + .build(); + // Some relational databases do not support DML statement as ping so using query which works for all of them + HealthSupport health = HealthSupport.builder() + .addLiveness( + DbClientHealthCheck.create(dbClient, dbConfig.get("health-check"))) + .build(); + + // Initialize database schema + InitializeDb.init(dbClient); + + return Routing.builder() + .register(health) // Health at "/health" + .register(MetricsSupport.create()) // Metrics at "/metrics" + .register("/db", new PokemonService(dbClient)) + .build(); + } +} diff --git a/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMapper.java b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMapper.java new file mode 100644 index 00000000..52dde7fa --- /dev/null +++ b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMapper.java @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2019, 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.dbclient.pokemons; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import io.helidon.dbclient.DbColumn; +import io.helidon.dbclient.DbMapper; +import io.helidon.dbclient.DbRow; + +/** + * Maps database statements to {@link io.helidon.examples.dbclient.common.Pokemon} class. + */ +public class PokemonMapper implements DbMapper { + + @Override + public Pokemon read(DbRow row) { + DbColumn id = row.column("id"); + DbColumn name = row.column("name"); + DbColumn type = row.column("idType"); + return new Pokemon(id.as(Integer.class), name.as(String.class), type.as(Integer.class)); + } + + @Override + public Map toNamedParameters(Pokemon value) { + Map map = new HashMap<>(3); + map.put("id", value.getId()); + map.put("name", value.getName()); + map.put("idType", value.getIdType()); + return map; + } + + @Override + public List toIndexedParameters(Pokemon value) { + List list = new ArrayList<>(3); + list.add(value.getId()); + list.add(value.getName()); + list.add(value.getIdType()); + return list; + } +} diff --git a/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMapperProvider.java b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMapperProvider.java new file mode 100644 index 00000000..f5dd8912 --- /dev/null +++ b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMapperProvider.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2019, 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.dbclient.pokemons; + +import java.util.Optional; + +import javax.annotation.Priority; + +import io.helidon.dbclient.DbMapper; +import io.helidon.dbclient.spi.DbMapperProvider; + +/** + * Provides pokemon mappers. + */ +@Priority(1000) +public class PokemonMapperProvider implements DbMapperProvider { + private static final PokemonMapper MAPPER = new PokemonMapper(); + + @SuppressWarnings("unchecked") + @Override + public Optional> mapper(Class type) { + if (type.equals(Pokemon.class)) { + return Optional.of((DbMapper) MAPPER); + } + return Optional.empty(); + } +} diff --git a/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonService.java b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonService.java new file mode 100644 index 00000000..453f5e2e --- /dev/null +++ b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonService.java @@ -0,0 +1,268 @@ +/* + * Copyright (c) 2019, 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.dbclient.pokemons; + +import java.util.concurrent.CompletionException; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.DbRow; +import io.helidon.webserver.Handler; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Example service using a database. + */ +public class PokemonService implements Service { + + private static final Logger LOGGER = Logger.getLogger(PokemonService.class.getName()); + + private final DbClient dbClient; + + PokemonService(DbClient dbClient) { + this.dbClient = dbClient; + } + + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::index) + // List all types + .get("/type", this::listTypes) + // List all pokemons + .get("/pokemon", this::listPokemons) + // Get pokemon by name + .get("/pokemon/name/{name}", this::getPokemonByName) + // Get pokemon by ID + .get("/pokemon/{id}", this::getPokemonById) + // Create new pokemon + .post("/pokemon", Handler.create(Pokemon.class, this::insertPokemon)) + // Update name of existing pokemon + .put("/pokemon", Handler.create(Pokemon.class, this::updatePokemon)) + // Delete pokemon by ID including type relation + .delete("/pokemon/{id}", this::deletePokemonById); + } + + + /** + * Return index page. + * + * @param request the server request + * @param response the server response + */ + private void index(ServerRequest request, ServerResponse response) { + response.headers().contentType(MediaType.TEXT_PLAIN); + response.send("Pokemon JDBC Example:\n" + + " GET /type - List all pokemon types\n" + + " GET /pokemon - List all pokemons\n" + + " GET /pokemon/{id} - Get pokemon by id\n" + + " GET /pokemon/name/{name} - Get pokemon by name\n" + + " POST /pokemon - Insert new pokemon:\n" + + " {\"id\":,\"name\":,\"type\":}\n" + + " PUT /pokemon - Update pokemon\n" + + " {\"id\":,\"name\":,\"type\":}\n" + + " DELETE /pokemon/{id} - Delete pokemon with specified id\n"); + } + + /** + * Return JsonArray with all stored pokemons. + * Pokemon object contains list of all type names. + * This method is abstract because implementation is DB dependent. + * + * @param request the server request + * @param response the server response + */ + private void listTypes(ServerRequest request, ServerResponse response) { + response.send(dbClient.execute(exec -> exec.namedQuery("select-all-types")) + .map(it -> it.as(JsonObject.class)), JsonObject.class); + } + + /** + * Return JsonArray with all stored pokemons. + * Pokemon object contains list of all type names. + * This method is abstract because implementation is DB dependent. + * + * @param request the server request + * @param response the server response + */ + private void listPokemons(ServerRequest request, ServerResponse response) { + response.send(dbClient.execute(exec -> exec.namedQuery("select-all-pokemons")) + .map(it -> it.as(JsonObject.class)), JsonObject.class); + } + + /** + * Get a single pokemon by id. + * + * @param request server request + * @param response server response + */ + private void getPokemonById(ServerRequest request, ServerResponse response) { + try { + int pokemonId = Integer.parseInt(request.path().param("id")); + dbClient.execute(exec -> exec + .createNamedGet("select-pokemon-by-id") + .addParam("id", pokemonId) + .execute()) + .thenAccept(maybeRow -> maybeRow + .ifPresentOrElse( + row -> sendRow(row, response), + () -> sendNotFound(response, "Pokemon " + pokemonId + " not found"))) + .exceptionally(throwable -> sendError(throwable, response)); + } catch (NumberFormatException ex) { + sendError(ex, response); + } + } + + /** + * Get a single pokemon by name. + * + * @param request server request + * @param response server response + */ + private void getPokemonByName(ServerRequest request, ServerResponse response) { + String pokemonName = request.path().param("name"); + dbClient.execute(exec -> exec.namedGet("select-pokemon-by-name", pokemonName)) + .thenAccept(it -> { + if (it.isEmpty()) { + sendNotFound(response, "Pokemon " + pokemonName + " not found"); + } else { + sendRow(it.get(), response); + } + }) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Insert new pokemon with specified name. + * + * @param request the server request + * @param response the server response + */ + private void insertPokemon(ServerRequest request, ServerResponse response, Pokemon pokemon) { + dbClient.execute(exec -> exec + .createNamedInsert("insert-pokemon") + .indexedParam(pokemon) + .execute()) + .thenAccept(count -> response.send("Inserted: " + count + " values\n")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Update a pokemon. + * Uses a transaction. + * + * @param request the server request + * @param response the server response + */ + private void updatePokemon(ServerRequest request, ServerResponse response, Pokemon pokemon) { + dbClient.execute(exec -> exec + .createNamedUpdate("update-pokemon-by-id") + .namedParam(pokemon) + .execute()) + .thenAccept(count -> response.send("Updated: " + count + " values\n")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Delete pokemon with specified id (key). + * + * @param request the server request + * @param response the server response + */ + private void deletePokemonById(ServerRequest request, ServerResponse response) { + try { + int id = Integer.parseInt(request.path().param("id")); + dbClient.execute(exec -> exec + .createNamedDelete("delete-pokemon-by-id") + .addParam("id", id) + .execute()) + .thenAccept(count -> response.send("Deleted: " + count + " values\n")) + .exceptionally(throwable -> sendError(throwable, response)); + } catch (NumberFormatException ex) { + sendError(ex, response); + } + } + + /** + * Delete pokemon with specified id (key). + * + * @param request the server request + * @param response the server response + */ + private void deleteAllPokemons(ServerRequest request, ServerResponse response) { + // Response message contains information about deleted records from both tables + StringBuilder sb = new StringBuilder(); + // Pokemon must be removed from both PokemonTypes and Pokemons tables in transaction + dbClient.execute(exec -> exec + // Execute delete from PokemonTypes table + .createDelete("DELETE FROM Pokemons") + .execute()) + // Process response when transaction is completed + .thenAccept(count -> response.send("Deleted: " + count + " values\n")) + .exceptionally(throwable -> sendError(throwable, response)); + } + + /** + * Send a 404 status code. + * + * @param response the server response + * @param message entity content + */ + private void sendNotFound(ServerResponse response, String message) { + response.status(Http.Status.NOT_FOUND_404); + response.send(message); + } + + /** + * Send a single DB row as JSON object. + * + * @param row row as read from the database + * @param response server response + */ + private void sendRow(DbRow row, ServerResponse response) { + response.send(row.as(javax.json.JsonObject.class)); + } + + /** + * Send a 500 response code and a few details. + * + * @param throwable throwable that caused the issue + * @param response server response + * @param type of expected response, will be always {@code null} + * @return {@code Void} so this method can be registered as a lambda + * with {@link java.util.concurrent.CompletionStage#exceptionally(java.util.function.Function)} + */ + private T sendError(Throwable throwable, ServerResponse response) { + Throwable realCause = throwable; + if (throwable instanceof CompletionException) { + realCause = throwable.getCause(); + } + response.status(Http.Status.INTERNAL_SERVER_ERROR_500); + response.send("Failed to process request: " + realCause.getClass().getName() + "(" + realCause.getMessage() + ")"); + LOGGER.log(Level.WARNING, "Failed to process request", throwable); + return null; + } + +} diff --git a/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/package-info.java b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/package-info.java new file mode 100644 index 00000000..df1b4e75 --- /dev/null +++ b/examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Quick start demo application. + */ +package io.helidon.examples.dbclient.pokemons; diff --git a/examples/dbclient/pokemons/src/main/resources/META-INF/services/io.helidon.dbclient.spi.DbMapperProvider b/examples/dbclient/pokemons/src/main/resources/META-INF/services/io.helidon.dbclient.spi.DbMapperProvider new file mode 100644 index 00000000..1d19c17c --- /dev/null +++ b/examples/dbclient/pokemons/src/main/resources/META-INF/services/io.helidon.dbclient.spi.DbMapperProvider @@ -0,0 +1,17 @@ +# +# Copyright (c) 2019, 2021 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. +# + +io.helidon.examples.dbclient.pokemons.PokemonMapperProvider diff --git a/examples/dbclient/pokemons/src/main/resources/Types.json b/examples/dbclient/pokemons/src/main/resources/Types.json new file mode 100644 index 00000000..646ec725 --- /dev/null +++ b/examples/dbclient/pokemons/src/main/resources/Types.json @@ -0,0 +1,20 @@ +[ + {"id": 1, "name": "Normal"}, + {"id": 2, "name": "Fighting"}, + {"id": 3, "name": "Flying"}, + {"id": 4, "name": "Poison"}, + {"id": 5, "name": "Ground"}, + {"id": 6, "name": "Rock"}, + {"id": 7, "name": "Bug"}, + {"id": 8, "name": "Ghost"}, + {"id": 9, "name": "Steel"}, + {"id": 10, "name": "Fire"}, + {"id": 11, "name": "Water"}, + {"id": 12, "name": "Grass"}, + {"id": 13, "name": "Electric"}, + {"id": 14, "name": "Psychic"}, + {"id": 15, "name": "Ice"}, + {"id": 16, "name": "Dragon"}, + {"id": 17, "name": "Dark"}, + {"id": 18, "name": "Fairy"} +] diff --git a/examples/dbclient/pokemons/src/main/resources/application.yaml b/examples/dbclient/pokemons/src/main/resources/application.yaml new file mode 100644 index 00000000..c07753cc --- /dev/null +++ b/examples/dbclient/pokemons/src/main/resources/application.yaml @@ -0,0 +1,92 @@ +# +# Copyright (c) 2019, 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. +# + +server: + port: 8079 + host: 0.0.0.0 + features: + print-details: true + +tracing: + service: jdbc-db + +# see README.md for details how to run databases in docker +db: + source: jdbc + connection: + # + # Oracle configuration + # + url: "jdbc:oracle:thin:@localhost:1521/XE" + username: "system" + password: "oracle" + poolName: "oracle" + # + # MySQL configuration + # +# url: jdbc:mysql://127.0.0.1:3306/pokemon?useSSL=false +# username: user +# password: password +# poolName: "mysql" + # + # H2 configuration + # +# url: "jdbc:h2:tcp://localhost:9092/~test" +# username: h2 +# password: "" +# poolName: h2 + initializationFailTimeout: -1 + connectionTimeout: 2000 + helidon: + pool-metrics: + enabled: true + # name prefix defaults to "db.pool." - if you have more than one client within a JVM, you may want to distinguish between them + name-prefix: "hikari." + services: + tracing: + - enabled: true + metrics: + - type: METER + health-check: + type: "query" + statementName: "health-check" + statements: + # Health check query statement for MySQL and H2 databases +# health-check: "SELECT 0" + # Health check query statement for Oracle database + health-check: "SELECT 1 FROM DUAL" + ## Create database schema (table "Types" is system in H2) + create-types: "CREATE TABLE PokeTypes (id INTEGER NOT NULL PRIMARY KEY, name VARCHAR(64) NOT NULL)" + create-pokemons: "CREATE TABLE Pokemons (id INTEGER NOT NULL PRIMARY KEY, name VARCHAR(64) NOT NULL, id_type INTEGER NOT NULL REFERENCES PokeTypes(id))" + # Select all types + select-all-types: "SELECT id, name FROM PokeTypes" + # Select all pokemons without type information + select-all-pokemons: "SELECT id, name, id_type FROM Pokemons" + # Select pokemon by id + select-pokemon-by-id: "SELECT id, name, id_type FROM Pokemons WHERE id = :id" + # Select pokemon by name + select-pokemon-by-name: "SELECT id, name, id_type FROM Pokemons WHERE name = ?" + # Insert records into database + insert-type: "INSERT INTO PokeTypes(id, name) VALUES(?, ?)" + insert-pokemon: "INSERT INTO Pokemons(id, name, id_type) VALUES(?, ?, ?)" + # Update name of pokemon specified by id + update-pokemon-by-id: "UPDATE Pokemons SET name = :name, id_type = :idType WHERE id = :id" + # Delete pokemon by id + delete-pokemon-by-id: "DELETE FROM Pokemons WHERE id = :id" + # Delete all types + delete-all-types: "DELETE FROM PokeTypes" + # Delete all pokemons + delete-all-pokemons: "DELETE FROM Pokemons" diff --git a/examples/dbclient/pokemons/src/main/resources/logging.properties b/examples/dbclient/pokemons/src/main/resources/logging.properties new file mode 100644 index 00000000..bdbfedcb --- /dev/null +++ b/examples/dbclient/pokemons/src/main/resources/logging.properties @@ -0,0 +1,36 @@ +# +# Copyright (c) 2019, 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.common.HelidonConsoleHandler + +# Global default logging level. Can be overriden by specific handlers and loggers +.level=INFO + +# Helidon Web Server has a custom log formatter that extends SimpleFormatter. +# It replaces "!thread!" with the current thread name +io.helidon.common.HelidonConsoleHandler.level=ALL +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 + +#Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/dbclient/pokemons/src/main/resources/mongo.yaml b/examples/dbclient/pokemons/src/main/resources/mongo.yaml new file mode 100644 index 00000000..8e7fa77e --- /dev/null +++ b/examples/dbclient/pokemons/src/main/resources/mongo.yaml @@ -0,0 +1,114 @@ +# +# Copyright (c) 2019, 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. +# + +server: + port: 8079 + host: 0.0.0.0 + features: + print-details: true + +tracing: + service: mongo-db + +# docker run --rm --name mongo -p 27017:27017 mongo +db: + source: "mongoDb" + connection: + url: "mongodb://127.0.0.1:27017/pokemon" + services: + tracing: + - enabled: true + metrics: + - type: METER + statements: + # Health check statement. HealthCheck statement type must be query. + health-check: '{ + "operation": "command", + "query": { ping: 1 } + }' + ## Create database schema + # Select all types + select-all-types: '{ + "collection": "types", + "operation": "query", + "projection": { id: 1, name: 1, _id: 0 }, + "query": {} + }' + # Select all pokemons without type information + select-all-pokemons: '{ + "collection": "pokemons", + "operation": "query", + "projection": { id: 1, name: 1, id_type: 1, _id: 0 }, + "query": {} + }' + # Select pokemon by id + select-pokemon-by-id: '{ + "collection": "pokemons", + "operation": "query", + "projection": { id: 1, name: 1, id_type: 1, _id: 0 }, + "query": { id: $id } + }' + # Select pokemon by name + select-pokemon-by-name: '{ + "collection": "pokemons", + "operation": "query", + "projection": { id: 1, name: 1, id_type: 1, _id: 0 }, + "query": { name: ? } + }' + # Insert records into database + insert-type: '{ + "collection": "types", + "operation": "insert", + "value": { + "id": ?, + "name": ? + } + }' + insert-pokemon: '{ + "collection": "pokemons", + "operation": "insert", + "value": { + "id": ?, + "name": ?, + "id_type": ? + } + }' + # Update name of pokemon specified by id + update-pokemon-by-id: '{ + "collection": "pokemons", + "operation": "update", + "value":{ $set: { "name": $name, "id_type": $idType } }, + "query": { id: $id } + }' + # Delete pokemon by id + delete-pokemon-by-id: '{ + "collection": "pokemons", + "operation": "delete", + "query": { id: $id } + }' + # Delete all types + delete-all-types: '{ + "collection": "types", + "operation": "delete", + "query": { } + }' + # Delete all pokemons + delete-all-pokemons: '{ + "collection": "pokemons", + "operation": "delete", + "query": { } + }' + diff --git a/examples/dbclient/pokemons/src/main/resources/pokemons.json b/examples/dbclient/pokemons/src/main/resources/pokemons.json new file mode 100644 index 00000000..c4e78bed --- /dev/null +++ b/examples/dbclient/pokemons/src/main/resources/pokemons.json @@ -0,0 +1,8 @@ +[ + {"id": 1, "name": "Bulbasaur", "idType": 12}, + {"id": 2, "name": "Charmander", "idType": 10}, + {"id": 3, "name": "Squirtle", "idType": 11}, + {"id": 4, "name": "Caterpie", "idType": 7}, + {"id": 5, "name": "Weedle", "idType": 7}, + {"id": 6, "name": "Pidgey", "idType": 3} +] diff --git a/examples/dbclient/pom.xml b/examples/dbclient/pom.xml new file mode 100644 index 00000000..a4f96712 --- /dev/null +++ b/examples/dbclient/pom.xml @@ -0,0 +1,45 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + + pom + + io.helidon.examples.dbclient + helidon-examples-dbclient-project + Helidon Examples DB Client + + + Examples of Helidon DB Client + + + + + jdbc + mongodb + common + pokemons + + diff --git a/examples/employee-app/.dockerignore b/examples/employee-app/.dockerignore new file mode 100644 index 00000000..c8b241f2 --- /dev/null +++ b/examples/employee-app/.dockerignore @@ -0,0 +1 @@ +target/* \ No newline at end of file diff --git a/examples/employee-app/Dockerfile b/examples/employee-app/Dockerfile new file mode 100644 index 00000000..ad2674d6 --- /dev/null +++ b/examples/employee-app/Dockerfile @@ -0,0 +1,45 @@ +# +# Copyright (c) 2019, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-employee-app.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-examples-employee-app.jar"] + +EXPOSE 8080 diff --git a/examples/employee-app/README.md b/examples/employee-app/README.md new file mode 100644 index 00000000..7214687a --- /dev/null +++ b/examples/employee-app/README.md @@ -0,0 +1,293 @@ +# Helidon Quickstart SE - Employee Directory Example + +This project implements an employee directory REST service using Helidon SE. + The application is composed of a Helidon REST Microservice backend along with + an HTML/JavaScript front end. The source for both application is included with + the Maven project. + +By default the service uses a ArrayList backend with sample data. You can connect + the backend application to an Oracle database by changing the values in the + `resources/application.yaml` file. + +The service uses Helidon DB Client that provides reactive and non-blocking access to a database. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-employee-app.jar +``` + +## Create script +If you do not have the employee table in your database, you can create it and required resources as follows: + +```sql +CREATE TABLE EMPLOYEE (ID NUMBER(6), + FIRSTNAME VARCHAR2(20), + LASTNAME VARCHAR2(25), + EMAIL VARCHAR2(30), + PHONE VARCHAR2(30), + BIRTHDATE VARCHAR2(15), + TITLE VARCHAR2(20), + DEPARTMENT VARCHAR2(20)); + +ALTER TABLE EMPLOYEE ADD (CONSTRAINT emp_id_pk PRIMARY KEY (ID)); + +CREATE SEQUENCE EMPLOYEE_SEQ INCREMENT BY 1 NOCACHE NOCYCLE; +``` + +## Exercise the application +Get all employees. +```shell +curl -X GET curl -X GET http://localhost:8080/employees +``` + +Only 1 output record is shown for brevity: +```json +[ + { + "birthDate": "1970-11-28T08:28:48.078Z", + "department": "Mobility", + "email": "Hugh.Jast@example.com", + "firstName": "Hugh", + "id": "48cf06ad-6ed4-47e6-ac44-3ea9c67cbe2d", + "lastName": "Jast", + "phone": "730-715-4446", + "title": "National Data Strategist" + } +] +``` + + +Get all employees whose last name contains "S". +```shell +curl -X GET http://localhost:8080/employees/lastname/S +``` + +Only 1 output record is shown for brevity: +```json +[ + { + "birthDate": "1978-03-18T17:00:12.938Z", + "department": "Security", + "email": "Zora.Sawayn@example.com", + "firstName": "Zora", + "id": "d7b583a2-f068-40d9-aec0-6f87899c5d8a", + "lastName": "Sawayn", + "phone": "923-814-0502", + "title": "Dynamic Marketing Designer" + } +] +``` + +Get an individual record. +```shell +curl -X GET http://localhost:8080/employees/48cf06ad-6ed4-47e6-ac44-3ea9c67cbe2d +``` +Output: +```json +[ + { + "birthDate": "1970-11-28T08:28:48.078Z", + "department": "Mobility", + "email": "Hugh.Jast@example.com", + "firstName": "Hugh", + "id": "48cf06ad-6ed4-47e6-ac44-3ea9c67cbe2d", + "lastName": "Jast", + "phone": "730-715-4446", + "title": "National Data Strategist" + } +] +``` + +Connect with a web brower at: +```text +http://localhost:8080/public/index.html +``` + + +## Try health and metrics + +```shell +curl -s -X GET http://localhost:8080/health +``` + +```json +{ + "outcome": "UP", + "checks": [ + { + "name": "deadlock", + "state": "UP" + }, + { + "name": "diskSpace", + "state": "UP", + "data": { + "free": "306.61 GB", + "freeBytes": 329225338880, + "percentFree": "65.84%", + "total": "465.72 GB", + "totalBytes": 500068036608 + } + }, + { + "name": "heapMemory", + "state": "UP", + "data": { + "free": "239.35 MB", + "freeBytes": 250980656, + "max": "4.00 GB", + "maxBytes": 4294967296, + "percentFree": "99.59%", + "total": "256.00 MB", + "totalBytes": 268435456 + } + } + ] +} +``` + +### Prometheus Format + +```shell +curl -s -X GET http://localhost:8080/metrics +``` + +Only 1 output item is shown for brevity: +```text +# TYPE base:classloader_current_loaded_class_count counter +# HELP base:classloader_current_loaded_class_count Displays the number of classes that are currently loaded in the Java virtual machine. +base:classloader_current_loaded_class_count 3995 +``` + +### JSON Format +```shell +curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics +``` + +Output: +```json +{ + "base": { + "classloader.currentLoadedClass.count": 4011, + "classloader.totalLoadedClass.count": 4011, + "classloader.totalUnloadedClass.count": 0, + "cpu.availableProcessors": 8, + "cpu.systemLoadAverage": 1.65283203125, + "gc.G1 Old Generation.count": 0, + "gc.G1 Old Generation.time": 0, + "gc.G1 Young Generation.count": 2, + "gc.G1 Young Generation.time": 8, + "jvm.uptime": 478733, + "memory.committedHeap": 268435456, + "memory.maxHeap": 4294967296, + "memory.usedHeap": 18874368, + "thread.count": 11, + "thread.daemon.count": 4, + "thread.max.count": 11 + }, + "vendor": { + "grpc.requests.count": 0, + "grpc.requests.meter": { + "count": 0, + "meanRate": 0, + "oneMinRate": 0, + "fiveMinRate": 0, + "fifteenMinRate": 0 + }, + "requests.count": 5, + "requests.meter": { + "count": 5, + "meanRate": 0.01046407983617782, + "oneMinRate": 0.0023897243038835964, + "fiveMinRate": 0.003944597070306631, + "fifteenMinRate": 0.0023808575122958794 + } + } +} +``` + +## Build the Docker Image + +```shell +docker build -t employee-app . +``` + +## Start the application with Docker + +```shell +docker run --rm -p 8080:8080 employee-app:latest +``` + +Exercise the application as described above. + +## Deploy the application to Kubernetes + +```shell +kubectl cluster-info # Verify which cluster +kubectl get pods # Verify connectivity to cluster +kubectl create -f app.yaml # Deply application +kubectl get service employee-app # Get service info +``` + + +### Oracle DB Credentials +You can connect to two different datastores for the back end application. + Just fill in the application.yaml files. To use an ArrayList as the data store, + simply set `drivertype` to `Array`. To connect to an Oracle database, you must + set all the values: `user`, `password`, `hosturl`, and `drivertype`. + For Oracle, the `drivertype` should be set to `Oracle`. + +**Sample `application.yaml`** +```yaml +app: + user: + password: + hosturl: :/. + drivertype: Array + + server: + port: 8080 + host: 0.0.0.0 +``` + +## Create the database objects + +1. Create a connection to your Oracle Database using sqlplus or SQL Developer. + See https://docs.cloud.oracle.com/iaas/Content/Database/Tasks/connectingDB.htm. +2. Create the database objects: + +```sql +CREATE TABLE EMPLOYEE ( + ID INTEGER NOT NULL, + FIRSTNAME VARCHAR(100), + LASTNAME VARCHAR(100), + EMAIL VARCHAR(100), + PHONE VARCHAR(100), + BIRTHDATE VARCHAR(10), + TITLE VARCHAR(100), + DEPARTMENT VARCHAR(100), + PRIMARY KEY (ID) + ); +``` + +```sql +CREATE SEQUENCE EMPLOYEE_SEQ + START WITH 100 + INCREMENT BY 1; +``` + +```sql +INSERT INTO EMPLOYEE (ID, FIRSTNAME, LASTNAME, EMAIL, PHONE, BIRTHDATE, TITLE, DEPARTMENT) VALUES (EMPLOYEE_SEQ.nextVal, 'Hugh', 'Jast', 'Hugh.Jast@example.com', '730-555-0100', '1970-11-28', 'National Data Strategist', 'Mobility'); + +INSERT INTO EMPLOYEE (ID, FIRSTNAME, LASTNAME, EMAIL, PHONE, BIRTHDATE, TITLE, DEPARTMENT) VALUES (EMPLOYEE_SEQ.nextVal, 'Toy', 'Herzog', 'Toy.Herzog@example.com', '769-555-0102', '1961-08-08', 'Dynamic Operations Manager', 'Paradigm'); + +INSERT INTO EMPLOYEE (ID, FIRSTNAME, LASTNAME, EMAIL, PHONE, BIRTHDATE, TITLE, DEPARTMENT) VALUES (EMPLOYEE_SEQ.nextVal, 'Reed', 'Hahn', 'Reed.Hahn@example.com', '429-555-0153', '1977-02-05', 'Future Directives Facilitator', 'Quality'); + +INSERT INTO EMPLOYEE (ID, FIRSTNAME, LASTNAME, EMAIL, PHONE, BIRTHDATE, TITLE, DEPARTMENT) VALUES (EMPLOYEE_SEQ.nextVal, 'Novella', 'Bahringer', 'Novella.Bahringer@example.com', '293-596-3547', '1961-07-25', 'Principal Factors Architect', 'Division'); + +INSERT INTO EMPLOYEE (ID, FIRSTNAME, LASTNAME, EMAIL, PHONE, BIRTHDATE, TITLE, DEPARTMENT) VALUES (EMPLOYEE_SEQ.nextVal, 'Zora', 'Sawayn', 'Zora.Sawayn@example.com', '923-555-0161', '1978-03-18', 'Dynamic Marketing Designer', 'Security'); + +INSERT INTO EMPLOYEE (ID, FIRSTNAME, LASTNAME, EMAIL, PHONE, BIRTHDATE, TITLE, DEPARTMENT) VALUES (EMPLOYEE_SEQ.nextVal, 'Cordia', 'Willms', 'Cordia.Willms@example.com', '778-555-0187', '1989-03-31', 'Human Division Representative', 'Optimization'); +``` diff --git a/examples/employee-app/app.yaml b/examples/employee-app/app.yaml new file mode 100644 index 00000000..7f3d18e6 --- /dev/null +++ b/examples/employee-app/app.yaml @@ -0,0 +1,63 @@ +# +# Copyright (c) 2019, 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: helidon-examples-employee-app + labels: + app: helidon-examples-employee-app +spec: + type: NodePort + selector: + app: helidon-examples-employee-app + ports: + - port: 8080 + targetPort: 8080 + name: http +--- +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-examples-employee-app +spec: + replicas: 1 + template: + metadata: + labels: + app: helidon-examples-employee-app + version: v1 + spec: + containers: + - name: helidon-examples-employee-app + image: helidon-examples-employee-app + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 +--- +apiVersion: v1 +kind: Service +metadata: + name: helidon-examples-employee-app + labels: + app: helidon-examples-employee-app +spec: + type: LoadBalancer + ports: + - port: 80 + targetPort: 8080 + selector: + app: helidon-examples-employee-app \ No newline at end of file diff --git a/examples/employee-app/pom.xml b/examples/employee-app/pom.xml new file mode 100644 index 00000000..72c2a3ec --- /dev/null +++ b/examples/employee-app/pom.xml @@ -0,0 +1,114 @@ + + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.employee + helidon-examples-employee-app + 1.0.0-SNAPSHOT + Helidon Examples Employee App + + + io.helidon.service.employee.Main + + + + + com.oracle.database.jdbc + ojdbc8-production + pom + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.media + helidon-media-jsonb + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.dbclient + helidon-dbclient + + + io.helidon.dbclient + helidon-dbclient-jdbc + + + io.helidon.metrics + helidon-metrics + runtime + + + io.helidon.webclient + helidon-webclient + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/employee-app/src/main/java/io/helidon/service/employee/Employee.java b/examples/employee-app/src/main/java/io/helidon/service/employee/Employee.java new file mode 100644 index 00000000..1d2b72a6 --- /dev/null +++ b/examples/employee-app/src/main/java/io/helidon/service/employee/Employee.java @@ -0,0 +1,153 @@ +/* + * Copyright (c) 2019, 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.service.employee; + +import java.util.UUID; + +import javax.json.bind.annotation.JsonbCreator; +import javax.json.bind.annotation.JsonbProperty; +/** + * Represents an employee. + */ +public final class Employee { + + private final String id; + private final String firstName; + private final String lastName; + private final String email; + private final String phone; + private final String birthDate; + private final String title; + private final String department; + + /**Creates a new Employee. + * @param id The employee ID. + * @param firstName The employee first name. + * @param lastName The employee lastName. + * @param email The employee email. + * @param phone The employee phone. + * @param birthDate The employee birthDatee. + * @param title The employee title. + * @param department The employee department.*/ + @SuppressWarnings("checkstyle:ParameterNumber") + private Employee(String id, String firstName, String lastName, String email, String phone, String birthDate, + String title, String department) { + this.id = id; + this.firstName = firstName; + this.lastName = lastName; + this.email = email; + this.phone = phone; + this.birthDate = birthDate; + this.title = title; + this.department = department; + } + + /** + * Creates a new employee. This method helps to parse the json parameters in the requests. + * @param id The employee ID. If the employee ID is null or empty generates a new ID. + * @param firstName The employee first name. + * @param lastName The employee lastName. + * @param email The employee email. + * @param phone The employee phone. + * @param birthDate The employee birthDatee. + * @param title The employee title. + * @param department The employee department. + * @return A new employee object + */ + @JsonbCreator + @SuppressWarnings("checkstyle:ParameterNumber") + public static Employee of(@JsonbProperty("id") String id, @JsonbProperty("firstName") String firstName, + @JsonbProperty("lastName") String lastName, @JsonbProperty("email") String email, + @JsonbProperty("phone") String phone, @JsonbProperty("birthDate") String birthDate, + @JsonbProperty("title") String title, @JsonbProperty("department") String department) { + if (id == null || id.trim().equals("")) { + id = UUID.randomUUID().toString(); + } + Employee e = new Employee(id, firstName, lastName, email, phone, birthDate, title, department); + return e; + } + + /** + * Returns the employee ID. + * @return the ID + */ + public String getId() { + return this.id; + } + + /** + * Returns the employee first name. + * @return The first name + */ + public String getFirstName() { + return this.firstName; + } + + /** + * Returns the employee last name. + * @return The last name + */ + public String getLastName() { + return this.lastName; + } + + /** + * Returns the employee e-mail. + * @return The email + */ + public String getEmail() { + return this.email; + } + + /** + * Returns the employee phone. + * @return The phone + */ + public String getPhone() { + return this.phone; + } + + /** + * Returns the employee birthdate. + * @return The birthdate + */ + public String getBirthDate() { + return this.birthDate; + } + + /** + * Returns the employee title. + * @return The title + */ + public String getTitle() { + return this.title; + } + + /** + * Returns the employee department. + * @return The department + */ + public String getDepartment() { + return this.department; + } + + @Override + public String toString() { + return "ID: " + id + " First Name: " + firstName + " Last Name: " + lastName + " EMail: " + email + " Phone: " + + phone + " Birth Date: " + birthDate + " Title: " + title + " Department: " + department; + } + +} diff --git a/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepository.java b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepository.java new file mode 100644 index 00000000..e8289d21 --- /dev/null +++ b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepository.java @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2019, 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.service.employee; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletionStage; + +import io.helidon.config.Config; + +/** + * Interface for Data Access Objects. + *

+ * As Helidon SE is a reactive framework, we cannot block it. + * Method on this interface return a {@link java.util.concurrent.CompletionStage} with the data, so it + * can be correctly handled by the server. + *

+ * Methods in implementation must not block thread + */ +public interface EmployeeRepository { + + /** + * Create a new employeeRepository instance using one of the two implementations + * {@link EmployeeRepositoryImpl} or {@link EmployeeRepositoryImplDB} depending + * on the specified driver type. + * @param driverType Represents the driver type. It can be Array or Oracle. + * @param config Contains the application configuration specified in the + * application.yaml file. + * @return The employee repository implementation. + */ + static EmployeeRepository create(String driverType, Config config) { + switch (driverType) { + case "Database": + return new EmployeeRepositoryImplDB(config); + case "Array": + default: + // Array is default + return new EmployeeRepositoryImpl(); + } + } + + /** + * Returns the list of the employees. + * @return The collection of all the employee objects + */ + CompletionStage> getAll(); + + /** + * Returns the list of the employees that match with the specified lastName. + * @param lastName Represents the last name value for the search. + * @return The collection of the employee objects that match with the specified + * lastName + */ + CompletionStage> getByLastName(String lastName); + + /** + * Returns the list of the employees that match with the specified title. + * @param title Represents the title value for the search + * @return The collection of the employee objects that match with the specified + * title + */ + CompletionStage> getByTitle(String title); + + /** + * Returns the list of the employees that match with the specified department. + * @param department Represents the department value for the search. + * @return The collection of the employee objects that match with the specified + * department + */ + CompletionStage> getByDepartment(String department); + + /** + * Add a new employee. + * @param employee returns the employee object including the ID generated. + * @return the employee object including the ID generated + */ + CompletionStage save(Employee employee); // Add new employee + + /** + * Update an existing employee. + * @param updatedEmployee The employee object with the values to update + * @param id The employee ID + * @return number of updated records + */ + CompletionStage update(Employee updatedEmployee, String id); + + /** + * Delete an employee by ID. + * @param id The employee ID + * @return number of deleted records + */ + CompletionStage deleteById(String id); + + /** + * Get an employee by ID. + * @param id The employee ID + * @return The employee object if the employee is found + */ + CompletionStage> getById(String id); +} diff --git a/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepositoryImpl.java b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepositoryImpl.java new file mode 100644 index 00000000..f78ae3cc --- /dev/null +++ b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepositoryImpl.java @@ -0,0 +1,128 @@ +/* + * Copyright (c) 2019, 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.service.employee; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Arrays; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionStage; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.stream.Collectors; + +import javax.json.bind.Jsonb; +import javax.json.bind.JsonbBuilder; +import javax.json.bind.JsonbConfig; + +/** + * Implementation of the {@link EmployeeRepository}. This implementation uses a + * mock database written with in-memory ArrayList classes. + * The strings id, name, and other search strings are validated before being + * passed to the methods in this class. + * + */ +public final class EmployeeRepositoryImpl implements EmployeeRepository { + + private final CopyOnWriteArrayList eList = new CopyOnWriteArrayList(); + + /** + * To load the initial data, parses the content of employee.json + * file located in the resources directory to a list of Employee + * objects. + */ + public EmployeeRepositoryImpl() { + JsonbConfig config = new JsonbConfig().withFormatting(Boolean.TRUE); + + Jsonb jsonb = JsonbBuilder.create(config); + try (InputStream jsonFile = EmployeeRepositoryImpl.class.getResourceAsStream("/employees.json")) { + Employee[] employees = jsonb.fromJson(jsonFile, Employee[].class); + eList.addAll(Arrays.asList(employees)); + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } + + @Override + public CompletionStage> getByLastName(String name) { + List matchList = eList.stream().filter((e) -> (e.getLastName().contains(name))) + .collect(Collectors.toList()); + + return CompletableFuture.completedFuture(matchList); + } + + @Override + public CompletionStage> getByTitle(String title) { + List matchList = eList.stream().filter((e) -> (e.getTitle().contains(title))) + .collect(Collectors.toList()); + + return CompletableFuture.completedFuture(matchList); + } + + @Override + public CompletableFuture> getByDepartment(String department) { + List matchList = eList.stream().filter((e) -> (e.getDepartment().contains(department))) + .collect(Collectors.toList()); + + return CompletableFuture.completedFuture(matchList); + } + + @Override + public CompletionStage> getAll() { + return CompletableFuture.completedFuture(eList); + } + + @Override + public CompletionStage> getById(String id) { + return CompletableFuture.completedFuture(eList.stream().filter(e -> e.getId().equals(id)).findFirst()); + } + + @Override + public CompletionStage save(Employee employee) { + Employee nextEmployee = Employee.of(null, + employee.getFirstName(), + employee.getLastName(), + employee.getEmail(), + employee.getPhone(), + employee.getBirthDate(), + employee.getTitle(), + employee.getDepartment()); + eList.add(nextEmployee); + return CompletableFuture.completedFuture(nextEmployee); + } + + @Override + public CompletionStage update(Employee updatedEmployee, String id) { + deleteById(id); + Employee e = Employee.of(id, updatedEmployee.getFirstName(), updatedEmployee.getLastName(), + updatedEmployee.getEmail(), updatedEmployee.getPhone(), updatedEmployee.getBirthDate(), + updatedEmployee.getTitle(), updatedEmployee.getDepartment()); + eList.add(e); + return CompletableFuture.completedFuture(1L); + } + + @Override + public CompletionStage deleteById(String id) { + return CompletableFuture.completedFuture(eList.stream() + .filter(e -> e.getId().equals(id)) + .findFirst() + .map(eList::remove) + .map(it -> 1L) + .orElse(0L)); + } +} diff --git a/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepositoryImplDB.java b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepositoryImplDB.java new file mode 100644 index 00000000..6e2d2c93 --- /dev/null +++ b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeRepositoryImplDB.java @@ -0,0 +1,167 @@ +/* + * Copyright (c) 2019, 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.service.employee; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletionStage; + +import io.helidon.common.reactive.Multi; +import io.helidon.config.Config; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.DbRow; +import io.helidon.dbclient.jdbc.JdbcDbClientProviderBuilder; + +/** + * Implementation of the {@link EmployeeRepository}. This implementation uses an + * Oracle database to persist the Employee objects. + * + */ +final class EmployeeRepositoryImplDB implements EmployeeRepository { + + private final DbClient dbClient; + + /** + * Creates the database connection using the parameters specified in the + * application.yaml file located in the resources directory. + * @param config Represents the application configuration. + */ + EmployeeRepositoryImplDB(Config config) { + String url = "jdbc:oracle:thin:@"; + String driver = "oracle.jdbc.driver.OracleDriver"; + + String dbUserName = config.get("app.user").asString().orElse("sys as SYSDBA"); + String dbUserPassword = config.get("app.password").asString().orElse("changeit"); + String dbHostURL = config.get("app.hosturl").asString().orElse("localhost:1521/xe"); + + try { + Class.forName(driver); + } catch (Exception sqle) { + sqle.printStackTrace(); + } + + // now we create the reactive DB Client - explicitly use JDBC, so we can + // configure JDBC specific configuration + dbClient = JdbcDbClientProviderBuilder.create() + .url(url + dbHostURL) + .username(dbUserName) + .password(dbUserPassword) + .build(); + } + + @Override + public CompletionStage> getAll() { + String queryStr = "SELECT * FROM EMPLOYEE"; + + return toEmployeeList(dbClient.execute(exec -> exec.query(queryStr))); + } + + @Override + public CompletionStage> getByLastName(String name) { + String queryStr = "SELECT * FROM EMPLOYEE WHERE LASTNAME LIKE ?"; + + return toEmployeeList(dbClient.execute(exec -> exec.query(queryStr, name))); + } + + @Override + public CompletionStage> getByTitle(String title) { + String queryStr = "SELECT * FROM EMPLOYEE WHERE TITLE LIKE ?"; + + return toEmployeeList(dbClient.execute(exec -> exec.query(queryStr, title))); + } + + @Override + public CompletionStage> getByDepartment(String department) { + String queryStr = "SELECT * FROM EMPLOYEE WHERE DEPARTMENT LIKE ?"; + + return toEmployeeList(dbClient.execute(exec -> exec.query(queryStr, department))); + } + + @Override + public CompletionStage save(Employee employee) { + String insertTableSQL = "INSERT INTO EMPLOYEE " + + "(ID, FIRSTNAME, LASTNAME, EMAIL, PHONE, BIRTHDATE, TITLE, DEPARTMENT) " + + "VALUES(EMPLOYEE_SEQ.NEXTVAL,?,?,?,?,?,?,?)"; + + return dbClient.execute(exec -> exec.createInsert(insertTableSQL) + .addParam(employee.getFirstName()) + .addParam(employee.getLastName()) + .addParam(employee.getEmail()) + .addParam(employee.getPhone()) + .addParam(employee.getBirthDate()) + .addParam(employee.getTitle()) + .addParam(employee.getDepartment()) + .execute()) + // let's always return the employee once the insert finishes + .thenApply(count -> employee); + } + + @Override + public CompletionStage deleteById(String id) { + String deleteRowSQL = "DELETE FROM EMPLOYEE WHERE ID=?"; + + return dbClient.execute(exec -> exec.delete(deleteRowSQL, id)); + } + + @Override + public CompletionStage> getById(String id) { + String queryStr = "SELECT * FROM EMPLOYEE WHERE ID =?"; + + return dbClient.execute(exec -> exec.get(queryStr, id)) + .map(optionalRow -> optionalRow.map(dbRow -> dbRow.as(Employee.class))); + } + + @Override + public CompletionStage update(Employee updatedEmployee, String id) { + String updateTableSQL = "UPDATE EMPLOYEE SET FIRSTNAME=?, LASTNAME=?, EMAIL=?, PHONE=?, BIRTHDATE=?, TITLE=?, " + + "DEPARTMENT=? WHERE ID=?"; + + return dbClient.execute(exec -> exec.createUpdate(updateTableSQL) + .addParam(updatedEmployee.getFirstName()) + .addParam(updatedEmployee.getLastName()) + .addParam(updatedEmployee.getEmail()) + .addParam(updatedEmployee.getPhone()) + .addParam(updatedEmployee.getBirthDate()) + .addParam(updatedEmployee.getTitle()) + .addParam(updatedEmployee.getDepartment()) + .addParam(Integer.parseInt(id)) + .execute()); + } + + private static CompletionStage> toEmployeeList(Multi resultSet) { + return resultSet.map(EmployeeDbMapper::read) + .collectList(); + } + + private static final class EmployeeDbMapper { + private EmployeeDbMapper() { + } + + static Employee read(DbRow row) { + // map named columns to an object + return Employee.of( + row.column("ID").as(String.class), + row.column("FIRSTNAME").as(String.class), + row.column("LASTNAME").as(String.class), + row.column("EMAIL").as(String.class), + row.column("PHONE").as(String.class), + row.column("BIRTHDATE").as(String.class), + row.column("TITLE").as(String.class), + row.column("DEPARTMENT").as(String.class) + ); + } + } +} diff --git a/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeService.java b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeService.java new file mode 100644 index 00000000..4fd6773c --- /dev/null +++ b/examples/employee-app/src/main/java/io/helidon/service/employee/EmployeeService.java @@ -0,0 +1,240 @@ +/* + * Copyright (c) 2019, 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.service.employee; + +import java.util.HashMap; +import java.util.Map; +import java.util.logging.Logger; + +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * The Employee service endpoints. Get all employees: curl -X GET + * http://localhost:8080/employees Get employee by id: curl -X GET + * http://localhost:8080/employees/{id} Add employee curl -X POST + * http://localhost:8080/employees/{id} Update employee by id curl -X PUT + * http://localhost:8080/employees/{id} Delete employee by id curl -X DELETE + * http://localhost:8080/employees/{id} The message is returned as a JSON object + */ +public class EmployeeService implements Service { + private final EmployeeRepository employees; + private static final Logger LOGGER = Logger.getLogger(EmployeeService.class.getName()); + + EmployeeService(Config config) { + employees = EmployeeRepository.create(config.get("app.drivertype") + .asString() + .orElse("Array"), + config); + } + + /** + * A service registers itself by updating the routine rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules.get("/", this::getAll) + .get("/lastname/{name}", this::getByLastName) + .get("/department/{name}", this::getByDepartment) + .get("/title/{name}", this::getByTitle) + .post("/", this::save) + .get("/{id}", this::getEmployeeById) + .put("/{id}", this::update) + .delete("/{id}", this::delete); + } + + /** + * Gets all the employees. + * @param request the server request + * @param response the server response + */ + private void getAll(final ServerRequest request, final ServerResponse response) { + LOGGER.fine("getAll"); + + this.employees + .getAll() + .thenAccept(response::send) + .exceptionally(response::send); + } + + /** + * Gets the employees by the last name specified in the parameter. + * @param request the server request + * @param response the server response + */ + private void getByLastName(final ServerRequest request, final ServerResponse response) { + LOGGER.fine("getByLastName"); + + String name = request.path().param("name"); + // Invalid query strings handled in isValidQueryStr. Keeping DRY + if (isValidQueryStr(response, name)) { + this.employees.getByLastName(name) + .thenAccept(response::send) + .exceptionally(response::send); + } + } + + /** + * Gets the employees by the title specified in the parameter. + * @param request the server request + * @param response the server response + */ + private void getByTitle(final ServerRequest request, final ServerResponse response) { + LOGGER.fine("getByTitle"); + + String title = request.path().param("name"); + if (isValidQueryStr(response, title)) { + this.employees.getByTitle(title) + .thenAccept(response::send) + .exceptionally(response::send); + } + } + + /** + * Gets the employees by the department specified in the parameter. + * @param request the server request + * @param response the server response + */ + private void getByDepartment(final ServerRequest request, final ServerResponse response) { + LOGGER.fine("getByDepartment"); + + String department = request.path().param("name"); + if (isValidQueryStr(response, department)) { + this.employees.getByDepartment(department) + .thenAccept(response::send) + .exceptionally(response::send); + } + } + + /** + * Gets the employees by the ID specified in the parameter. + * @param request the server request + * @param response the server response + */ + private void getEmployeeById(ServerRequest request, ServerResponse response) { + LOGGER.fine("getEmployeeById"); + + String id = request.path().param("id"); + // If invalid, response handled in isValidId. Keeping DRY + if (isValidQueryStr(response, id)) { + this.employees.getById(id) + .thenAccept(it -> { + if (it.isPresent()) { + // found + response.send(it.get()); + } else { + // not found + response.status(404).send(); + } + }) + .exceptionally(response::send); + } + } + + /** + * Saves a new employee. + * @param request the server request + * @param response the server response + */ + private void save(ServerRequest request, ServerResponse response) { + LOGGER.fine("save"); + + request.content() + .as(Employee.class) + .thenApply(e -> Employee.of(null, + e.getFirstName(), + e.getLastName(), + e.getEmail(), + e.getPhone(), + e.getBirthDate(), + e.getTitle(), + e.getDepartment())) + .thenCompose(this.employees::save) + .thenAccept(it -> response.status(201).send()) + .exceptionally(response::send); + } + + /** + * Updates an existing employee. + * @param request the server request + * @param response the server response + */ + private void update(ServerRequest request, ServerResponse response) { + LOGGER.fine("update"); + + String id = request.path().param("id"); + + if (isValidQueryStr(response, id)) { + request.content() + .as(Employee.class) + .thenCompose(e -> this.employees.update(e, id)) + .thenAccept(count -> { + if (count == 0) { + response.status(404).send(); + } else { + response.status(204).send(); + } + }) + .exceptionally(response::send); + + } + + } + + /** + * Deletes an existing employee. + * @param request the server request + * @param response the server response + */ + private void delete(final ServerRequest request, final ServerResponse response) { + LOGGER.fine("delete"); + + String id = request.path().param("id"); + + if (isValidQueryStr(response, id)) { + this.employees.deleteById(id) + .thenAccept(count -> { + if (count == 0) { + response.status(404).send(); + } else { + response.status(204).send(); + } + }) + .exceptionally(response::send); + } + } + + /** + * Validates the parameter. + * @param response the server response + * @param nameStr + * @return + */ + private boolean isValidQueryStr(ServerResponse response, String nameStr) { + Map errorMessage = new HashMap<>(); + if (nameStr == null || nameStr.isEmpty() || nameStr.length() > 100) { + errorMessage.put("errorMessage", "Invalid query string"); + response.status(400).send(errorMessage); + return false; + } else { + return true; + } + } +} diff --git a/examples/employee-app/src/main/java/io/helidon/service/employee/Main.java b/examples/employee-app/src/main/java/io/helidon/service/employee/Main.java new file mode 100644 index 00000000..ed98b465 --- /dev/null +++ b/examples/employee-app/src/main/java/io/helidon/service/employee/Main.java @@ -0,0 +1,106 @@ +/* + * Copyright (c) 2019, 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.service.employee; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonb.JsonbSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +/** + * Simple Employee rest application. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // Get webserver config from the "server" section of application.yaml and JSON support registration + Single server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonbSupport.create()) + .build() + .start(); + + server.thenAccept(ws -> { + System.out.println("WEB server is up!"); + System.out.println("Web client at: http://localhost:" + ws.port() + + "/public/index.html"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }).exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + // Server threads are not daemon. No need to block. Just react. + + return server; + } + + /** + * Creates new {@link Routing}. + * + * @param config configuration of this server + * @return routing configured with a health check, and a service + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + EmployeeService employeeService = new EmployeeService(config); + HealthSupport health = HealthSupport.builder().addLiveness(HealthChecks.healthChecks()) + .build(); // Adds a convenient set of checks + + return Routing.builder() + .register("/public", StaticContentSupport.builder("public") + .welcomeFileName("index.html")) + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register("/employees", employeeService) + .build(); + } + +} diff --git a/examples/employee-app/src/main/java/io/helidon/service/employee/package-info.java b/examples/employee-app/src/main/java/io/helidon/service/employee/package-info.java new file mode 100644 index 00000000..817243c9 --- /dev/null +++ b/examples/employee-app/src/main/java/io/helidon/service/employee/package-info.java @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Employee example application + *

+ * Start with {@link io.helidon.service.employee.Main} class. + * + * @see io.helidon.service.employee.Main + */ +package io.helidon.service.employee; diff --git a/examples/employee-app/src/main/resources/application.yaml b/examples/employee-app/src/main/resources/application.yaml new file mode 100644 index 00000000..946d4854 --- /dev/null +++ b/examples/employee-app/src/main/resources/application.yaml @@ -0,0 +1,29 @@ +# +# Copyright (c) 2019, 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. +# + +app: + # database user, such as "system" + user: + # database password + password: + # host url - remove to use the default of Oracle XE (localhost:1521/XE) + hosturl: :/. + # switch to "Database" to use database. Uses in-memory structure otherwise + drivertype: Array + +server: + port: 8080 + host: 0.0.0.0 diff --git a/examples/employee-app/src/main/resources/employees.json b/examples/employee-app/src/main/resources/employees.json new file mode 100644 index 00000000..bce81a67 --- /dev/null +++ b/examples/employee-app/src/main/resources/employees.json @@ -0,0 +1,402 @@ +[ + { + "id": "84240085-7c68-4930-8fb3-2f9be11b6810", + "firstName": "Hugh", + "lastName": "Jast", + "email": "Hugh.Jast@example.com", + "phone": "730-715-4446", + "birthDate": "1970-11-28", + "title": "National Data Strategist", + "department": "Mobility" + }, + { + "id": "f9971d4f-5b30-4553-8d5c-2116f9a58264", + "firstName": "Toy", + "lastName": "Herzog", + "email": "Toy.Herzog@example.com", + "phone": "769-569-1789", + "birthDate": "1961-08-08", + "title": "Dynamic Operations Manager", + "department": "Paradigm" + }, + { + "id": "5b8a19f4-8ccf-49b2-9d68-9644c29eb0f0", + "firstName": "Reed", + "lastName": "Hahn", + "email": "Reed.Hahn@example.com", + "phone": "429-071-2018", + "birthDate": "1977-02-05", + "title": "Future Directives Facilitator", + "department": "Quality" + }, + { + "id": "07700c37-a418-4762-9d7e-831dc1ea797e", + "firstName": "Novella", + "lastName": "Bahringer", + "email": "Novella.Bahringer@example.com", + "phone": "293-596-3547", + "birthDate": "1961-07-25", + "title": "Principal Factors Architect", + "department": "Division" + }, + { + "id": "11c9cf10-fbbd-4ffa-8ef6-038a4bce9713", + "firstName": "Zora", + "lastName": "Sawayn", + "email": "Zora.Sawayn@example.com", + "phone": "923-814-0502", + "birthDate": "1978-03-18", + "title": "Dynamic Marketing Designer", + "department": "Security" + }, + { + "id": "19737839-97a8-4b07-b52b-828db9f98e0a", + "firstName": "Cordia", + "lastName": "Willms", + "email": "Cordia.Willms@example.com", + "phone": "778-821-3941", + "birthDate": "1989-03-31", + "title": "Human Division Representative", + "department": "Optimization" + }, + { + "id": "3e8822ea-6a3d-4855-9e79-d918c7733ec5", + "firstName": "Clair", + "lastName": "Bartoletti", + "email": "Clair.Bartoletti@example.com", + "phone": "647-896-8993", + "birthDate": "1986-01-04", + "title": "Customer Marketing Executive", + "department": "Factors" + }, + { + "id": "2937368c-2dd9-4e86-908c-4a39a27bde39", + "firstName": "Joe", + "lastName": "Beahan", + "email": "Joe.Beahan@example.com", + "phone": "548-890-6181", + "birthDate": "1990-07-11", + "title": "District Group Specialist", + "department": "Program" + }, + { + "id": "e74f77d9-69f2-48ac-8a7f-b90a70bdeeea", + "firstName": "Daphney", + "lastName": "Feest", + "email": "Daphney.Feest@example.com", + "phone": "143-967-7041", + "birthDate": "1984-03-26", + "title": "Dynamic Mobility Consultant", + "department": "Metrics" + }, + { + "id": "154df9ce-1e86-47e1-a770-306a26cd62e9", + "firstName": "Janessa", + "lastName": "Wyman", + "email": "Janessa.Wyman@example.com", + "phone": "498-186-9009", + "birthDate": "1985-09-06", + "title": "Investor Brand Associate", + "department": "Markets" + }, + { + "id": "92c8b250-786d-47eb-a7f5-eabe3d6e39c2", + "firstName": "Mara", + "lastName": "Roob", + "email": "Mara.Roob@example.com", + "phone": "962-540-9884", + "birthDate": "1975-05-11", + "title": "Legacy Assurance Engineer", + "department": "Usability" + }, + { + "id": "9e046988-c561-417f-9696-f14608c00bd4", + "firstName": "Brennon", + "lastName": "Bernhard", + "email": "Brennon.Bernhard@example.com", + "phone": "395-224-9853", + "birthDate": "1963-12-05", + "title": "Product Web Officer", + "department": "Interactions" + }, + { + "id": "490a1262-15a7-4606-84ae-6e02f6671c13", + "firstName": "Amya", + "lastName": "Bernier", + "email": "Amya.Bernier@example.com", + "phone": "563-562-4171", + "birthDate": "1972-06-23", + "title": "Global Tactics Planner", + "department": "Program" + }, + { + "id": "60bad2bd-a71d-4494-bff1-09940809c51c", + "firstName": "Claud", + "lastName": "Boehm", + "email": "Claud.Boehm@example.com", + "phone": "089-073-7399", + "birthDate": "1965-02-27", + "title": "National Marketing Associate", + "department": "Directives" + }, + { + "id": "0f48efc9-a820-42c0-9d8f-2ae962d0ce7b", + "firstName": "Nyah", + "lastName": "Schowalter", + "email": "Nyah.Schowalter@example.com", + "phone": "823-063-7120", + "birthDate": "1969-02-19", + "title": "Dynamic Communications Assistant", + "department": "Metrics" + }, + { + "id": "3323fc7a-dcb9-4cfe-9e59-4160290c1ccc", + "firstName": "Imogene", + "lastName": "Bernhard", + "email": "Imogene.Bernhard@example.com", + "phone": "747-970-6062", + "birthDate": "1958-02-09", + "title": "Dynamic Assurance Supervisor", + "department": "Paradigm" + }, + { + "id": "44c5fe14-d1a3-416a-aab8-f569c3ed2eca", + "firstName": "Chanel", + "lastName": "Kuhlman", + "email": "Chanel.Kuhlman@example.com", + "phone": "882-145-9513", + "birthDate": "1985-03-03", + "title": "District Paradigm Representative", + "department": "Integration" + }, + { + "id": "8235e91e-3024-47f8-afd8-577617cfb8bf", + "firstName": "Cierra", + "lastName": "Morar", + "email": "Cierra.Morar@example.com", + "phone": "273-607-2209", + "birthDate": "1965-01-25", + "title": "Dynamic Data Planner", + "department": "Paradigm" + }, + { + "id": "5733bed9-ce41-4ed5-8b29-9288318dd5a7", + "firstName": "Faye", + "lastName": "Grimes", + "email": "Faye.Grimes@example.com", + "phone": "750-139-1344", + "birthDate": "1962-08-21", + "title": "Central Applications Analyst", + "department": "Tactics" + }, + { + "id": "34956311-26fb-46b1-abf0-a95a08d929ea", + "firstName": "Doyle", + "lastName": "Rohan", + "email": "Doyle.Rohan@example.com", + "phone": "093-457-5621", + "birthDate": "1991-11-29", + "title": "Corporate Accountability Supervisor", + "department": "Applications" + }, + { + "id": "2e121065-431a-4ba2-aeb4-3919fcb7969a", + "firstName": "Jonathan", + "lastName": "Barrows", + "email": "Jonathan.Barrows@example.com", + "phone": "262-503-2161", + "birthDate": "1963-12-15", + "title": "Regional Configuration Liason", + "department": "Implementation" + }, + { + "id": "99d0603f-03cc-4dca-bebe-a711eaf14d77", + "firstName": "Myriam", + "lastName": "Luettgen", + "email": "Myriam.Luettgen@example.com", + "phone": "951-924-8295", + "birthDate": "1962-02-08", + "title": "Central Functionality Specialist", + "department": "Accountability" + }, + { + "id": "50653f57-3379-4bfd-9999-2ec86ab1131d", + "firstName": "Johnnie", + "lastName": "Schiller", + "email": "Johnnie.Schiller@example.com", + "phone": "534-025-2200", + "birthDate": "1965-04-11", + "title": "Principal Creative Developer", + "department": "Interactions" + }, + { + "id": "d93c7987-69c8-4333-99fe-d1561b338722", + "firstName": "Laila", + "lastName": "White", + "email": "Laila.White@example.com", + "phone": "468-939-2298", + "birthDate": "1956-01-04", + "title": "Corporate Optimization Engineer", + "department": "Assurance" + }, + { + "id": "ac90bb96-79e1-424a-94f6-90f7c01ea4b3", + "firstName": "Alessandra", + "lastName": "Becker", + "email": "Alessandra.Becker@example.com", + "phone": "081-724-0866", + "birthDate": "1984-08-12", + "title": "Central Identity Associate", + "department": "Quality" + }, + { + "id": "215f86fb-8434-4b75-8cc2-4bf731b71f6f", + "firstName": "Shannon", + "lastName": "McCullough", + "email": "Shannon.McCullough@example.com", + "phone": "101-995-1089", + "birthDate": "1989-02-25", + "title": "Global Data Engineer", + "department": "Division" + }, + { + "id": "f09f164c-7fc2-4afe-b9ae-29bc1c48b529", + "firstName": "Garnet", + "lastName": "Labadie", + "email": "Garnet.Labadie@example.com", + "phone": "147-954-6624", + "birthDate": "1990-01-01", + "title": "Senior Communications Producer", + "department": "Program" + }, + { + "id": "b16d7d13-e4ee-4293-bb2d-c79d98485ef0", + "firstName": "Mark", + "lastName": "Graham", + "email": "Mark.Graham@example.com", + "phone": "462-746-7388", + "birthDate": "1991-08-23", + "title": "Legacy Directives Agent", + "department": "Assurance" + }, + { + "id": "3ff0adc3-09e0-4490-900c-9d59dd622bd8", + "firstName": "Tristin", + "lastName": "Bayer", + "email": "Tristin.Bayer@example.com", + "phone": "882-044-3996", + "birthDate": "1964-03-26", + "title": "Internal Marketing Officer", + "department": "Intranet" + }, + { + "id": "c1e5e2ad-2ee9-4eb1-af9e-e9e17fe694bc", + "firstName": "Maurice", + "lastName": "Renner", + "email": "Maurice.Renner@example.com", + "phone": "383-435-0943", + "birthDate": "1973-11-05", + "title": "National Accountability Planner", + "department": "Accounts" + }, + { + "id": "06a0ac23-ff09-4f27-971d-1b901e5ff1c8", + "firstName": "Preston", + "lastName": "Stark", + "email": "Preston.Stark@example.com", + "phone": "080-698-9552", + "birthDate": "1994-02-02", + "title": "Corporate Program Orchestrator", + "department": "Integration" + }, + { + "id": "2443a803-39ec-435b-9bda-1bfdee716308", + "firstName": "Mabelle", + "lastName": "Herman", + "email": "Mabelle.Herman@example.com", + "phone": "778-672-2787", + "birthDate": "1956-11-30", + "title": "Human Identity Officer", + "department": "Integration" + }, + { + "id": "45d87394-7fb2-430a-9b65-714b5266b8a1", + "firstName": "Juvenal", + "lastName": "Swaniawski", + "email": "Juvenal.Swaniawski@example.com", + "phone": "349-906-2745", + "birthDate": "1963-11-17", + "title": "Future Program Planner", + "department": "Response" + }, + { + "id": "f0b4ec27-af12-4694-aee2-77a620c6fb5e", + "firstName": "Rachelle", + "lastName": "Okuneva", + "email": "Rachelle.Okuneva@example.com", + "phone": "134-565-3868", + "birthDate": "1992-05-27", + "title": "District Creative Architect", + "department": "Paradigm" + }, + { + "id": "7c4dc3be-6141-4ce2-8513-cee11e2708d1", + "firstName": "Macey", + "lastName": "Weissnat", + "email": "Macey.Weissnat@example.com", + "phone": "210-461-3749", + "birthDate": "1978-06-24", + "title": "Product Accountability Facilitator", + "department": "Data" + }, + { + "id": "c4282cf5-f10b-4752-b201-a1f6cb469212", + "firstName": "Ena", + "lastName": "Gerlach", + "email": "Ena.Gerlach@example.com", + "phone": "429-925-7634", + "birthDate": "1976-04-09", + "title": "Human Tactics Agent", + "department": "Creative" + }, + { + "id": "2b32bbbd-c4bb-426c-a759-1664f40db4c8", + "firstName": "Darrick", + "lastName": "Deckow", + "email": "Darrick.Deckow@example.com", + "phone": "549-222-4121", + "birthDate": "1956-10-25", + "title": "Lead Solutions Producer", + "department": "Metrics" + }, + { + "id": "65389ce1-d930-48ae-9347-49741496dc4e", + "firstName": "Palma", + "lastName": "Torp", + "email": "Palma.Torp@example.com", + "phone": "346-556-3517", + "birthDate": "1967-06-24", + "title": "Product Infrastructure Consultant", + "department": "Response" + }, + { + "id": "9cbaf350-0e00-4aaf-84a4-b348f75257ca", + "firstName": "Lucious", + "lastName": "Steuber", + "email": "Lucious.Steuber@example.com", + "phone": "977-372-2840", + "birthDate": "1961-11-24", + "title": "District Creative Supervisor", + "department": "Mobility" + }, + { + "id": "72de2181-3f3d-4b0d-a528-bc60a1aa0a12", + "firstName": "Kacey", + "lastName": "Kilback", + "email": "Kacey.Kilback@example.com", + "phone": "268-777-2011", + "birthDate": "1957-09-06", + "title": "Corporate Mobility Agent", + "department": "Infrastructure" + } +] \ No newline at end of file diff --git a/examples/employee-app/src/main/resources/logging.properties b/examples/employee-app/src/main/resources/logging.properties new file mode 100644 index 00000000..ab333c92 --- /dev/null +++ b/examples/employee-app/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2019, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/employee-app/src/main/resources/public/EmployeeController.js b/examples/employee-app/src/main/resources/public/EmployeeController.js new file mode 100644 index 00000000..d25e6ceb --- /dev/null +++ b/examples/employee-app/src/main/resources/public/EmployeeController.js @@ -0,0 +1,218 @@ +/* + * Copyright (c) 2019, 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. + */ +var server = "/"; + +function search (){ + var searchTerm = $("#searchText").val().trim(); + if (searchTerm != "") { + $("#people").show(); + $("#people").html("SEARCHING..."); + $.ajax({ + url: server + "employees/" + + $("#searchType").val() + "/" + + encodeURIComponent(searchTerm), + method: "GET" + }).done( + function(data) { + $("#people").empty(); + $("#people").hide(); + if (data.length == 0) { + $("#people").html(""); + $("#notFound").show(); + $("#notFound").html("No people found matching your search criteria"); + } else { + showResults(data); + } + $("#people").show(400, "swing"); + }); + } else { + loadEmployees(); + } +} + +$(function() { + $("#searchText").on("keyup", function(e) { + if (e.keyCode == 13) { + search (); + } + }); +}); + +function showResults(data){ + $("#people").hide(); + $("#people").empty(); + $("#notFound").hide(); + data.forEach(function(employee) { + var item = $(renderEmployees(employee)); + item.on("click", function() { + var detailItem = $(renderDetailEmployee(employee)); + $("#home").hide(); + $("#detail").empty(); + $("#notFound").hide(); + $("#detail").append(detailItem); + $("#people").hide( + 400, + "swing", + function() { + $("#detail").show() + }); + }); + $("#people").append(item); + }); +} + +function showEmployeeForm() { + $("#notFound").hide(); + $("#editForm").hide(); + $("#deleteButton").hide(); + $("#employeeForm").show(); + $("#formTitle").text("Add Employee"); + $("#home").hide(); + $("#people").hide(); +} + +function loadEmployees() { + $("#notFound").hide(); + $("#searchText").val(""); + $("#employeeForm").hide(); + $("#editForm").hide(); + $("#home").show(); + $("#people").show(); + $("#people").html("LOADING..."); + $.ajax({ + dataType: "json", + url: server + "employees", + method: "GET" + }).done(function(data) { + showResults(data); + $("#people").show(400, "swing"); + }); +} + + +function renderEmployees(employee){ + var template = $('#employees_tpl').html(); + Mustache.parse(template); + var rendered = Mustache.render(template, { + "firstName" : employee.firstName, + "lastName" : employee.lastName, + "title" : employee.title, + "department" : employee.department + }); + return rendered; +} + +function renderDetailEmployee(employee){ + var template = $('#detail_tpl').html(); + Mustache.parse(template); + var rendered = Mustache.render(template,{ + "id" : employee.id, + "firstName" : employee.firstName, + "lastName" : employee.lastName, + "email" : employee.email, + "birthDate" : employee.birthDate, + "phone" : employee.phone, + "title" : employee.title, + "department" : employee.department + }); + return rendered; +} + +function save() { + var employee = { + id: "", + firstName: $("#firstName").val(), + lastName: $("#lastName").val(), + email: $("#email").val(), + phone: $("#phone").val(), + birthDate: $("#birthDate").val(), + title: $("#title").val(), + department: $("#department").val() + }; + $.ajax({ + url: server + "employees", + method: "POST", + data: JSON.stringify(employee) + }).done(function(data) { + $("#detail").hide(); + $("#firstName").val(""); + $("#lastName").val(""); + $("#email").val(""); + $("#phone").val(""); + $("#birthDate").val(""); + $("#title").val(""); + $("#department").val(""); + loadEmployees(); + }); + +} + +function updateEmployee() { + var employee = { + id: $("#editId").val(), + firstName: $("#editFirstName").val(), + lastName: $("#editLastName").val(), + email: $("#editEmail").val(), + phone: $("#editPhone").val(), + birthDate: $("#editBirthDate").val(), + title: $("#editTitle").val(), + department: $("#editDepartment").val() + }; + $("#detail").html("UPDATING..."); + $.ajax({ + url: server + "employees/" + employee.id, + method: "PUT", + data: JSON.stringify(employee) + }).done(function(data) { + $("#detail").hide(); + loadEmployees(); + }); +} + +function deleteEmployee() { + var employee = { + firstName: $("#editFirstName").val(), + lastName: $("#editLastName").val(), + id: $("#editId").val() + }; + $('

').dialog({ + modal: true, + title: "Confirm Delete", + open: function() { + var markup = 'Are you sure you want to delete ' + + employee.firstName + ' ' + employee.lastName + + " employee?"; + $(this).html(markup); + }, + buttons: { + Ok: function() { + $("#detail").html("DELETING..."); + $(this).dialog("close"); + $.ajax({ + url: server + "employees/" + employee.id, + method: "DELETE" + }).done(function(data) { + $("#detail").hide(); + loadEmployees(); + }); + }, + Cancel: function() { + $(this).dialog("close"); + } + } + }); + +} \ No newline at end of file diff --git a/examples/employee-app/src/main/resources/public/index.html b/examples/employee-app/src/main/resources/public/index.html new file mode 100644 index 00000000..7351e33c --- /dev/null +++ b/examples/employee-app/src/main/resources/public/index.html @@ -0,0 +1,399 @@ + + + + + + + + + + + + + + + + + + + + + + +

Cloud Employee App

+ + +
+
+
LOADING...
+
+
+ + + + diff --git a/examples/employee-app/src/main/resources/public/nopic.png b/examples/employee-app/src/main/resources/public/nopic.png new file mode 100644 index 00000000..5967653c Binary files /dev/null and b/examples/employee-app/src/main/resources/public/nopic.png differ diff --git a/examples/employee-app/src/test/java/io/helidon/service/employee/MainTest.java b/examples/employee-app/src/test/java/io/helidon/service/employee/MainTest.java new file mode 100644 index 00000000..be351128 --- /dev/null +++ b/examples/employee-app/src/test/java/io/helidon/service/employee/MainTest.java @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2019, 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.service.employee; + +import java.util.concurrent.TimeUnit; + +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + + @BeforeAll + public static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addHeader(Http.Header.ACCEPT, MediaType.APPLICATION_JSON.toString()) + .build(); + } + + @AfterAll + public static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + public void testHelloWorld() { + webClient.get() + .path("/employees") + .request() + .thenAccept(response -> { + response.close(); + assertThat("HTTP response2", response.status(), is(Http.Status.OK_200)); + }) + .await(); + + webClient.get() + .path("/health") + .request() + .thenAccept(response -> { + response.close(); + assertThat("HTTP response2", response.status(), is(Http.Status.OK_200)); + }) + .await(); + + webClient.get() + .path("/metrics") + .request() + .thenAccept(response -> { + response.close(); + assertThat("HTTP response2", response.status(), is(Http.Status.OK_200)); + }) + .await(); + } + +} diff --git a/examples/graphql/basics/README.md b/examples/graphql/basics/README.md new file mode 100644 index 00000000..f1134671 --- /dev/null +++ b/examples/graphql/basics/README.md @@ -0,0 +1,35 @@ +# Helidon GraphQL Basic Example + +This example shows the basics of using Helidon SE GraphQL. The example +manually creates a GraphQL Schema using the [GraphQL Java](https://github.com/graphql-java/graphql-java) API. + +## Build and run + +Start the application: + +```shell +mvn package +java -jar target/helidon-examples-graphql-basics.jar +``` + +Note the port number reported by the application. + +Probe the GraphQL endpoints: + +1. Hello word endpoint: + +```shell +export PORT=35497 +curl -X POST http://127.0.0.1:${PORT}/graphql -d '{"query":"query { hello }"}' + + #Output: "data":{"hello":"world"}} +``` + +1. Hello in different languages + +```shell +export PORT=35497 +curl -X POST http://127.0.0.1:${PORT}/graphql -d '{"query":"query { helloInDifferentLanguages }"}' + +#Output: {"data":{"helloInDifferentLanguages":["Bonjour","Hola","Zdravstvuyte","Nǐn hǎo","Salve","Gudday","Konnichiwa","Guten Tag"]}} +``` diff --git a/examples/graphql/basics/pom.xml b/examples/graphql/basics/pom.xml new file mode 100644 index 00000000..5042ecb1 --- /dev/null +++ b/examples/graphql/basics/pom.xml @@ -0,0 +1,71 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.graphql + helidon-examples-graphql-basics + 1.0.0-SNAPSHOT + Helidon GraphQL Examples Basics + + + Basic usage of GraphQL in helidon SE + + + + io.helidon.examples.graphql.basics.Main + + + + + io.helidon.graphql + helidon-graphql-server + + + io.helidon.webserver + helidon-webserver + + + io.helidon.common + helidon-common + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/graphql/basics/src/main/java/io/helidon/examples/graphql/basics/Main.java b/examples/graphql/basics/src/main/java/io/helidon/examples/graphql/basics/Main.java new file mode 100644 index 00000000..6c57f96f --- /dev/null +++ b/examples/graphql/basics/src/main/java/io/helidon/examples/graphql/basics/Main.java @@ -0,0 +1,87 @@ +/* + * Copyright (c) 2020, 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.graphql.basics; + +import java.util.List; + +import io.helidon.graphql.server.GraphQlSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import graphql.schema.DataFetcher; +import graphql.schema.GraphQLSchema; +import graphql.schema.StaticDataFetcher; +import graphql.schema.idl.RuntimeWiring; +import graphql.schema.idl.SchemaGenerator; +import graphql.schema.idl.SchemaParser; +import graphql.schema.idl.TypeDefinitionRegistry; + +/** + * Main class of Graphql SE integration example. + */ +public class Main { + + private Main() { + } + + /** + * Start the example. Prints endpoints to standard output. + * + * @param args not used + */ + public static void main(String[] args) { + WebServer server = WebServer.builder() + .routing(Routing.builder() + .register(GraphQlSupport.create(buildSchema())) + .build()) + .build(); + + server.start() + .thenApply(webServer -> { + String endpoint = "http://localhost:" + webServer.port(); + System.out.println("GraphQL started on " + endpoint + "/graphql"); + System.out.println("GraphQL schema available on " + endpoint + "/graphql/schema.graphql"); + return null; + }); + } + + /** + * Generate a {@link GraphQLSchema}. + * @return a {@link GraphQLSchema} + */ + private static GraphQLSchema buildSchema() { + String schema = "type Query{\n" + + "hello: String \n" + + "helloInDifferentLanguages: [String] \n" + + "\n}"; + + SchemaParser schemaParser = new SchemaParser(); + TypeDefinitionRegistry typeDefinitionRegistry = schemaParser.parse(schema); + + // DataFetcher to return various hello's in difference languages + DataFetcher> hellosDataFetcher = (DataFetcher>) environment -> + List.of("Bonjour", "Hola", "Zdravstvuyte", "Nǐn hǎo", "Salve", "Gudday", "Konnichiwa", "Guten Tag"); + + RuntimeWiring runtimeWiring = RuntimeWiring.newRuntimeWiring() + .type("Query", builder -> builder.dataFetcher("hello", new StaticDataFetcher("world"))) + .type("Query", builder -> builder.dataFetcher("helloInDifferentLanguages", hellosDataFetcher)) + .build(); + + SchemaGenerator schemaGenerator = new SchemaGenerator(); + return schemaGenerator.makeExecutableSchema(typeDefinitionRegistry, runtimeWiring); + } +} diff --git a/examples/graphql/basics/src/main/java/io/helidon/examples/graphql/basics/package-info.java b/examples/graphql/basics/src/main/java/io/helidon/examples/graphql/basics/package-info.java new file mode 100644 index 00000000..23b3ca70 --- /dev/null +++ b/examples/graphql/basics/src/main/java/io/helidon/examples/graphql/basics/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2020, 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 of healthchecks in helidon SE. + */ +package io.helidon.examples.graphql.basics; diff --git a/examples/graphql/pom.xml b/examples/graphql/pom.xml new file mode 100644 index 00000000..ea2da77a --- /dev/null +++ b/examples/graphql/pom.xml @@ -0,0 +1,35 @@ + + + + + 4.0.0 + + helidon-examples-project + io.helidon.examples + 1.0.0-SNAPSHOT + + io.helidon.examples.graphql + helidon-examples-graphql-project + pom + Helidon GraphQL Examples + + + basics + + diff --git a/examples/grpc/.dockerignore b/examples/grpc/.dockerignore new file mode 100644 index 00000000..901b6e6f --- /dev/null +++ b/examples/grpc/.dockerignore @@ -0,0 +1 @@ +*/target/ diff --git a/examples/grpc/README.md b/examples/grpc/README.md new file mode 100644 index 00000000..70fd1bfd --- /dev/null +++ b/examples/grpc/README.md @@ -0,0 +1 @@ +# Helidon MP and SE gRPC Server Examples diff --git a/examples/grpc/basics/README.md b/examples/grpc/basics/README.md new file mode 100644 index 00000000..44eba617 --- /dev/null +++ b/examples/grpc/basics/README.md @@ -0,0 +1,24 @@ +# Helidon gRPC Example + +A basic example gRPC server. + +## Build and run + +```shell +mvn -f ../pom.xml -pl common,basics package +java -jar target/helidon-examples-grpc-basics.jar +``` + +Exercise the example: +```shell +java -cp target/helidon-examples-grpc-basics.jar \ + io.helidon.grpc.examples.basics.HealthClient +``` + +The HealthClient will give this output: +```text +GreetService response -> status: SERVING + +FooService StatusRuntimeException.getMessage() -> NOT_FOUND: Service 'FooService' does not exist or does not have a registered health check + +``` diff --git a/examples/grpc/basics/pom.xml b/examples/grpc/basics/pom.xml new file mode 100644 index 00000000..f69bcc61 --- /dev/null +++ b/examples/grpc/basics/pom.xml @@ -0,0 +1,79 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-basics + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples Basics + + + Examples of elementary use of the gRPC Server + + + + io.helidon.grpc.examples.basics.Server + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.grpc + helidon-grpc-server + + + io.helidon.grpc + helidon-grpc-client + + + io.helidon.health + helidon-health-checks + + + io.helidon.bundles + helidon-bundles-config + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/HealthClient.java b/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/HealthClient.java new file mode 100644 index 00000000..ec288f75 --- /dev/null +++ b/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/HealthClient.java @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.basics; + +import io.helidon.grpc.client.ClientServiceDescriptor; +import io.helidon.grpc.client.GrpcServiceClient; + +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; +import io.grpc.StatusRuntimeException; +import io.grpc.health.v1.HealthCheckRequest; +import io.grpc.health.v1.HealthCheckResponse; +import io.grpc.health.v1.HealthGrpc; + +/** + * A gRPC health check client implemented with Helidon gRPC client API. + *

+ * This example uses the java-grpc built in health check client. + */ +public class HealthClient { + + private HealthClient() { + } + + /** + * The program entry point. + * + * @param args the program arguments + */ + public static void main(String[] args) { + ClientServiceDescriptor descriptor = ClientServiceDescriptor + .builder(HealthGrpc.getServiceDescriptor()) + .build(); + + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + GrpcServiceClient grpcClient = GrpcServiceClient.create(channel, descriptor); + + // query the health of a deployed service + HealthCheckResponse response = grpcClient.blockingUnary("Check", + HealthCheckRequest.newBuilder().setService("GreetService").build()); + + System.out.println("GreetService response -> " + response); + + // query the health of a non-existent service + try { + grpcClient.blockingUnary("Check", + HealthCheckRequest.newBuilder().setService("FooService").build()); + } catch (StatusRuntimeException e) { + // expect to catch a NOT_FOUND exception + System.out.println("FooService StatusRuntimeException.getMessage() -> " + e.getMessage()); + } + } +} diff --git a/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/Server.java b/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/Server.java new file mode 100644 index 00000000..c1148260 --- /dev/null +++ b/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/Server.java @@ -0,0 +1,105 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.basics; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.GreetService; +import io.helidon.grpc.examples.common.GreetServiceJava; +import io.helidon.grpc.examples.common.StringService; +import io.helidon.grpc.server.GrpcRouting; +import io.helidon.grpc.server.GrpcServer; +import io.helidon.grpc.server.GrpcServerConfiguration; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * A basic example of a Helidon gRPC server. + */ +public class Server { + + private Server() { + } + + /** + * The main program entry point. + * + * @param args the program arguments + */ + public static void main(String[] args) { + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // load logging configuration + LogConfig.configureRuntime(); + + // Get gRPC server config from the "grpc" section of application.yaml + GrpcServerConfiguration serverConfig = + GrpcServerConfiguration.builder(config.get("grpc")).build(); + + GrpcServer grpcServer = GrpcServer.create(serverConfig, createRouting(config)); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + grpcServer.start() + .thenAccept(s -> { + System.out.println("gRPC server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + // add support for standard and gRPC health checks + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) + .addLiveness(grpcServer.healthChecks()) + .build(); + + // start web server with health endpoint + Routing routing = Routing.builder() + .register(health) + .build(); + + WebServer.create(routing, config.get("webserver")) + .start() + .thenAccept(s -> { + System.out.println("HTTP server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("HTTP server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + } + + private static GrpcRouting createRouting(Config config) { + GreetService greetService = new GreetService(config); + GreetServiceJava greetServiceJava = new GreetServiceJava(config); + + return GrpcRouting.builder() + .register(greetService) + .register(greetServiceJava) + .register(new StringService()) + .build(); + } +} diff --git a/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/package-info.java b/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/package-info.java new file mode 100644 index 00000000..273d3f5f --- /dev/null +++ b/examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * A set of small usage examples. Start with {@link io.helidon.grpc.examples.basics.Server Main} class. + */ +package io.helidon.grpc.examples.basics; diff --git a/examples/grpc/basics/src/main/resources/application.yaml b/examples/grpc/basics/src/main/resources/application.yaml new file mode 100644 index 00000000..51f97bec --- /dev/null +++ b/examples/grpc/basics/src/main/resources/application.yaml @@ -0,0 +1,29 @@ +# +# Copyright (c) 2019, 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. +# + +app: + greeting: "Hello" + +grpc: + name: "test.server" + port: 1408 + marshaller: + java: + enabled: true + +webserver: + port: 8080 + bind-address: "0.0.0.0" \ No newline at end of file diff --git a/examples/grpc/basics/src/main/resources/logging.properties b/examples/grpc/basics/src/main/resources/logging.properties new file mode 100644 index 00000000..ab333c92 --- /dev/null +++ b/examples/grpc/basics/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2019, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/grpc/client-standalone/README.md b/examples/grpc/client-standalone/README.md new file mode 100644 index 00000000..428baa69 --- /dev/null +++ b/examples/grpc/client-standalone/README.md @@ -0,0 +1,18 @@ +# Helidon gRPC Standalone client + +An example gRPC client. Can be used with the [basics](../basics/README.md) example that would act as a server. + +This example is created to test native image on pure client side, so it does not have a server side +implemented. + +## Build and run + +```shell +mvn -f ../pom.xml -pl common,client-standalone package +java -jar target/helidon-examples-grpc-client-standalone.jar +``` + +The client invokes the string service on the server, and should print out: +```text +Text 'lower case original' to upper case is 'LOWER CASE ORIGINAL' +``` diff --git a/examples/grpc/client-standalone/pom.xml b/examples/grpc/client-standalone/pom.xml new file mode 100644 index 00000000..7eb8722f --- /dev/null +++ b/examples/grpc/client-standalone/pom.xml @@ -0,0 +1,88 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-client-standalone + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples Standalone client + + + A standalone client invoking a strings gRPC service (such as in basics example) + + + + io.helidon.grpc.examples.client.standalone.StandaloneClient + + + + + io.helidon.grpc + helidon-grpc-core + + + io.helidon.grpc + helidon-grpc-client + + + io.grpc + grpc-netty + + + io.grpc + grpc-services + + + io.grpc + grpc-protobuf + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.xolstice.maven.plugins + protobuf-maven-plugin + + + + compile + compile-custom + + + + + + + diff --git a/examples/grpc/client-standalone/src/main/java/io/helidon/grpc/examples/client/standalone/StandaloneClient.java b/examples/grpc/client-standalone/src/main/java/io/helidon/grpc/examples/client/standalone/StandaloneClient.java new file mode 100644 index 00000000..d71e2191 --- /dev/null +++ b/examples/grpc/client-standalone/src/main/java/io/helidon/grpc/examples/client/standalone/StandaloneClient.java @@ -0,0 +1,51 @@ +/* + * 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. + */ + +package io.helidon.grpc.examples.client.standalone; + +import io.helidon.grpc.examples.common.StringServiceGrpc; +import io.helidon.grpc.examples.common.Strings; + +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; + +/** + * A gRPC client using only client side libraries. + * To test it, please setup a server, such as the one in "basics" example of Helidon grpc examples. + */ +public class StandaloneClient { + private StandaloneClient() { + } + + /** + * Start the client with a single invocation to the server. + * + * @param args ignored + */ + public static void main(String[] args) { + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + StringServiceGrpc.StringServiceBlockingStub stub = StringServiceGrpc.newBlockingStub(channel); + + String text = "lower case original"; + Strings.StringMessage request = Strings.StringMessage.newBuilder().setText(text).build(); + Strings.StringMessage response = stub.upper(request); + + System.out.println("Text '" + text + "' to upper case is '" + response.getText() + "'"); + } +} diff --git a/examples/grpc/client-standalone/src/main/java/io/helidon/grpc/examples/client/standalone/package-info.java b/examples/grpc/client-standalone/src/main/java/io/helidon/grpc/examples/client/standalone/package-info.java new file mode 100644 index 00000000..051fdb82 --- /dev/null +++ b/examples/grpc/client-standalone/src/main/java/io/helidon/grpc/examples/client/standalone/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * Standalone gRPC client example. + */ +package io.helidon.grpc.examples.client.standalone; diff --git a/examples/grpc/client-standalone/src/main/proto/strings.proto b/examples/grpc/client-standalone/src/main/proto/strings.proto new file mode 100644 index 00000000..437a75ac --- /dev/null +++ b/examples/grpc/client-standalone/src/main/proto/strings.proto @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2021 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. + */ + + +syntax = "proto3"; +option java_package = "io.helidon.grpc.examples.common"; + +service StringService { + rpc Upper (StringMessage) returns (StringMessage) {} + rpc Lower (StringMessage) returns (StringMessage) {} + rpc Split (StringMessage) returns (stream StringMessage) {} + rpc Join (stream StringMessage) returns (StringMessage) {} + rpc Echo (stream StringMessage) returns (stream StringMessage) {} +} + +message StringMessage { + string text = 1; +} diff --git a/examples/grpc/client-standalone/src/main/resources/logging.properties b/examples/grpc/client-standalone/src/main/resources/logging.properties new file mode 100644 index 00000000..27e59610 --- /dev/null +++ b/examples/grpc/client-standalone/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +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 + +.level=INFO diff --git a/examples/grpc/common/README.md b/examples/grpc/common/README.md new file mode 100644 index 00000000..1ac7eb2d --- /dev/null +++ b/examples/grpc/common/README.md @@ -0,0 +1 @@ +# Helidon gRPC Examples Common Library diff --git a/examples/grpc/common/pom.xml b/examples/grpc/common/pom.xml new file mode 100644 index 00000000..381e0f97 --- /dev/null +++ b/examples/grpc/common/pom.xml @@ -0,0 +1,91 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-common + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples ProtoBuf Services + + + ProtoBuf generated gRPC services used in gRPC examples + + + + io.helidon.grpc.examples.common.GreetClient + + + + + io.helidon.grpc + helidon-grpc-server + + + io.helidon.grpc + helidon-grpc-client + + + io.grpc + grpc-netty + + + io.grpc + grpc-services + + + io.grpc + grpc-protobuf + + + io.helidon.common + helidon-common + + + + + + + kr.motd.maven + os-maven-plugin + + + + + org.xolstice.maven.plugins + protobuf-maven-plugin + + + + compile + compile-custom + + + + + + + diff --git a/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/EchoService.java b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/EchoService.java new file mode 100644 index 00000000..37274788 --- /dev/null +++ b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/EchoService.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.common; + + +import io.grpc.stub.StreamObserver; + +/** + * An implementation of the protocol buffer generated EchoService. + */ +public class EchoService + extends EchoServiceGrpc.EchoServiceImplBase { + + @Override + public void echo(Echo.EchoRequest request, StreamObserver observer) { + observer.onNext(Echo.EchoResponse.newBuilder().setMessage(request.getMessage()).build()); + observer.onCompleted(); + } +} diff --git a/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetClient.java b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetClient.java new file mode 100644 index 00000000..eb7b9b6e --- /dev/null +++ b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetClient.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.common; + +import java.net.URI; + +import io.helidon.grpc.client.ClientRequestAttribute; +import io.helidon.grpc.client.ClientServiceDescriptor; +import io.helidon.grpc.client.ClientTracingInterceptor; +import io.helidon.grpc.client.GrpcServiceClient; +import io.helidon.grpc.examples.common.Greet.GreetRequest; +import io.helidon.grpc.examples.common.Greet.GreetResponse; +import io.helidon.grpc.examples.common.Greet.SetGreetingRequest; +import io.helidon.grpc.examples.common.Greet.SetGreetingResponse; +import io.helidon.tracing.TracerBuilder; + +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; +import io.opentracing.Tracer; + +/** + * A client for the {@link GreetService} implemented with Helidon gRPC client API. + */ +public class GreetClient { + + private GreetClient() { + } + + /** + * The program entry point. + * + * @param args the program arguments + */ + public static void main(String[] args) { + Tracer tracer = TracerBuilder.create("Client") + .collectorUri(URI.create("http://localhost:9411/api/v2/spans")) + .build(); + + ClientTracingInterceptor tracingInterceptor = ClientTracingInterceptor.builder(tracer) + .withVerbosity() + .withTracedAttributes(ClientRequestAttribute.ALL_CALL_OPTIONS) + .build(); + + ClientServiceDescriptor descriptor = ClientServiceDescriptor + .builder(GreetServiceGrpc.getServiceDescriptor()) + .intercept(tracingInterceptor) + .build(); + + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + GrpcServiceClient client = GrpcServiceClient.create(channel, descriptor); + + // Obtain a greeting from the GreetService + GreetRequest request = GreetRequest.newBuilder().setName("Aleks").build(); + GreetResponse firstGreeting = client.blockingUnary("Greet", request); + System.out.println("First greeting: '" + firstGreeting.getMessage() + "'"); + + // Change the greeting + SetGreetingRequest setRequest = SetGreetingRequest.newBuilder().setGreeting("Ciao").build(); + SetGreetingResponse setResponse = client.blockingUnary("SetGreeting", setRequest); + System.out.println("Greeting set to: '" + setResponse.getGreeting() + "'"); + + // Obtain a second greeting from the GreetService + GreetResponse secondGreeting = client.blockingUnary("Greet", request); + System.out.println("Second greeting: '" + secondGreeting.getMessage() + "'"); + } +} diff --git a/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetService.java b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetService.java new file mode 100644 index 00000000..baed382c --- /dev/null +++ b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetService.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.common; + +import java.util.Optional; + +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.Greet.GreetRequest; +import io.helidon.grpc.examples.common.Greet.GreetResponse; +import io.helidon.grpc.examples.common.Greet.SetGreetingRequest; +import io.helidon.grpc.examples.common.Greet.SetGreetingResponse; +import io.helidon.grpc.server.GrpcService; +import io.helidon.grpc.server.ServiceDescriptor; + +import io.grpc.stub.StreamObserver; +import org.eclipse.microprofile.health.HealthCheckResponse; + +import static io.helidon.grpc.core.ResponseHelper.complete; + +/** + * A plain Java implementation of the GreetService. + */ +public class GreetService implements GrpcService { + /** + * The config value for the key {@code greeting}. + */ + private String greeting; + + /** + * Create a {@link GreetService}. + * + * @param config the service configuration + */ + public GreetService(Config config) { + this.greeting = config.get("app.greeting").asString().orElse("Ciao"); + } + + @Override + public void update(ServiceDescriptor.Rules rules) { + rules.proto(Greet.getDescriptor()) + .unary("Greet", this::greet) + .unary("SetGreeting", this::setGreeting) + .healthCheck(this::healthCheck); + } + + // ---- service methods ------------------------------------------------- + + private void greet(GreetRequest request, StreamObserver observer) { + String name = Optional.ofNullable(request.getName()).orElse("World"); + String msg = String.format("%s %s!", greeting, name); + + complete(observer, GreetResponse.newBuilder().setMessage(msg).build()); + } + + private void setGreeting(SetGreetingRequest request, StreamObserver observer) { + greeting = request.getGreeting(); + + complete(observer, SetGreetingResponse.newBuilder().setGreeting(greeting).build()); + } + + private HealthCheckResponse healthCheck() { + return HealthCheckResponse + .named(name()) + .up() + .withData("time", System.currentTimeMillis()) + .withData("greeting", greeting) + .build(); + } +} diff --git a/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetServiceJava.java b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetServiceJava.java new file mode 100644 index 00000000..926e5e46 --- /dev/null +++ b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/GreetServiceJava.java @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.common; + +import java.util.Optional; + +import io.helidon.config.Config; +import io.helidon.grpc.server.GrpcService; +import io.helidon.grpc.server.ServiceDescriptor; + +import io.grpc.stub.StreamObserver; + +import static io.helidon.grpc.core.ResponseHelper.complete; + +/** + * A plain Java implementation of the GreetService. + */ +public class GreetServiceJava + implements GrpcService { + /** + * The config value for the key {@code greeting}. + */ + private String greeting; + + /** + * Create a {@link GreetServiceJava}. + * + * @param config the service configuration + */ + public GreetServiceJava(Config config) { + this.greeting = config.get("app.greeting").asString().orElse("Ciao"); + } + + @Override + public void update(ServiceDescriptor.Rules rules) { + rules.unary("Greet", this::greet) + .unary("SetGreeting", this::setGreeting); + } + + // ---- service methods ------------------------------------------------- + + private void greet(String name, StreamObserver observer) { + name = Optional.ofNullable(name).orElse("World"); + String msg = String.format("%s %s!", greeting, name); + + complete(observer, msg); + } + + private void setGreeting(String greeting, StreamObserver observer) { + this.greeting = greeting; + + complete(observer, greeting); + } +} diff --git a/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/StringClient.java b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/StringClient.java new file mode 100644 index 00000000..82edd259 --- /dev/null +++ b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/StringClient.java @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.common; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionStage; +import java.util.stream.Collectors; + +import io.helidon.grpc.client.ClientServiceDescriptor; +import io.helidon.grpc.client.GrpcServiceClient; +import io.helidon.grpc.examples.common.Strings.StringMessage; + +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; +import io.grpc.stub.StreamObserver; + +/** + * A client to the {@link StringService} implemented with Helidon gRPC client API. + */ +public class StringClient { + private static String inputStr = "Test_String_for_Lower_and_Upper"; + private static StringMessage inputMsg = StringMessage.newBuilder().setText(inputStr).build(); + + private StringClient() { + } + + /** + * Program entry point. + * + * @param args the program arguments + * + * @throws Exception if an error occurs + */ + public static void main(String[] args) throws Exception { + ClientServiceDescriptor descriptor = ClientServiceDescriptor + .builder(StringServiceGrpc.getServiceDescriptor()) + .build(); + + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + GrpcServiceClient client = GrpcServiceClient.create(channel, descriptor); + + unary(client); + asyncUnary(client); + blockingUnary(client); + clientStreaming(client); + clientStreamingOfIterable(client); + serverStreamingBlocking(client); + serverStreaming(client); + bidirectional(client); + } + + /** + * Call the unary {@code Lower} method using an normal unary call. + * + * @param client the StringService {@link GrpcServiceClient} + * @throws java.lang.Exception if the call fails + */ + public static void unary(GrpcServiceClient client) throws Exception { + FutureObserver observer = new FutureObserver(); + client.unary("Lower", inputMsg, observer); + + String response = observer.get(); + + System.out.println("Unary Lower response: '" + response + "'"); + } + + /** + * Call the unary {@code Lower} method using an async call. + * + * @param client the StringService {@link GrpcServiceClient} + */ + public static void asyncUnary(GrpcServiceClient client) { + CompletionStage stage = client.unary("Lower", inputMsg); + + stage.handle((response, error) -> { + if (error == null) { + System.out.println("Async Lower response: '" + response.getText() + "'"); + } else { + error.printStackTrace(); + } + return null; + }); + } + + /** + * Call the unary {@code Upper} method using a blocking call. + * + * @param client the StringService {@link GrpcServiceClient} + */ + public static void blockingUnary(GrpcServiceClient client) { + StringMessage upperResonse = client.blockingUnary("Upper", inputMsg); + + System.out.println("Blocking Upper response: '" + upperResonse.getText() + "'"); + } + + /** + * Call the client streaming {@code Join} method. + * + * @param client the StringService {@link GrpcServiceClient} + * @throws java.lang.Exception if the call fails + */ + public static void clientStreaming(GrpcServiceClient client) throws Exception { + FutureObserver responses = new FutureObserver(); + StreamObserver requests = client.clientStreaming("Join", responses); + + List joinValues = List.of("A", "B", "C", "D"); + + // stream the values to the server + joinValues.forEach(word -> requests.onNext(StringMessage.newBuilder().setText(word).build())); + requests.onCompleted(); + + // wait for the response observer to complete + String joined = responses.get(); + + System.out.println("Join response: '" + joined + "'"); + } + + /** + * Call the client streaming {@code Join} method streaming the contents of an {@link Iterable}. + * + * @param client the StringService {@link GrpcServiceClient} + * @throws java.lang.Exception if the call fails + */ + public static void clientStreamingOfIterable(GrpcServiceClient client) throws Exception { + List joinValues = List.of("A", "B", "C", "D") + .stream() + .map(val -> StringMessage.newBuilder().setText(val).build()) + .collect(Collectors.toList()); + + // stream the value to the server + CompletionStage stage = client.clientStreaming("Join", joinValues); + + // wait for the response future to complete + stage.handle((response, error) -> { + if (error == null) { + System.out.println("Join response: '" + response.getText() + "'"); + } else { + error.printStackTrace(); + } + return null; + }); + } + + /** + * Call the server streaming {@code Split} method using a blocking call. + * + * @param client the StringService {@link GrpcServiceClient} + */ + public static void serverStreamingBlocking(GrpcServiceClient client) { + String stringToSplit = "A B C D E"; + StringMessage request = StringMessage.newBuilder().setText(stringToSplit).build(); + + Iterator iterator = client.blockingServerStreaming("Split", request); + + while (iterator.hasNext()) { + StringMessage response = iterator.next(); + System.out.println("Response from blocking Split: '" + response.getText() + "'"); + } + } + + /** + * Call the server streaming {@code Split} method using an async call. + * + * @param client the StringService {@link GrpcServiceClient} + * @throws java.lang.Exception if the call fails + */ + public static void serverStreaming(GrpcServiceClient client) throws Exception { + String stringToSplit = "A B C D E"; + FutureStreamingObserver responses = new FutureStreamingObserver(); + StringMessage request = StringMessage.newBuilder().setText(stringToSplit).build(); + + client.serverStreaming("Split", request, responses); + + // wait for the call to complete + List words = responses.get(); + + for (String word : words) { + System.out.println("Response from async Split: '" + word + "'"); + } + } + + /** + * Call the bidirectional streaming {@code Echo} method using an async call. + * + * @param client the StringService {@link GrpcServiceClient} + * @throws java.lang.Exception if the call fails + */ + public static void bidirectional(GrpcServiceClient client) throws Exception { + List valuesToStream = List.of("A", "B", "C", "D"); + FutureStreamingObserver responses = new FutureStreamingObserver(); + + StreamObserver requests = client.bidiStreaming("Echo", responses); + + // stream the words to the server + valuesToStream.forEach(word -> requests.onNext(StringMessage.newBuilder().setText(word).build())); + // signal that we have completed + requests.onCompleted(); + + // wait for the echo responses to complete + List echoes = responses.get(); + + for (String word : echoes) { + System.out.println("Response from Echo: '" + word + "'"); + } + } + + + /** + * A combination {@link java.util.concurrent.CompletableFuture} and + * {@link io.grpc.stub.StreamObserver}. + *

+ * This future will complete when the {@link #onCompleted()} or the + * {@link #onError(Throwable)} methods are called. + *

+ * This implementation expects a single result. + */ + static class FutureObserver + extends CompletableFuture + implements StreamObserver { + + private String value; + + public void onNext(StringMessage value) { + this.value = value.getText(); + } + + public void onError(Throwable t) { + completeExceptionally(t); + } + + public void onCompleted() { + complete(value); + } + } + + /** + * A combination {@link java.util.concurrent.CompletableFuture} and + * {@link io.grpc.stub.StreamObserver}. + *

+ * This future will complete when the {@link #onCompleted()} or the + * {@link #onError(Throwable)} methods are called. + *

+ * This implementation can handle multiple calls to + * {@link #onNext(StringMessage)}. + */ + static class FutureStreamingObserver + extends CompletableFuture> + implements StreamObserver { + + private List values = new ArrayList<>(); + + public void onNext(StringMessage value) { + values.add(value.getText()); + } + + public void onError(Throwable t) { + completeExceptionally(t); + } + + public void onCompleted() { + complete(values); + } + } +} diff --git a/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/StringService.java b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/StringService.java new file mode 100644 index 00000000..4d638480 --- /dev/null +++ b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/StringService.java @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.common; + +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import io.helidon.grpc.examples.common.Strings.StringMessage; +import io.helidon.grpc.server.CollectingObserver; +import io.helidon.grpc.server.GrpcService; +import io.helidon.grpc.server.ServiceDescriptor; + +import io.grpc.stub.StreamObserver; + +import static io.helidon.grpc.core.ResponseHelper.complete; +import static io.helidon.grpc.core.ResponseHelper.stream; + +/** + * AN implementation of the StringService. + */ +public class StringService + implements GrpcService { + @Override + public void update(ServiceDescriptor.Rules rules) { + rules.proto(Strings.getDescriptor()) + .unary("Upper", this::upper) + .unary("Lower", this::lower) + .serverStreaming("Split", this::split) + .clientStreaming("Join", this::join) + .bidirectional("Echo", this::echo); + } + + // ---- service methods ------------------------------------------------- + + private void upper(StringMessage request, StreamObserver observer) { + complete(observer, response(request.getText().toUpperCase())); + } + + private void lower(StringMessage request, StreamObserver observer) { + complete(observer, response(request.getText().toLowerCase())); + } + + private void split(StringMessage request, StreamObserver observer) { + String[] parts = request.getText().split(" "); + stream(observer, Stream.of(parts).map(this::response)); + } + + private StreamObserver join(StreamObserver observer) { + return new CollectingObserver<>( + Collectors.joining(" "), + observer, + StringMessage::getText, + this::response); + } + + private StreamObserver echo(StreamObserver observer) { + return new StreamObserver() { + public void onNext(StringMessage value) { + observer.onNext(value); + } + + public void onError(Throwable t) { + t.printStackTrace(); + } + + public void onCompleted() { + observer.onCompleted(); + } + }; + } + + // ---- helper methods -------------------------------------------------- + + private StringMessage response(String text) { + return StringMessage.newBuilder().setText(text).build(); + } + +} diff --git a/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/package-info.java b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/package-info.java new file mode 100644 index 00000000..036dbb5b --- /dev/null +++ b/examples/grpc/common/src/main/java/io/helidon/grpc/examples/common/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Common classes and ProtoBuf generated gRPC servcies used in the Helidon gROC examples. + */ +package io.helidon.grpc.examples.common; diff --git a/examples/grpc/common/src/main/proto/echo.proto b/examples/grpc/common/src/main/proto/echo.proto new file mode 100644 index 00000000..b43f5521 --- /dev/null +++ b/examples/grpc/common/src/main/proto/echo.proto @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2019, 2021 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. + */ + +syntax = "proto3"; +option java_package = "io.helidon.grpc.examples.common"; + +service EchoService { + rpc Echo (EchoRequest) returns (EchoResponse) {} +} + +message EchoRequest { + string message = 1; +} + +message EchoResponse { + string message = 1; +} diff --git a/examples/grpc/common/src/main/proto/greet.proto b/examples/grpc/common/src/main/proto/greet.proto new file mode 100644 index 00000000..a56226ea --- /dev/null +++ b/examples/grpc/common/src/main/proto/greet.proto @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2019, 2021 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. + */ + + +syntax = "proto3"; +option java_package = "io.helidon.grpc.examples.common"; + +service GreetService { + rpc Greet (GreetRequest) returns (GreetResponse) {} + rpc SetGreeting (SetGreetingRequest) returns (SetGreetingResponse) {} +} + +message GreetRequest { + string name = 1; +} + +message GreetResponse { + string message = 1; +} + +message SetGreetingRequest { + string greeting = 1; +} + +message SetGreetingResponse { + string greeting = 1; +} diff --git a/examples/grpc/common/src/main/proto/strings.proto b/examples/grpc/common/src/main/proto/strings.proto new file mode 100644 index 00000000..77f9a257 --- /dev/null +++ b/examples/grpc/common/src/main/proto/strings.proto @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2019, 2021 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. + */ + + +syntax = "proto3"; +option java_package = "io.helidon.grpc.examples.common"; + +service StringService { + rpc Upper (StringMessage) returns (StringMessage) {} + rpc Lower (StringMessage) returns (StringMessage) {} + rpc Split (StringMessage) returns (stream StringMessage) {} + rpc Join (stream StringMessage) returns (StringMessage) {} + rpc Echo (stream StringMessage) returns (stream StringMessage) {} +} + +message StringMessage { + string text = 1; +} diff --git a/examples/grpc/metrics/README.md b/examples/grpc/metrics/README.md new file mode 100644 index 00000000..6a2f1c4e --- /dev/null +++ b/examples/grpc/metrics/README.md @@ -0,0 +1,159 @@ +# Helidon gRPC Metrics Example + +A basic example using metrics with gRPC server. + +## Build and run + +```shell +mvn -f ../pom.xml -pl common,metrics package +java -jar target/helidon-examples-grpc-metrics.jar +``` + +Run the GreetService client: +```shell +java -cp target/helidon-examples-grpc-metrics.jar io.helidon.grpc.examples.common.GreetClient +``` + +Run the StringService client: +```shell +java -cp target/helidon-examples-grpc-metrics.jar io.helidon.grpc.examples.common.StringClient +``` + +Retrieve the metrics: +```shell +curl http://localhost:8080/metrics +``` + +Notice that you will get application metrics from the Helidon server metric response similar to this: +```text +... +# TYPE application_GreetService_Greet_total counter +# HELP application_GreetService_Greet_total +application_GreetService_Greet_total 2 +# TYPE application_GreetService_SetGreeting_total counter +# HELP application_GreetService_SetGreeting_total +application_GreetService_SetGreeting_total 1 +# TYPE application_StringService_Echo_rate_per_second gauge +application_StringService_Echo_rate_per_second 0.12718615252125942 +# TYPE application_StringService_Echo_one_min_rate_per_second gauge +application_StringService_Echo_one_min_rate_per_second 0.2 +# TYPE application_StringService_Echo_five_min_rate_per_second gauge +application_StringService_Echo_five_min_rate_per_second 0.2 +# TYPE application_StringService_Echo_fifteen_min_rate_per_second gauge +application_StringService_Echo_fifteen_min_rate_per_second 0.2 +# TYPE application_StringService_Echo_mean_seconds gauge +application_StringService_Echo_mean_seconds 0.001451683 +# TYPE application_StringService_Echo_max_seconds gauge +application_StringService_Echo_max_seconds 0.001451683 +# TYPE application_StringService_Echo_min_seconds gauge +application_StringService_Echo_min_seconds 0.001451683 +# TYPE application_StringService_Echo_stddev_seconds gauge +application_StringService_Echo_stddev_seconds 0.0 +# TYPE application_StringService_Echo_seconds summary +# HELP application_StringService_Echo_seconds +application_StringService_Echo_seconds_count 1 +application_StringService_Echo_seconds_sum 0 +application_StringService_Echo_seconds{quantile="0.5"} 0.001451683 +application_StringService_Echo_seconds{quantile="0.75"} 0.001451683 +application_StringService_Echo_seconds{quantile="0.95"} 0.001451683 +application_StringService_Echo_seconds{quantile="0.98"} 0.001451683 +application_StringService_Echo_seconds{quantile="0.99"} 0.001451683 +application_StringService_Echo_seconds{quantile="0.999"} 0.001451683 +# TYPE application_StringService_Join_rate_per_second gauge +application_StringService_Join_rate_per_second 0.25353058349417795 +# TYPE application_StringService_Join_one_min_rate_per_second gauge +application_StringService_Join_one_min_rate_per_second 0.4 +# TYPE application_StringService_Join_five_min_rate_per_second gauge +application_StringService_Join_five_min_rate_per_second 0.4 +# TYPE application_StringService_Join_fifteen_min_rate_per_second gauge +application_StringService_Join_fifteen_min_rate_per_second 0.4 +# TYPE application_StringService_Join_mean_seconds gauge +application_StringService_Join_mean_seconds 0.002281452 +# TYPE application_StringService_Join_max_seconds gauge +application_StringService_Join_max_seconds 0.003709154 +# TYPE application_StringService_Join_min_seconds gauge +application_StringService_Join_min_seconds 8.5375E-4 +# TYPE application_StringService_Join_stddev_seconds gauge +application_StringService_Join_stddev_seconds 0.001427702 +# TYPE application_StringService_Join_seconds summary +# HELP application_StringService_Join_seconds +application_StringService_Join_seconds_count 2 +application_StringService_Join_seconds_sum 0 +application_StringService_Join_seconds{quantile="0.5"} 0.003709154 +application_StringService_Join_seconds{quantile="0.75"} 0.003709154 +application_StringService_Join_seconds{quantile="0.95"} 0.003709154 +application_StringService_Join_seconds{quantile="0.98"} 0.003709154 +application_StringService_Join_seconds{quantile="0.99"} 0.003709154 +application_StringService_Join_seconds{quantile="0.999"} 0.003709154 +# TYPE application_StringService_Lower_rate_per_second gauge +application_StringService_Lower_rate_per_second 0.25274282459020236 +# TYPE application_StringService_Lower_one_min_rate_per_second gauge +application_StringService_Lower_one_min_rate_per_second 0.4 +# TYPE application_StringService_Lower_five_min_rate_per_second gauge +application_StringService_Lower_five_min_rate_per_second 0.4 +# TYPE application_StringService_Lower_fifteen_min_rate_per_second gauge +application_StringService_Lower_fifteen_min_rate_per_second 0.4 +# TYPE application_StringService_Lower_mean_seconds gauge +application_StringService_Lower_mean_seconds 5.606925E-4 +# TYPE application_StringService_Lower_max_seconds gauge +application_StringService_Lower_max_seconds 7.27866E-4 +# TYPE application_StringService_Lower_min_seconds gauge +application_StringService_Lower_min_seconds 3.93519E-4 +# TYPE application_StringService_Lower_stddev_seconds gauge +application_StringService_Lower_stddev_seconds 1.671735E-4 +# TYPE application_StringService_Lower_seconds summary +# HELP application_StringService_Lower_seconds +application_StringService_Lower_seconds_count 2 +application_StringService_Lower_seconds_sum 0 +application_StringService_Lower_seconds{quantile="0.5"} 7.27866E-4 +application_StringService_Lower_seconds{quantile="0.75"} 7.27866E-4 +application_StringService_Lower_seconds{quantile="0.95"} 7.27866E-4 +application_StringService_Lower_seconds{quantile="0.98"} 7.27866E-4 +application_StringService_Lower_seconds{quantile="0.99"} 7.27866E-4 +application_StringService_Lower_seconds{quantile="0.999"} 7.27866E-4 +# TYPE application_StringService_Split_rate_per_second gauge +application_StringService_Split_rate_per_second 0.25378693218040604 +# TYPE application_StringService_Split_one_min_rate_per_second gauge +application_StringService_Split_one_min_rate_per_second 0.4 +# TYPE application_StringService_Split_five_min_rate_per_second gauge +application_StringService_Split_five_min_rate_per_second 0.4 +# TYPE application_StringService_Split_fifteen_min_rate_per_second gauge +application_StringService_Split_fifteen_min_rate_per_second 0.4 +# TYPE application_StringService_Split_mean_seconds gauge +application_StringService_Split_mean_seconds 9.63112E-4 +# TYPE application_StringService_Split_max_seconds gauge +application_StringService_Split_max_seconds 0.001190785 +# TYPE application_StringService_Split_min_seconds gauge +application_StringService_Split_min_seconds 7.35439E-4 +# TYPE application_StringService_Split_stddev_seconds gauge +application_StringService_Split_stddev_seconds 2.27673E-4 +# TYPE application_StringService_Split_seconds summary +# HELP application_StringService_Split_seconds +application_StringService_Split_seconds_count 2 +application_StringService_Split_seconds_sum 0 +application_StringService_Split_seconds{quantile="0.5"} 0.001190785 +application_StringService_Split_seconds{quantile="0.75"} 0.001190785 +application_StringService_Split_seconds{quantile="0.95"} 0.001190785 +application_StringService_Split_seconds{quantile="0.98"} 0.001190785 +application_StringService_Split_seconds{quantile="0.99"} 0.001190785 +application_StringService_Split_seconds{quantile="0.999"} 0.001190785 +# TYPE application_StringService_Upper_mean gauge +application_StringService_Upper_mean 1 +# TYPE application_StringService_Upper_max gauge +application_StringService_Upper_max 1 +# TYPE application_StringService_Upper_min gauge +application_StringService_Upper_min 1 +# TYPE application_StringService_Upper_stddev gauge +application_StringService_Upper_stddev 0 +# TYPE application_StringService_Upper summary +# HELP application_StringService_Upper +application_StringService_Upper_count 1 +application_StringService_Upper_sum 1 +application_StringService_Upper{quantile="0.5"} 1 +application_StringService_Upper{quantile="0.75"} 1 +application_StringService_Upper{quantile="0.95"} 1 +application_StringService_Upper{quantile="0.98"} 1 +application_StringService_Upper{quantile="0.99"} 1 +application_StringService_Upper{quantile="0.999"} 1 +... +``` diff --git a/examples/grpc/metrics/pom.xml b/examples/grpc/metrics/pom.xml new file mode 100644 index 00000000..d0d70c2a --- /dev/null +++ b/examples/grpc/metrics/pom.xml @@ -0,0 +1,88 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-metrics + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples Metrics + + + Examples of elementary use of the gRPC Server metrics + + + + io.helidon.grpc.examples.metrics.Server + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.grpc + helidon-grpc-server + + + io.helidon.grpc + helidon-grpc-metrics + + + io.helidon.bundles + helidon-bundles-config + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.grpc + helidon-grpc-client + + + io.helidon.metrics + helidon-metrics + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/grpc/metrics/src/main/java/io/helidon/grpc/examples/metrics/Server.java b/examples/grpc/metrics/src/main/java/io/helidon/grpc/examples/metrics/Server.java new file mode 100644 index 00000000..ac42ae55 --- /dev/null +++ b/examples/grpc/metrics/src/main/java/io/helidon/grpc/examples/metrics/Server.java @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.metrics; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.GreetService; +import io.helidon.grpc.examples.common.StringService; +import io.helidon.grpc.metrics.GrpcMetrics; +import io.helidon.grpc.server.GrpcRouting; +import io.helidon.grpc.server.GrpcServer; +import io.helidon.grpc.server.GrpcServerConfiguration; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * A basic example of a Helidon gRPC server. + */ +public class Server { + + private Server() { + } + + /** + * The main program entry point. + * + * @param args the program arguments + * + * @throws Exception if an error occurs + */ + public static void main(String[] args) throws Exception { + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // load logging configuration + LogConfig.configureRuntime(); + + // Get gRPC server config from the "grpc" section of application.yaml + GrpcServerConfiguration serverConfig = + GrpcServerConfiguration.builder(config.get("grpc")).build(); + + GrpcRouting grpcRouting = GrpcRouting.builder() + .intercept(GrpcMetrics.counted()) // global metrics - all service methods counted + .register(new GreetService(config)) // GreetService uses global metrics so all methods are counted + .register(new StringService(), rules -> { + // service level metrics - StringService overrides global so that its methods are timed + rules.intercept(GrpcMetrics.timed()) + // method level metrics - overrides service and global + .intercept("Upper", GrpcMetrics.histogram()); + }) + .build(); + + GrpcServer grpcServer = GrpcServer.create(serverConfig, grpcRouting); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + grpcServer.start() + .thenAccept(s -> { + System.out.println("gRPC server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + // start web server with the metrics endpoints + Routing routing = Routing.builder() + .register(MetricsSupport.create()) + .build(); + + WebServer.create(routing, config.get("webserver")) + .start() + .thenAccept(s -> { + System.out.println("HTTP server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("HTTP server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + } +} diff --git a/examples/grpc/metrics/src/main/java/io/helidon/grpc/examples/metrics/package-info.java b/examples/grpc/metrics/src/main/java/io/helidon/grpc/examples/metrics/package-info.java new file mode 100644 index 00000000..648d0bfe --- /dev/null +++ b/examples/grpc/metrics/src/main/java/io/helidon/grpc/examples/metrics/package-info.java @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * An example of gRPC metrics. + *

+ * Start with {@link io.helidon.grpc.examples.metrics.Server Main} class. + */ +package io.helidon.grpc.examples.metrics; diff --git a/examples/grpc/metrics/src/main/resources/application.yaml b/examples/grpc/metrics/src/main/resources/application.yaml new file mode 100644 index 00000000..51f97bec --- /dev/null +++ b/examples/grpc/metrics/src/main/resources/application.yaml @@ -0,0 +1,29 @@ +# +# Copyright (c) 2019, 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. +# + +app: + greeting: "Hello" + +grpc: + name: "test.server" + port: 1408 + marshaller: + java: + enabled: true + +webserver: + port: 8080 + bind-address: "0.0.0.0" \ No newline at end of file diff --git a/examples/grpc/metrics/src/main/resources/logging.properties b/examples/grpc/metrics/src/main/resources/logging.properties new file mode 100644 index 00000000..ab333c92 --- /dev/null +++ b/examples/grpc/metrics/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2019, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/grpc/microprofile/basic-client/README.md b/examples/grpc/microprofile/basic-client/README.md new file mode 100644 index 00000000..9bcdb293 --- /dev/null +++ b/examples/grpc/microprofile/basic-client/README.md @@ -0,0 +1,40 @@ + +# Helidon MP gRPC Client Example + +This examples shows a simple gRPC client application written using Helidon MP. + +This example should be run together with the [Basic Implicit gRPC Server example](../basic-server-implicit/README.md) +which provides the server side implementation of the `StringService` used by this client. The server should be started +before running the client. + +This example shows how a client can be written without needing to write any client side gRPC code. The gRPC service that +the client will use is represented by an annotated interface `io.helidon.microprofile.grpc.example.client.StringService` +which defines all of the methods available on the service deployed on the server. + +## Build +```shell +mvn -f ../../pom.xml -pl common,microprofile/basic-client package +``` + +## Run +Ensure that the server in [Basic Implicit gRPC Server example](../basic-server-implicit/README.md) is started. +Then in this module run: +```shell +java -jar target/helidon-examples-grpc-microprofile-client.jar +``` +Sample output from the client: +```text +... +Unary Lower response: 'abcd' +Response from blocking Split: 'A' +Response from blocking Split: 'B' +Response from blocking Split: 'C' +Response from blocking Split: 'D' +Response from blocking Split: 'E' +Join response: 'A B C D' +Response from Echo: 'A' +Response from Echo: 'B' +Response from Echo: 'C' +Response from Echo: 'D' +... +``` diff --git a/examples/grpc/microprofile/basic-client/pom.xml b/examples/grpc/microprofile/basic-client/pom.xml new file mode 100644 index 00000000..26d24de3 --- /dev/null +++ b/examples/grpc/microprofile/basic-client/pom.xml @@ -0,0 +1,85 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-microprofile-client + 1.0.0-SNAPSHOT + Helidon Microprofile gRPC Client Example + + + Microprofile 2.2 gRPC client example + + + + io.helidon.microprofile.grpc.example.client.Client + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.grpc + helidon-microprofile-grpc-client + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/AsyncClient.java b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/AsyncClient.java new file mode 100644 index 00000000..2733f9ba --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/AsyncClient.java @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.client; + +import java.util.concurrent.CompletionStage; + +import javax.enterprise.context.ApplicationScoped; +import javax.enterprise.inject.se.SeContainer; +import javax.enterprise.inject.se.SeContainerInitializer; +import javax.inject.Inject; + +import io.helidon.microprofile.grpc.client.GrpcChannel; +import io.helidon.microprofile.grpc.client.GrpcProxy; + +/** + * A client to the {@link io.helidon.microprofile.grpc.example.client.AsyncStringService}. + *

+ * This client is a CDI bean which will be initialised when the CDI container + * is initialised in the {@link #main(String[])} method. + */ +@ApplicationScoped +public class AsyncClient { + + /** + * The {@link io.helidon.microprofile.grpc.example.client.StringService} client to use to call methods on the server. + *

+ * A dynamic proxy of the {@link io.helidon.microprofile.grpc.example.client.StringService} interface will be injected by CDI. + * This proxy will connect to the service using the default {@link io.grpc.Channel}. + */ + @Inject + @GrpcProxy + @GrpcChannel(name = "test-server") + private AsyncStringService stringService; + + + /** + * Program entry point. + * + * @param args the program arguments + * + * @throws Exception if an error occurs + */ + public static void main(String[] args) throws Exception { + SeContainerInitializer initializer = SeContainerInitializer.newInstance(); + SeContainer container = initializer.initialize(); + + AsyncClient client = container.select(AsyncClient.class).get(); + + client.asyncUnary(); + } + + /** + * Call the unary {@code Lower} method. + * @throws java.lang.Exception if the async call fails + */ + void asyncUnary() throws Exception { + CompletionStage response = stringService.lower("ABCD"); + String value = response.toCompletableFuture().get(); + System.out.println("Async Unary Lower response: '" + value + "'"); + } +} diff --git a/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/AsyncStringService.java b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/AsyncStringService.java new file mode 100644 index 00000000..6c637528 --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/AsyncStringService.java @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.client; + +import java.util.concurrent.CompletionStage; +import java.util.stream.Stream; + +import io.helidon.microprofile.grpc.core.Bidirectional; +import io.helidon.microprofile.grpc.core.ClientStreaming; +import io.helidon.microprofile.grpc.core.Grpc; +import io.helidon.microprofile.grpc.core.ServerStreaming; +import io.helidon.microprofile.grpc.core.Unary; + +import io.grpc.stub.StreamObserver; + +/** + * The gRPC StringService. + *

+ * This class has the {@link io.helidon.microprofile.grpc.core.Grpc} annotation + * so that it will be discovered and loaded using CDI when the MP gRPC server starts. + */ +@Grpc +@SuppressWarnings("CdiManagedBeanInconsistencyInspection") +public interface AsyncStringService { + + /** + * Convert a string value to upper case. + * + * @param request the request containing the string to convert + * @return the request value converted to upper case + */ + @Unary + CompletionStage upper(String request); + + /** + * Convert a string value to lower case. + * + * @param request the request containing the string to convert + * @return the request converted to lower case + */ + @Unary + CompletionStage lower(String request); + + /** + * Split a space delimited string value and stream back the split parts. + * @param request the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ServerStreaming + Stream split(String request); + + /** + * Join a stream of string values and return the result. + * @param observer the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ClientStreaming + StreamObserver join(StreamObserver observer); + + /** + * Echo each value streamed from the client back to the client. + * @param observer the {@link io.grpc.stub.StreamObserver} to send responses to + * @return the {@link io.grpc.stub.StreamObserver} to receive requests from + */ + @Bidirectional + StreamObserver echo(StreamObserver observer); +} diff --git a/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/Client.java b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/Client.java new file mode 100644 index 00000000..9f7275a2 --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/Client.java @@ -0,0 +1,199 @@ +/* + * Copyright (c) 2019, 2022 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.client; + +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; + +import javax.enterprise.context.ApplicationScoped; +import javax.enterprise.inject.se.SeContainer; +import javax.enterprise.inject.se.SeContainerInitializer; +import javax.inject.Inject; + +import io.helidon.microprofile.grpc.client.GrpcChannel; +import io.helidon.microprofile.grpc.client.GrpcProxy; + +import io.grpc.stub.StreamObserver; + +/** + * A client to the {@link StringService}. + *

+ * This client is a CDI bean which will be initialised when the CDI container + * is initialised in the {@link #main(String[])} method. + */ +@ApplicationScoped +public class Client { + + /** + * The {@link StringService} client to use to call methods on the server. + *

+ * A dynamic proxy of the {@link StringService} interface will be injected by CDI. + * This proxy will connect to the service using the default {@link io.grpc.Channel}. + */ + @Inject + @GrpcProxy + @GrpcChannel(name = "test-server") + private StringService stringService; + + + /** + * Program entry point. + * + * @param args the program arguments + * + * @throws Exception if an error occurs + */ + public static void main(String[] args) throws Exception { + SeContainerInitializer initializer = SeContainerInitializer.newInstance(); + SeContainer container = initializer.initialize(); + + Client client = container.select(Client.class).get(); + + client.unary(); + client.serverStreaming(); + client.clientStreaming(); + client.bidirectional(); + System.exit(0); + } + + /** + * Call the unary {@code Lower} method. + */ + public void unary() { + String response = stringService.lower("ABCD"); + System.out.println("Unary Lower response: '" + response + "'"); + } + + /** + * Call the server streaming {@code Split} method. + */ + public void serverStreaming() { + String stringToSplit = "A B C D E"; + + stringService.split(stringToSplit) + .forEach(response -> System.out.println("Response from blocking Split: '" + response + "'")); + } + + /** + * Call the client streaming {@code Join} method. + * + * @throws Exception if the call fails + */ + public void clientStreaming() throws Exception { + FutureObserver responses = new FutureObserver(); + StreamObserver requests = stringService.join(responses); + + List joinValues = List.of("A", "B", "C", "D"); + + // stream the values to the server + joinValues.forEach(requests::onNext); + requests.onCompleted(); + + // wait for the response observer to complete + String joined = responses.get(); + + System.out.println("Join response: '" + joined + "'"); + } + + /** + * Call the bidirectional streaming {@code Echo} method. + * @throws Exception if the call fails + */ + public void bidirectional() throws Exception { + List valuesToStream = List.of("A", "B", "C", "D"); + FutureStreamingObserver responses = new FutureStreamingObserver(); + + StreamObserver requests = stringService.echo(responses); + + // stream the words to the server + valuesToStream.forEach(requests::onNext); + // signal that we have completed + requests.onCompleted(); + + // wait for the echo responses to complete + List echoes = responses.get(); + + for (String word : echoes) { + System.out.println("Response from Echo: '" + word + "'"); + } + } + + + /** + * A combination {@link java.util.concurrent.CompletableFuture} and + * {@link io.grpc.stub.StreamObserver}. + *

+ * This future will complete when the {@link #onCompleted()} or the + * {@link #onError(Throwable)} methods are called. + *

+ * This implementation expects a single result. + */ + static class FutureObserver + extends CompletableFuture + implements StreamObserver { + + private String value; + + @Override + public void onNext(String value) { + this.value = value; + } + + @Override + public void onError(Throwable t) { + completeExceptionally(t); + } + + @Override + public void onCompleted() { + complete(value); + } + } + + /** + * A combination {@link java.util.concurrent.CompletableFuture} and + * {@link io.grpc.stub.StreamObserver}. + *

+ * This future will complete when the {@link #onCompleted()} or the + * {@link #onError(Throwable)} methods are called. + *

+ * This implementation can handle multiple calls to + * {@link #onNext(String)}. + */ + static class FutureStreamingObserver + extends CompletableFuture> + implements StreamObserver { + + private List values = new ArrayList<>(); + + @Override + public void onNext(String value) { + values.add(value); + } + + @Override + public void onError(Throwable t) { + completeExceptionally(t); + } + + @Override + public void onCompleted() { + complete(values); + } + } +} diff --git a/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/StringService.java b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/StringService.java new file mode 100644 index 00000000..f9de569b --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/StringService.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.client; + +import java.util.stream.Stream; + +import io.helidon.microprofile.grpc.core.Bidirectional; +import io.helidon.microprofile.grpc.core.ClientStreaming; +import io.helidon.microprofile.grpc.core.Grpc; +import io.helidon.microprofile.grpc.core.ServerStreaming; +import io.helidon.microprofile.grpc.core.Unary; + +import io.grpc.stub.StreamObserver; + +/** + * The gRPC StringService. + *

+ * This class has the {@link io.helidon.microprofile.grpc.core.Grpc} annotation + * so that it will be discovered and loaded using CDI when the MP gRPC server starts. + */ +@Grpc +@SuppressWarnings("CdiManagedBeanInconsistencyInspection") +public interface StringService { + + /** + * Convert a string value to upper case. + * + * @param request the request containing the string to convert + * @return the request value converted to upper case + */ + @Unary + String upper(String request); + + /** + * Convert a string value to lower case. + * + * @param request the request containing the string to convert + * @return the request converted to lower case + */ + @Unary + String lower(String request); + + /** + * Split a space delimited string value and stream back the split parts. + * @param request the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ServerStreaming + Stream split(String request); + + /** + * Join a stream of string values and return the result. + * @param observer the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ClientStreaming + StreamObserver join(StreamObserver observer); + + /** + * Echo each value streamed from the client back to the client. + * @param observer the {@link io.grpc.stub.StreamObserver} to send responses to + * @return the {@link io.grpc.stub.StreamObserver} to receive requests from + */ + @Bidirectional + StreamObserver echo(StreamObserver observer); +} diff --git a/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/package-info.java b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/package-info.java new file mode 100644 index 00000000..20bf191b --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/java/io/helidon/microprofile/grpc/example/client/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. + * + * 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. + */ + +/** + * Examples of gRPC microprofile clients. + */ +package io.helidon.microprofile.grpc.example.client; diff --git a/examples/grpc/microprofile/basic-client/src/main/resources/META-INF/beans.xml b/examples/grpc/microprofile/basic-client/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..f6e961c3 --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + + + diff --git a/examples/grpc/microprofile/basic-client/src/main/resources/application.yaml b/examples/grpc/microprofile/basic-client/src/main/resources/application.yaml new file mode 100644 index 00000000..4e1b8395 --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# Copyright (c) 2019, 2021 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. +# + +grpc: + channels: + test-server: + host: localhost + port: 1408 + marshaller: + java: + enabled: true + +mp.initializer: + allow: true + no-warn: true diff --git a/examples/grpc/microprofile/basic-client/src/main/resources/logging.properties b/examples/grpc/microprofile/basic-client/src/main/resources/logging.properties new file mode 100644 index 00000000..e71467f3 --- /dev/null +++ b/examples/grpc/microprofile/basic-client/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. +# +# 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.config.level=FINEST diff --git a/examples/grpc/microprofile/basic-server-implicit/README.md b/examples/grpc/microprofile/basic-server-implicit/README.md new file mode 100644 index 00000000..fd7a1f9d --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/README.md @@ -0,0 +1,32 @@ + +# Helidon MP Implicit gRPC Server Example + +This examples shows a simple gRPC application written using Helidon MP. +It is implicit because in this example you don't write the +`main` class, instead you rely on the Microprofile gRPC Server main class. + +The gRPC services to deploy will be discovered by CDI when the gRPC server starts. +The `StringService` is a POJO service implementation that is annotated with the +CDI qualifier `Grpc` so that it can be discovered. + +Two additional services (`GreetService` and `EchoService`) that are not normally CDI +managed beans are manually added as CDI managed beans in the `AdditionalServices` class +so that they can be discovered. + +This example can be run together with the [Basic gRPC Client example](../basic-client/README.md) +which provides a microprofile gRPC client that uses the services deployed in this server. + +## Build + +```shell +mvn -f ../../pom.xml -pl common,microprofile/basic-server-implicit package +``` + +## Run + +```shell +java -jar target/helidon-examples-grpc-microprofile-basic-implicit.jar +``` + +Then the services can be accessed on the gRPC endpoint `localhost:1408`. As noted above, the client in +[Basic gRPC Client example](../basic-client/README.md) can be used for this purpose. diff --git a/examples/grpc/microprofile/basic-server-implicit/pom.xml b/examples/grpc/microprofile/basic-server-implicit/pom.xml new file mode 100644 index 00000000..76a5a36f --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/pom.xml @@ -0,0 +1,89 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-microprofile-basic-implicit + 1.0.0-SNAPSHOT + Helidon Microprofile Examples gRPC Implicit Server + + + Microprofile 2.2 example gRPC server with implicit bootstrapping (server.Main(new String[0]) + + + + io.helidon.microprofile.server.Main + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.grpc + helidon-microprofile-grpc-server + + + io.helidon.microprofile.grpc + helidon-microprofile-grpc-client + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/AdditionalServices.java b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/AdditionalServices.java new file mode 100644 index 00000000..4fe8b6b6 --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/AdditionalServices.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.basic.implicit; + +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.EchoService; +import io.helidon.grpc.examples.common.GreetService; +import io.helidon.microprofile.grpc.server.spi.GrpcMpContext; +import io.helidon.microprofile.grpc.server.spi.GrpcMpExtension; + +/** + * An example of adding additional non-managed bean gRPC services. + *

+ * This class is a {@link GrpcMpExtension} that will be called by + * the {@link io.helidon.microprofile.grpc.server.GrpcServerCdiExtension + * gRPC MP Extension} prior to starting the gRPC server. + *

+ * As an extension this class also needs to be specified in the + * {@code META-INF/services/io.helidon.microprofile.grpc.server.spi.GrpcMpExtension} + * file (or for Java 9+ modules in the {@code module-info.java} file). + */ +public class AdditionalServices + implements GrpcMpExtension { + /** + * Add additional gRPC services as managed beans. + *

+ * These are classes that are on the classpath but for whatever reason are not + * annotated as managed beans (for example we do not own the source) but we want + * them to be located and loaded by the server. + * + * @param context the {@link GrpcMpContext} to use to add the extra services + */ + @Override + public void configure(GrpcMpContext context) { + context.routing() + .register(new GreetService(Config.empty())) + .register(new EchoService()); + } +} diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/AsyncStringService.java b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/AsyncStringService.java new file mode 100644 index 00000000..5ffb7e80 --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/AsyncStringService.java @@ -0,0 +1,125 @@ +/* + * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.basic.implicit; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionStage; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import javax.enterprise.context.ApplicationScoped; + +import io.helidon.grpc.server.CollectingObserver; +import io.helidon.microprofile.grpc.core.Bidirectional; +import io.helidon.microprofile.grpc.core.ClientStreaming; +import io.helidon.microprofile.grpc.core.Grpc; +import io.helidon.microprofile.grpc.core.ServerStreaming; +import io.helidon.microprofile.grpc.core.Unary; + +import io.grpc.stub.StreamObserver; + +/** + * The gRPC StringService implementation that uses async unary methods. + *

+ * This class is a gRPC service annotated with {@link io.helidon.microprofile.grpc.core.Grpc} and + * {@link javax.enterprise.context.ApplicationScoped} so that it will be discovered and deployed using + * CDI when the MP gRPC server starts. + */ +@Grpc +@ApplicationScoped +public class AsyncStringService { + + /** + * Convert a string value to upper case asynchronously. + * + * @param request the request containing the string to convert + * @return the request value converted to upper case + */ + @Unary + public CompletionStage upper(String request) { + return CompletableFuture.supplyAsync(request::toUpperCase); + } + + /** + * Convert a string value to lower case. + * + * @param request the request containing the string to convert + * @return the request converted to lower case + */ + @Unary + public CompletionStage lower(String request) { + return CompletableFuture.supplyAsync(request::toLowerCase); + } + + /** + * Split a space delimited string value and stream back the split parts. + * @param request the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ServerStreaming + public Stream split(String request) { + return Stream.of(request.split(" ")); + } + + /** + * Join a stream of string values and return the result. + * @param observer the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ClientStreaming + public StreamObserver join(StreamObserver observer) { + return new CollectingObserver<>(Collectors.joining(" "), observer); + } + + /** + * Echo each value streamed from the client back to the client. + * @param observer the {@link io.grpc.stub.StreamObserver} to send responses to + * @return the {@link io.grpc.stub.StreamObserver} to receive requests from + */ + @Bidirectional + public StreamObserver echo(StreamObserver observer) { + return new EchoObserver(observer); + } + + /** + * Inner StreamObserver used to echo values back to the caller. + */ + private static class EchoObserver + implements StreamObserver { + + private final StreamObserver observer; + + private EchoObserver(StreamObserver observer) { + this.observer = observer; + } + + @Override + public void onNext(String msg) { + observer.onNext(msg); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + } + + @Override + public void onCompleted() { + observer.onCompleted(); + } + } +} diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/StringService.java b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/StringService.java new file mode 100644 index 00000000..d47a2a9f --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/StringService.java @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.basic.implicit; + +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import javax.enterprise.context.ApplicationScoped; + +import io.helidon.grpc.server.CollectingObserver; +import io.helidon.microprofile.grpc.core.Bidirectional; +import io.helidon.microprofile.grpc.core.ClientStreaming; +import io.helidon.microprofile.grpc.core.Grpc; +import io.helidon.microprofile.grpc.core.ServerStreaming; +import io.helidon.microprofile.grpc.core.Unary; + +import io.grpc.stub.StreamObserver; + +/** + * The gRPC StringService implementation. + *

+ * This class is a gRPC service annotated with {@link Grpc} and {@link ApplicationScoped} + * so that it will be discovered and deployed using CDI when the MP gRPC server starts. + */ +@Grpc +@ApplicationScoped +public class StringService { + + /** + * Convert a string value to upper case. + * + * @param request the request containing the string to convert + * @return the request value converted to upper case + */ + @Unary + public String upper(String request) { + return request.toUpperCase(); + } + + /** + * Convert a string value to lower case. + * + * @param request the request containing the string to convert + * @return the request converted to lower case + */ + @Unary + public String lower(String request) { + return request.toLowerCase(); + } + + /** + * Split a space delimited string value and stream back the split parts. + * @param request the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ServerStreaming + public Stream split(String request) { + return Stream.of(request.split(" ")); + } + + /** + * Join a stream of string values and return the result. + * @param observer the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + */ + @ClientStreaming + public StreamObserver join(StreamObserver observer) { + return new CollectingObserver<>(Collectors.joining(" "), observer); + } + + /** + * Echo each value streamed from the client back to the client. + * @param observer the {@link io.grpc.stub.StreamObserver} to send responses to + * @return the {@link io.grpc.stub.StreamObserver} to receive requests from + */ + @Bidirectional + public StreamObserver echo(StreamObserver observer) { + return new EchoObserver(observer); + } + + /** + * Inner StreamObserver used to echo values back to the caller. + */ + private static class EchoObserver + implements StreamObserver { + + private final StreamObserver observer; + + private EchoObserver(StreamObserver observer) { + this.observer = observer; + } + + @Override + public void onNext(String msg) { + observer.onNext(msg); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + } + + @Override + public void onCompleted() { + observer.onCompleted(); + } + } +} diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/package-info.java b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/package-info.java new file mode 100644 index 00000000..ab874673 --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/java/io/helidon/microprofile/grpc/example/basic/implicit/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. + * + * 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. + */ + +/** + * Examples of implicit gRPC microprofile. + */ +package io.helidon.microprofile.grpc.example.basic.implicit; diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/resources/META-INF/beans.xml b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..f6e961c3 --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + + + diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/resources/META-INF/services/io.helidon.microprofile.grpc.server.spi.GrpcMpExtension b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/META-INF/services/io.helidon.microprofile.grpc.server.spi.GrpcMpExtension new file mode 100644 index 00000000..951460f7 --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/META-INF/services/io.helidon.microprofile.grpc.server.spi.GrpcMpExtension @@ -0,0 +1,17 @@ +# +# Copyright (c) 2019, 2021 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. +# + +io.helidon.microprofile.grpc.example.basic.implicit.AdditionalServices diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/resources/application.yaml b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/application.yaml new file mode 100644 index 00000000..e51c9dc7 --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# Copyright (c) 2019, 2021 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. +# + +grpc: + name: "test.server" + port: 1408 + marshaller: + java: + enabled: true + +server: + port: 8080 + +tracing: + service: "grpc-server" diff --git a/examples/grpc/microprofile/basic-server-implicit/src/main/resources/logging.properties b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/logging.properties new file mode 100644 index 00000000..4b50b0d4 --- /dev/null +++ b/examples/grpc/microprofile/basic-server-implicit/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2019, 2021 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.config.level=FINEST diff --git a/examples/grpc/microprofile/metrics/README.md b/examples/grpc/microprofile/metrics/README.md new file mode 100644 index 00000000..5ee72c31 --- /dev/null +++ b/examples/grpc/microprofile/metrics/README.md @@ -0,0 +1,101 @@ + +# Helidon MP gRPC Server with Metrics and Tracing Example + +This examples shows a simple gRPC application written using Helidon MP that enables +metrics and tracing. + +This example can be run together with the [Basic gRPC Client example](../basic-client/README.md) +which provides a microprofile gRPC client that uses the services deployed in this server. + +## Build and run + +```shell +mvn -f ../../pom.xml -pl common,microprofile/metrics package +java -jar target/helidon-examples-grpc-microprofile-metrics.jar +``` + +Run the basic-client from [Basic gRPC Client example](../basic-client/README.md) to invoke +activity on the gRPC endpoint `localhost:1408`. +```shell +java -jar target/helidon-examples-grpc-microprofile-client.jar +``` + +Retrieve the metrics: +```shell +curl http://localhost:8080/metrics +``` + +Notice that you will get application metrics from the Helidon server metric response similar to this: +```text +... +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_echo_total counter +# HELP application_io_helidon_microprofile_grpc_example_metrics_StringService_echo_total +application_io_helidon_microprofile_grpc_example_metrics_StringService_echo_total 1 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_join_total counter +# HELP application_io_helidon_microprofile_grpc_example_metrics_StringService_join_total +application_io_helidon_microprofile_grpc_example_metrics_StringService_join_total 1 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_rate_per_second 0.0025970177279218687 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_one_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_one_min_rate_per_second 0.014712537947741825 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_five_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_five_min_rate_per_second 0.0032510706679223173 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_fifteen_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_fifteen_min_rate_per_second 0.0011018917421948848 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_mean_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_mean_seconds 0.023214181 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_max_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_max_seconds 0.023214181 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_min_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_min_seconds 0.023214181 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_stddev_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_stddev_seconds 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds summary +# HELP application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds_count 1 +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds_sum 0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds{quantile="0.5"} 0.023214181 +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds{quantile="0.75"} 0.023214181 +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds{quantile="0.95"} 0.023214181 +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds{quantile="0.98"} 0.023214181 +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds{quantile="0.99"} 0.023214181 +application_io_helidon_microprofile_grpc_example_metrics_StringService_lower_seconds{quantile="0.999"} 0.023214181 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_split_total counter +# HELP application_io_helidon_microprofile_grpc_example_metrics_StringService_split_total +application_io_helidon_microprofile_grpc_example_metrics_StringService_split_total 1 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_split_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_split_rate_per_second 0.002596994840713117 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_split_one_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_split_one_min_rate_per_second 0.014712537947741825 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_split_five_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_split_five_min_rate_per_second 0.0032510706679223173 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_split_fifteen_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_split_fifteen_min_rate_per_second 0.0011018917421948848 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_rate_per_second 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_one_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_one_min_rate_per_second 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_five_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_five_min_rate_per_second 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_fifteen_min_rate_per_second gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_fifteen_min_rate_per_second 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_mean_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_mean_seconds 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_max_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_max_seconds 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_min_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_min_seconds 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_stddev_seconds gauge +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_stddev_seconds 0.0 +# TYPE application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds summary +# HELP application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds_count 0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds_sum 0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds{quantile="0.5"} 0.0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds{quantile="0.75"} 0.0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds{quantile="0.95"} 0.0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds{quantile="0.98"} 0.0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds{quantile="0.99"} 0.0 +application_io_helidon_microprofile_grpc_example_metrics_StringService_upper_seconds{quantile="0.999"} 0.0 +... +``` diff --git a/examples/grpc/microprofile/metrics/pom.xml b/examples/grpc/microprofile/metrics/pom.xml new file mode 100644 index 00000000..b4a9778b --- /dev/null +++ b/examples/grpc/microprofile/metrics/pom.xml @@ -0,0 +1,93 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-microprofile-metrics + 1.0.0-SNAPSHOT + Helidon Microprofile Examples gRPC Metrics + + + Microprofile 2.2 example gRPC server with metrics + + + + io.helidon.microprofile.server.Main + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.grpc + helidon-microprofile-grpc-server + + + io.helidon.microprofile.grpc + helidon-microprofile-grpc-metrics + + + io.helidon.microprofile.grpc + helidon-microprofile-grpc-client + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/grpc/microprofile/metrics/src/main/java/io/helidon/microprofile/grpc/example/metrics/StringService.java b/examples/grpc/microprofile/metrics/src/main/java/io/helidon/microprofile/grpc/example/metrics/StringService.java new file mode 100644 index 00000000..75b07e49 --- /dev/null +++ b/examples/grpc/microprofile/metrics/src/main/java/io/helidon/microprofile/grpc/example/metrics/StringService.java @@ -0,0 +1,151 @@ +/* + * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.grpc.example.metrics; + +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import javax.enterprise.context.ApplicationScoped; + +import io.helidon.grpc.server.CollectingObserver; +import io.helidon.microprofile.grpc.core.Bidirectional; +import io.helidon.microprofile.grpc.core.ClientStreaming; +import io.helidon.microprofile.grpc.core.Grpc; +import io.helidon.microprofile.grpc.core.ServerStreaming; +import io.helidon.microprofile.grpc.core.Unary; + +import io.grpc.stub.StreamObserver; +import org.eclipse.microprofile.metrics.annotation.Counted; +import org.eclipse.microprofile.metrics.annotation.Metered; +import org.eclipse.microprofile.metrics.annotation.Timed; + +/** + * The gRPC StringService implementation. + *

+ * This class is a gRPC service annotated with {@link io.helidon.microprofile.grpc.core.Grpc} + * and {@link javax.enterprise.context.ApplicationScoped} so that it will be discovered and deployed + * using CDI when the MP gRPC server starts. + */ +@Grpc +@ApplicationScoped +public class StringService { + + /** + * Convert a string value to upper case. + *

+ * This method is annotated with {@literal @}{@link Timed} so a + * gRPC metrics {@link io.grpc.ServerInterceptor} will be added + * by the gRPC metrics CDI extension. + * + * @param request the request containing the string to convert + * @return the request value converted to upper case + */ + @Unary + @Timed + public String upper(String request) { + return request.toUpperCase(); + } + + /** + * Convert a string value to lower case. + *

+ * This method is annotated with {@literal @}{@link Timed} so a + * gRPC metrics {@link io.grpc.ServerInterceptor} will be added + * by the gRPC metrics CDI extension. + * + * @param request the request containing the string to convert + * @return the request converted to lower case + */ + @Unary + @Timed + public String lower(String request) { + return request.toLowerCase(); + } + + /** + * Split a space delimited string value and stream back the split parts. + * @param request the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + *

+ * This method is annotated with {@literal @}{@link Metered} so a + * gRPC metrics {@link io.grpc.ServerInterceptor} will be added + * by the gRPC metrics CDI extension. + */ + @ServerStreaming + @Metered + public Stream split(String request) { + return Stream.of(request.split(" ")); + } + + /** + * Join a stream of string values and return the result. + * @param observer the request containing the string to split + * @return a {@link java.util.stream.Stream} containing the split parts + *

+ * This method is annotated with {@literal @}{@link Counted} so a + * gRPC metrics {@link io.grpc.ServerInterceptor} will be added + * by the gRPC metrics CDI extension. + */ + @ClientStreaming + @Counted + public StreamObserver join(StreamObserver observer) { + return new CollectingObserver<>(Collectors.joining(" "), observer); + } + + /** + * Echo each value streamed from the client back to the client. + * @param observer the {@link io.grpc.stub.StreamObserver} to send responses to + * @return the {@link io.grpc.stub.StreamObserver} to receive requests from + *

+ * This method is annotated with {@literal @}{@link Counted} so a + * gRPC metrics {@link io.grpc.ServerInterceptor} will be added + * by the gRPC metrics CDI extension. + */ + @Bidirectional + @Counted + public StreamObserver echo(StreamObserver observer) { + return new EchoObserver(observer); + } + + /** + * Inner StreamObserver used to echo values back to the caller. + */ + private static class EchoObserver + implements StreamObserver { + + private final StreamObserver observer; + + private EchoObserver(StreamObserver observer) { + this.observer = observer; + } + + @Override + public void onNext(String msg) { + observer.onNext(msg); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + } + + @Override + public void onCompleted() { + observer.onCompleted(); + } + } +} diff --git a/examples/grpc/microprofile/metrics/src/main/java/io/helidon/microprofile/grpc/example/metrics/package-info.java b/examples/grpc/microprofile/metrics/src/main/java/io/helidon/microprofile/grpc/example/metrics/package-info.java new file mode 100644 index 00000000..c2b6d0a8 --- /dev/null +++ b/examples/grpc/microprofile/metrics/src/main/java/io/helidon/microprofile/grpc/example/metrics/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. + * + * 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. + */ + +/** + * Examples of gRPC microprofile metrics. + */ +package io.helidon.microprofile.grpc.example.metrics; diff --git a/examples/grpc/microprofile/metrics/src/main/resources/META-INF/beans.xml b/examples/grpc/microprofile/metrics/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..f6e961c3 --- /dev/null +++ b/examples/grpc/microprofile/metrics/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + + + diff --git a/examples/grpc/microprofile/metrics/src/main/resources/application.yaml b/examples/grpc/microprofile/metrics/src/main/resources/application.yaml new file mode 100644 index 00000000..e51c9dc7 --- /dev/null +++ b/examples/grpc/microprofile/metrics/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# Copyright (c) 2019, 2021 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. +# + +grpc: + name: "test.server" + port: 1408 + marshaller: + java: + enabled: true + +server: + port: 8080 + +tracing: + service: "grpc-server" diff --git a/examples/grpc/microprofile/metrics/src/main/resources/logging.properties b/examples/grpc/microprofile/metrics/src/main/resources/logging.properties new file mode 100644 index 00000000..ae2be375 --- /dev/null +++ b/examples/grpc/microprofile/metrics/src/main/resources/logging.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. +# +# 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.config.level=FINEST +io.helidon.microprofile.metrics.level=FINEST +io.helidon.microprofile.grpc.metrics.level=FINEST diff --git a/examples/grpc/microprofile/pom.xml b/examples/grpc/microprofile/pom.xml new file mode 100644 index 00000000..85c12883 --- /dev/null +++ b/examples/grpc/microprofile/pom.xml @@ -0,0 +1,38 @@ + + + + + 4.0.0 + + io.helidon.examples.grpc + helidon-examples-grpc-project + 1.0.0-SNAPSHOT + + pom + io.helidon.examples.grpc.microprofile + helidon-examples-grpc-microprofile-project + 1.0.0-SNAPSHOT + Helidon gRPC Microprofile Examples + + + basic-client + basic-server-implicit + metrics + + diff --git a/examples/grpc/opentracing/README.md b/examples/grpc/opentracing/README.md new file mode 100644 index 00000000..d0e45cec --- /dev/null +++ b/examples/grpc/opentracing/README.md @@ -0,0 +1,32 @@ +# Opentracing gRPC Server Example Application + +## Start Zipkin + +With Docker: +```shell +docker run --name zipkin -d -p 9411:9411 openzipkin/zipkin +``` + +```shell +curl -sSL https://zipkin.io/quickstart.sh | bash -s +java -jar zipkin.jar +``` + +## Build and run +```shell +mvn -f ../pom.xml -pl common,opentracing package +java -jar target/helidon-examples-grpc-opentracing.jar +``` + +Exercise the gRPC endpoint with GreeClient and StringClient: +```shell +java -cp target/helidon-examples-grpc-opentracing.jar io.helidon.grpc.examples.common.GreetClient +java -cp target/helidon-examples-grpc-opentracing.jar io.helidon.grpc.examples.common.StringClient +``` + +Then check out the traces at http://localhost:9411 from a browser. + +Stop zipkin if run with the docker container: +```shell +docker stop zipkin && docker rm zipkin +``` diff --git a/examples/grpc/opentracing/pom.xml b/examples/grpc/opentracing/pom.xml new file mode 100644 index 00000000..ff3684f7 --- /dev/null +++ b/examples/grpc/opentracing/pom.xml @@ -0,0 +1,79 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-opentracing + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples OpenTracing + + + Examples gRPC application using Open Tracing + + + + io.helidon.grpc.examples.opentracing.ZipkinExampleMain + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.grpc + helidon-grpc-server + + + io.helidon.bundles + helidon-bundles-config + + + io.helidon.grpc + helidon-grpc-client + + + io.helidon.tracing + helidon-tracing-zipkin + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/grpc/opentracing/src/main/java/io/helidon/grpc/examples/opentracing/ZipkinExampleMain.java b/examples/grpc/opentracing/src/main/java/io/helidon/grpc/examples/opentracing/ZipkinExampleMain.java new file mode 100644 index 00000000..c5158266 --- /dev/null +++ b/examples/grpc/opentracing/src/main/java/io/helidon/grpc/examples/opentracing/ZipkinExampleMain.java @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.opentracing; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.GreetService; +import io.helidon.grpc.examples.common.StringService; +import io.helidon.grpc.server.GrpcRouting; +import io.helidon.grpc.server.GrpcServer; +import io.helidon.grpc.server.GrpcServerConfiguration; +import io.helidon.grpc.server.GrpcTracingConfig; +import io.helidon.grpc.server.ServerRequestAttribute; +import io.helidon.tracing.TracerBuilder; + +import io.opentracing.Tracer; + +/** + * An example gRPC server with Zipkin tracing enabled. + */ +public class ZipkinExampleMain { + + private ZipkinExampleMain() { + } + + /** + * Program entry point. + * + * @param args the program command line arguments + * @throws Exception if there is a program error + */ + public static void main(String[] args) throws Exception { + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // load logging configuration + LogConfig.configureRuntime(); + + Tracer tracer = TracerBuilder.create(config.get("tracing")).build(); + + GrpcTracingConfig tracingConfig = GrpcTracingConfig.builder() + .withStreaming() + .withVerbosity() + .withTracedAttributes(ServerRequestAttribute.CALL_ATTRIBUTES, + ServerRequestAttribute.HEADERS, + ServerRequestAttribute.METHOD_NAME) + .build(); + + // Get gRPC server config from the "grpc" section of application.yaml + GrpcServerConfiguration serverConfig = + GrpcServerConfiguration.builder(config.get("grpc")).tracer(tracer).tracingConfig(tracingConfig).build(); + + GrpcServer grpcServer = GrpcServer.create(serverConfig, createRouting(config)); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + grpcServer.start() + .thenAccept(s -> { + System.out.println("gRPC server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + } + + private static GrpcRouting createRouting(Config config) { + return GrpcRouting.builder() + .register(new GreetService(config)) + .register(new StringService()) + .build(); + } +} diff --git a/examples/grpc/opentracing/src/main/java/io/helidon/grpc/examples/opentracing/package-info.java b/examples/grpc/opentracing/src/main/java/io/helidon/grpc/examples/opentracing/package-info.java new file mode 100644 index 00000000..2075e6ae --- /dev/null +++ b/examples/grpc/opentracing/src/main/java/io/helidon/grpc/examples/opentracing/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * A set of small usage examples of running the Helidon gRPC server with Zipkin tracing enabled. + */ +package io.helidon.grpc.examples.opentracing; diff --git a/examples/grpc/opentracing/src/main/resources/application.yaml b/examples/grpc/opentracing/src/main/resources/application.yaml new file mode 100644 index 00000000..9fa6faca --- /dev/null +++ b/examples/grpc/opentracing/src/main/resources/application.yaml @@ -0,0 +1,33 @@ +# +# Copyright (c) 2019, 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. +# + +app: + greeting: "Hello" + +grpc: + name: "test.server" + port: 1408 + marshaller: + java: + enabled: true + +webserver: + port: 8080 + bind-address: "0.0.0.0" + +tracing: + host: "localhost" + service: "grpc-server" \ No newline at end of file diff --git a/examples/grpc/opentracing/src/main/resources/logging.properties b/examples/grpc/opentracing/src/main/resources/logging.properties new file mode 100644 index 00000000..ab333c92 --- /dev/null +++ b/examples/grpc/opentracing/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2019, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/grpc/pom.xml b/examples/grpc/pom.xml new file mode 100644 index 00000000..15377458 --- /dev/null +++ b/examples/grpc/pom.xml @@ -0,0 +1,45 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.grpc + helidon-examples-grpc-project + pom + Helidon gRPC Examples + + + common + basics + metrics + opentracing + security + security-abac + security-outbound + microprofile + client-standalone + + diff --git a/examples/grpc/security-abac/README.md b/examples/grpc/security-abac/README.md new file mode 100644 index 00000000..197c8d41 --- /dev/null +++ b/examples/grpc/security-abac/README.md @@ -0,0 +1,35 @@ +# Helidon gRPC Security ABAC Example + +An example gRPC server for attribute based access control. + +## Build and run +Build: +```shell +mvn -f ../pom.xml -pl common,security-abac package +``` + +Run using programmatic ABAC setup(see [AbacServer.java](src/main/java/io/helidon/grpc/examples/security/abac/AbacServer.java)): +```shell +java -jar target/helidon-examples-grpc-security-abac.jar +``` + +Run using ABAC config setup (see [application.yaml](src/main/resources/application.yaml)): +```shell +java -cp target/helidon-examples-grpc-security-abac.jar \ + io.helidon.grpc.examples.security.abac.AbacServerFromConfig +``` + +Exercise the example using SecureStringClient: +```shell +java -cp target/helidon-examples-grpc-security-abac.jar \ + io.helidon.grpc.examples.security.abac.SecureStringClient +``` + +The client will only fail if parameters are not within the ABAC attributes setup. For example, below failed +because the request was made outside the `time-of-day` attribute range: +```shell +Jul 20, 2022 12:27:39 PM io.helidon.security.DefaultAuditProvider lambda$logEvent$1 +FINEST: FAILURE authz.authorize 71e94b20-961c-4123-8f8b-ad8c365b8f80:1 io.helidon.common.context.Contexts runInContext Contexts.java 117 :: "Path Optional[StringService/Upper]. Provider io.helidon.security.providers.abac.AbacProvider, Description io.helidon.security.AuthorizationClientImpl@186478ad, Request Optional[Subject: Principal: Principal{properties=BasicAttributes{registry={name=user, id=user}}, name='user', id='user'} Principal: role:user_role Principal: scope:calendar_read Principal: scope:calendar_edit ]. Subject FATAL: 12:27:38 is in neither of allowed times: [08:15 - 12:00, 12:30 - 17:30] at io.helidon.security.abac.time.TimeValidator@72486851" +Jul 20, 2022 12:27:39 PM io.helidon.security.DefaultAuditProvider lambda$logEvent$1 +FINEST: FAILURE grpcRequest 71e94b20-961c-4123-8f8b-ad8c365b8f80:1 io.helidon.security.integration.grpc.GrpcSecurityHandler processAudit GrpcSecurityHandler.java 442 :: "PERMISSION_DENIED StringService/Upper grpc grpc requested by Subject: Principal: Principal{properties=BasicAttributes{registry={name=user, id=user}}, name='user', id='user'} Principal: role:user_role Principal: scope:calendar_read Principal: scope:calendar_edit " +``` diff --git a/examples/grpc/security-abac/pom.xml b/examples/grpc/security-abac/pom.xml new file mode 100644 index 00000000..b11918d5 --- /dev/null +++ b/examples/grpc/security-abac/pom.xml @@ -0,0 +1,107 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-security-abac + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples ABAC Security + + + Examples of securing gRPC services using ABAC + + + + io.helidon.grpc.examples.security.abac.AbacServer + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.grpc + helidon-grpc-core + + + io.helidon.grpc + helidon-grpc-server + + + io.helidon.security.integration + helidon-security-integration-grpc + + + io.helidon.bundles + helidon-bundles-config + + + io.helidon.bundles + helidon-bundles-security + + + io.helidon.security.abac + helidon-security-abac-policy-el + + + org.glassfish + jakarta.el + + + io.helidon.grpc + helidon-grpc-client + + + io.grpc + grpc-netty + + + io.grpc + grpc-services + + + io.grpc + grpc-protobuf + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AbacServer.java b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AbacServer.java new file mode 100644 index 00000000..0d63e203 --- /dev/null +++ b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AbacServer.java @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security.abac; + +import java.time.DayOfWeek; +import java.time.LocalTime; + +import io.helidon.common.LogConfig; +import io.helidon.grpc.examples.common.StringService; +import io.helidon.grpc.server.GrpcRouting; +import io.helidon.grpc.server.GrpcServer; +import io.helidon.grpc.server.GrpcServerConfiguration; +import io.helidon.grpc.server.ServiceDescriptor; +import io.helidon.security.Security; +import io.helidon.security.SubjectType; +import io.helidon.security.abac.policy.PolicyValidator; +import io.helidon.security.abac.scope.ScopeValidator; +import io.helidon.security.abac.time.TimeValidator; +import io.helidon.security.integration.grpc.GrpcSecurity; +import io.helidon.security.providers.abac.AbacProvider; + +/** + * An example of a secure gRPC server that uses + * ABAC security configured in the code below. + *

+ * This server configures in code the same rules that + * the {@link AbacServerFromConfig} class uses from + * its configuration. + */ +public class AbacServer { + + private AbacServer() { + } + + /** + * Main entry point. + * + * @param args the program arguments + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + Security security = Security.builder() + .addProvider(AtnProvider.builder().build()) // add out custom provider + .addProvider(AbacProvider.builder().build()) // add the ABAC provider + .build(); + + // Create the time validator that will be used by the ABAC security provider + TimeValidator.TimeConfig validTimes = TimeValidator.TimeConfig.builder() + .addBetween(LocalTime.of(8, 15), LocalTime.of(12, 0)) + .addBetween(LocalTime.of(12, 30), LocalTime.of(17, 30)) + .addDaysOfWeek(DayOfWeek.MONDAY, DayOfWeek.TUESDAY, DayOfWeek.WEDNESDAY, DayOfWeek.THURSDAY, DayOfWeek.FRIDAY) + .build(); + + // Create the policy validator that will be used by the ABAC security provider + PolicyValidator.PolicyConfig validPolicy = PolicyValidator.PolicyConfig.builder() + .statement("${env.time.year >= 2017}") + .build(); + + // Create the scope validator that will be used by the ABAC security provider + ScopeValidator.ScopesConfig validScopes = ScopeValidator.ScopesConfig.create("calendar_read", "calendar_edit"); + + // Create the Atn config that will be used by out custom security provider + AtnProvider.AtnConfig atnConfig = AtnProvider.AtnConfig.builder() + .addAuth(AtnProvider.Auth.builder("user") + .type(SubjectType.USER) + .roles("user_role") + .scopes("calendar_read", "calendar_edit") + .build()) + .addAuth(AtnProvider.Auth.builder("service") + .type(SubjectType.SERVICE) + .roles("service_role") + .scopes("calendar_read", "calendar_edit") + .build()) + .build(); + + ServiceDescriptor stringService = ServiceDescriptor.builder(new StringService()) + .intercept("Upper", GrpcSecurity.secure() + .customObject(atnConfig) + .customObject(validScopes) + .customObject(validTimes) + .customObject(validPolicy)) + .build(); + + GrpcRouting grpcRouting = GrpcRouting.builder() + .intercept(GrpcSecurity.create(security).securityDefaults(GrpcSecurity.secure())) + .register(stringService) + .build(); + + GrpcServerConfiguration serverConfig = GrpcServerConfiguration.builder().build(); + GrpcServer grpcServer = GrpcServer.create(serverConfig, grpcRouting); + + grpcServer.start() + .thenAccept(s -> { + System.out.println("gRPC server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + } +} diff --git a/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AbacServerFromConfig.java b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AbacServerFromConfig.java new file mode 100644 index 00000000..d8ff0140 --- /dev/null +++ b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AbacServerFromConfig.java @@ -0,0 +1,73 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security.abac; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.StringService; +import io.helidon.grpc.server.GrpcRouting; +import io.helidon.grpc.server.GrpcServer; +import io.helidon.grpc.server.GrpcServerConfiguration; +import io.helidon.security.Security; +import io.helidon.security.integration.grpc.GrpcSecurity; + +/** + * An example of a secure gRPC server that uses ABAC + * security configured from configuration the configuration + * file application.conf. + *

+ * This server's configuration file configures security with + * same rules that the {@link AbacServer} class builds in + * code. + */ +public class AbacServerFromConfig { + + private AbacServerFromConfig() { + } + + /** + * Main entry point. + * + * @param args the program arguments + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + Config config = Config.create(); + + Security security = Security.create(config.get("security")); + + GrpcRouting grpcRouting = GrpcRouting.builder() + .intercept(GrpcSecurity.create(security, config.get("security"))) + .register(new StringService()) + .build(); + + GrpcServerConfiguration serverConfig = GrpcServerConfiguration.create(config.get("grpc")); + GrpcServer grpcServer = GrpcServer.create(serverConfig, grpcRouting); + + grpcServer.start() + .thenAccept(s -> { + System.out.println("gRPC server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + } +} diff --git a/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AtnProvider.java b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AtnProvider.java new file mode 100644 index 00000000..7ed3f981 --- /dev/null +++ b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AtnProvider.java @@ -0,0 +1,414 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security.abac; + +import java.lang.annotation.Annotation; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Inherited; +import java.lang.annotation.Repeatable; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Objects; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + +import io.helidon.config.Config; +import io.helidon.security.AuthenticationResponse; +import io.helidon.security.EndpointConfig; +import io.helidon.security.Grant; +import io.helidon.security.Principal; +import io.helidon.security.ProviderRequest; +import io.helidon.security.Role; +import io.helidon.security.Subject; +import io.helidon.security.SubjectType; +import io.helidon.security.spi.AuthenticationProvider; +import io.helidon.security.spi.SynchronousProvider; + +/** + * Example authentication provider that reads annotation to create a subject. + */ +public class AtnProvider extends SynchronousProvider implements AuthenticationProvider { + + /** + * The configuration key for this provider. + */ + public static final String CONFIG_KEY = "atn"; + + private final Config config; + + private AtnProvider(Config config) { + this.config = config; + } + + @Override + protected AuthenticationResponse syncAuthenticate(ProviderRequest providerRequest) { + EndpointConfig endpointConfig = providerRequest.endpointConfig(); + Config atnConfig = endpointConfig.config(CONFIG_KEY).orElse(null); + Subject user = null; + Subject service = null; + List list; + + Optional optional = providerRequest.endpointConfig().instance(AtnConfig.class); + + if (optional.isPresent()) { + list = optional.get().auths(); + } else if (atnConfig != null && !atnConfig.isLeaf()) { + list = atnConfig.asNodeList() + .map(this::fromConfig).orElse(Collections.emptyList()); + } else { + list = fromAnnotations(endpointConfig); + } + + for (Auth authentication : list) { + if (authentication.type() == SubjectType.USER) { + user = buildSubject(authentication); + } else { + service = buildSubject(authentication); + } + } + + return AuthenticationResponse.success(user, service); + } + + private List fromConfig(List configList) { + return configList.stream() + .map(Auth::new) + .collect(Collectors.toList()); + } + + private List fromAnnotations(EndpointConfig endpointConfig) { + return endpointConfig.securityLevels() + .stream() + .flatMap(level -> level.combineAnnotations(Authentications.class, EndpointConfig.AnnotationScope.METHOD).stream()) + .map(Authentications::value) + .flatMap(Arrays::stream) + .map(Auth::new) + .collect(Collectors.toList()); + } + + private Subject buildSubject(Auth authentication) { + Subject.Builder subjectBuilder = Subject.builder(); + + subjectBuilder.principal(Principal.create(authentication.principal())); + + Arrays.stream(authentication.roles()) + .map(Role::create) + .forEach(subjectBuilder::addGrant); + + Arrays.stream(authentication.scopes()) + .map(scope -> Grant.builder().name(scope).type("scope").build()) + .forEach(subjectBuilder::addGrant); + + return subjectBuilder.build(); + } + + @Override + public Collection> supportedAnnotations() { + return Set.of(Authentication.class); + } + + /** + * Create a {@link AtnProvider}. + * @return a {@link AtnProvider} + */ + public static AtnProvider create() { + return builder().build(); + } + + /** + * Create a {@link AtnProvider}. + * + * @param config the configuration for the {@link AtnProvider} + * + * @return a {@link AtnProvider} + */ + public static AtnProvider create(Config config) { + return builder(config).build(); + } + + /** + * Create a {@link AtnProvider.Builder}. + * @return a {@link AtnProvider.Builder} + */ + public static Builder builder() { + return builder(null); + } + + /** + * Create a {@link AtnProvider.Builder}. + * + * @param config the configuration for the {@link AtnProvider} + * + * @return a {@link AtnProvider.Builder} + */ + public static Builder builder(Config config) { + return new Builder(config); + } + + /** + * A builder that builds {@link AtnProvider} instances. + */ + public static class Builder + implements io.helidon.common.Builder { + + private Config config; + + private Builder(Config config) { + this.config = config; + } + + /** + * Set the configuration for the {@link AtnProvider}. + * @param config the configuration for the {@link AtnProvider} + * @return this builder + */ + public Builder config(Config config) { + this.config = config; + return this; + } + + @Override + public AtnProvider build() { + return new AtnProvider(config); + } + } + + /** + * Authentication annotation. + */ + @Retention(RetentionPolicy.RUNTIME) + @Target({ElementType.METHOD}) + @Documented + @Inherited + @Repeatable(Authentications.class) + public @interface Authentication { + /** + * Name of the principal. + * + * @return principal name + */ + String value(); + + /** + * Type of the subject, defaults to user. + * + * @return type + */ + SubjectType type() default SubjectType.USER; + + /** + * Granted roles. + * @return array of roles + */ + String[] roles() default ""; + + /** + * Granted scopes. + * @return array of scopes + */ + String[] scopes() default ""; + } + + /** + * Repeatable annotation for {@link Authentication}. + */ + @Retention(RetentionPolicy.RUNTIME) + @Target({ElementType.METHOD}) + @Documented + @Inherited + public @interface Authentications { + /** + * Repeating annotation. + * @return annotations + */ + Authentication[] value(); + } + + /** + * A holder for authentication settings. + */ + public static class Auth { + private String principal; + private SubjectType type = SubjectType.USER; + private String[] roles; + private String[] scopes; + + private Auth(Authentication authentication) { + principal = authentication.value(); + type = authentication.type(); + roles = authentication.roles(); + scopes = authentication.scopes(); + } + + private Auth(Config config) { + config.get("principal").ifExists(cfg -> principal = cfg.asString().get()); + config.get("type").ifExists(cfg -> type = SubjectType.valueOf(cfg.asString().get())); + config.get("roles").ifExists(cfg -> roles = cfg.asList(String.class).get().toArray(new String[0])); + config.get("scopes").ifExists(cfg -> scopes = cfg.asList(String.class).get().toArray(new String[0])); + } + + private Auth(String principal, SubjectType type, String[] roles, String[] scopes) { + this.principal = principal; + this.type = type; + this.roles = roles; + this.scopes = scopes; + } + + private String principal() { + return principal; + } + + private SubjectType type() { + return type; + } + + private String[] roles() { + return roles; + } + + private String[] scopes() { + return scopes; + } + + /** + * Obtain a builder for building {@link Auth} instances. + * + * @param principal the principal name + * + * @return a builder for building {@link Auth} instances. + */ + public static Builder builder(String principal) { + return new Auth.Builder(principal); + } + + /** + * A builder for building {@link Auth} instances. + */ + public static class Builder + implements io.helidon.common.Builder { + + private final String principal; + private SubjectType type = SubjectType.USER; + private String[] roles; + private String[] scopes; + + private Builder(String principal) { + this.principal = principal; + } + + /** + * Set the {@link SubjectType}. + * @param type the {@link SubjectType} + * @return this builder + */ + public Builder type(SubjectType type) { + this.type = type; + return this; + } + + /** + * Set the roles. + * @param roles the role names + * @return this builder + */ + public Builder roles(String... roles) { + this.roles = roles; + return this; + } + + /** + * Set the scopes. + * @param scopes the scopes names + * @return this builder + */ + public Builder scopes(String... scopes) { + this.scopes = scopes; + return this; + } + + @Override + public Auth build() { + return new Auth(principal, type, roles, scopes); + } + } + } + + /** + * The configuration for a {@link AtnProvider}. + */ + public static class AtnConfig { + private final List authData; + + private AtnConfig(List list) { + this.authData = list; + } + + /** + * Obtain the {@link List} of {@link Auth}s to use. + * + * @return the {@link List} of {@link Auth}s to use + */ + public List auths() { + return Collections.unmodifiableList(authData); + } + + /** + * Obtain a builder for building {@link AtnConfig} instances. + * + * @return a builder for building {@link AtnConfig} instances + */ + public static AtnConfig.Builder builder() { + return new Builder(); + } + + /** + * A builder for building {@link AtnConfig} instances. + */ + public static class Builder + implements io.helidon.common.Builder { + + private final List authData = new ArrayList<>(); + + /** + * Add an {@link Auth} instance. + * + * @param auth the {@link Auth} to add + * + * @return this builder + * + * @throws java.lang.NullPointerException if the {@link Auth} is null + */ + public Builder addAuth(Auth auth) { + authData.add(Objects.requireNonNull(auth)); + return this; + } + + @Override + public AtnConfig build() { + return new AtnConfig(authData); + } + } + } +} diff --git a/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AtnProviderService.java b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AtnProviderService.java new file mode 100644 index 00000000..2cede9e8 --- /dev/null +++ b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AtnProviderService.java @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security.abac; + +import io.helidon.config.Config; +import io.helidon.security.spi.SecurityProvider; +import io.helidon.security.spi.SecurityProviderService; + +/** + * A service provider for the {@link AtnProvider}. + */ +public class AtnProviderService + implements SecurityProviderService { + + @Override + public String providerConfigKey() { + return AtnProvider.CONFIG_KEY; + } + + @Override + public Class providerClass() { + return AtnProvider.class; + } + + @Override + public SecurityProvider providerInstance(Config config) { + return AtnProvider.create(config); + } +} diff --git a/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/SecureStringClient.java b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/SecureStringClient.java new file mode 100644 index 00000000..8ee69015 --- /dev/null +++ b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/SecureStringClient.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security.abac; + + +import io.helidon.grpc.examples.common.StringServiceGrpc; +import io.helidon.grpc.examples.common.Strings; + +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; + +/** + * A {@link io.helidon.grpc.examples.common.StringService} client that optionally + * provides {@link io.grpc.CallCredentials} using basic auth. + */ +public class SecureStringClient { + + private SecureStringClient() { + } + + /** + * Program entry point. + * + * @param args program arguments + */ + public static void main(String[] args) { + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + StringServiceGrpc.StringServiceBlockingStub stub = StringServiceGrpc.newBlockingStub(channel); + + String text = "abcde"; + Strings.StringMessage request = Strings.StringMessage.newBuilder().setText(text).build(); + Strings.StringMessage response = stub.upper(request); + + System.out.println("Text '" + text + "' to upper is '" + response.getText() + "'"); + } +} diff --git a/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/package-info.java b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/package-info.java new file mode 100644 index 00000000..1e5cb28e --- /dev/null +++ b/examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * A set of small usage examples. Start with {@link io.helidon.grpc.examples.security.SecureServer Main} class. + */ +package io.helidon.grpc.examples.security.abac; diff --git a/examples/grpc/security-abac/src/main/resources/META-INF/native-image/helidon-examples/grpc-security-abac/reflect-config.json b/examples/grpc/security-abac/src/main/resources/META-INF/native-image/helidon-examples/grpc-security-abac/reflect-config.json new file mode 100644 index 00000000..369ae4be --- /dev/null +++ b/examples/grpc/security-abac/src/main/resources/META-INF/native-image/helidon-examples/grpc-security-abac/reflect-config.json @@ -0,0 +1,11 @@ +[ + { + "name": "java.time.ZonedDateTime", + "methods": [ + { + "name": "getYear", + "parameterTypes": [] + } + ] + } +] \ No newline at end of file diff --git a/examples/grpc/security-abac/src/main/resources/META-INF/services/io.helidon.security.spi.SecurityProviderService b/examples/grpc/security-abac/src/main/resources/META-INF/services/io.helidon.security.spi.SecurityProviderService new file mode 100644 index 00000000..7888a0af --- /dev/null +++ b/examples/grpc/security-abac/src/main/resources/META-INF/services/io.helidon.security.spi.SecurityProviderService @@ -0,0 +1,17 @@ +# +# Copyright (c) 2019, 2021 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. +# + +io.helidon.grpc.examples.security.abac.AtnProviderService \ No newline at end of file diff --git a/examples/grpc/security-abac/src/main/resources/application.yaml b/examples/grpc/security-abac/src/main/resources/application.yaml new file mode 100644 index 00000000..77554c12 --- /dev/null +++ b/examples/grpc/security-abac/src/main/resources/application.yaml @@ -0,0 +1,87 @@ +# +# Copyright (c) 2019, 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. +# + +grpc: + port: 1408 + marshaller: + java: + enabled: true + +security: + providers: + - abac: + # prepares environment + # executes attribute validations + # validates that attributes were processed + # grants/denies access to resource + # + #### + # Combinations: + # # Will fail if any attribute is not validated and if any has failed validation + # fail-on-unvalidated: true + # fail-if-none-validated: true + # + # # Will fail if there is one or more attributes present and NONE of them is validated or if any has failed validation + # # Will NOT fail if there is at least one validated attribute and any number of not validated attributes (and NONE failed) + # fail-on-unvalidated: false + # fail-if-none-validated: true + # + # # Will fail if there is any attribute that failed validation + # # Will NOT fail if there are no failed validation or if there are NONE validated + # fail-on-unvalidated: false + # fail-if-none-validated: false + #### + # fail if an attribute was not validated (e.g. we do not know, whether it is valid or not) + # defaults to true + fail-on-unvalidated: true + # fail if none of the attributes were validated + # defaults to true + fail-if-none-validated: true + - atn: + class: "io.helidon.grpc.examples.security.abac.AtnProvider" + + grpc-server: + # Configuration of integration with grpc server + # The default configuration to apply to all services not explicitly configured below + defaults: + authenticate: true + authorize: true + services: + - name: "StringService" + methods: + - name: "Upper" + # Define our custom authenticator rules for the Upper method + atn: + - principal: "user" + type: "USER" + roles: ["user_role"] + scopes: ["calendar_read", "calendar_edit"] + - principal: "service" + type: "SERVICE" + roles: ["service_role"] + scopes: ["calendar_read", "calendar_edit"] + # Define ABAC rules for the Upper method + abac: + scopes: ["calendar_read", "calendar_edit"] + time: + time-of-day: + - from: "08:15:00" + to: "12:00:00" + - from: "12:30" + to: "17:30" + days-of-week: ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY"] + policy-validator: + statement: "${env.time.year >= 2017}" diff --git a/examples/grpc/security-abac/src/main/resources/logging.properties b/examples/grpc/security-abac/src/main/resources/logging.properties new file mode 100644 index 00000000..f136d2e8 --- /dev/null +++ b/examples/grpc/security-abac/src/main/resources/logging.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2019, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +.level=INFO +AUDIT.level=FINEST diff --git a/examples/grpc/security-outbound/README.md b/examples/grpc/security-outbound/README.md new file mode 100644 index 00000000..ae2563e2 --- /dev/null +++ b/examples/grpc/security-outbound/README.md @@ -0,0 +1,23 @@ +# Helidon gRPC Security ABAC Example + +An example gRPC outbound security + +## Build and run + +```shell +mvn -f ../pom.xml -pl common,security-outbound package +java -jar target/helidon-examples-grpc-security-outbound.jar +``` + +Exercise the example: +```shell +java -cp target/helidon-examples-grpc-security-outbound.jar \ + io.helidon.grpc.examples.security.outbound.SecureGreetClient +``` + +Sample output of the client: +```shell +bob +Greeting set to: MERHABA +bob +``` diff --git a/examples/grpc/security-outbound/pom.xml b/examples/grpc/security-outbound/pom.xml new file mode 100644 index 00000000..075da189 --- /dev/null +++ b/examples/grpc/security-outbound/pom.xml @@ -0,0 +1,103 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-security-outbound + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples Outbound Security + + + Examples of outbound security when using gRPC services + + + + io.helidon.grpc.examples.security.outbound.SecureServer + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.grpc + helidon-grpc-core + + + io.helidon.grpc + helidon-grpc-server + + + io.helidon.security.integration + helidon-security-integration-grpc + + + io.helidon.bundles + helidon-bundles-config + + + io.helidon.bundles + helidon-bundles-webserver + + + io.helidon.security.integration + helidon-security-integration-jersey-client + + + io.helidon.bundles + helidon-bundles-security + + + io.helidon.grpc + helidon-grpc-client + + + io.helidon.webclient + helidon-webclient + + + io.helidon.webclient + helidon-webclient-security + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/SecureGreetClient.java b/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/SecureGreetClient.java new file mode 100644 index 00000000..02e50630 --- /dev/null +++ b/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/SecureGreetClient.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security.outbound; + + +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.Greet; +import io.helidon.grpc.examples.common.GreetServiceGrpc; +import io.helidon.security.Security; +import io.helidon.security.integration.grpc.GrpcClientSecurity; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; + +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; + +/** + * A GreetService client that uses {@link io.grpc.CallCredentials} using basic auth. + */ +public class SecureGreetClient { + + private SecureGreetClient() { + } + + /** + * Program entry point. + * + * @param args program arguments + */ + public static void main(String[] args) { + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + Config config = Config.create(); + + // configure Helidon security and add the basic auth provider + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.create(config.get("http-basic-auth"))) + .build(); + + // create the gRPC client security call credentials + // setting the properties used by the basic auth provider for user name and password + GrpcClientSecurity clientSecurity = GrpcClientSecurity.builder(security.createContext("test.client")) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "Bob") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "password") + .build(); + + // create the GreetService client stub and use the GrpcClientSecurity call credentials + GreetServiceGrpc.GreetServiceBlockingStub stub = GreetServiceGrpc.newBlockingStub(channel) + .withCallCredentials(clientSecurity); + + Greet.GreetResponse greetResponse = stub.greet(Greet.GreetRequest.newBuilder().setName("Bob").build()); + + System.out.println(greetResponse.getMessage()); + + Greet.SetGreetingResponse setGreetingResponse = + stub.setGreeting(Greet.SetGreetingRequest.newBuilder().setGreeting("Merhaba").build()); + + System.out.println("Greeting set to: " + setGreetingResponse.getGreeting()); + + greetResponse = stub.greet(Greet.GreetRequest.newBuilder().setName("Bob").build()); + + System.out.println(greetResponse.getMessage()); + } +} diff --git a/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/SecureServer.java b/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/SecureServer.java new file mode 100644 index 00000000..0ee6df08 --- /dev/null +++ b/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/SecureServer.java @@ -0,0 +1,340 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security.outbound; + +import java.util.Optional; + +import io.helidon.common.LogConfig; +import io.helidon.common.context.Context; +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.grpc.core.GrpcHelper; +import io.helidon.grpc.examples.common.Greet; +import io.helidon.grpc.examples.common.StringService; +import io.helidon.grpc.examples.common.StringServiceGrpc; +import io.helidon.grpc.examples.common.Strings; +import io.helidon.grpc.server.GrpcRouting; +import io.helidon.grpc.server.GrpcServer; +import io.helidon.grpc.server.GrpcServerConfiguration; +import io.helidon.grpc.server.GrpcService; +import io.helidon.grpc.server.ServiceDescriptor; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.integration.grpc.GrpcClientSecurity; +import io.helidon.security.integration.grpc.GrpcSecurity; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webclient.security.WebClientSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; +import io.helidon.webserver.WebServer; + +import io.grpc.Channel; +import io.grpc.Status; +import io.grpc.StatusRuntimeException; +import io.grpc.inprocess.InProcessChannelBuilder; +import io.grpc.stub.StreamObserver; + +import static io.helidon.grpc.core.ResponseHelper.complete; + +/** + * An example server that configures services with outbound security. + */ +public class SecureServer { + + private static GrpcServer grpcServer; + + private static WebServer webServer; + + private SecureServer() { + } + + /** + * Program entry point. + * + * @param args the program command line arguments + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + Config config = Config.create(); + + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.create(config.get("http-basic-auth"))) + .build(); + + grpcServer = createGrpcServer(config.get("grpc"), security); + webServer = createWebServer(config.get("webserver"), security); + } + + /** + * Create the gRPC server. + */ + private static GrpcServer createGrpcServer(Config config, Security security) { + + GrpcRouting grpcRouting = GrpcRouting.builder() + // Add the security interceptor with a default of allowing any authenticated user + .intercept(GrpcSecurity.create(security).securityDefaults(GrpcSecurity.authenticate())) + // add the StringService with required role "admin" + .register(new StringService(), GrpcSecurity.rolesAllowed("admin")) + // add the GreetService (picking up the default security of any authenticated user) + .register(new GreetService()) + .build(); + + GrpcServer grpcServer = GrpcServer.create(GrpcServerConfiguration.create(config), grpcRouting); + + grpcServer.start() + .thenAccept(s -> { + System.out.println("gRPC server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("gRPC server startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + return grpcServer; + } + + /** + * Create the web server. + */ + private static WebServer createWebServer(Config config, Security security) { + + Routing routing = Routing.builder() + .register(WebSecurity.create(security).securityDefaults(WebSecurity.authenticate())) + .register(new RestService()) + .build(); + + WebServer webServer = WebServer.create(routing, config); + + webServer.start() + .thenAccept(s -> { + System.out.println("Web server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Web server startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + return webServer; + } + + /** + * A gRPC greet service that uses outbound security to + * access a ReST API. + */ + public static class GreetService + implements GrpcService { + + /** + * The current greeting. + */ + private String greeting = "hello"; + + /** + * The Helidon WebClient to use to make ReST calls. + */ + private WebClient client; + + private GreetService() { + client = WebClient.builder() + .addService(WebClientSecurity.create()) + .build(); + } + + @Override + public void update(ServiceDescriptor.Rules rules) { + rules.proto(Greet.getDescriptor()) + .unary("Greet", this::greet) + .unary("SetGreeting", this::setGreeting); + } + + /** + * This method calls a secure ReST endpoint using the caller's credentials. + * + * @param request the request + * @param observer the observer to send the response to + */ + private void greet(Greet.GreetRequest request, StreamObserver observer) { + // Obtain the greeting name from the request (default to "World". + String name = Optional.ofNullable(request.getName()).orElse("World"); + + // Obtain the security context from the current gRPC context + SecurityContext securityContext = GrpcSecurity.SECURITY_CONTEXT.get(); + Context context = Context.builder().id("example").build(); + context.register(securityContext); + + // Use the current credentials call the "lower" ReST endpoint which will call + // the "Lower" method on the secure gRPC StringService. + client.get() + .uri("http://localhost:" + webServer.port()) + .path("lower") + .queryParam("value", name) + .context(context) + .request() + .thenAccept(it -> handleResponse(it, observer)) + .exceptionally(throwable -> { + observer.onError(throwable); + return null; + }); + } + + /** + * This method calls a secure ReST endpoint overriding the caller's credentials and + * using the admin user's credentials. + * + * @param request the request + * @param observer the observer to send the response to + */ + private void setGreeting(Greet.SetGreetingRequest request, StreamObserver observer) { + // Obtain the greeting name from the request (default to "hello". + String name = Optional.ofNullable(request.getGreeting()).orElse("hello"); + + // Obtain the security context from the current gRPC context + SecurityContext securityContext = GrpcSecurity.SECURITY_CONTEXT.get(); + Context context = Context.builder().id("example").build(); + context.register(securityContext); + + // Use the admin user's credentials call the "upper" ReST endpoint which will call + // the "Upper" method on the secure gRPC StringService. + client.get() + .uri("http://127.0.0.1:" + webServer.port()) + .path("upper") + .queryParam("value", name) + .context(context) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "Ted") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "secret") + .request() + .thenAccept(it -> handleResponse(it, observer)) + .exceptionally(throwable -> { + observer.onError(throwable); + return null; + }); + } + + private void handleResponse(WebClientResponse response, StreamObserver observer) { + if (response.status() == Http.Status.OK_200) { + // Send the response to the caller of the current greeting and lower case name + response.content() + .as(String.class) + .thenAccept(str -> complete(observer, + Greet.SetGreetingResponse.newBuilder().setGreeting(str).build())); + } else { + completeWithError(response, observer); + } + } + + private void completeWithError(WebClientResponse response, StreamObserver observer) { + Http.ResponseStatus status = response.status(); + + if (status == Http.Status.UNAUTHORIZED_401 + || status == Http.Status.FORBIDDEN_403){ + observer.onError(Status.PERMISSION_DENIED.asRuntimeException()); + } else { + response.content() + .as(String.class) + .thenAccept(str -> observer.onError(Status.INTERNAL.withDescription(str).asRuntimeException())); + } + } + + @Override + public String name() { + return "GreetService"; + } + } + + /** + * A ReST service that calls the gRPC StringService to mutate String values. + */ + public static class RestService + implements Service { + + private Channel channel; + + @Override + public void update(Routing.Rules rules) { + rules.get("/lower", WebSecurity.rolesAllowed("user"), this::lower) + .get("/upper", WebSecurity.rolesAllowed("user"), this::upper); + } + + /** + * Call the gRPC StringService Lower method overriding the caller's credentials and + * using the admin user's credentials. + * + * @param req the http request + * @param res the http response + */ + private void lower(ServerRequest req, ServerResponse res) { + try { + // Create the gRPC client security credentials from the current request + // overriding with the admin user's credentials + GrpcClientSecurity clientSecurity = GrpcClientSecurity.builder(req) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "Ted") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "secret") + .build(); + + StringServiceGrpc.StringServiceBlockingStub stub = StringServiceGrpc.newBlockingStub(ensureChannel()) + .withCallCredentials(clientSecurity); + + String value = req.queryParams().first("value").orElse(null); + Strings.StringMessage response = stub.lower(Strings.StringMessage.newBuilder().setText(value).build()); + + res.status(200).send(response.getText()); + } catch (StatusRuntimeException e) { + res.status(GrpcHelper.toHttpResponseStatus(e.getStatus())).send(); + } + } + + /** + * Call the gRPC StringService Upper method using the current caller's credentials. + * + * @param req the http request + * @param res the http response + */ + private void upper(ServerRequest req, ServerResponse res) { + try { + // Create the gRPC client security credentials from the current request + GrpcClientSecurity clientSecurity = GrpcClientSecurity.create(req); + + StringServiceGrpc.StringServiceBlockingStub stub = StringServiceGrpc.newBlockingStub(ensureChannel()) + .withCallCredentials(clientSecurity); + + String value = req.queryParams().first("value").orElse(null); + Strings.StringMessage response = stub.upper(Strings.StringMessage.newBuilder().setText(value).build()); + + res.status(200).send(response.getText()); + } catch (StatusRuntimeException e) { + res.status(GrpcHelper.toHttpResponseStatus(e.getStatus())).send(); + } + } + + private synchronized Channel ensureChannel() { + if (channel == null) { + channel = InProcessChannelBuilder.forName(grpcServer.configuration().name()).build(); + } + return channel; + } + } +} diff --git a/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/package-info.java b/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/package-info.java new file mode 100644 index 00000000..67f1e1f1 --- /dev/null +++ b/examples/grpc/security-outbound/src/main/java/io/helidon/grpc/examples/security/outbound/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Examples of using outbound security with gRPC services. + */ +package io.helidon.grpc.examples.security.outbound; diff --git a/examples/grpc/security-outbound/src/main/resources/application.yaml b/examples/grpc/security-outbound/src/main/resources/application.yaml new file mode 100644 index 00000000..340a20aa --- /dev/null +++ b/examples/grpc/security-outbound/src/main/resources/application.yaml @@ -0,0 +1,39 @@ +# +# Copyright (c) 2019, 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. +# + +app: + greeting: "Hello" + +grpc: + name: "test.server" + port: 1408 + marshaller: + java: + enabled: true + +webserver: + port: 8080 + +http-basic-auth: + users: + - login: "Ted" + password: "secret" + roles: ["user", "admin"] + - login: "Bob" + password: "password" + roles: ["user"] + outbound: + - name: propagate_all diff --git a/examples/grpc/security-outbound/src/main/resources/logging.properties b/examples/grpc/security-outbound/src/main/resources/logging.properties new file mode 100644 index 00000000..d902c5b9 --- /dev/null +++ b/examples/grpc/security-outbound/src/main/resources/logging.properties @@ -0,0 +1,35 @@ +# +# Copyright (c) 2019, 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.common.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 + +# Component specific log levels +AUDIT.level=FINEST +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/grpc/security/README.md b/examples/grpc/security/README.md new file mode 100644 index 00000000..2df53fed --- /dev/null +++ b/examples/grpc/security/README.md @@ -0,0 +1,33 @@ +# Helidon gRPC Security Example + +An example gRPC server using basic auth security. + +## Build and run + +```shell +mvn -f ../pom.xml -pl common,security package +java -jar target/helidon-examples-grpc-security.jar +``` + +# Exercise the example: +```shell +java -cp target/helidon-examples-grpc-security.jar \ + io.helidon.grpc.examples.security.SecureGreetClient +java -cp target/helidon-examples-grpc-security.jar \ + io.helidon.grpc.examples.security.SecureStringClient +``` + +# Sample client output: +SecureGreetClient: +```shell +message: "Hello Aleks!" + +greeting: "Hey" + +message: "Hey Aleks!" +``` + +SecureStringClient: +```shell +Response from Lower method call is 'abcde' +``` diff --git a/examples/grpc/security/pom.xml b/examples/grpc/security/pom.xml new file mode 100644 index 00000000..ca39f6da --- /dev/null +++ b/examples/grpc/security/pom.xml @@ -0,0 +1,99 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.grpc + helidon-examples-grpc-security + 1.0.0-SNAPSHOT + Helidon gRPC Server Examples Security + + + Examples of securing gRPC services + + + + io.helidon.grpc.examples.security.SecureServer + + + + + io.helidon.examples.grpc + helidon-examples-grpc-common + ${project.version} + + + io.helidon.grpc + helidon-grpc-core + + + io.helidon.grpc + helidon-grpc-server + + + io.helidon.bundles + helidon-bundles-config + + + io.helidon.security.integration + helidon-security-integration-grpc + + + io.helidon.security.providers + helidon-security-providers-http-auth + + + io.helidon.grpc + helidon-grpc-client + + + io.grpc + grpc-netty + + + io.grpc + grpc-services + + + io.grpc + grpc-protobuf + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureGreetClient.java b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureGreetClient.java new file mode 100644 index 00000000..728020d4 --- /dev/null +++ b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureGreetClient.java @@ -0,0 +1,106 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security; + + +import io.helidon.config.Config; +import io.helidon.grpc.client.ClientServiceDescriptor; +import io.helidon.grpc.client.GrpcServiceClient; +import io.helidon.grpc.examples.common.Greet; +import io.helidon.grpc.examples.common.GreetServiceGrpc; +import io.helidon.security.Security; +import io.helidon.security.integration.grpc.GrpcClientSecurity; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; + +import io.grpc.CallCredentials; +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; + +/** + * A {@link io.helidon.grpc.examples.common.GreetService} client that optionally + * provides {@link CallCredentials} using basic auth. + */ +public class SecureGreetClient { + + private SecureGreetClient() { + } + + /** + * Main entry point. + * + * @param args the program arguments - {@code arg[0]} is the user name + * and {@code arg[1] is the password} + */ + public static void main(String[] args) { + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + // Obtain the user name and password from the program arguments + String user = args.length >= 2 ? args[0] : "Ted"; + String password = args.length >= 2 ? args[1] : "secret"; + + Config config = Config.create(); + + // configure Helidon security and add the basic auth provider + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.create(config.get("http-basic-auth"))) + .build(); + + // create the gRPC client security call credentials + // setting the properties used by the basic auth provider for user name and password + GrpcClientSecurity clientSecurity = GrpcClientSecurity.builder(security.createContext("test.client")) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, user) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, password) + .build(); + + // Create the client service descriptor and add the call credentials + ClientServiceDescriptor descriptor = ClientServiceDescriptor + .builder(GreetServiceGrpc.getServiceDescriptor()) + .callCredentials(clientSecurity) + .build(); + + // create the client for the service + GrpcServiceClient client = GrpcServiceClient.create(channel, descriptor); + + greet(client); + setGreeting(client); + greet(client); + } + + private static void greet(GrpcServiceClient client) { + try { + Greet.GreetRequest request = Greet.GreetRequest.newBuilder().setName("Aleks").build(); + Greet.GreetResponse response = client.blockingUnary("Greet", request); + + System.out.println(response); + } catch (Exception e) { + System.err.println("Caught exception obtaining greeting: " + e.getMessage()); + } + } + + private static void setGreeting(GrpcServiceClient client) { + try { + Greet.SetGreetingRequest setRequest = Greet.SetGreetingRequest.newBuilder().setGreeting("Hey").build(); + Greet.SetGreetingResponse setResponse = client.blockingUnary("SetGreeting", setRequest); + + System.out.println(setResponse); + } catch (Exception e) { + System.err.println("Caught exception setting greeting: " + e.getMessage()); + } + } +} diff --git a/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureServer.java b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureServer.java new file mode 100644 index 00000000..ca5cc00b --- /dev/null +++ b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureServer.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.grpc.examples.common.GreetService; +import io.helidon.grpc.examples.common.StringService; +import io.helidon.grpc.server.GrpcRouting; +import io.helidon.grpc.server.GrpcServer; +import io.helidon.grpc.server.GrpcServerConfiguration; +import io.helidon.grpc.server.ServiceDescriptor; +import io.helidon.security.Security; +import io.helidon.security.integration.grpc.GrpcSecurity; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; + +/** + * An example of a secure gRPC server. + */ +public class SecureServer { + + private SecureServer() { + } + + /** + * Main entry point. + * + * @param args the program arguments + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + Config config = Config.create(); + + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.create(config.get("http-basic-auth"))) + .build(); + + ServiceDescriptor greetService1 = ServiceDescriptor.builder(new GreetService(config)) + .name("GreetService") + .intercept(GrpcSecurity.rolesAllowed("user")) + .intercept("SetGreeting", GrpcSecurity.rolesAllowed("admin")) + .build(); + + GrpcRouting grpcRouting = GrpcRouting.builder() + .intercept(GrpcSecurity.create(security).securityDefaults(GrpcSecurity.authenticate())) + .register(greetService1) + .register(new StringService()) + .build(); + + GrpcServerConfiguration serverConfig = GrpcServerConfiguration.create(config.get("grpc")); + GrpcServer grpcServer = GrpcServer.create(serverConfig, grpcRouting); + + grpcServer.start() + .thenAccept(s -> { + System.out.println("gRPC server is UP! http://localhost:" + s.port()); + s.whenShutdown().thenRun(() -> System.out.println("gRPC server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + } +} diff --git a/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureStringClient.java b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureStringClient.java new file mode 100644 index 00000000..a21e8fca --- /dev/null +++ b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/SecureStringClient.java @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2019, 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.grpc.examples.security; + + +import io.helidon.config.Config; +import io.helidon.grpc.client.ClientServiceDescriptor; +import io.helidon.grpc.client.GrpcServiceClient; +import io.helidon.grpc.examples.common.StringServiceGrpc; +import io.helidon.grpc.examples.common.Strings; +import io.helidon.security.Security; +import io.helidon.security.integration.grpc.GrpcClientSecurity; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; + +import io.grpc.CallCredentials; +import io.grpc.Channel; +import io.grpc.ManagedChannelBuilder; + +/** + * A {@link io.helidon.grpc.examples.common.StringService} client that optionally + * provides {@link CallCredentials} using basic auth. + */ +public class SecureStringClient { + + private SecureStringClient() { + } + + /** + * Program entry point. + * + * @param args the program arguments - {@code arg[0]} is the user name + * and {@code arg[1] is the password} + */ + public static void main(String[] args) { + Channel channel = ManagedChannelBuilder.forAddress("localhost", 1408) + .usePlaintext() + .build(); + + // Obtain the user name and password from the program arguments + String user = args.length >= 2 ? args[0] : "Ted"; + String password = args.length >= 2 ? args[1] : "secret"; + + Config config = Config.create(); + + // configure Helidon security and add the basic auth provider + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.create(config.get("http-basic-auth"))) + .build(); + + // create the gRPC client security call credentials + // setting the properties used by the basic auth provider for user name and password + GrpcClientSecurity clientSecurity = GrpcClientSecurity.builder(security.createContext("test.client")) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, user) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, password) + .build(); + + // Create the client service descriptor and add the call credentials + ClientServiceDescriptor descriptor = ClientServiceDescriptor + .builder(StringServiceGrpc.getServiceDescriptor()) + .callCredentials(clientSecurity) + .build(); + + // create the client for the service + GrpcServiceClient client = GrpcServiceClient.create(channel, descriptor); + + Strings.StringMessage request = Strings.StringMessage.newBuilder().setText("ABCDE").build(); + Strings.StringMessage response = client.blockingUnary("Lower", request); + + System.out.println("Response from Lower method call is '" + response.getText() + "'"); + } +} diff --git a/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/package-info.java b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/package-info.java new file mode 100644 index 00000000..2da5d4d9 --- /dev/null +++ b/examples/grpc/security/src/main/java/io/helidon/grpc/examples/security/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * A set of small usage examples. Start with {@link io.helidon.grpc.examples.security.SecureServer Main} class. + */ +package io.helidon.grpc.examples.security; diff --git a/examples/grpc/security/src/main/resources/application.yaml b/examples/grpc/security/src/main/resources/application.yaml new file mode 100644 index 00000000..36f9913d --- /dev/null +++ b/examples/grpc/security/src/main/resources/application.yaml @@ -0,0 +1,37 @@ +# +# Copyright (c) 2019, 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. +# + +app: + greeting: "Hello" + +grpc: + name: "test.server" + port: 1408 + marshaller: + java: + enabled: true + +webserver: + port: 8080 + +http-basic-auth: + users: + - login: "Ted" + password: "secret" + roles: ["user", "admin"] + - login: "Bob" + password: "password" + roles: ["user"] \ No newline at end of file diff --git a/examples/grpc/security/src/main/resources/logging.properties b/examples/grpc/security/src/main/resources/logging.properties new file mode 100644 index 00000000..d902c5b9 --- /dev/null +++ b/examples/grpc/security/src/main/resources/logging.properties @@ -0,0 +1,35 @@ +# +# Copyright (c) 2019, 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.common.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 + +# Component specific log levels +AUDIT.level=FINEST +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/health/basics/README.md b/examples/health/basics/README.md new file mode 100644 index 00000000..9e02cc89 --- /dev/null +++ b/examples/health/basics/README.md @@ -0,0 +1,24 @@ +# Helidon Health Basic Example + +This example shows the basics of using Helidon SE Health. It uses the +set of built-in health checks that Helidon provides plus defines a +custom health check. + +## Build and run + +Start the application: + +```shell +mvn package +java -jar target/helidon-examples-health-basics.jar +``` + +Note the port number reported by the application. + +Probe the health endpoints: + +```shell +export PORT=45909 +curl -X GET http://localhost:${PORT}/health/ +curl -X GET http://localhost:${PORT}/health/ready +``` diff --git a/examples/health/basics/pom.xml b/examples/health/basics/pom.xml new file mode 100644 index 00000000..0143b0d2 --- /dev/null +++ b/examples/health/basics/pom.xml @@ -0,0 +1,80 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.health + helidon-examples-health-basics + 1.0.0-SNAPSHOT + Helidon Health Examples Basics + + + Basic usage of health checks in helidon SE + + + + io.helidon.examples.health.basics.Main + + + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.webserver + helidon-webserver + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/health/basics/src/main/java/io/helidon/examples/health/basics/Main.java b/examples/health/basics/src/main/java/io/helidon/examples/health/basics/Main.java new file mode 100644 index 00000000..adcee4e3 --- /dev/null +++ b/examples/health/basics/src/main/java/io/helidon/examples/health/basics/Main.java @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2018, 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.health.basics; + +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.eclipse.microprofile.health.HealthCheck; +import org.eclipse.microprofile.health.HealthCheckResponse; + +/** + * Main class of health check integration example. + */ +public final class Main { + + private Main() { + } + + /** + * Start the example. Prints endpoints to standard output. + * + * @param args not used + */ + public static void main(String[] args) { + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) + .addReadiness((HealthCheck) () -> HealthCheckResponse.named("exampleHealthCheck") + .up() + .withData("time", System.currentTimeMillis()) + .build()) + .build(); + + Routing routing = Routing.builder() + .register(health) + .get("/hello", (req, res) -> res.send("Hello World!")) + .build(); + + WebServer ws = WebServer.create(routing); + + ws.start() + .thenApply(webServer -> { + String endpoint = "http://localhost:" + webServer.port(); + System.out.println("Hello World started on " + endpoint + "/hello"); + System.out.println("Health checks available on " + endpoint + "/health"); + return null; + }); + + } +} diff --git a/examples/health/basics/src/main/java/io/helidon/examples/health/basics/package-info.java b/examples/health/basics/src/main/java/io/helidon/examples/health/basics/package-info.java new file mode 100644 index 00000000..f5911509 --- /dev/null +++ b/examples/health/basics/src/main/java/io/helidon/examples/health/basics/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2018, 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 of healthchecks in helidon SE. + */ +package io.helidon.examples.health.basics; diff --git a/examples/health/pom.xml b/examples/health/pom.xml new file mode 100644 index 00000000..ff872f6e --- /dev/null +++ b/examples/health/pom.xml @@ -0,0 +1,35 @@ + + + + + 4.0.0 + + helidon-examples-project + io.helidon.examples + 1.0.0-SNAPSHOT + + io.helidon.examples.health + helidon-examples-health-project + pom + Helidon Health Examples + + + basics + + diff --git a/examples/integrations/README.md b/examples/integrations/README.md new file mode 100644 index 00000000..05fd10c9 --- /dev/null +++ b/examples/integrations/README.md @@ -0,0 +1 @@ +# Helidon Integrations Examples diff --git a/examples/integrations/cdi/README.md b/examples/integrations/cdi/README.md new file mode 100644 index 00000000..64fad795 --- /dev/null +++ b/examples/integrations/cdi/README.md @@ -0,0 +1 @@ +# Helidon Integrations CDI Examples diff --git a/examples/integrations/cdi/datasource-hikaricp-h2/README.md b/examples/integrations/cdi/datasource-hikaricp-h2/README.md new file mode 100644 index 00000000..d630d6a6 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-h2/README.md @@ -0,0 +1,19 @@ +# H2 Integration Example + +## Overview + +This example shows a trivial Helidon MicroProfile application that +uses the Hikari connection pool CDI integration and an H2 in-memory +database. + +## Build and run + +```shell +mvn package +java -jar target/helidon-integrations-examples-datasource-hikaricp-h2.jar +``` + +Try the endpoint: +```shell +curl http://localhost:8080/tables +``` diff --git a/examples/integrations/cdi/datasource-hikaricp-h2/pom.xml b/examples/integrations/cdi/datasource-hikaricp-h2/pom.xml new file mode 100644 index 00000000..025fcb5c --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-h2/pom.xml @@ -0,0 +1,104 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.cdi + helidon-integrations-examples-datasource-hikaricp-h2 + 1.0.0-SNAPSHOT + Helidon CDI Extensions Examples DataSource/HikariCP H2 + + + + + jakarta.enterprise + jakarta.enterprise.cdi-api + compile + + + jakarta.ws.rs + jakarta.ws.rs-api + compile + + + org.eclipse.microprofile.config + microprofile-config-api + compile + + + + + com.h2database + h2 + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-hikaricp + runtime + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.server + helidon-microprofile-server + runtime + + + io.helidon.microprofile.config + helidon-microprofile-config + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/cdi/datasource-hikaricp-h2/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java new file mode 100644 index 00000000..ce8a9931 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2019, 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.integrations.examples.datasource.hikaricp.jaxrs; + +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.Objects; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.inject.Named; +import javax.sql.DataSource; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +/** + * A JAX-RS resource class in {@linkplain ApplicationScoped + * application scope} rooted at {@code /tables}. + * + * @see #get() + */ +@Path("/tables") +@ApplicationScoped +public class TablesResource { + + private final DataSource dataSource; + + /** + * Creates a new {@link TablesResource}. + * + * @param dataSource the {@link DataSource} to use to acquire + * database table names; must not be {@code null} + * + * @exception NullPointerException if {@code dataSource} is {@code + * null} + */ + @Inject + public TablesResource(@Named("example") final DataSource dataSource) { + super(); + this.dataSource = Objects.requireNonNull(dataSource); + } + + /** + * Returns a {@link Response} which, if successful, contains a + * newline-separated list of Oracle database table names. + * + *

This method never returns {@code null}.

+ * + * @return a non-{@code null} {@link Response} + * + * @exception SQLException if a database error occurs + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public Response get() throws SQLException { + final StringBuilder sb = new StringBuilder(); + try (Connection connection = this.dataSource.getConnection(); + PreparedStatement ps = + connection.prepareStatement(" SELECT TABLE_NAME" + + " FROM INFORMATION_SCHEMA.TABLES " + + "ORDER BY TABLE_NAME ASC"); + ResultSet rs = ps.executeQuery()) { + while (rs.next()) { + sb.append(rs.getString(1)).append("\n"); + } + } + final Response returnValue = Response.ok() + .entity(sb.toString()) + .build(); + return returnValue; + } + +} diff --git a/examples/integrations/cdi/datasource-hikaricp-h2/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java new file mode 100644 index 00000000..d92e1799 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Provides JAX-RS-related classes and interfaces for this example + * project. + */ +package io.helidon.integrations.examples.datasource.hikaricp.jaxrs; diff --git a/examples/integrations/cdi/datasource-hikaricp-h2/src/main/resources/META-INF/beans.xml b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..fc0fe765 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/cdi/datasource-hikaricp-h2/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..f1fd9dc1 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-h2/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2019, 2021 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. +# + +# Default database properties. +javax.sql.DataSource.example.dataSourceClassName = org.h2.jdbcx.JdbcDataSource +javax.sql.DataSource.example.dataSource.url = jdbc:h2:mem:sample +javax.sql.DataSource.example.dataSource.user = sa +javax.sql.DataSource.example.dataSource.password = + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/integrations/cdi/datasource-hikaricp-mysql/README.md b/examples/integrations/cdi/datasource-hikaricp-mysql/README.md new file mode 100644 index 00000000..7dd68e78 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-mysql/README.md @@ -0,0 +1,60 @@ +# MySQL Integration Example + +## Overview + +This example shows a trivial Helidon MicroProfile application that +uses the MySQL CDI integration. It also shows how to run MySQL in a +Docker container and connect to it using the application. + +## Notes + +To run MySQL's `mysql:8` Docker image in a Docker container named +`mysql` that publishes its port 3306 to the host machine's port 3306 +and uses `tiger` as the MySQL root password and that will +automatically be removed when it is stopped: + +```shell +docker container run --rm -d -p 3306:3306 \ + --env MYSQL_ROOT_PASSWORD=tiger \ + --name mysql \ + mysql:8 +``` + +(Note that in the `3306:3306` option value above the first port number +is the port number on the host (i.e. your physical machine running +`docker`) and the second number (after the colon) is the port number +on the Docker container.) + +To ensure that the sample application is configured to talk to MySQL +running in this Docker container, verify that the following lines +(among others) are present in +`src/main/resources/META-INF/microprofile-config.properties`: + +```properties +javax.sql.DataSource.example.dataSourceClassName=com.mysql.cj.jdbc.MysqlDataSource +javax.sql.DataSource.example.dataSource.url = jdbc:mysql://localhost:3306 +javax.sql.DataSource.example.dataSource.user = root +javax.sql.DataSource.example.dataSource.password = tiger +``` + + +## Build and run + +```shell +mvn package +java -jar target/helidon-integrations-examples-datasource-hikaricp-mysql.jar +``` + +Try the endpoint: +```shell +curl http://localhost:8080/tables +``` + +Stop the docker container: +```shell +docker stop mysql +``` + +## References + +- [MySQL Docker documentation](https://hub.docker.com/_/mysql?tab=description) diff --git a/examples/integrations/cdi/datasource-hikaricp-mysql/pom.xml b/examples/integrations/cdi/datasource-hikaricp-mysql/pom.xml new file mode 100644 index 00000000..c387fcb2 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-mysql/pom.xml @@ -0,0 +1,105 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.cdi + helidon-integrations-examples-datasource-hikaricp-mysql + 1.0.0-SNAPSHOT + Helidon CDI Extensions Examples DataSource/HikariCP MySQL + + + + + jakarta.enterprise + jakarta.enterprise.cdi-api + compile + + + jakarta.ws.rs + jakarta.ws.rs-api + compile + + + org.eclipse.microprofile.config + microprofile-config-api + compile + + + + + com.mysql + mysql-connector-j + runtime + true + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-hikaricp + runtime + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.server + helidon-microprofile-server + runtime + + + io.helidon.microprofile.config + helidon-microprofile-config + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java new file mode 100644 index 00000000..ce8a9931 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2019, 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.integrations.examples.datasource.hikaricp.jaxrs; + +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.Objects; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.inject.Named; +import javax.sql.DataSource; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +/** + * A JAX-RS resource class in {@linkplain ApplicationScoped + * application scope} rooted at {@code /tables}. + * + * @see #get() + */ +@Path("/tables") +@ApplicationScoped +public class TablesResource { + + private final DataSource dataSource; + + /** + * Creates a new {@link TablesResource}. + * + * @param dataSource the {@link DataSource} to use to acquire + * database table names; must not be {@code null} + * + * @exception NullPointerException if {@code dataSource} is {@code + * null} + */ + @Inject + public TablesResource(@Named("example") final DataSource dataSource) { + super(); + this.dataSource = Objects.requireNonNull(dataSource); + } + + /** + * Returns a {@link Response} which, if successful, contains a + * newline-separated list of Oracle database table names. + * + *

This method never returns {@code null}.

+ * + * @return a non-{@code null} {@link Response} + * + * @exception SQLException if a database error occurs + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public Response get() throws SQLException { + final StringBuilder sb = new StringBuilder(); + try (Connection connection = this.dataSource.getConnection(); + PreparedStatement ps = + connection.prepareStatement(" SELECT TABLE_NAME" + + " FROM INFORMATION_SCHEMA.TABLES " + + "ORDER BY TABLE_NAME ASC"); + ResultSet rs = ps.executeQuery()) { + while (rs.next()) { + sb.append(rs.getString(1)).append("\n"); + } + } + final Response returnValue = Response.ok() + .entity(sb.toString()) + .build(); + return returnValue; + } + +} diff --git a/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java new file mode 100644 index 00000000..d92e1799 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Provides JAX-RS-related classes and interfaces for this example + * project. + */ +package io.helidon.integrations.examples.datasource.hikaricp.jaxrs; diff --git a/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/resources/META-INF/beans.xml b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..fc0fe765 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..2259bbf2 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp-mysql/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved. +# +# 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. +# + +# Default database properties. +javax.sql.DataSource.example.dataSourceClassName=com.mysql.cj.jdbc.MysqlDataSource +javax.sql.DataSource.example.dataSource.url = jdbc:mysql://localhost:3306 +javax.sql.DataSource.example.dataSource.user = root +javax.sql.DataSource.example.dataSource.password = tiger + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/integrations/cdi/datasource-hikaricp/.dockerignore b/examples/integrations/cdi/datasource-hikaricp/.dockerignore new file mode 100644 index 00000000..2f7896d1 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/.dockerignore @@ -0,0 +1 @@ +target/ diff --git a/examples/integrations/cdi/datasource-hikaricp/Dockerfile b/examples/integrations/cdi/datasource-hikaricp/Dockerfile new file mode 100644 index 00000000..6653ba56 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/Dockerfile @@ -0,0 +1,44 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-integrations-datasource-hikaricp.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD [ "java", "-jar", "helidon-examples-integrations-datasource-hikaricp.jar" ] + +EXPOSE 8080 diff --git a/examples/integrations/cdi/datasource-hikaricp/README.md b/examples/integrations/cdi/datasource-hikaricp/README.md new file mode 100644 index 00000000..cb72a0de --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/README.md @@ -0,0 +1,85 @@ +# Hikari Connection Pool Integration Example + +## Overview + +This example shows a trivial Helidon MicroProfile application that +uses the Hikari connection pool CDI integration. It also shows how to +run the Oracle database in a Docker container and connect the +application to it. + +## Prerequisites + +You'll need an Oracle account in order to log in to the Oracle +Container Registry. The Oracle Container Registry is where the Docker +image housing the Oracle database is located. To set up an Oracle +account if you don't already have one, see +[the Oracle account creation website](https://profile.oracle.com/myprofile/account/create-account.jspx). + +## Notes + +To log in to the Oracle Container Registry (which you will need to do +in order to download Oracle database Docker images from it): + +```shell +docker login -u username -p password container-registry.oracle.com +``` + +For more information on the Oracle Container Registry, please visit +its [website](https://container-registry.oracle.com/). + +To run Oracle's `database/standard` Docker image in a Docker container +named `oracle` that publishes ports 1521 and 5500 to +the host while relying on the defaults for all other settings: + +```shell +docker container run -d -it -p 1521:1521 -p 5500:5500 --shm-size=3g \ + --name oracle \ + container-registry.oracle.com/database/standard:latest +``` + +It will take about ten minutes before the database is ready. + +For more information on the Oracle database image used by this +example, you can visit the relevant section of the + [Oracle Container Registry website](https://container-registry.oracle.com/). + +To ensure that the sample application is configured to talk to the +Oracle database running in this Docker container, verify that the +following lines (among others) are present in +`src/main/resources/META-INF/microprofile-config.properties`: + +```properties +javax.sql.DataSource.example.dataSourceClassName=oracle.jdbc.pool.OracleDataSource +javax.sql.DataSource.example.dataSource.url = jdbc:oracle:thin:@localhost:1521:ORCL +javax.sql.DataSource.example.dataSource.user = sys as sysoper +javax.sql.DataSource.example.dataSource.password = Oracle +``` + +## Build and run + +With Docker: +```shell +docker build -t helidon-examples-integrations-datasource-hikaricp . +docker run --rm -d \ + --link oracle \ + -e javax_sql_DataSource_example_dataSource_url="jdbc:oracle:thin:@oracle:1521:ORCL" \ + --name helidon-examples-integrations-datasource-hikaricp \ + -p 8080:8080 helidon-examples-integrations-datasource-hikaricp:latest +``` +OR + +With Maven: +```shell +mvn package +java -jar target/helidon-examples-integrations-datasource-hikaricp.jar +``` + +Try the endpoint: +```shell +curl http://localhost:8080/tables +``` + +Stop the docker containers: +```shell +docker stop oracle helidon-examples-integrations-datasource-hikaricp +``` diff --git a/examples/integrations/cdi/datasource-hikaricp/pom.xml b/examples/integrations/cdi/datasource-hikaricp/pom.xml new file mode 100644 index 00000000..3b36ca52 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/pom.xml @@ -0,0 +1,110 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.cdi + helidon-examples-integrations-datasource-hikaricp + 1.0.0-SNAPSHOT + Helidon CDI Extensions Examples DataSource/HikariCP + + + + + jakarta.enterprise + jakarta.enterprise.cdi-api + compile + + + jakarta.ws.rs + jakarta.ws.rs-api + compile + + + redis.clients + jedis + compile + + + org.eclipse.microprofile.config + microprofile-config-api + compile + + + + + com.oracle.database.jdbc + ojdbc8-production + pom + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-hikaricp + runtime + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.server + helidon-microprofile-server + runtime + + + io.helidon.microprofile.config + helidon-microprofile-config + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/cdi/datasource-hikaricp/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java b/examples/integrations/cdi/datasource-hikaricp/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java new file mode 100644 index 00000000..45bd216c --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/TablesResource.java @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2018, 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.integrations.examples.datasource.hikaricp.jaxrs; + +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.Objects; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.inject.Named; +import javax.sql.DataSource; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +/** + * A JAX-RS resource class in {@linkplain ApplicationScoped + * application scope} rooted at {@code /tables}. + * + * @see #get() + */ +@Path("/tables") +@ApplicationScoped +public class TablesResource { + + private final DataSource dataSource; + + /** + * Creates a new {@link TablesResource}. + * + * @param dataSource the {@link DataSource} to use to acquire + * database table names; must not be {@code null} + * + * @exception NullPointerException if {@code dataSource} is {@code + * null} + */ + @Inject + public TablesResource(@Named("example") final DataSource dataSource) { + super(); + this.dataSource = Objects.requireNonNull(dataSource); + } + + /** + * Returns a {@link Response} which, if successful, contains a + * newline-separated list of Oracle database table names. + * + *

This method never returns {@code null}.

+ * + * @return a non-{@code null} {@link Response} + * + * @exception SQLException if a database error occurs + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public Response get() throws SQLException { + final StringBuilder sb = new StringBuilder(); + try (Connection connection = this.dataSource.getConnection(); + PreparedStatement ps = + connection.prepareStatement(" SELECT TABLE_NAME" + + " FROM ALL_TABLES " + + "ORDER BY TABLE_NAME ASC"); + ResultSet rs = ps.executeQuery()) { + while (rs.next()) { + sb.append(rs.getString(1)).append("\n"); + } + } + final Response returnValue = Response.ok() + .entity(sb.toString()) + .build(); + return returnValue; + } + +} diff --git a/examples/integrations/cdi/datasource-hikaricp/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java b/examples/integrations/cdi/datasource-hikaricp/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java new file mode 100644 index 00000000..140b92b6 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/src/main/java/io/helidon/integrations/examples/datasource/hikaricp/jaxrs/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2018, 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. + */ + +/** + * Provides JAX-RS-related classes and interfaces for this example + * project. + */ +package io.helidon.integrations.examples.datasource.hikaricp.jaxrs; diff --git a/examples/integrations/cdi/datasource-hikaricp/src/main/resources/META-INF/beans.xml b/examples/integrations/cdi/datasource-hikaricp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..c757b2b0 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/cdi/datasource-hikaricp/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/cdi/datasource-hikaricp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..1140dcc0 --- /dev/null +++ b/examples/integrations/cdi/datasource-hikaricp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,29 @@ +# +# Copyright (c) 2018, 2021 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. +# + +# Default database properties. +# See +# https://container-registry.oracle.com/pls/apex/f?p=113:4:102624334361221::NO::: +# and +# https://technology.amis.nl/2017/11/18/run-oracle-database-in-docker-using-prebaked-image-from-oracle-container-registry-a-two-minute-guide/ +javax.sql.DataSource.example.dataSourceClassName=oracle.jdbc.pool.OracleDataSource +javax.sql.DataSource.example.dataSource.url = jdbc:oracle:thin:@localhost:1521:ORCL +javax.sql.DataSource.example.dataSource.user = sys as sysoper +javax.sql.DataSource.example.dataSource.password = Oracle + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/integrations/cdi/jedis/.dockerignore b/examples/integrations/cdi/jedis/.dockerignore new file mode 100644 index 00000000..2f7896d1 --- /dev/null +++ b/examples/integrations/cdi/jedis/.dockerignore @@ -0,0 +1 @@ +target/ diff --git a/examples/integrations/cdi/jedis/Dockerfile b/examples/integrations/cdi/jedis/Dockerfile new file mode 100644 index 00000000..8c72ffb2 --- /dev/null +++ b/examples/integrations/cdi/jedis/Dockerfile @@ -0,0 +1,44 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-integrations-cdi-jedis.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD [ "java", "-jar", "helidon-examples-integrations-cdi-jedis.jar" ] + +EXPOSE 8080 diff --git a/examples/integrations/cdi/jedis/README.md b/examples/integrations/cdi/jedis/README.md new file mode 100644 index 00000000..6bfc0509 --- /dev/null +++ b/examples/integrations/cdi/jedis/README.md @@ -0,0 +1,55 @@ +# Jedis Integration Example + +## Start Redis + +```shell +docker run --rm --name redis -d -p 6379:6379 redis +``` + +## Build and run + +With Docker: +```shell +docker build -t helidon-examples-integrations-cdi-jedis . +docker run --rm -d \ + --link redis + --name helidon-examples-integrations-cdi-jedis \ + -p 8080:8080 helidon-examples-integrations-cdi-jedis:latest +``` + +With Java: +```shell +mvn package +java -jar target/helidon-examples-integrations-cdi-jedis.jar +``` + +Try the endpoint: +```shell +curl -X PUT -H "Content-Type: text/plain" http://localhost:8080/jedis/foo -d 'bar' +curl http://localhost:8080/jedis/foo +``` + +## Run with Kubernetes (docker for desktop) + +```shell +docker build -t helidon-examples-integrations-cdi-jedis . +kubectl apply \ + -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/ingress-nginx-3.15.2/deploy/static/provider/cloud/deploy.yaml \ + -f app.yaml +``` + +Try the endpoint: +```shell +curl -X PUT -H "Content-Type: text/plain" http://localhost/helidon-cdi-jedis/jedis/foo -d 'bar' +curl http://localhost/helidon-cdi-jedis/jedis/foo +``` + +Stop the docker containers: +```shell +docker stop redis helidon-examples-integrations-cdi-jedis +``` + +Delete the Kubernetes resources: +```shell +kubectl delete -f app.yaml +``` diff --git a/examples/integrations/cdi/jedis/app.yaml b/examples/integrations/cdi/jedis/app.yaml new file mode 100644 index 00000000..03ac186a --- /dev/null +++ b/examples/integrations/cdi/jedis/app.yaml @@ -0,0 +1,77 @@ +# +# Copyright (c) 2018, 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. +# + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-examples-integrations-cdi-jedis + labels: + app: helidon-examples-integrations-cdi-jedis + version: v1 +spec: + replicas: 1 + template: + metadata: + labels: + app: helidon-examples-integrations-cdi-jedis + spec: + containers: + - name: helidon-examples-integrations-cdi-jedis + image: helidon-examples-integrations-cdi-jedis + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 + env: + - name: redis_clients_jedis_JedisPool_default_host + value: redis + +--- + +kind: Service +apiVersion: v1 +metadata: + name: helidon-examples-integrations-cdi-jedis + labels: + app: helidon-examples-integrations-cdi-jedis +spec: + type: ClusterIP + ports: + - name: http + port: 8080 + selector: + app: helidon-examples-integrations-cdi-jedis + sessionAffinity: None + +--- + +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: helidon-examples-integrations-cdi-jedis + annotations: + nginx.ingress.kubernetes.io/rewrite-target: /$1 +spec: + rules: + - host: localhost + http: + paths: + - path: /helidon-cdi-jedis/(.*) + pathType: Prefix + backend: + service: + name: helidon-examples-integrations-cdi-jedis + port: + number: 8080 diff --git a/examples/integrations/cdi/jedis/pom.xml b/examples/integrations/cdi/jedis/pom.xml new file mode 100644 index 00000000..3041a401 --- /dev/null +++ b/examples/integrations/cdi/jedis/pom.xml @@ -0,0 +1,103 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.cdi + helidon-examples-integrations-cdi-jedis + 1.0.0-SNAPSHOT + Helidon CDI Extensions Examples Jedis + + + + + jakarta.enterprise + jakarta.enterprise.cdi-api + compile + + + jakarta.ws.rs + jakarta.ws.rs-api + compile + + + redis.clients + jedis + compile + + + org.eclipse.microprofile.config + microprofile-config-api + compile + + + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jedis + runtime + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.server + helidon-microprofile-server + runtime + + + io.helidon.microprofile.config + helidon-microprofile-config + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/cdi/jedis/redis.yaml b/examples/integrations/cdi/jedis/redis.yaml new file mode 100644 index 00000000..72dd01e8 --- /dev/null +++ b/examples/integrations/cdi/jedis/redis.yaml @@ -0,0 +1,50 @@ +# +# Copyright (c) 2019, 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: redis +spec: + type: ClusterIP + selector: + app: redis + ports: + - name: tcp + port: 6379 + targetPort: 6379 + +--- + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: redis + labels: + app: redis +spec: + replicas: 1 + template: + metadata: + labels: + app: redis + spec: + containers: + - name: redis + image: redis:5 + imagePullPolicy: IfNotPresent + ports: + - containerPort: 6379 diff --git a/examples/integrations/cdi/jedis/src/main/java/io/helidon/integrations/examples/jedis/jaxrs/RedisClientResource.java b/examples/integrations/cdi/jedis/src/main/java/io/helidon/integrations/examples/jedis/jaxrs/RedisClientResource.java new file mode 100644 index 00000000..7b3379b2 --- /dev/null +++ b/examples/integrations/cdi/jedis/src/main/java/io/helidon/integrations/examples/jedis/jaxrs/RedisClientResource.java @@ -0,0 +1,180 @@ +/* + * Copyright (c) 2018, 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.integrations.examples.jedis.jaxrs; + +import java.util.Objects; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.inject.Provider; +import javax.ws.rs.Consumes; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import javax.ws.rs.core.UriInfo; + +import redis.clients.jedis.Jedis; + +/** + * A JAX-RS resource class rooted at {@code /jedis}. + * + * @see #get(String) + * + * @see #set(UriInfo, String, String) + * + * @see #del(String) + */ +@Path("/jedis") +@ApplicationScoped +public class RedisClientResource { + + private final Provider clientProvider; + + /** + * Creates a new {@link RedisClientResource}. + * + * @param clientProvider a {@link Provider} of a {@link Jedis} + * instance; must not be {@code null} + * + * @exception NullPointerException if {@code clientProvider} is + * {@code null} + */ + @Inject + public RedisClientResource(final Provider clientProvider) { + super(); + this.clientProvider = Objects.requireNonNull(clientProvider); + } + + /** + * Returns a non-{@code null} {@link Response} which, if successful, + * will contain any value indexed under the supplied Redis key. + * + *

This method never returns {@code null}.

+ * + * @param key the key whose value should be deleted; must not be + * {@code null} + * + * @return a non-{@code null} {@link Response} + * + * @see #set(UriInfo, String, String) + * + * @see #del(String) + */ + @GET + @Path("/{key}") + @Produces(MediaType.TEXT_PLAIN) + public Response get(@PathParam("key") final String key) { + final Response returnValue; + if (key == null || key.isEmpty()) { + returnValue = Response.status(400) + .build(); + } else { + final String response = this.clientProvider.get().get(key); + if (response == null) { + returnValue = Response.status(404) + .build(); + } else { + returnValue = Response.ok() + .entity(response) + .build(); + } + } + return returnValue; + } + + /** + * Sets a value under a key in a Redis system. + * + * @param uriInfo a {@link UriInfo} describing the current request; + * must not be {@code null} + * + * @param key the key in question; must not be {@code null} + * + * @param value the value to set; may be {@code null} + * + * @return a non-{@code null} {@link Response} indicating the status + * of the operation + * + * @exception NullPointerException if {@code uriInfo} is {@code + * null} + * + * @see #del(String) + */ + @PUT + @Path("/{key}") + @Consumes(MediaType.TEXT_PLAIN) + public Response set(@Context final UriInfo uriInfo, + @PathParam("key") final String key, + final String value) { + Objects.requireNonNull(uriInfo); + final Response returnValue; + if (key == null || key.isEmpty() || value == null) { + returnValue = Response.status(400) + .build(); + } else { + final Object priorValue = this.clientProvider.get().getSet(key, value); + if (priorValue == null) { + returnValue = Response.created(uriInfo.getRequestUri()) + .build(); + } else { + returnValue = Response.ok() + .build(); + } + } + return returnValue; + } + + /** + * Deletes a value from Redis. + * + * @param key the key identifying the value to delete; must not be + * {@code null} + * + * @return a non-{@code null} {@link Response} describing the result + * of the operation + * + * @see #get(String) + * + * @see #set(UriInfo, String, String) + */ + @DELETE + @Path("/{key}") + @Produces(MediaType.TEXT_PLAIN) + public Response del(@PathParam("key") final String key) { + final Response returnValue; + if (key == null || key.isEmpty()) { + returnValue = Response.status(400) + .build(); + } else { + final Long numberOfKeysDeleted = this.clientProvider.get().del(key); + if (numberOfKeysDeleted == null || numberOfKeysDeleted.longValue() <= 0L) { + returnValue = Response.status(404) + .build(); + } else { + returnValue = Response.noContent() + .build(); + } + } + return returnValue; + } + +} diff --git a/examples/integrations/cdi/jedis/src/main/java/io/helidon/integrations/examples/jedis/jaxrs/package-info.java b/examples/integrations/cdi/jedis/src/main/java/io/helidon/integrations/examples/jedis/jaxrs/package-info.java new file mode 100644 index 00000000..26c222bb --- /dev/null +++ b/examples/integrations/cdi/jedis/src/main/java/io/helidon/integrations/examples/jedis/jaxrs/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2018, 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. + */ + +/** + * Provides JAX-RS-related classes and interfaces for this example + * project. + */ +package io.helidon.integrations.examples.jedis.jaxrs; diff --git a/examples/integrations/cdi/jedis/src/main/resources/META-INF/beans.xml b/examples/integrations/cdi/jedis/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..c757b2b0 --- /dev/null +++ b/examples/integrations/cdi/jedis/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/cdi/jedis/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/cdi/jedis/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..71e89c2f --- /dev/null +++ b/examples/integrations/cdi/jedis/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved. +# +# 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. +# + +# Jedis properties +redis.clients.jedis.JedisPool.default.port=6379 + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/integrations/cdi/jpa/README.md b/examples/integrations/cdi/jpa/README.md new file mode 100644 index 00000000..5a202ed5 --- /dev/null +++ b/examples/integrations/cdi/jpa/README.md @@ -0,0 +1,13 @@ +# JPA Integration Example + +With Java: +```shell +mvn package +java -jar target/helidon-integrations-examples-jpa.jar +``` + +Try the endpoint: +```shell +curl -X POST -H "Content-Type: text/plain" http://localhost:8080/foo -d 'bar' +curl http://localhost:8080/foo +``` diff --git a/examples/integrations/cdi/jpa/pom.xml b/examples/integrations/cdi/jpa/pom.xml new file mode 100644 index 00000000..ef27bc7e --- /dev/null +++ b/examples/integrations/cdi/jpa/pom.xml @@ -0,0 +1,172 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.cdi + helidon-integrations-examples-jpa + 1.0.0-SNAPSHOT + Helidon CDI Extensions Examples JPA + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + com.h2database + h2 + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-eclipselink + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jta-weld + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-hikaricp + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jpa + runtime + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.server + helidon-microprofile-server + runtime + + + io.helidon.microprofile.config + helidon-microprofile-config + runtime + + + org.eclipse.microprofile.config + microprofile-config-api + runtime + + + + + + jakarta.annotation + jakarta.annotation-api + compile + + + jakarta.enterprise + jakarta.enterprise.cdi-api + compile + + + jakarta.inject + jakarta.inject-api + compile + + + jakarta.ws.rs + jakarta.ws.rs-api + compile + + + jakarta.persistence + jakarta.persistence-api + compile + + + jakarta.transaction + jakarta.transaction-api + compile + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + com.ethlo.persistence.tools + eclipselink-maven-plugin + + + weave + process-classes + + weave + + + + modelgen + generate-sources + + modelgen + + + + + + + diff --git a/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/Greeting.java b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/Greeting.java new file mode 100644 index 00000000..71cf1ace --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/Greeting.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2019, 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.integrations.cdi.jpa; + +import java.util.Objects; + +import javax.persistence.Access; +import javax.persistence.AccessType; +import javax.persistence.Basic; +import javax.persistence.Column; +import javax.persistence.Entity; +import javax.persistence.Id; +import javax.persistence.Table; + +/** + * A contrived representation for example purposes only of a two-part + * greeting as might be stored in a database. + */ +@Access(AccessType.FIELD) +@Entity(name = "Greeting") +@Table(name = "GREETING") +public class Greeting { + + @Id + @Column(name = "FIRSTPART", insertable = true, nullable = false, updatable = false) + private String firstPart; + + @Basic(optional = false) + @Column(name = "SECONDPART", insertable = true, nullable = false, updatable = true) + private String secondPart; + + /** + * Creates a new {@link Greeting}; required by the JPA + * specification and for no other purpose. + * + * @deprecated Please use the {@link #Greeting(String, + * String)} constructor instead. + * + * @see #Greeting(String, String) + */ + @Deprecated + protected Greeting() { + super(); + } + + /** + * Creates a new {@link Greeting}. + * + * @param firstPart the first part of the greeting; must not be + * {@code null} + * + * @param secondPart the second part of the greeting; must not be + * {@code null} + * + * @exception NullPointerException if {@code firstPart} or {@code + * secondPart} is {@code null} + */ + public Greeting(final String firstPart, final String secondPart) { + super(); + this.firstPart = Objects.requireNonNull(firstPart); + this.secondPart = Objects.requireNonNull(secondPart); + } + + /** + * Sets the second part of this greeting. + * + * @param secondPart the second part of this greeting; must not be + * {@code null} + * + * @exception NullPointerException if {@code secondPart} is {@code + * null} + */ + public void setSecondPart(final String secondPart) { + this.secondPart = Objects.requireNonNull(secondPart); + } + + /** + * Returns a {@link String} representation of the second part of + * this {@link Greeting}. + * + *

This method never returns {@code null}.

+ * + * @return a non-{@code null} {@link String} representation of the + * second part of this {@link Greeting} + */ + @Override + public String toString() { + return this.secondPart; + } + +} diff --git a/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/HelloWorldApplication.java b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/HelloWorldApplication.java new file mode 100644 index 00000000..d82d0ba1 --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/HelloWorldApplication.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2019, 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.integrations.cdi.jpa; + +import java.util.Collections; +import java.util.HashSet; +import java.util.Set; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.core.Application; + +/** + * An example {@link Application} demonstrating the modular + * integration of JPA and JTA with Helidon MicroProfile. + */ +@ApplicationScoped +public class HelloWorldApplication extends Application { + + private final Set> classes; + + /** + * Creates a new {@link HelloWorldApplication}. + */ + public HelloWorldApplication() { + super(); + final Set> classes = new HashSet<>(); + classes.add(HelloWorldResource.class); + classes.add(JPAExceptionMapper.class); + this.classes = Collections.unmodifiableSet(classes); + } + + /** + * Returns a non-{@code null} {@link Set} of {@link Class}es that + * comprise this JAX-RS application. + * + * @return a non-{@code null}, {@linkplain + * Collections#unmodifiableSet(Set) unmodifiable Set} + * + * @see HelloWorldResource + */ + @Override + public Set> getClasses() { + return this.classes; + } + +} diff --git a/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/HelloWorldResource.java b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/HelloWorldResource.java new file mode 100644 index 00000000..9e26af3c --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/HelloWorldResource.java @@ -0,0 +1,171 @@ +/* + * Copyright (c) 2019, 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.integrations.cdi.jpa; + +import java.net.URI; +import java.util.Objects; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; +import javax.persistence.PersistenceException; +import javax.transaction.Status; +import javax.transaction.SystemException; +import javax.transaction.Transaction; +import javax.transaction.Transactional; +import javax.transaction.Transactional.TxType; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +/** + * A JAX-RS root resource class that manipulates greetings in a + * database. + * + * @see #get(String) + * + * @see #post(String, String) + */ +@Path("") +@RequestScoped +public class HelloWorldResource { + + /** + * The {@link EntityManager} used by this class. + * + *

Note that it behaves as though there is a transaction manager + * in effect, because there is.

+ */ + @PersistenceContext(unitName = "test") + private EntityManager entityManager; + + /** + * A {@link Transaction} that is guaranteed to be non-{@code null} + * only when a transactional method is executing. + * + * @see #post(String, String) + */ + @Inject + private Transaction transaction; + + /** + * Creates a new {@link HelloWorldResource}. + */ + public HelloWorldResource() { + super(); + } + + /** + * Returns a {@link Response} with a status of {@code 404} when + * invoked. + * + * @return a non-{@code null} {@link Response} + */ + @GET + @Path("favicon.ico") + public Response getFavicon() { + return Response.status(404).build(); + } + + /** + * When handed a {@link String} like, say, "{@code hello}", responds + * with the second part of the composite greeting as found via an + * {@link EntityManager}. + * + * @param firstPart the first part of the greeting; must not be + * {@code null} + * + * @return the second part of the greeting; never {@code null} + * + * @exception NullPointerException if {@code firstPart} was {@code + * null} + * + * @exception PersistenceException if the {@link EntityManager} + * encountered an error + */ + @GET + @Path("{firstPart}") + @Produces(MediaType.TEXT_PLAIN) + public String get(@PathParam("firstPart") final String firstPart) { + Objects.requireNonNull(firstPart); + assert this.entityManager != null; + final Greeting greeting = this.entityManager.find(Greeting.class, firstPart); + assert greeting != null; + return greeting.toString(); + } + + /** + * When handed two parts of a greeting, like, say, "{@code hello}" + * and "{@code world}", stores a new {@link Greeting} entity in the + * database appropriately. + * + * @param firstPart the first part of the greeting; must not be + * {@code null} + * + * @param secondPart the second part of the greeting; must not be + * {@code null} + * + * @return the {@link String} representation of the resulting {@link + * Greeting}'s identifier; never {@code null} + * + * @exception NullPointerException if {@code firstPart} or {@code + * secondPart} was {@code null} + * + * @exception PersistenceException if the {@link EntityManager} + * encountered an error + * + * @exception SystemException if something went wrong with the + * transaction + */ + @POST + @Path("{firstPart}") + @Consumes(MediaType.TEXT_PLAIN) + @Produces(MediaType.TEXT_PLAIN) + @Transactional(TxType.REQUIRED) + public Response post(@PathParam("firstPart") final String firstPart, + final String secondPart) + throws SystemException { + Objects.requireNonNull(firstPart); + Objects.requireNonNull(secondPart); + assert this.transaction != null; + assert this.transaction.getStatus() == Status.STATUS_ACTIVE; + assert this.entityManager != null; + assert this.entityManager.isJoinedToTransaction(); + Greeting greeting = this.entityManager.find(Greeting.class, firstPart); + final boolean created; + if (greeting == null) { + greeting = new Greeting(firstPart, secondPart); + this.entityManager.persist(greeting); + created = true; + } else { + greeting.setSecondPart(secondPart); + created = false; + } + assert this.entityManager.contains(greeting); + if (created) { + return Response.created(URI.create(firstPart)).build(); + } else { + return Response.ok(firstPart).build(); + } + } + +} diff --git a/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/JPAExceptionMapper.java b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/JPAExceptionMapper.java new file mode 100644 index 00000000..92a3c9f7 --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/JPAExceptionMapper.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2019, 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.integrations.cdi.jpa; + +import javax.enterprise.context.ApplicationScoped; +import javax.persistence.EntityNotFoundException; +import javax.persistence.NoResultException; +import javax.persistence.PersistenceException; +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; +import javax.ws.rs.ext.Provider; + +/** + * An {@link ExceptionMapper} that handles {@link + * PersistenceException}s. + * + * @see ExceptionMapper + */ +@ApplicationScoped +@Provider +public class JPAExceptionMapper implements ExceptionMapper { + + /** + * Creates a new {@link JPAExceptionMapper}. + */ + public JPAExceptionMapper() { + super(); + } + + /** + * Returns an appropriate non-{@code null} {@link Response} for the + * supplied {@link PersistenceException}. + * + * @param persistenceException the {@link PersistenceException} that + * caused this {@link JPAExceptionMapper} to be invoked; may be + * {@code null} + * + * @return a non-{@code null} {@link Response} representing the + * error + */ + @Override + public Response toResponse(final PersistenceException persistenceException) { + final Response returnValue; + if (persistenceException instanceof NoResultException + || persistenceException instanceof EntityNotFoundException) { + returnValue = Response.status(404).build(); + } else { + returnValue = null; + throw persistenceException; + } + return returnValue; + } + +} diff --git a/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/package-info.java b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/package-info.java new file mode 100644 index 00000000..7c80b84a --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/java/io/helidon/examples/integrations/cdi/jpa/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Provides classes and interfaces demonstrating the usage of JPA and + * JTA integration within Helidon MicroProfile. + */ +package io.helidon.examples.integrations.cdi.jpa; diff --git a/examples/integrations/cdi/jpa/src/main/resources/META-INF/beans.xml b/examples/integrations/cdi/jpa/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..190c6e0e --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + diff --git a/examples/integrations/cdi/jpa/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/cdi/jpa/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..2bcf9829 --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,23 @@ +# +# Copyright (c) 2019, 2021 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. +# +javax.sql.DataSource.test.dataSourceClassName=org.h2.jdbcx.JdbcDataSource +javax.sql.DataSource.test.dataSource.url=jdbc:h2:mem:test;INIT=CREATE TABLE IF NOT EXISTS GREETING (FIRSTPART VARCHAR NOT NULL, SECONDPART VARCHAR NOT NULL, PRIMARY KEY (FIRSTPART))\\;MERGE INTO GREETING (FIRSTPART, SECONDPART) VALUES ('hello', 'world') +javax.sql.DataSource.test.dataSource.user=sa +javax.sql.DataSource.test.dataSource.password= + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/integrations/cdi/jpa/src/main/resources/META-INF/persistence.xml b/examples/integrations/cdi/jpa/src/main/resources/META-INF/persistence.xml new file mode 100644 index 00000000..d8318e9f --- /dev/null +++ b/examples/integrations/cdi/jpa/src/main/resources/META-INF/persistence.xml @@ -0,0 +1,52 @@ + + + + + test + io.helidon.examples.integrations.cdi.jpa.Greeting + + + + + + + + + + + + + + + + + + + diff --git a/examples/integrations/cdi/oci-objectstorage/.dockerignore b/examples/integrations/cdi/oci-objectstorage/.dockerignore new file mode 100644 index 00000000..2f7896d1 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/.dockerignore @@ -0,0 +1 @@ +target/ diff --git a/examples/integrations/cdi/oci-objectstorage/.gitignore b/examples/integrations/cdi/oci-objectstorage/.gitignore new file mode 100644 index 00000000..31942ca4 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/.gitignore @@ -0,0 +1,3 @@ +oci-env +logging.properties + diff --git a/examples/integrations/cdi/oci-objectstorage/Dockerfile b/examples/integrations/cdi/oci-objectstorage/Dockerfile new file mode 100644 index 00000000..c67c2f77 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/Dockerfile @@ -0,0 +1,52 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-integrations-cdi-oci-objectstorage.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD [ "sh", "-c", "exec java \ + -Doci.auth.fingerprint=\"${OCI_AUTH_FINGERPRINT}\" \ + -Doci.auth.passphraseCharacters=\"${OCI_AUTH_PASSPHRASE}\" \ + -Doci.auth.privateKey=\"${OCI_AUTH_PRIVATEKEY}\" \ + -Doci.auth.tenancy=\"${OCI_AUTH_TENANCY}\" \ + -Doci.auth.user=\"${OCI_AUTH_USER}\" \ + -Doci.objectstorage.compartmentId=\"${OCI_OBJECTSTORAGE_COMPARTMENT}\" \ + -Doci.objectstorage.region=\"${OCI_OBJECTSTORAGE_REGION}\" \ + -jar helidon-examples-integrations-cdi-oci-objectstorage.jar" ] + +EXPOSE 8080 diff --git a/examples/integrations/cdi/oci-objectstorage/README.md b/examples/integrations/cdi/oci-objectstorage/README.md new file mode 100644 index 00000000..a329eba0 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/README.md @@ -0,0 +1,75 @@ +# OCI Object Storage CDI Integration Example + +## OCI setup + +Setup your OCI SDK [configuration](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm) + if you haven't done so already, and then run the following command: +```shell +./oci-setup.sh && source oci-env +``` + +This example requires an Object Storage, you can create one using the + [OCI console](https://console.us-phoenix-1.oraclecloud.com). Once created, + upload a file in order to exercise the example. + +## Build and run + +With Docker: +```shell +docker build -t helidon-examples-integrations-cdi-oci-objectstorage . +docker run --rm -d -p 8080:8080 \ + -e OCI_AUTH_PRIVATEKEY \ + -e OCI_AUTH_FINGERPRINT \ + -e OCI_AUTH_PASSPHRASE \ + -e OCI_AUTH_TENANCY \ + -e OCI_AUTH_USER \ + -e OCI_OBJECTSTORAGE_COMPARTMENT \ + -e OCI_OBJECTSTORAGE_REGION \ + --name helidon-examples-integrations-cdi-oci-objectstorage \ + helidon-examples-integrations-cdi-oci-objectstorage:latest +``` + +With Java: +```shell +mvn package +java -Doci.auth.fingerprint="${OCI_AUTH_FINGERPRINT}" \ + -Doci.auth.passphraseCharacters="${OCI_AUTH_PASSPHRASE}" \ + -Doci.auth.privateKey="${OCI_AUTH_PRIVATEKEY}" \ + -Doci.auth.tenancy="${OCI_AUTH_TENANCY}" \ + -Doci.auth.user="${OCI_AUTH_USER}" \ + -Doci.objectstorage.compartmentId="${OCI_OBJECTSTORAGE_COMPARTMENT}" \ + -Doci.objectstorage.region="${OCI_OBJECTSTORAGE_REGION}" \ + -jar target/helidon-examples-integrations-cdi-oci-objectstorage.jar +``` + +Try the endpoint: + +```shell +curl http://localhost:8080/logo/{namespaceName}/{bucketName}/{objectName} +``` + +## Run With Kubernetes (docker for desktop) + +```shell +docker build -t helidon-examples-integrations-cdi-oci-objectstorage . +./oci-setup.sh -k8s +kubectl apply \ + -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/ingress-nginx-3.15.2/deploy/static/provider/cloud/deploy.yaml \ + -f app.yaml +``` + +Try the endpoint: + +```shell +curl http://localhost/oci-objectstorage/logo/{namespaceName}/{bucketName}/{objectName} +``` + +Stop the docker containers: +```shell +docker stop helidon-examples-integrations-cdi-oci-objectstorage +``` + +Delete the Kubernetes resources: +```shell +kubectl -f app.yaml +``` diff --git a/examples/integrations/cdi/oci-objectstorage/app.yaml b/examples/integrations/cdi/oci-objectstorage/app.yaml new file mode 100644 index 00000000..d99de4ab --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/app.yaml @@ -0,0 +1,107 @@ +# +# Copyright (c) 2018, 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. +# + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-examples-integrations-cdi-oci-objectstorage +spec: + replicas: 1 + template: + metadata: + labels: + app: helidon-examples-integrations-cdi-oci-objectstorage + spec: + containers: + - name: helidon-examples-integrations-cdi-oci-objectstorage + image: helidon-examples-integrations-cdi-oci-objectstorage + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 + env: + - name: OCI_AUTH_FINGERPRINT + valueFrom: + secretKeyRef: + key: OCI_AUTH_FINGERPRINT + name: oci-objectstorage-secret + - name: OCI_AUTH_PASSPHRASE + valueFrom: + secretKeyRef: + key: OCI_AUTH_PASSPHRASE + name: oci-objectstorage-secret + - name: OCI_AUTH_PRIVATEKEY + valueFrom: + secretKeyRef: + key: OCI_AUTH_PRIVATEKEY + name: oci-objectstorage-secret + - name: OCI_AUTH_TENANCY + valueFrom: + secretKeyRef: + key: OCI_AUTH_TENANCY + name: oci-objectstorage-secret + - name: OCI_AUTH_USER + valueFrom: + secretKeyRef: + key: OCI_AUTH_USER + name: oci-objectstorage-secret + - name: OCI_OBJECTSTORAGE_COMPARTMENT + valueFrom: + secretKeyRef: + key: OCI_OBJECTSTORAGE_COMPARTMENT + name: oci-objectstorage-secret + - name: OCI_OBJECTSTORAGE_REGION + valueFrom: + secretKeyRef: + key: OCI_OBJECTSTORAGE_REGION + name: oci-objectstorage-secret + +--- + +kind: Service +apiVersion: v1 +metadata: + name: helidon-examples-integrations-cdi-oci-objectstorage + labels: + app: helidon-examples-integrations-cdi-oci-objectstorage +spec: + type: ClusterIP + ports: + - name: http + port: 8080 + selector: + app: helidon-examples-integrations-cdi-oci-objectstorage + sessionAffinity: None + +--- + +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: helidon-examples-integrations-cdi-oci-objectstorage + annotations: + nginx.ingress.kubernetes.io/rewrite-target: /$1 +spec: + rules: + - host: localhost + http: + paths: + - path: /oci-objectstorage/(.*) + pathType: Prefix + backend: + service: + name: helidon-examples-integrations-cdi-oci-objectstorage + port: + number: 8080 diff --git a/examples/integrations/cdi/oci-objectstorage/oci-setup.sh b/examples/integrations/cdi/oci-objectstorage/oci-setup.sh new file mode 100755 index 00000000..b8ffe049 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/oci-setup.sh @@ -0,0 +1,97 @@ +#!/bin/sh +# +# Copyright (c) 2019, 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. + +readonly OCI_SECRET_FILE=$(dirname ${0})/oci-env + +if [ ! -f ${OCI_SECRET_FILE} ] ; then + if [ -f ${HOME}/.oci/config ] ; then + echo "Found ${HOME}/.oci/config" + eval $(cat ~/.oci/config | sed -n '/\[ADMIN_USER\]/q;p' | sed '1d' | sed -E s@'^(.*)=(.*)$'@'oci_\1=\2'@g) + fi + + if [ -z "${oci_user}" ] ; then + read -p "User OCID: " oci_user + fi + if [ -z "${oci_user}" ] ; then + echo "ERROR: user OCID is empty" + fi + + if [ -z "${oci_key_file}" ] ; then + read -p "Private key location: " oci_key_file + fi + if [ -z "${oci_key_file}" ] || [ ! -f ${oci_key_file} ] ; then + echo "ERROR: Private key is not a valid file" + fi + + if [ -z "${oci_pass_phrase}" ] ; then + read -p "Private key passphrase: " oci_pass_phrase + fi + + if [ -z "${oci_fingerprint}" ] ; then + read -p "Public key fingerprint: " oci_fingerprint + fi + if [ -z "${oci_fingerprint}" ] ; then + echo "ERROR: Public key is empty" + fi + + if [ -z "${oci_tenancy}" ] ; then + read -p "Tenancy OCID: " oci_tenancy + fi + if [ -z "${oci_tenancy}" ] ; then + echo "ERROR: Tenancy OCID is empty" + fi + + if [ -z "${oci_region}" ] ; then + read -p "Region: " oci_region + fi + if [ -z "${oci_region}" ] ; then + echo "ERROR: Region is empty" + fi + + if [ -z "${oci_compartment}" ] ; then + read -p "Compartment OCID: " oci_compartment + fi + if [ -z "${oci_compartment}" ] ; then + echo "ERROR: Compartment OCID is empty" + fi + + readonly OCI_AUTH_PRIVATEKEY="$(cat ~/.oci/oci_api_key.pem)" + readonly OCI_AUTH_FINGERPRINT="${oci_fingerprint}" + readonly OCI_AUTH_PASSPHRASE="${oci_passphrase}" + readonly OCI_AUTH_TENANCY="${oci_tenancy}" + readonly OCI_AUTH_USER="${oci_user}" + readonly OCI_OBJECTSTORAGE_COMPARTMENT="${oci_compartment}" + readonly OCI_OBJECTSTORAGE_REGION="${oci_region}" + + echo "export OCI_AUTH_PRIVATEKEY=\"${OCI_AUTH_PRIVATEKEY}\"" > ${OCI_SECRET_FILE} + echo "export OCI_AUTH_FINGERPRINT=\"${OCI_AUTH_FINGERPRINT}\"" >> ${OCI_SECRET_FILE} + echo "export OCI_AUTH_PASSPHRASE=\"${OCI_AUTH_PASSPHRASE}\"" >> ${OCI_SECRET_FILE} + echo "export OCI_AUTH_TENANCY=\"${OCI_AUTH_TENANCY}\"" >> ${OCI_SECRET_FILE} + echo "export OCI_AUTH_USER=\"${OCI_AUTH_USER}\"" >> ${OCI_SECRET_FILE} + echo "export OCI_OBJECTSTORAGE_COMPARTMENT=\"${OCI_OBJECTSTORAGE_COMPARTMENT}\"" >> ${OCI_SECRET_FILE} + echo "export OCI_OBJECTSTORAGE_REGION=\"${OCI_OBJECTSTORAGE_REGION}\"" >> ${OCI_SECRET_FILE} +fi + +if [ "${1}" = "-k8s" ] ; then + kubectl create secret generic oci-objectstorage-secret \ + --from-literal=OCI_AUTH_FINGERPRINT="${OCI_AUTH_FINGERPRINT}" \ + --from-literal=OCI_AUTH_PASSPHRASE="${OCI_AUTH_PASSPHRASE}" \ + --from-literal=OCI_AUTH_PRIVATEKEY="${OCI_AUTH_PRIVATEKEY}" \ + --from-literal=OCI_AUTH_TENANCY="${OCI_AUTH_TENANCY}" \ + --from-literal=OCI_AUTH_USER="${OCI_AUTH_USER}" \ + --from-literal=OCI_OBJECTSTORAGE_COMPARTMENT="${OCI_OBJECTSTORAGE_COMPARTMENT}" \ + --from-literal=OCI_OBJECTSTORAGE_REGION="${OCI_OBJECTSTORAGE_REGION}" +fi \ No newline at end of file diff --git a/examples/integrations/cdi/oci-objectstorage/pom.xml b/examples/integrations/cdi/oci-objectstorage/pom.xml new file mode 100644 index 00000000..873d0e60 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/pom.xml @@ -0,0 +1,108 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.cdi + helidon-examples-integrations-cdi-oci-objectstorage + 1.0.0-SNAPSHOT + Helidon CDI Extensions Examples OCI ObjectStorage + + + + + jakarta.enterprise + jakarta.enterprise.cdi-api + compile + + + com.oracle.oci.sdk + oci-java-sdk-objectstorage + compile + + + jakarta.ws.rs + jakarta.ws.rs-api + compile + + + org.eclipse.microprofile.config + microprofile-config-api + compile + + + + + io.helidon.integrations.oci.sdk + helidon-integrations-oci-sdk-cdi + runtime + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.server + helidon-microprofile-server + runtime + + + io.helidon.microprofile.config + helidon-microprofile-config + runtime + + + org.slf4j + slf4j-jdk14 + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/java/io/helidon/integrations/examples/oci/objectstorage/jaxrs/HelidonLogoResource.java b/examples/integrations/cdi/oci-objectstorage/src/main/java/io/helidon/integrations/examples/oci/objectstorage/jaxrs/HelidonLogoResource.java new file mode 100644 index 00000000..d4de8e62 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/java/io/helidon/integrations/examples/oci/objectstorage/jaxrs/HelidonLogoResource.java @@ -0,0 +1,127 @@ +/* + * Copyright (c) 2018, 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.integrations.examples.oci.objectstorage.jaxrs; + +import java.util.Objects; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import com.oracle.bmc.model.BmcException; +import com.oracle.bmc.objectstorage.ObjectStorage; +import com.oracle.bmc.objectstorage.requests.GetObjectRequest; +import com.oracle.bmc.objectstorage.responses.GetObjectResponse; +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * A JAX-RS resource class rooted at {@code /logo}. + * + * @see #getLogo(String, String, String) + */ +@Path("/logo") +@ApplicationScoped +public class HelidonLogoResource { + + private final ObjectStorage client; + + private final String namespaceName; + + /** + * Creates a new {@link HelidonLogoResource}. + * + * @param client an {@link ObjectStorage} client; must not be {@code + * null} + * + * @param namespaceName the name of an OCI object storage namespace that will be used; must not be {@code null} + * + * @exception NullPointerException if either parameter is {@code + * null} + */ + @Inject + public HelidonLogoResource(final ObjectStorage client, + @ConfigProperty(name = "oci.objectstorage.namespace") final String namespaceName) { + super(); + this.client = Objects.requireNonNull(client); + this.namespaceName = Objects.requireNonNull(namespaceName); + } + + /** + * Returns a non-{@code null} {@link Response} which, if successful, will contain the object stored under the supplied {@code + * namespaceName}, {@code bucketName} and {@code objectName}. + * + * @param namespaceName the OCI object storage namespace to use; must not be {@code null} + * + * @param bucketName the OCI object storage bucket name to use; must not be {@code null} + * + * @param objectName the OCI object storage object name to use; must not be {@code null} + * + * @return a non-{@code null} {@link Response} describing the operation + * + * @exception NullPointerException if any of the parameters is {@code null} + */ + @GET + @Path("/{namespaceName}/{bucketName}/{objectName}") + @Produces(MediaType.WILDCARD) + public Response getLogo(@PathParam("namespaceName") String namespaceName, + @PathParam("bucketName") final String bucketName, + @PathParam("objectName") final String objectName) { + final Response returnValue; + if (bucketName == null || bucketName.isEmpty() || objectName == null || objectName.isEmpty()) { + returnValue = Response.status(400) + .build(); + } else { + if (namespaceName == null || namespaceName.isEmpty()) { + namespaceName = this.namespaceName; + } + Response temp = null; + try { + final GetObjectRequest request = GetObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .objectName(objectName) + .build(); + assert request != null; + final GetObjectResponse response = this.client.getObject(request); + assert response != null; + final Long contentLength = response.getContentLength(); + assert contentLength != null; + if (contentLength <= 0L) { + temp = Response.noContent() + .build(); + } else { + temp = Response.ok() + .type(response.getContentType()) + .entity(response.getInputStream()) + .build(); + } + } catch (final BmcException bmcException) { + final int statusCode = bmcException.getStatusCode(); + temp = Response.status(statusCode) + .build(); + } finally { + returnValue = temp; + } + } + return returnValue; + } + +} diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/java/io/helidon/integrations/examples/oci/objectstorage/jaxrs/package-info.java b/examples/integrations/cdi/oci-objectstorage/src/main/java/io/helidon/integrations/examples/oci/objectstorage/jaxrs/package-info.java new file mode 100644 index 00000000..2622e7e9 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/java/io/helidon/integrations/examples/oci/objectstorage/jaxrs/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2018, 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. + */ + +/** + * Provides JAX-RS-related classes and interfaces for this example + * project. + */ +package io.helidon.integrations.examples.oci.objectstorage.jaxrs; diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/beans.xml b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..c757b2b0 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..254b9341 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved. +# +# 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. +# + +oci.objectstorage.namespace=${oci.objectstorage.namespaceName} + + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/com.fasterxml.jackson.module/jackson-module-jaxb-annotations/reflect-config.json b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/com.fasterxml.jackson.module/jackson-module-jaxb-annotations/reflect-config.json new file mode 100644 index 00000000..8c7bac58 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/com.fasterxml.jackson.module/jackson-module-jaxb-annotations/reflect-config.json @@ -0,0 +1,8 @@ +[ + { + "name": "com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector", + "methods": [ + { "name": "", "parameterTypes": [] } + ] + } +] diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/com.oracle.oci.sdk/oci-java-sdk-common/native-image.properties b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/com.oracle.oci.sdk/oci-java-sdk-common/native-image.properties new file mode 100644 index 00000000..55f78302 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/com.oracle.oci.sdk/oci-java-sdk-common/native-image.properties @@ -0,0 +1,17 @@ +# +# Copyright (c) 2022, 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. +# +Args=\ +--initialize-at-run-time=com.oracle.bmc.auth.AbstractFederationClientAuthenticationDetailsProviderBuilder$SessionKeySupplierImpl diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/commons-logging/commons-logging/reflect-config.json b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/commons-logging/commons-logging/reflect-config.json new file mode 100644 index 00000000..ab7ae619 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/commons-logging/commons-logging/reflect-config.json @@ -0,0 +1,26 @@ +[ + { + "name": "org.apache.commons.logging.impl.Jdk14Logger", + "methods": [ + { "name": "", "parameterTypes": [ "java.lang.String" ] } + ] + }, + { + "name": "org.apache.commons.logging.impl.LogFactoryImpl", + "methods": [ + { "name": "", "parameterTypes": [] } + ] + }, + { + "name": "org.apache.commons.logging.impl.NoOpLog", + "methods": [ + { "name": "", "parameterTypes": [ "java.lang.String" ] } + ] + }, + { + "name": "org.apache.commons.logging.impl.SimpleLog", + "methods": [ + { "name": "", "parameterTypes": [ "java.lang.String" ] } + ] + } +] diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/org.apache.httpcomponents/httpclient/native-image.properties b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/org.apache.httpcomponents/httpclient/native-image.properties new file mode 100644 index 00000000..2230a312 --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/resources/META-INF/native-image/org.apache.httpcomponents/httpclient/native-image.properties @@ -0,0 +1,17 @@ +# +# Copyright (c) 2022, 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. +# +Args=\ +--initialize-at-run-time=org.apache.http.impl.auth.NTLMEngineImpl diff --git a/examples/integrations/cdi/oci-objectstorage/src/main/resources/commons-logging.properties b/examples/integrations/cdi/oci-objectstorage/src/main/resources/commons-logging.properties new file mode 100644 index 00000000..1b3e18ff --- /dev/null +++ b/examples/integrations/cdi/oci-objectstorage/src/main/resources/commons-logging.properties @@ -0,0 +1,16 @@ +# +# Copyright (c) 2022, 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. +# +org.apache.commons.logging.Log=org.apache.commons.logging.impl.Jdk14Logger diff --git a/examples/integrations/cdi/pokemons/README.md b/examples/integrations/cdi/pokemons/README.md new file mode 100644 index 00000000..bafcec30 --- /dev/null +++ b/examples/integrations/cdi/pokemons/README.md @@ -0,0 +1,23 @@ +# JPA Pokemons Example + +With Java: +```shell +mvn package +java -jar target/helidon-integrations-examples-pokemons.jar +``` + +## Exercise the application + +```bash +curl -X GET http://localhost:8080/pokemon +#Output: [{"id":1,"type":12,"name":"Bulbasaur"}, ...] + +curl -X GET http://localhost:8080/type +#Output: [{"id":1,"name":"Normal"}, ...] + +curl -H "Content-Type: application/json" --request POST --data '{"id":100, "type":1, "name":"Test"}' http://localhost:8080/pokemon +``` + +--- + +Pokémon, and Pokémon character names are trademarks of Nintendo. diff --git a/examples/integrations/cdi/pokemons/pom.xml b/examples/integrations/cdi/pokemons/pom.xml new file mode 100644 index 00000000..01f15f00 --- /dev/null +++ b/examples/integrations/cdi/pokemons/pom.xml @@ -0,0 +1,184 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.cdi + helidon-integrations-examples-pokemons + 1.0.0-SNAPSHOT + Helidon CDI Extensions Examples Pokemons JPA + + + + + jakarta.annotation + jakarta.annotation-api + + + jakarta.enterprise + jakarta.enterprise.cdi-api + + + jakarta.inject + jakarta.inject-api + + + jakarta.ws.rs + jakarta.ws.rs-api + + + jakarta.json.bind + jakarta.json.bind-api + + + jakarta.persistence + jakarta.persistence-api + + + jakarta.transaction + jakarta.transaction-api + + + + + com.h2database + h2 + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-hibernate + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jta-weld + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-hikaricp + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jpa + runtime + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.server + helidon-microprofile-server + runtime + + + org.glassfish.jersey.media + jersey-media-json-binding + runtime + + + io.helidon.microprofile.config + helidon-microprofile-config + runtime + + + org.eclipse.microprofile.config + microprofile-config-api + runtime + + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + org.hibernate.orm.tooling + hibernate-enhance-maven-plugin + + + + true + true + true + + + enhance + + + + + + com.ethlo.persistence.tools + eclipselink-maven-plugin + + + modelgen + generate-sources + + modelgen + + + + + + + diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/Pokemon.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/Pokemon.java new file mode 100644 index 00000000..3efd4e2f --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/Pokemon.java @@ -0,0 +1,109 @@ +/* + * Copyright (c) 2020, 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.integrations.cdi.pokemon; + +import javax.json.bind.annotation.JsonbTransient; +import javax.persistence.Access; +import javax.persistence.AccessType; +import javax.persistence.Basic; +import javax.persistence.Column; +import javax.persistence.Entity; +import javax.persistence.Id; +import javax.persistence.ManyToOne; +import javax.persistence.NamedQueries; +import javax.persistence.NamedQuery; +import javax.persistence.Table; +import javax.persistence.Transient; + +/** + * A Pokemon entity class. A Pokemon is represented as a triple of an + * ID, a name and a type. + */ +@Entity(name = "Pokemon") +@Table(name = "POKEMON") +@Access(AccessType.PROPERTY) +@NamedQueries({ + @NamedQuery(name = "getPokemons", + query = "SELECT p FROM Pokemon p"), + @NamedQuery(name = "getPokemonByName", + query = "SELECT p FROM Pokemon p WHERE p.name = :name") +}) +public class Pokemon { + + private int id; + + private String name; + + @JsonbTransient + private PokemonType pokemonType; + + private int type; + + /** + * Creates a new pokemon. + */ + public Pokemon() { + } + + @Id + @Column(name = "ID", nullable = false, updatable = false) + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + @Basic(optional = false) + @Column(name = "NAME", nullable = false) + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + /** + * Returns pokemon's type. + * + * @return Pokemon's type. + */ + @ManyToOne + public PokemonType getPokemonType() { + return pokemonType; + } + + /** + * Sets pokemon's type. + * + * @param pokemonType Pokemon's type. + */ + public void setPokemonType(PokemonType pokemonType) { + this.pokemonType = pokemonType; + this.type = pokemonType.getId(); + } + + @Transient + public int getType() { + return type; + } + + public void setType(int type) { + this.type = type; + } +} diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonResource.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonResource.java new file mode 100644 index 00000000..a25a1e60 --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonResource.java @@ -0,0 +1,133 @@ +/* + * Copyright (c) 2020, 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.integrations.cdi.pokemon; + +import java.util.List; + +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; +import javax.persistence.TypedQuery; +import javax.transaction.Transactional; +import javax.ws.rs.BadRequestException; +import javax.ws.rs.Consumes; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.NotFoundException; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +/** + * This class implements REST endpoints to interact with Pokemons. The following + * operations are supported: + * + * GET /pokemon: Retrieve list of all pokemons + * GET /pokemon/{id}: Retrieve single pokemon by ID + * GET /pokemon/name/{name}: Retrieve single pokemon by name + * DELETE /pokemon/{id}: Delete a pokemon by ID + * POST /pokemon: Create a new pokemon + */ +@Path("pokemon") +public class PokemonResource { + + @PersistenceContext(unitName = "test") + private EntityManager entityManager; + + /** + * Retrieves list of all pokemons. + * + * @return List of pokemons. + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public List getPokemons() { + return entityManager.createNamedQuery("getPokemons", Pokemon.class).getResultList(); + } + + /** + * Retrieves single pokemon by ID. + * + * @param id The ID. + * @return A pokemon that matches the ID. + * @throws NotFoundException If no pokemon found for the ID. + */ + @GET + @Path("{id}") + @Produces(MediaType.APPLICATION_JSON) + public Pokemon getPokemonById(@PathParam("id") String id) { + try { + return entityManager.find(Pokemon.class, Integer.valueOf(id)); + } catch (IllegalArgumentException e) { + throw new NotFoundException("Unable to find pokemon with ID " + id); + } + } + + /** + * Deletes a single pokemon by ID. + * + * @param id The ID. + */ + @DELETE + @Path("{id}") + @Produces(MediaType.APPLICATION_JSON) + @Transactional(Transactional.TxType.REQUIRED) + public void deletePokemon(@PathParam("id") String id) { + Pokemon pokemon = getPokemonById(id); + entityManager.remove(pokemon); + } + + /** + * Retrieves a pokemon by name. + * + * @param name The name. + * @return A pokemon that matches the name. + * @throws NotFoundException If no pokemon found for the name. + */ + @GET + @Path("name/{name}") + @Produces(MediaType.APPLICATION_JSON) + public Pokemon getPokemonByName(@PathParam("name") String name) { + TypedQuery query = entityManager.createNamedQuery("getPokemonByName", Pokemon.class); + List list = query.setParameter("name", name).getResultList(); + if (list.isEmpty()) { + throw new NotFoundException("Unable to find pokemon with name " + name); + } + return list.get(0); + } + + /** + * Creates a new pokemon. + * + * @param pokemon New pokemon. + * @throws BadRequestException If a problem was found. + */ + @POST + @Consumes(MediaType.APPLICATION_JSON) + @Transactional(Transactional.TxType.REQUIRED) + public void createPokemon(Pokemon pokemon) { + try { + PokemonType pokemonType = entityManager.createNamedQuery("getPokemonTypeById", PokemonType.class) + .setParameter("id", pokemon.getType()).getSingleResult(); + pokemon.setPokemonType(pokemonType); + entityManager.persist(pokemon); + } catch (Exception e) { + throw new BadRequestException("Unable to create pokemon with ID " + pokemon.getId()); + } + } +} + diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonType.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonType.java new file mode 100644 index 00000000..2cb10b28 --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonType.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2020, 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.integrations.cdi.pokemon; + +import javax.persistence.Access; +import javax.persistence.AccessType; +import javax.persistence.Basic; +import javax.persistence.Column; +import javax.persistence.Entity; +import javax.persistence.Id; +import javax.persistence.NamedQueries; +import javax.persistence.NamedQuery; +import javax.persistence.Table; + +/** + * A Pokemon Type entity. A type is represented by an ID and a name. + */ +@Entity(name = "PokemonType") +@Table(name = "POKEMONTYPE") +@Access(AccessType.FIELD) +@NamedQueries({ + @NamedQuery(name = "getPokemonTypes", + query = "SELECT t FROM PokemonType t"), + @NamedQuery(name = "getPokemonTypeById", + query = "SELECT t FROM PokemonType t WHERE t.id = :id") +}) +public class PokemonType { + + @Id + @Column(name = "ID", nullable = false, updatable = false) + private int id; + + @Basic(optional = false) + @Column(name = "NAME") + private String name; + + /** + * Creates a new type. + */ + public PokemonType() { + } + + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonTypeResource.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonTypeResource.java new file mode 100644 index 00000000..b877df2a --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonTypeResource.java @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2020, 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.integrations.cdi.pokemon; + +import java.util.List; + +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +/** + * This class implements a REST endpoint to retrieve Pokemon types. + * + * GET /type: Retrieve list of all pokemon types + */ +@Path("type") +public class PokemonTypeResource { + + @PersistenceContext(unitName = "test") + private EntityManager entityManager; + + @GET + @Produces(MediaType.APPLICATION_JSON) + public List getPokemonTypes() { + return entityManager.createNamedQuery("getPokemonTypes", PokemonType.class).getResultList(); + } +} diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/package-info.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/package-info.java new file mode 100644 index 00000000..85a2ffde --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Pokemon JPA integration sample. + */ +package io.helidon.examples.integrations.cdi.pokemon; diff --git a/examples/integrations/cdi/pokemons/src/main/resources/META-INF/beans.xml b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..a9742995 --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + diff --git a/examples/integrations/cdi/pokemons/src/main/resources/META-INF/init_script.sql b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/init_script.sql new file mode 100644 index 00000000..8d3d00c7 --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/init_script.sql @@ -0,0 +1,25 @@ +INSERT INTO POKEMONTYPE VALUES (1, 'Normal'); +INSERT INTO POKEMONTYPE VALUES (2, 'Fighting'); +INSERT INTO POKEMONTYPE VALUES (3, 'Flying'); +INSERT INTO POKEMONTYPE VALUES (4, 'Poison'); +INSERT INTO POKEMONTYPE VALUES (5, 'Ground'); +INSERT INTO POKEMONTYPE VALUES (6, 'Rock'); +INSERT INTO POKEMONTYPE VALUES (7, 'Bug'); +INSERT INTO POKEMONTYPE VALUES (8, 'Ghost'); +INSERT INTO POKEMONTYPE VALUES (9, 'Steel'); +INSERT INTO POKEMONTYPE VALUES (10, 'Fire'); +INSERT INTO POKEMONTYPE VALUES (11, 'Water'); +INSERT INTO POKEMONTYPE VALUES (12, 'Grass'); +INSERT INTO POKEMONTYPE VALUES (13, 'Electric'); +INSERT INTO POKEMONTYPE VALUES (14, 'Psychic'); +INSERT INTO POKEMONTYPE VALUES (15, 'Ice'); +INSERT INTO POKEMONTYPE VALUES (16, 'Dragon'); +INSERT INTO POKEMONTYPE VALUES (17, 'Dark'); +INSERT INTO POKEMONTYPE VALUES (18, 'Fairy'); + +INSERT INTO POKEMON VALUES (1, 'Bulbasaur', 12); +INSERT INTO POKEMON VALUES (2, 'Charmander', 10); +INSERT INTO POKEMON VALUES (3, 'Squirtle', 11); +INSERT INTO POKEMON VALUES (4, 'Caterpie', 7); +INSERT INTO POKEMON VALUES (5, 'Weedle', 7); +INSERT INTO POKEMON VALUES (6, 'Pidgey', 3); diff --git a/examples/integrations/cdi/pokemons/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..1ea62d92 --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,24 @@ +# +# Copyright (c) 2020 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. +# +javax.sql.DataSource.test.dataSourceClassName=org.h2.jdbcx.JdbcDataSource +#javax.sql.DataSource.test.dataSource.url=jdbc:h2:tcp://localhost:1521/test;IFEXISTS=FALSE +javax.sql.DataSource.test.dataSource.url=jdbc:h2:mem:test;DB_CLOSE_DELAY=-1 +javax.sql.DataSource.test.dataSource.user=sa +javax.sql.DataSource.test.dataSource.password= + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/integrations/cdi/pokemons/src/main/resources/META-INF/persistence.xml b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/persistence.xml new file mode 100644 index 00000000..8a143668 --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/main/resources/META-INF/persistence.xml @@ -0,0 +1,34 @@ + + + + + test + io.helidon.examples.integrations.cdi.pokemon.Pokemon + io.helidon.examples.integrations.cdi.pokemon.PokemonType + + + + + + + diff --git a/examples/integrations/cdi/pokemons/src/test/java/io/helidon/examples/integrations/cdi/pokemon/MainTest.java b/examples/integrations/cdi/pokemons/src/test/java/io/helidon/examples/integrations/cdi/pokemon/MainTest.java new file mode 100644 index 00000000..57657e26 --- /dev/null +++ b/examples/integrations/cdi/pokemons/src/test/java/io/helidon/examples/integrations/cdi/pokemon/MainTest.java @@ -0,0 +1,110 @@ +/* + * Copyright (c) 2020, 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.integrations.cdi.pokemon; + +import javax.enterprise.inject.se.SeContainer; +import javax.enterprise.inject.spi.CDI; +import javax.json.JsonArray; +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.Entity; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.server.Server; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +class MainTest { + + private static Server server; + private static Client client; + + @BeforeAll + public static void startTheServer() { + client = ClientBuilder.newClient(); + server = Server.create().start(); + } + + @AfterAll + static void destroyClass() { + CDI current = CDI.current(); + ((SeContainer) current).close(); + } + + @Test + void testPokemonTypes() { + JsonArray types = client.target(getConnectionString("/type")) + .request() + .get(JsonArray.class); + assertThat(types.size(), is(18)); + } + + @Test + void testPokemon() { + assertThat(getPokemonCount(), is(6)); + + Pokemon pokemon = client.target(getConnectionString("/pokemon/1")) + .request() + .get(Pokemon.class); + assertThat(pokemon.getName(), is("Bulbasaur")); + + pokemon = client.target(getConnectionString("/pokemon/name/Charmander")) + .request() + .get(Pokemon.class); + assertThat(pokemon.getType(), is(10)); + + try (Response response = client.target(getConnectionString("/pokemon/1")) + .request() + .get()) { + assertThat(response.getStatus(), is(200)); + } + + Pokemon test = new Pokemon(); + test.setType(1); + test.setId(100); + test.setName("Test"); + try (Response response = client.target(getConnectionString("/pokemon")) + .request() + .post(Entity.entity(test, MediaType.APPLICATION_JSON))) { + assertThat(response.getStatus(), is(204)); + assertThat(getPokemonCount(), is(7)); + } + + try (Response response = client.target(getConnectionString("/pokemon/100")) + .request() + .delete()) { + assertThat(response.getStatus(), is(204)); + assertThat(getPokemonCount(), is(6)); + } + } + + private int getPokemonCount() { + JsonArray pokemons = client.target(getConnectionString("/pokemon")) + .request() + .get(JsonArray.class); + return pokemons.size(); + } + + private String getConnectionString(String path) { + return "http://localhost:" + server.port() + path; + } +} diff --git a/examples/integrations/cdi/pom.xml b/examples/integrations/cdi/pom.xml new file mode 100644 index 00000000..63494369 --- /dev/null +++ b/examples/integrations/cdi/pom.xml @@ -0,0 +1,43 @@ + + + + 4.0.0 + + io.helidon.examples.integrations + helidon-examples-integrations-project + 1.0.0-SNAPSHOT + + io.helidon.examples.integrations.cdi + helidon-examples-integrations-cdi-project + pom + Helidon CDI Extensions Examples + + + datasource-hikaricp + datasource-hikaricp-h2 + datasource-hikaricp-mysql + jedis + jpa + oci-objectstorage + pokemons + + diff --git a/examples/integrations/micrometer/mp/README.md b/examples/integrations/micrometer/mp/README.md new file mode 100644 index 00000000..da062e9c --- /dev/null +++ b/examples/integrations/micrometer/mp/README.md @@ -0,0 +1,76 @@ +# Helidon MP Micrometer Example + +This example shows a simple greeting application, similar to the one from the Helidon MP +QuickStart, but enhanced with Helidon MP Micrometer support to +* time all accesses to the two `GET` endpoints, and + +* count the accesses to the `GET` endpoint which returns a personalized + greeting. + +The example is similar to the one from the Helidon MP QuickStart with these differences: +* The `pom.xml` file contains this additional dependency on the Helidon Micrometer integration + module: +```xml + + io.helidon.integrations + helidon-integrations-micrometer + +``` +* The `GreetingService` includes additional annotations: + * `@Timed` on the two `GET` methods. + * `@Counted` on the `GET` method that returns a personalized greeting. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-integrations-micrometer-mp.jar +``` + +## Using the app endpoints as with the "classic" greeting app + +These normal greeting app endpoints work just as in the original greeting app: + +```shell +curl -X GET http://localhost:8080/greet +#Output: {"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#Output: {"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#Output: {"message":"Hola Jose!"} +``` + +## Using Micrometer + +Access the `/micrometer` endpoint which reports the newly-added timer and counter. + +```shell +curl http://localhost:8080/micrometer +``` +Because the `@Timer` annotation specifies a histogram, +the actual timer output includes a lengthy histogram (only part of which is shown below). +Your output might show the `personalizedGets` output before the `allGets` output, +rather than after as shown here. + +```bash +curl http://localhost:8080/micrometer +``` +```text +# HELP allGets_seconds_max Tracks all GET operations +# TYPE allGets_seconds_max gauge +allGets_seconds_max 0.004840005 +# HELP allGets_seconds Tracks all GET operations +# TYPE allGets_seconds histogram +allGets_seconds_bucket{le="0.001",} 2.0 +allGets_seconds_bucket{le="30.0",} 3.0 +allGets_seconds_bucket{le="+Inf",} 3.0 +allGets_seconds_count 3.0 +allGets_seconds_sum 0.005098119 +# HELP personalizedGets_total Counts personalized GET operations +# TYPE personalizedGets_total counter +personalizedGets_total 2.0 +``` diff --git a/examples/integrations/micrometer/mp/pom.xml b/examples/integrations/micrometer/mp/pom.xml new file mode 100644 index 00000000..76c8601f --- /dev/null +++ b/examples/integrations/micrometer/mp/pom.xml @@ -0,0 +1,103 @@ + + + + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + 4.0.0 + + Helidon MP Examples Micrometer + + + Basic illustration of Micrometer integration in Helidon MP + + + io.helidon.examples.integrations.micrometer + helidon-examples-integrations-micrometer-mp + 1.0.0-SNAPSHOT + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.integrations.micrometer + helidon-integrations-micrometer-cdi + + + org.eclipse.microprofile.openapi + microprofile-openapi-api + + + org.glassfish.jersey.media + jersey-media-json-binding + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + diff --git a/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetResource.java b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetResource.java new file mode 100644 index 00000000..5949c7c4 --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetResource.java @@ -0,0 +1,138 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.micrometer.mp; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.micrometer.core.annotation.Counted; +import io.micrometer.core.annotation.Timed; +import org.eclipse.microprofile.openapi.annotations.enums.SchemaType; +import org.eclipse.microprofile.openapi.annotations.media.Content; +import org.eclipse.microprofile.openapi.annotations.media.Schema; +import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponses; + +/** + * A simple JAX-RS resource to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object. + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + + static final String PERSONALIZED_GETS_COUNTER_NAME = "personalizedGets"; + private static final String PERSONALIZED_GETS_COUNTER_DESCRIPTION = "Counts personalized GET operations"; + static final String GETS_TIMER_NAME = "allGets"; + private static final String GETS_TIMER_DESCRIPTION = "Tracks all GET operations"; + + /** + * The greeting message provider. + */ + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a worldly greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + @Timed(value = GETS_TIMER_NAME, description = GETS_TIMER_DESCRIPTION, histogram = true) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link GreetingMessage} + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Counted(value = PERSONALIZED_GETS_COUNTER_NAME, description = PERSONALIZED_GETS_COUNTER_DESCRIPTION) + @Timed(value = GETS_TIMER_NAME, description = GETS_TIMER_DESCRIPTION, histogram = true) + public GreetingMessage getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message JSON containing the new greeting + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + @RequestBody(name = "greeting", + required = true, + content = @Content(mediaType = "application/json", + schema = @Schema(type = SchemaType.OBJECT, requiredProperties = { "greeting" }))) + @APIResponses({ + @APIResponse(name = "normal", responseCode = "204", description = "Greeting updated"), + @APIResponse(name = "missing 'greeting'", responseCode = "400", + description = "JSON did not contain setting for 'greeting'")}) + public Response updateGreeting(GreetingMessage message) { + + if (message.getMessage() == null) { + GreetingMessage entity = new GreetingMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); + } + greetingProvider.setMessage(message.getMessage()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new GreetingMessage(msg); + } +} diff --git a/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetingMessage.java b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetingMessage.java new file mode 100644 index 00000000..e7a993ea --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023, 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.integrations.micrometer.mp; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetingProvider.java b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetingProvider.java new file mode 100644 index 00000000..52f2a1f7 --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/GreetingProvider.java @@ -0,0 +1,49 @@ +/* + * 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. + */ +package io.helidon.examples.integrations.micrometer.mp; + +import java.util.concurrent.atomic.AtomicReference; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +public class GreetingProvider { + private final AtomicReference message = new AtomicReference<>(); + + /** + * Create a new greeting provider, reading the message from configuration. + * + * @param message greeting to use + */ + @Inject + public GreetingProvider(@ConfigProperty(name = "app.greeting") String message) { + this.message.set(message); + } + + String getMessage() { + return message.get(); + } + + void setMessage(String message) { + this.message.set(message); + } +} diff --git a/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/package-info.java b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/package-info.java new file mode 100644 index 00000000..cbcea4b5 --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/java/io/helidon/examples/integrations/micrometer/mp/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 for Micrometer integration. + */ +package io.helidon.examples.integrations.micrometer.mp; diff --git a/examples/integrations/micrometer/mp/src/main/resources/META-INF/beans.xml b/examples/integrations/micrometer/mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..d703ee7b --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/micrometer/mp/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/micrometer/mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..91a97c1d --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2021 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. +# + +# Application properties. This is the default greeting +app.greeting=Hello + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +micrometer.builtin-registries.0.type=prometheus +micrometer.builtin-registries.0.prefix=myPrefix diff --git a/examples/integrations/micrometer/mp/src/main/resources/application.yaml b/examples/integrations/micrometer/mp/src/main/resources/application.yaml new file mode 100644 index 00000000..040ee86d --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/resources/application.yaml @@ -0,0 +1,20 @@ +# +# 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. +# + +micrometer: + builtin-registries: + - type: prometheus + prefix: myPrefix \ No newline at end of file diff --git a/examples/integrations/micrometer/mp/src/main/resources/logging.properties b/examples/integrations/micrometer/mp/src/main/resources/logging.properties new file mode 100644 index 00000000..fb539577 --- /dev/null +++ b/examples/integrations/micrometer/mp/src/main/resources/logging.properties @@ -0,0 +1,37 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.microprofile.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO +#org.glassfish.jersey.level=INFO +#org.jboss.weld=INFO diff --git a/examples/integrations/micrometer/mp/src/test/java/io/helidon/examples/integrations/micrometer/mp/TestEndpoint.java b/examples/integrations/micrometer/mp/src/test/java/io/helidon/examples/integrations/micrometer/mp/TestEndpoint.java new file mode 100644 index 00000000..3bcf9547 --- /dev/null +++ b/examples/integrations/micrometer/mp/src/test/java/io/helidon/examples/integrations/micrometer/mp/TestEndpoint.java @@ -0,0 +1,66 @@ +/* + * 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. + */ +package io.helidon.examples.integrations.micrometer.mp; + +import javax.inject.Inject; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MediaType; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.MeterRegistry; + +import org.junit.jupiter.api.Test; + +import static io.helidon.examples.integrations.micrometer.mp.GreetResource.PERSONALIZED_GETS_COUNTER_NAME; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + + +@HelidonTest +public class TestEndpoint { + + @Inject + private WebTarget webTarget; + + @Inject + private MeterRegistry registry; + + @Test + public void pingGreet() { + + GreetingMessage message = webTarget + .path("/greet/Joe") + .request(MediaType.APPLICATION_JSON_TYPE) + .get(GreetingMessage.class); + + assertThat("Response string", message.getMessage(), is("Hello Joe!")); + Counter counter = registry.counter(PERSONALIZED_GETS_COUNTER_NAME); + double before = counter.count(); + + message = webTarget + .path("/greet/Jose") + .request(MediaType.APPLICATION_JSON_TYPE) + .get(GreetingMessage.class); + + assertThat("Response string", message.getMessage(), is("Hello Jose!")); + double after = counter.count(); + assertThat("Difference in personalized greeting counter between successive calls", after - before, is(1d)); + + } +} diff --git a/examples/integrations/micrometer/pom.xml b/examples/integrations/micrometer/pom.xml new file mode 100644 index 00000000..6498fdec --- /dev/null +++ b/examples/integrations/micrometer/pom.xml @@ -0,0 +1,42 @@ + + + + + 4.0.0 + + io.helidon.examples.integrations + helidon-examples-integrations-project + 1.0.0-SNAPSHOT + + + helidon-examples-micrometer-project + Helidon Micrometer Examples + + pom + + + se + mp + + + + Basic illustrations of Micrometer integration in Helidon + + + diff --git a/examples/integrations/micrometer/se/README.md b/examples/integrations/micrometer/se/README.md new file mode 100644 index 00000000..fdf0fb6a --- /dev/null +++ b/examples/integrations/micrometer/se/README.md @@ -0,0 +1,90 @@ +# Helidon SE Micrometer Example + +This example shows a simple greeting application, similar to the one from the +Helidon SE QuickStart, but enhanced with Micrometer support to: + +* time all accesses to the two `GET` endpoints, and + +* count the accesses to the `GET` endpoint which returns a personalized + greeting. + +The Helidon Micrometer integration creates a Micrometer `MeterRegistry` automatically for you. +The `registry()` instance method on `MicrometerSupport` returns that meter registry. + +The `Main` class +1. Uses `MicrometerSupport` to obtain the Micrometer `MeterRegistry` which Helidon SE + automatically provides. + +1. Uses the `MeterRegistry` to: + * Create a Micrometer `Timer` for recording accesses to all `GET` endpoints. + * Create a Micrometer `Counter` for counting accesses to the `GET` endpoint that + returns a personalized greeting. + +1. Registers the built-in support for the `/micrometer` endpoint. + +1. Passes the `Timer` and `Counter` to the `GreetingService` constructor. + +The `GreetingService` class +1. Accepts in the constructor the `Timer` and `Counter` and saves them. +1. Adds routing rules to: + * Update the `Timer` with every `GET` access. + * Increment `Counter` (in addition to returning a personalized greeting) for every + personalized `GET` access. + + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-integrations-micrometer-se.jar +``` + +## Using the app endpoints as with the "classic" greeting app + +These normal greeting app endpoints work just as in the original greeting app: + +```shell +curl -X GET http://localhost:8080/greet +#Output: {"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#Output: {"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#Output: {"message":"Hola Jose!"} +``` + +## Using Micrometer + +Access the `/micrometer` endpoint which reports the newly-added timer and counter. +```shell +curl http://localhost:8080/micrometer +``` + +Because we created the `Timer` with a histogram, +the actual timer output includes a lengthy histogram (only part of which is shown below). +Your output might show the `personalizedGets` output before the `allGets` output, +rather than after as shown here. + +```bash +curl http://localhost:8080/micrometer +``` +```text +# HELP allGets_seconds_max +# TYPE allGets_seconds_max gauge +allGets_seconds_max 0.04341847 +# HELP allGets_seconds +# TYPE allGets_seconds histogram +allGets_seconds_bucket{le="0.001",} 0.0 +... +allGets_seconds_bucket{le="30.0",} 3.0 +allGets_seconds_bucket{le="+Inf",} 3.0 +allGets_seconds_count 3.0 +allGets_seconds_sum 0.049222592 +# HELP personalizedGets_total +# TYPE personalizedGets_total counter +personalizedGets_total 2.0 + +``` \ No newline at end of file diff --git a/examples/integrations/micrometer/se/pom.xml b/examples/integrations/micrometer/se/pom.xml new file mode 100644 index 00000000..ab62b910 --- /dev/null +++ b/examples/integrations/micrometer/se/pom.xml @@ -0,0 +1,94 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.micrometer-project + helidon-examples-integrations-micrometer-se + 1.0.0-SNAPSHOT + + Helidon SE Examples Micrometer + + + Basic illustration of Micrometer integration in Helidon SE + + + + io.helidon.examples.micrometer.se.Main + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.webserver + helidon-webserver-cors + + + io.helidon.integrations.micrometer + helidon-integrations-micrometer + + + io.helidon.media + helidon-media-jsonp + + + org.junit.jupiter + junit-jupiter-api + test + + + io.helidon.webclient + helidon-webclient + test + + + org.hamcrest + hamcrest-all + test + + + diff --git a/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/GreetService.java b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/GreetService.java new file mode 100644 index 00000000..06cafbfe --- /dev/null +++ b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/GreetService.java @@ -0,0 +1,141 @@ +/* + * 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. + */ + +package io.helidon.examples.micrometer.se; + +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.Timer; + +/** + * A simple service to greet you. + *

+ * Examples: + * 

{@code
+ * Get default greeting message:
+ * curl -X GET http://localhost:8080/greet
+ *
+ * Get greeting message for Joe:
+ * curl -X GET http://localhost:8080/greet/Joe
+ *
+ * Change greeting
+ * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting
+ *
+ * }
+ * The greeting message is returned as a JSON object. + * + *

+ */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private String greeting; + + private final Timer getTimer; + private final Counter personalizedGetCounter; + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + + GreetService(Config config, Timer getTimer, Counter personalizedGetCounter) { + this.greeting = config.get("app.greeting").asString().orElse("Ciao"); + this.getTimer = getTimer; + this.personalizedGetCounter = personalizedGetCounter; + } + + /** + * A service registers itself by updating the routine rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get((req, resp) -> getTimer.record((Runnable) req::next)) // Update the timer with every GET. + .get("/", this::getDefaultMessageHandler) + .get("/{name}", + (req, resp) -> { + personalizedGetCounter.increment(); + req.next(); + }, // Count personalized GETs... + this::getMessageHandler) // ...and process them. + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + GreetingMessage msg = new GreetingMessage(String.format("%s %s!", greeting, name)); + response.send(msg.forRest()); + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey(GreetingMessage.JSON_LABEL)) { + JsonObject jsonErrorObject = JSON_BF.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting = GreetingMessage.fromRest(jo).getMessage(); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class).thenAccept(jo -> updateGreetingFromJson(jo, response)); + } +} diff --git a/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/GreetingMessage.java b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/GreetingMessage.java new file mode 100644 index 00000000..20287598 --- /dev/null +++ b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/GreetingMessage.java @@ -0,0 +1,87 @@ +/* + * 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. + */ +package io.helidon.examples.micrometer.se; + +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.json.JsonObjectBuilder; + +/** + * POJO for the greeting message exchanged between the server and the client. + */ +public class GreetingMessage { + + /** + * Label for tagging a {@code GreetingMessage} instance in JSON. + */ + public static final String JSON_LABEL = "greeting"; + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + + private String message; + + /** + * Create a new greeting with the specified message content. + * + * @param message the message to store in the greeting + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Returns the message value. + * + * @return the message + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message value to be set + */ + public void setMessage(String message) { + this.message = message; + } + + /** + * Converts a JSON object (typically read from the request payload) + * into a {@code GreetingMessage}. + * + * @param jsonObject the {@link JsonObject} to convert. + * @return {@code GreetingMessage} set according to the provided object + */ + public static GreetingMessage fromRest(JsonObject jsonObject) { + return new GreetingMessage(jsonObject.getString(JSON_LABEL)); + } + + /** + * Prepares a {@link JsonObject} corresponding to this instance. + * + * @return {@code JsonObject} representing this {@code GreetingMessage} instance + */ + public JsonObject forRest() { + JsonObjectBuilder builder = JSON_BF.createObjectBuilder(); + return builder.add(JSON_LABEL, message) + .build(); + } +} diff --git a/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/Main.java b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/Main.java new file mode 100644 index 00000000..d56a6e81 --- /dev/null +++ b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/Main.java @@ -0,0 +1,109 @@ +/* + * 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. + */ + +package io.helidon.examples.micrometer.se; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.integrations.micrometer.MicrometerSupport; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.Timer; + +/** + * Simple Hello World rest application. + */ +public final class Main { + + static final String PERSONALIZED_GETS_COUNTER_NAME = "personalizedGets"; + static final String ALL_GETS_TIMER_NAME = "allGets"; + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // Get webserver config from the "server" section of application.yaml + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .port(8080) + .addMediaSupport(JsonpSupport.create()) + .build(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + // Server threads are not daemon. No need to block. Just react. + return server.start() + .peek(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .onError(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, Micrometer metrics, and the greeting service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MicrometerSupport micrometerSupport = MicrometerSupport.create(); + Counter personalizedGetCounter = micrometerSupport.registry() + .counter(PERSONALIZED_GETS_COUNTER_NAME); + Timer getTimer = Timer.builder(ALL_GETS_TIMER_NAME) + .publishPercentileHistogram() + .register(micrometerSupport.registry()); + + GreetService greetService = new GreetService(config, getTimer, personalizedGetCounter); + + return Routing.builder() + .register(micrometerSupport) // Micrometer support at "/micrometer" + .register("/greet", greetService) + .build(); + } +} diff --git a/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/package-info.java b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/package-info.java new file mode 100644 index 00000000..60dc55d3 --- /dev/null +++ b/examples/integrations/micrometer/se/src/main/java/io/helidon/examples/micrometer/se/package-info.java @@ -0,0 +1,24 @@ +/* + * 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 application showing Micrometer support in Helidon SE + *

+ * Start with {@link io.helidon.examples.micrometer.se.Main} class. + * + * @see io.helidon.examples.micrometer.se.Main + */ +package io.helidon.examples.micrometer.se; diff --git a/examples/integrations/micrometer/se/src/main/resources/application.yaml b/examples/integrations/micrometer/se/src/main/resources/application.yaml new file mode 100644 index 00000000..92e9f51e --- /dev/null +++ b/examples/integrations/micrometer/se/src/main/resources/application.yaml @@ -0,0 +1,24 @@ +# +# 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 + + diff --git a/examples/integrations/micrometer/se/src/test/java/io/helidon/examples/micrometer/se/MainTest.java b/examples/integrations/micrometer/se/src/test/java/io/helidon/examples/micrometer/se/MainTest.java new file mode 100644 index 00000000..b3423258 --- /dev/null +++ b/examples/integrations/micrometer/se/src/test/java/io/helidon/examples/micrometer/se/MainTest.java @@ -0,0 +1,152 @@ +/* + * 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. + */ +package io.helidon.examples.micrometer.se; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.MethodOrderer; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestMethodOrder; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.CoreMatchers.containsString; + +// we need to first call the methods, before validating metrics +@TestMethodOrder(MethodOrderer.OrderAnnotation.class) +public class MainTest { + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + private static WebServer webServer; + private static WebClient webClient; + + private static double expectedPersonalizedGets; + private static double expectedAllGets; + + static { + TEST_JSON_OBJECT = JSON_BF.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + @BeforeAll + public static void startTheServer() { + webServer = Main.startServer() + .await(10, TimeUnit.SECONDS); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + private static JsonObject get() { + return get("/greet"); + } + + private static JsonObject get(String path) { + JsonObject jsonObject = webClient.get() + .path(path) + .request(JsonObject.class) + .await(); + expectedAllGets++; + return jsonObject; + } + + private static JsonObject personalizedGet(String name) { + JsonObject result = get("/greet/" + name); + expectedPersonalizedGets++; + return result; + } + + @Test + @Order(1) + void testDefaultGreeting() { + JsonObject jsonObject = get(); + assertThat(jsonObject.getString("greeting"), is("Hello World!")); + } + + @Test + @Order(2) + void testNamedGreeting() { + JsonObject jsonObject = personalizedGet("Joe"); + Assertions.assertEquals("Hello Joe!", jsonObject.getString("greeting")); + } + + @Test + @Order(3) + void testUpdateGreeting() { + + WebClientResponse response = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + + assertThat(response.status(), is(Http.Status.NO_CONTENT_204)); + + JsonObject jsonObject = personalizedGet("Joe"); + assertThat(jsonObject.getString("greeting"), is("Hola Joe!")); + } + + @Test + @Order(4) + void testMicrometer() { + WebClientResponse response = webClient.get() + .path("/micrometer") + .request() + .await(); + + assertThat(response.status().code(), is(200)); + + String output = response.content() + .as(String.class) + .await(); + String expected = Main.ALL_GETS_TIMER_NAME + "_seconds_count " + expectedAllGets; + assertThat("Unable to find expected all-gets timer count " + expected + "; output is " + output, + output, containsString(expected)); // all gets; the put + // is not counted + assertThat("Unable to find expected all-gets timer sum", output, + containsString(Main.ALL_GETS_TIMER_NAME + "_seconds_sum")); + expected = Main.PERSONALIZED_GETS_COUNTER_NAME + "_total " + expectedPersonalizedGets; + assertThat("Unable to find expected counter result " + expected + "; output is " + output, + output, containsString(expected)); + response.close(); + } +} diff --git a/examples/integrations/micronaut/data/README.md b/examples/integrations/micronaut/data/README.md new file mode 100644 index 00000000..9578ce3b --- /dev/null +++ b/examples/integrations/micronaut/data/README.md @@ -0,0 +1,138 @@ +# Helidon Micronaut Data Example + +This example shows integration with Micronaut Data into Helidon MP. + +## Sources + +This example combines Micronaut Data and CDI. + +### CDI classes + +The following classes are CDI and JAX-RS classes that use injected Micronaut beans: + +- `PetResource` - JAX-RS resource exposing Pet REST API +- `OwnerResource` - JAX-RS resource exposing Owner REST API +- `BeanValidationExceptionMapper` - JAX-RS exception mapper to return correct status code + in case of validation failure + +### Micronaut classes + +The following classes are pure Micronaut beans (and cannot have CDI injected into them) + +- `DbPetRepository` - Micronaut Data repository extending an abstract class +- `DbOwnerRepository` - Micronaut Data repository implementing an interface +- `DbPopulateData` - Micronaut startup event listener to initialize the database +- package `model` - data model of the database + +## Build and run + +Start the application: + +```shell +mvn package +java -jar target/helidon-examples-integrations-micronaut-data.jar +``` + +Access endpoints + +```shell +# Get all pets +curl -i http://localhost:8080/pets +# Get all owners +curl -i http://localhost:8080/owners +# Get a single pet +curl -i http://localhost:8080/pets/Dino +# Get a single owner +curl -i http://localhost:8080/owners/Barney +# To fail input validation +curl -i http://localhost:8080/pets/s +``` + +# To use Oracle XE instead of H2 + +- Update ./pom.xml to replace dependency on micronaut-jdbc-hikari with following +```xml + + io.micronaut.sql + micronaut-jdbc-ucp + runtime + +``` + +- Update ./pom.xml to replace dependency on com.h2database with following +```xml + + com.oracle.database.jdbc + ojdbc8-production + pom + runtime + +``` + +- Update ./src/main/java/io/helidon/examples/integrations/micronaut/data/DbOwnerRepository.java and + ./src/main/java/io/helidon/examples/integrations/micronaut/data/DbOwnerRepository.java to change from + Dialect.H2 to Dialect.ORACLE + +- Update ./src/main/java/io/helidon/examples/integrations/micronaut/data/DbPopulateData.java to change Typehint to + @TypeHint(typeNames = {"oracle.jdbc.OracleDriver"}) + +- Install Oracle XE + Instructions for running XE in a docker container can be found here: https://github.com/oracle/docker-images/tree/master/OracleDatabase/SingleInstance + +- Update ./src/main/resources/META-INF/microprofile-config.properties to comment out h2 related datasource.* properties and uncomment+update following ones related to XE. +```text +#datasources.default.url=jdbc:oracle:thin:@localhost:/ +#datasources.default.driverClassName=oracle.jdbc.OracleDriver +#datasources.default.username=system +#datasources.default.password= +#datasources.default.schema-generate=CREATE_DROP +#datasources.default.dialect=oracle +``` + +# To use Oracle ATP cloud service instead of H2 + +- Update ./pom.xml to replace dependency on micronaut-jdbc-hikari with following +```xml + + io.micronaut.sql + micronaut-jdbc-ucp + runtime + +``` + +- Update ./pom.xml to replace dependency on com.h2database with following +```xml + + com.oracle.database.jdbc + ojdbc8-production + pom + runtime + +``` + +- Update ./src/main/java/io/helidon/examples/integrations/micronaut/data/DbOwnerRepository.java and + ./src/main/java/io/helidon/examples/integrations/micronaut/data/DbOwnerRepository.java to change from + Dialect.H2 to Dialect.ORACLE + +- Update ./src/main/java/io/helidon/examples/integrations/micronaut/data/DbPopulateData.java to change Typehint to + @TypeHint(typeNames = {"oracle.jdbc.OracleDriver"}) + +- Setup ATP + Instructions for ATP setup can be found here: https://blogs.oracle.com/developers/the-complete-guide-to-getting-up-and-running-with-autonomous-database-in-the-cloud + +- Create Schema used by test +```sql +CREATE TABLE "PET" ("ID" VARCHAR(36),"OWNER_ID" NUMBER(19) NOT NULL,"NAME" VARCHAR(255) NOT NULL,"TYPE" VARCHAR(255) NOT NULL); +CREATE SEQUENCE "OWNER_SEQ" MINVALUE 1 START WITH 1 NOCACHE NOCYCLE; +CREATE TABLE "OWNER" ("ID" NUMBER(19) PRIMARY KEY NOT NULL,"AGE" NUMBER(10) NOT NULL,"NAME" VARCHAR(255) NOT NULL); +``` + +- Update ./src/main/resources/META-INF/microprofile-config.properties to comment out h2 related datasource.* properties and add uncomment+update following ones related to ATP. +```properties +#datasources.default.url=jdbc:oracle:thin:@?TNS_ADMIN= +#datasources.default.driverClassName=oracle.jdbc.OracleDriver +#datasources.default.username= +#datasources.default.password= +#datasources.default.schema-generate=NONE +#datasources.default.dialect=oracle +``` \ No newline at end of file diff --git a/examples/integrations/micronaut/data/pom.xml b/examples/integrations/micronaut/data/pom.xml new file mode 100644 index 00000000..0f54c7ec --- /dev/null +++ b/examples/integrations/micronaut/data/pom.xml @@ -0,0 +1,159 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations + helidon-examples-integrations-micronaut-data + 1.0.0-SNAPSHOT + Helidon Example Integration Micronaut Data + + + + jakarta.persistence + jakarta.persistence-api + provided + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.micronaut.data + micronaut-data-jdbc + + + io.micronaut + micronaut-runtime + + + io.helidon.integrations.micronaut + helidon-integrations-micronaut-cdi + runtime + + + io.helidon.integrations.micronaut + helidon-integrations-micronaut-data + runtime + + + io.micronaut.data + micronaut-data-tx + runtime + + + io.micronaut.sql + micronaut-jdbc-hikari + runtime + + + com.h2database + + + h2 + runtime + + + org.jboss + jandex + runtime + true + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + true + + + io.micronaut + micronaut-inject-java + ${version.lib.micronaut} + + + io.micronaut + micronaut-validation + ${version.lib.micronaut} + + + io.micronaut.data + micronaut-data-processor + ${version.lib.micronaut.data} + + + io.helidon.integrations.micronaut + helidon-integrations-micronaut-cdi-processor + ${helidon.version} + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/BeanValidationExceptionMapper.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/BeanValidationExceptionMapper.java new file mode 100644 index 00000000..0821fa3b --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/BeanValidationExceptionMapper.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data; + +import javax.validation.ConstraintViolationException; +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; +import javax.ws.rs.ext.Provider; + +/** + * A JAX-RS provider that maps {@link javax.validation.ConstraintViolationException} from bean validation + * to a proper JAX-RS response with {@link javax.ws.rs.core.Response.Status#BAD_REQUEST} status. + * If this provider is not present, validation exception from Micronaut would end with an internal server + * error. + */ +@Provider +public class BeanValidationExceptionMapper implements ExceptionMapper { + @Override + public Response toResponse(ConstraintViolationException exception) { + return Response.status(Response.Status.BAD_REQUEST) + .entity(exception.getMessage()) + .build(); + } +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbOwnerRepository.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbOwnerRepository.java new file mode 100644 index 00000000..84a6f55d --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbOwnerRepository.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data; + +import java.util.List; +import java.util.Optional; + +import io.helidon.examples.integrations.micronaut.data.model.Owner; + +import io.micronaut.data.jdbc.annotation.JdbcRepository; +import io.micronaut.data.model.query.builder.sql.Dialect; +import io.micronaut.data.repository.CrudRepository; + +/** + * Micronaut Data repository for pet owners. + */ +@JdbcRepository(dialect = Dialect.H2) +public interface DbOwnerRepository extends CrudRepository { + /** + * Get all owners from the database. + * + * @return all owners + */ + @Override + List findAll(); + + /** + * Find an owner by name. + * + * @param name name of owner + * @return owner if found + */ + Optional findByName(String name); +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbPetRepository.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbPetRepository.java new file mode 100644 index 00000000..a0281465 --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbPetRepository.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data; + +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +import io.helidon.examples.integrations.micronaut.data.model.NameDTO; +import io.helidon.examples.integrations.micronaut.data.model.Pet; + +import io.micronaut.data.annotation.Join; +import io.micronaut.data.jdbc.annotation.JdbcRepository; +import io.micronaut.data.model.Pageable; +import io.micronaut.data.model.query.builder.sql.Dialect; +import io.micronaut.data.repository.PageableRepository; + +/** + * Micronaut data repository for pets. + */ +@JdbcRepository(dialect = Dialect.H2) +public abstract class DbPetRepository implements PageableRepository { + + /** + * Get all pets. + * + * @param pageable pageable instance + * @return list of pets + */ + public abstract List list(Pageable pageable); + + /** + * Find a pet by its name. + * + * @param name pet name + * @return pet if it was found + */ + @Join("owner") + public abstract Optional findByName(String name); +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbPopulateData.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbPopulateData.java new file mode 100644 index 00000000..3de83acc --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/DbPopulateData.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2020, 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. + */ +/* + This class is almost exactly copied from Micronaut examples. + */ +package io.helidon.examples.integrations.micronaut.data; + +import java.util.Arrays; + +import javax.inject.Inject; +import javax.inject.Singleton; + +import io.helidon.examples.integrations.micronaut.data.model.Owner; +import io.helidon.examples.integrations.micronaut.data.model.Pet; + +import io.micronaut.context.event.StartupEvent; +import io.micronaut.core.annotation.TypeHint; +import io.micronaut.runtime.event.annotation.EventListener; + +/** + * A Micronaut bean that listens on startup event and populates database with data. + */ +@Singleton +@TypeHint(typeNames = {"org.h2.Driver", "org.h2.mvstore.db.MVTableEngine"}) +public class DbPopulateData { + private final DbOwnerRepository ownerRepository; + private final DbPetRepository petRepository; + + @Inject + DbPopulateData(DbOwnerRepository ownerRepository, DbPetRepository petRepository) { + this.ownerRepository = ownerRepository; + this.petRepository = petRepository; + } + + @EventListener + void init(StartupEvent event) { + Owner fred = new Owner("Fred"); + fred.setAge(45); + Owner barney = new Owner("Barney"); + barney.setAge(40); + ownerRepository.saveAll(Arrays.asList(fred, barney)); + + Pet dino = new Pet("Dino", fred); + Pet bp = new Pet("Baby Puss", fred); + bp.setType(Pet.PetType.CAT); + Pet hoppy = new Pet("Hoppy", barney); + + petRepository.saveAll(Arrays.asList(dino, bp, hoppy)); + } +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/OwnerResource.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/OwnerResource.java new file mode 100644 index 00000000..424df509 --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/OwnerResource.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data; + +import javax.inject.Inject; +import javax.validation.constraints.Pattern; +import javax.ws.rs.GET; +import javax.ws.rs.NotFoundException; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; + +import io.helidon.examples.integrations.micronaut.data.model.Owner; + +import org.eclipse.microprofile.metrics.annotation.SimplyTimed; + +/** + * JAX-RS resource, and the MicroProfile entry point to manage pet owners. + * This resource used Micronaut data beans (repositories) to query database, and + * bean validation as implemented by Micronaut. + */ +@Path("/owners") +public class OwnerResource { + private final DbOwnerRepository ownerRepository; + + /** + * Create a new instance with repository. + * + * @param ownerRepo owner repository from Micronaut data + */ + @Inject + public OwnerResource(DbOwnerRepository ownerRepo) { + this.ownerRepository = ownerRepo; + } + + /** + * Gets all owners from the database. + * @return all owners, using JSON-B to map them to JSON + */ + @GET + public Iterable getAll() { + return ownerRepository.findAll(); + } + + /** + * Get a named owner from the database. + * + * @param name name of the owner to find, must be at least two characters long, may contain whitespace + * @return a single owner + * @throws javax.ws.rs.NotFoundException in case the owner is not in the database (to return 404 status) + */ + @Path("/{name}") + @GET + @SimplyTimed + public Owner owner(@PathParam("name") @Pattern(regexp = "\\w+[\\w+\\s?]*\\w") String name) { + return ownerRepository.findByName(name) + .orElseThrow(() -> new NotFoundException("Owner by name " + name + " does not exist")); + } +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/PetResource.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/PetResource.java new file mode 100644 index 00000000..2c14793b --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/PetResource.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data; + +import javax.inject.Inject; +import javax.validation.constraints.Pattern; +import javax.ws.rs.GET; +import javax.ws.rs.NotFoundException; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; + +import io.helidon.examples.integrations.micronaut.data.model.Pet; + +import org.eclipse.microprofile.metrics.annotation.SimplyTimed; + +/** + * JAX-RS resource, and the MicroProfile entry point to manage pets. + * This resource used Micronaut data beans (repositories) to query database, and + * bean validation as implemented by Micronaut. + */ +@Path("/pets") +public class PetResource { + private final DbPetRepository petRepository; + + /** + * Create a new instance with pet repository. + * + * @param petRepo Pet repository from Micronaut data + */ + @Inject + public PetResource(DbPetRepository petRepo) { + this.petRepository = petRepo; + } + + /** + * Gets all pets from the database. + * @return all pets, using JSON-B to map them to JSON + */ + @GET + public Iterable getAll() { + return petRepository.findAll(); + } + + /** + * Get a named pet from the database. + * + * @param name name of the pet to find, must be at least two characters long, may contain whitespace + * @return a single pet + * @throws javax.ws.rs.NotFoundException in case the pet is not in the database (to return 404 status) + */ + @Path("/{name}") + @GET + @SimplyTimed + public Pet pet(@PathParam("name") @Pattern(regexp = "\\w+[\\w+\\s?]*\\w") String name) { + return petRepository.findByName(name) + .orElseThrow(() -> new NotFoundException("Pet by name " + name + " does not exist")); + } +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/NameDTO.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/NameDTO.java new file mode 100644 index 00000000..35a119c2 --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/NameDTO.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data.model; + +import io.micronaut.core.annotation.Introspected; + +/** + * Used in list of names of pets. + */ +@Introspected +public class NameDTO { + private String name; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/Owner.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/Owner.java new file mode 100644 index 00000000..7216312c --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/Owner.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data.model; + +import javax.persistence.Entity; +import javax.persistence.GeneratedValue; +import javax.persistence.Id; + +import io.micronaut.core.annotation.Creator; + +/** + * Owner database entity. + */ +@Entity +public class Owner { + + @Id + @GeneratedValue + private Long id; + private String name; + private int age; + + /** + * Create a named owner. + * + * @param name name of the owner + */ + @Creator + public Owner(String name) { + this.name = name; + } + + public int getAge() { + return age; + } + + public void setAge(int age) { + this.age = age; + } + + public String getName() { + return name; + } + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/Pet.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/Pet.java new file mode 100644 index 00000000..535893db --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/Pet.java @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data.model; + +import java.util.UUID; + +import javax.persistence.Entity; +import javax.persistence.Id; +import javax.persistence.ManyToOne; + +import io.micronaut.core.annotation.Creator; +import io.micronaut.core.annotation.Nullable; +import io.micronaut.data.annotation.AutoPopulated; + +/** + * Pet database entity. + */ +@Entity +public class Pet { + + @Id + @AutoPopulated + private UUID id; + private String name; + @ManyToOne + private Owner owner; + private PetType type = PetType.DOG; + + /** + * Creates a new pet. + * @param name name of the pet + * @param owner owner of the pet (optional) + */ + // NOTE - please use Nullable from this package, javax.annotation.Nullable will fail with JPMS, + // as it is declared in the same package as is used by annother module (jakarta.annotation-api) + @Creator + public Pet(String name, @Nullable Owner owner) { + this.name = name; + this.owner = owner; + } + + public Owner getOwner() { + return owner; + } + + public String getName() { + return name; + } + + public UUID getId() { + return id; + } + + public PetType getType() { + return type; + } + + public void setType(PetType type) { + this.type = type; + } + + public void setId(UUID id) { + this.id = id; + } + + /** + * Type of pet. + */ + public enum PetType { + /** + * Dog. + */ + DOG, + /** + * Cat. + */ + CAT + } +} diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/package-info.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/package-info.java new file mode 100644 index 00000000..c5cd8a9a --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/model/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Model classes for entities and transfer objects. + */ +package io.helidon.examples.integrations.micronaut.data.model; diff --git a/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/package-info.java b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/package-info.java new file mode 100644 index 00000000..d1109606 --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/java/io/helidon/examples/integrations/micronaut/data/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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 showing use of Micronaut Data in Helidon MicroProfile server. + */ +package io.helidon.examples.integrations.micronaut.data; diff --git a/examples/integrations/micronaut/data/src/main/resources/META-INF/beans.xml b/examples/integrations/micronaut/data/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..10d82415 --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/resources/META-INF/beans.xml @@ -0,0 +1,23 @@ + + + + + diff --git a/examples/integrations/micronaut/data/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/micronaut/data/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..b61c69cb --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,40 @@ +# +# Copyright (c) 2020, 2021 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. +# + +server.port=8080 + +#When native image is used, we must use remote h2 +#datasources.default.url=jdbc:h2:tcp://localhost:9092/test +datasources.default.url=jdbc:h2:mem:devDb;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE +datasources.default.driverClassName=org.h2.Driver +datasources.default.username=sa +datasources.default.password= +datasources.default.schema-generate=CREATE_DROP +datasources.default.dialect=h2 + +#datasources.default.url=jdbc:oracle:thin:@localhost:/ +#datasources.default.driverClassName=oracle.jdbc.OracleDriver +#datasources.default.username=system +#datasources.default.password= +#datasources.default.schema-generate=CREATE_DROP +#datasources.default.dialect=oracle + +#datasources.default.url=jdbc:oracle:thin:@?TNS_ADMIN= +#datasources.default.driverClassName=oracle.jdbc.OracleDriver +#datasources.default.username= +#datasources.default.password= +#datasources.default.schema-generate=NONE +#datasources.default.dialect=oracle diff --git a/examples/integrations/micronaut/data/src/main/resources/logging.properties b/examples/integrations/micronaut/data/src/main/resources/logging.properties new file mode 100644 index 00000000..80b90542 --- /dev/null +++ b/examples/integrations/micronaut/data/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2020, 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO diff --git a/examples/integrations/micronaut/data/src/test/java/io/helidon/examples/integrations/micronaut/data/MicronautExampleTest.java b/examples/integrations/micronaut/data/src/test/java/io/helidon/examples/integrations/micronaut/data/MicronautExampleTest.java new file mode 100644 index 00000000..d8184805 --- /dev/null +++ b/examples/integrations/micronaut/data/src/test/java/io/helidon/examples/integrations/micronaut/data/MicronautExampleTest.java @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2020, 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.integrations.micronaut.data; + +import javax.inject.Inject; +import javax.json.JsonArray; +import javax.json.JsonObject; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; + +import io.helidon.examples.integrations.micronaut.data.model.Pet; +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +@HelidonTest +class MicronautExampleTest { + @Inject + private WebTarget webTarget; + + @Test + void testAllPets() { + JsonArray jsonValues = webTarget.path("/pets") + .request() + .get(JsonArray.class); + + assertThat("We should get all pets", jsonValues.size(), is(3)); + } + + @Test + void testGetPet() { + JsonObject pet = webTarget.path("/pets/Dino") + .request() + .get(JsonObject.class); + + assertThat(pet.getString("name"), is("Dino")); + assertThat(pet.getString("type"), is(Pet.PetType.DOG.toString())); + } + + @Test + void testNotFound() { + try (Response response = webTarget.path("/pets/Fino") + .request() + .get()) { + assertThat("Should be not found: 404", response.getStatus(), is(404)); + } + } + + @Test + void testValidationError() { + try (Response response = webTarget.path("/pets/a") + .request() + .get()) { + assertThat("Should be bad request: 400", response.getStatus(), is(400)); + } + } + +} \ No newline at end of file diff --git a/examples/integrations/micronaut/pom.xml b/examples/integrations/micronaut/pom.xml new file mode 100644 index 00000000..dd356e1d --- /dev/null +++ b/examples/integrations/micronaut/pom.xml @@ -0,0 +1,37 @@ + + + + 4.0.0 + + io.helidon.examples.integrations + helidon-examples-integrations-project + 1.0.0-SNAPSHOT + + io.helidon.examples.integrations.micronaut + helidon-examples-integrations-micronaut-project + pom + Helidon Micronaut Integration Examples + + + data + + diff --git a/examples/integrations/microstream/README.md b/examples/integrations/microstream/README.md new file mode 100644 index 00000000..d48be207 --- /dev/null +++ b/examples/integrations/microstream/README.md @@ -0,0 +1 @@ +# Microstream Integrations Examples diff --git a/examples/integrations/microstream/greetings-mp/README.md b/examples/integrations/microstream/greetings-mp/README.md new file mode 100644 index 00000000..9ea53eec --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/README.md @@ -0,0 +1,27 @@ +# Microstream integration example + +This example uses Microstream to persist the greetings supplied + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-integrations-microstream-greetings-mp.jar +``` + +## Endpoints + +Get default greeting message: +```shell +curl -X GET http://localhost:7001/greet +``` + +Get greeting message for Joe: +```shell +curl -X GET http://localhost:7001/greet/Joe +``` + +Add a greeting: +```shell +curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Howdy"}' http://localhost:7001/greet/greeting +``` \ No newline at end of file diff --git a/examples/integrations/microstream/greetings-mp/pom.xml b/examples/integrations/microstream/greetings-mp/pom.xml new file mode 100644 index 00000000..bf1466cc --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/pom.xml @@ -0,0 +1,86 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integration + helidon-examples-integrations-microstream-greetings-mp + 1.0.0-SNAPSHOT + Helidon Microstream Integration Example Greetings mp + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.integrations.microstream + helidon-integrations-microstream-cdi + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + diff --git a/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetResource.java b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetResource.java new file mode 100644 index 00000000..2d430ce5 --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetResource.java @@ -0,0 +1,111 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.mp; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:7001/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:7001/greet/Joe + * + * add a greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:7001/greet/greeting + * + * The message is returned as a JSON object + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a default greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getGreeting(), who); + + return new GreetingMessage(msg); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link GreetingMessage} + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message JSON containing the new greeting + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + public Response updateGreeting(GreetingMessage message) { + + if (message.getMessage() == null) { + GreetingMessage entity = new GreetingMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); + } + greetingProvider.addGreeting(message.getMessage()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + +} diff --git a/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetingMessage.java b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetingMessage.java new file mode 100644 index 00000000..653a84c5 --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023, 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.integrations.microstream.greetings.mp; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetingProvider.java b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetingProvider.java new file mode 100644 index 00000000..99e67ae1 --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/GreetingProvider.java @@ -0,0 +1,96 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.mp; + +import java.util.ArrayList; +import java.util.List; +import java.util.Random; +import java.util.concurrent.locks.ReentrantReadWriteLock; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import io.helidon.integrations.microstream.cdi.MicrostreamStorage; + +import one.microstream.storage.embedded.types.EmbeddedStorageManager; + +/** + * Provider for greeting message that are persisted by microstream. + */ +@ApplicationScoped +public class GreetingProvider { + + private final ReentrantReadWriteLock lock = new ReentrantReadWriteLock(true); + private final EmbeddedStorageManager storage; + private final Random rnd = new Random(); + + private List greetingMessages; + + /** + * Creates new GreetingProvider using a microstream EmbeddedStorageManager. + * + * @param storage the used EmbeddedStorageManager. + */ + @SuppressWarnings("unchecked") + @Inject + public GreetingProvider(@MicrostreamStorage(configNode = "one.microstream.storage.greetings") + EmbeddedStorageManager storage) { + super(); + this.storage = storage; + + // load stored data + greetingMessages = (List) storage.root(); + + // Initialize storage if empty + if (greetingMessages == null) { + greetingMessages = new ArrayList<>(); + storage.setRoot(greetingMessages); + storage.storeRoot(); + addGreeting("Hello"); + } + } + + /** + * Add a new greeting to the available greetings and persist it. + * + * @param newGreeting the new greeting to be added and persisted. + */ + public void addGreeting(String newGreeting) { + try { + lock.writeLock().lock(); + greetingMessages.add(newGreeting); + storage.store(greetingMessages); + } finally { + lock.writeLock().unlock(); + } + } + + /** + * returns a random greeting. + * + * @return a greeting. + */ + public String getGreeting() { + try { + lock.readLock().lock(); + return greetingMessages.get(rnd.nextInt(greetingMessages.size())); + } finally { + lock.readLock().unlock(); + } + } + +} diff --git a/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/package-info.java b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/package-info.java new file mode 100644 index 00000000..e43f651b --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/src/main/java/io/helidon/examples/integrations/microstream/greetings/mp/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * An example that uses Microstream to persist the greetings. + */ +package io.helidon.examples.integrations.microstream.greetings.mp; diff --git a/examples/integrations/microstream/greetings-mp/src/main/resources/META-INF/beans.xml b/examples/integrations/microstream/greetings-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..6e95720d --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + \ No newline at end of file diff --git a/examples/integrations/microstream/greetings-mp/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/microstream/greetings-mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..541ed066 --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1 @@ +one.microstream.storage.greetings.storage-directory=./greetingsStorage diff --git a/examples/integrations/microstream/greetings-mp/src/test/java/io/helidon/examples/integrations/microstream/greetings/mp/MicrostreamExampleGreetingsMpTest.java b/examples/integrations/microstream/greetings-mp/src/test/java/io/helidon/examples/integrations/microstream/greetings/mp/MicrostreamExampleGreetingsMpTest.java new file mode 100644 index 00000000..74afebcf --- /dev/null +++ b/examples/integrations/microstream/greetings-mp/src/test/java/io/helidon/examples/integrations/microstream/greetings/mp/MicrostreamExampleGreetingsMpTest.java @@ -0,0 +1,53 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.mp; + +import java.nio.file.Path; + +import javax.inject.Inject; +import javax.ws.rs.client.WebTarget; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +@HelidonTest +class MicrostreamExampleGreetingsMpTest { + + @Inject + private WebTarget webTarget; + + @TempDir + static Path tempDir; + + @BeforeAll + static void beforeAll() { + System.setProperty("one.microstream.storage.greetings.storage-directory", tempDir.toString()); + } + + @Test + void testGreeting() { + GreetingMessage response = webTarget.path("/greet").request().get(GreetingMessage.class); + + assertEquals("Hello World!", response.getMessage(), "response should be 'Hello World' "); + } + +} diff --git a/examples/integrations/microstream/greetings-se/README.md b/examples/integrations/microstream/greetings-se/README.md new file mode 100644 index 00000000..fabc26ec --- /dev/null +++ b/examples/integrations/microstream/greetings-se/README.md @@ -0,0 +1,32 @@ +# Microstream integration example + +This example uses Microstream to persist a log entry for every greeting + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-integrations-microstream-greetings-se.jar +``` + +## Endpoints + +Get default greeting message: +```shell +curl -X GET http://localhost:8080/greet +``` + +Get greeting message for Joe: +```shell +curl -X GET http://localhost:8080/greet/Joe +``` + +Change greeting: +```shell +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting +``` + +Get the logs: +```shell +curl -X GET http://localhost:8080/greet/logs +``` \ No newline at end of file diff --git a/examples/integrations/microstream/greetings-se/pom.xml b/examples/integrations/microstream/greetings-se/pom.xml new file mode 100644 index 00000000..e4ad070f --- /dev/null +++ b/examples/integrations/microstream/greetings-se/pom.xml @@ -0,0 +1,99 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations + helidon-examples-integrations-microstream-greetings-se + 1.0.0-SNAPSHOT + Helidon Microstream Integration Example Greetings se + + + io.helidon.examples.integrations.microstream.greetings.se.Main + + + + + io.helidon.bundles + helidon-bundles-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + + + io.helidon.integrations.microstream + helidon-integrations-microstream + + + io.helidon.metrics + helidon-metrics + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/GreetingService.java b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/GreetingService.java new file mode 100644 index 00000000..520ec15d --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/GreetingService.java @@ -0,0 +1,188 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.se; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonArrayBuilder; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.integrations.microstream.core.EmbeddedStorageManagerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * Get the logs: + * curl -X GET http://localhost:8080/greet/logs + * + * The message is returned as a JSON object + */ + +public class GreetingService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetingService.class.getName()); + + private final GreetingServiceMicrostreamContext mctx; + + GreetingService(Config config) { + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + + mctx = new GreetingServiceMicrostreamContext(EmbeddedStorageManagerBuilder.create(config.get("microstream"))); + // we need to initialize the root element first + // if we do not wait here, we have a race where HTTP method may be invoked before we initialize root + mctx.start().await(); + mctx.initRootElement(); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/logs", this::getLog) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + private void getLog(ServerRequest request, + ServerResponse response) { + + mctx.getLogs().thenAccept((logs) -> { + JsonArrayBuilder arrayBuilder = JSON.createArrayBuilder(); + logs.forEach((entry) -> arrayBuilder.add( + JSON.createObjectBuilder() + .add("name", entry.getName()) + .add("time", entry.getDateTime().toString()) + )); + response.send(arrayBuilder.build()); + }).exceptionally(e -> processErrors(e, request, response)); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + mctx.addLogEntry(name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + ex.printStackTrace(); + + if (ex.getCause() instanceof JsonException) { + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } + +} diff --git a/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/GreetingServiceMicrostreamContext.java b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/GreetingServiceMicrostreamContext.java new file mode 100644 index 00000000..b86a0f00 --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/GreetingServiceMicrostreamContext.java @@ -0,0 +1,87 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.se; + +import java.time.LocalDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; + +import io.helidon.common.reactive.Single; + +import one.microstream.storage.embedded.types.EmbeddedStorageManager; + +/** + * This class extends the MicrostreamSingleThreadedExecutionContext and provides + * data access methods using the MicrostreamSingleThreadedExecutionContext. + */ +public class GreetingServiceMicrostreamContext extends MicrostreamSingleThreadedExecutionContext { + + /** + * Create a new GreetingServiceMicrostreamContext. + * + * @param storageManager the EmbeddedStorageManager used. + */ + public GreetingServiceMicrostreamContext(EmbeddedStorageManager storageManager) { + super(storageManager); + } + + /** + * Add and store a new log entry. + * + * @param name paramter for log text. + * @return Void + */ + public CompletableFuture addLogEntry(String name) { + return execute(() -> { + @SuppressWarnings("unchecked") + List logs = (List) storageManager().root(); + logs.add(new LogEntry(name, LocalDateTime.now())); + storageManager().store(logs); + return null; + }); + } + + /** + * initialize the storage root with a new, empty List. + * + * @return Void + */ + public CompletableFuture initRootElement() { + return execute(() -> { + if (storageManager().root() == null) { + storageManager().setRoot(new ArrayList()); + storageManager().storeRoot(); + } + return null; + }); + } + + /** + * returns a List of all stored LogEntries. + * + * @return all LogEntries. + */ + public Single> getLogs() { + @SuppressWarnings("unchecked") + CompletableFuture> completableFuture = CompletableFuture.supplyAsync(() -> { + return (List) storageManager().root(); + }, executor()); + return (Single>) Single.create(completableFuture); + } + +} diff --git a/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/LogEntry.java b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/LogEntry.java new file mode 100644 index 00000000..83e67f94 --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/LogEntry.java @@ -0,0 +1,51 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.se; + +import java.time.LocalDateTime; + +/** + * + * simple POJO that represents a Log entry that is stored by microstream in this example. + * + */ +public class LogEntry { + private String name; + private LocalDateTime dateTime; + + /** + * The Constructor. + * + * @param name name to be logged. + * + * @param dateTime dateTime date and time to be logged + */ + public LogEntry(String name, LocalDateTime dateTime) { + super(); + this.name = name; + this.dateTime = dateTime; + } + + public String getName() { + return name; + } + + public LocalDateTime getDateTime() { + return dateTime; + } + +} diff --git a/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/Main.java b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/Main.java new file mode 100644 index 00000000..c2b30173 --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/Main.java @@ -0,0 +1,105 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.se; + +import java.util.concurrent.TimeUnit; + +import io.helidon.common.LogConfig; +import io.helidon.config.ClasspathConfigSource; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Microstream demo with a simple rest application. + */ +public class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * + * @param args command line arguments. + */ + public static void main(String[] args) { + startServer(); + } + + static WebServer startServer() { + + LogConfig.configureRuntime(); + Config config = Config.builder() + .addSource(ClasspathConfigSource.create("/application.yaml")) + .build(); + + // Build server with JSONP support + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + server.start() + .thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }) + .await(10, TimeUnit.SECONDS); + + // Server threads are not daemon. No need to block. Just react. + return server; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + GreetingService greetService = new GreetingService(config); + + return Routing.builder() + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register("/greet", greetService) + .build(); + } +} diff --git a/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/MicrostreamSingleThreadedExecutionContext.java b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/MicrostreamSingleThreadedExecutionContext.java new file mode 100644 index 00000000..8f55e740 --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/MicrostreamSingleThreadedExecutionContext.java @@ -0,0 +1,163 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.se; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.function.Supplier; + +import io.helidon.common.reactive.Single; + +import one.microstream.reference.LazyReferenceManager; +import one.microstream.storage.embedded.types.EmbeddedStorageManager; + +/** + * + * The MicrostreamSingleThreadedExecutionContext provides a very simply way to ensure + * thread safe access to a Microstream storage and it's associated data. + * + * This example just uses a single-treaded ExecutorService to avoid the need to manually synchronize + * any multi-threaded access to the storage and the user provided object-graph. + * + */ +public class MicrostreamSingleThreadedExecutionContext { + + private final EmbeddedStorageManager storage; + private final ExecutorService executor; + + /** + * Creates a MicrostreamSingleThreadedExecutionContext. + * + * @param storageManager the used EmbeddedStorageManager. + */ + public MicrostreamSingleThreadedExecutionContext(EmbeddedStorageManager storageManager) { + this.storage = storageManager; + this.executor = Executors.newSingleThreadExecutor(); + } + + /** + * returns the used storageManager. + * + * @return the used EmbeddedStorageManager. + */ + public EmbeddedStorageManager storageManager() { + return storage; + } + + /** + * returns the used ExecutorService. + * + * @return the used ExecutorService. + */ + public ExecutorService executor() { + return executor; + } + + /** + * Start the storage. + * + * @return a Single providing the started EmbeddedStorageManager. + */ + public Single start() { + CompletableFuture completableFuture = CompletableFuture.supplyAsync( + storage::start, executor); + + return Single.create(completableFuture); + } + + /** + * Shutdown the storage. + * + * @return a Single providing stopped EmbeddedStorageManager. + */ + public Single shutdown() { + CompletableFuture completableFuture = CompletableFuture.supplyAsync( + () -> { + storage.shutdown(); + LazyReferenceManager.get().stop(); + executor.shutdown(); + return storage; + }, executor); + + return Single.create(completableFuture); + } + + /** + * Return the persistent object graph's root object. + * + * @param type of the root object + * @return a Single containing the graph's root object casted to + */ + public Single root() { + @SuppressWarnings("unchecked") + CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> { + return (T) storage.root(); + }, executor); + return Single.create(completableFuture); + } + + /** + * Sets the passed instance as the new root for the persistent object graph. + * + * @param object the new root object + * @return Single containing the new root object + */ + public Single setRoot(Object object) { + CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> { + return storage.setRoot(object); + }, executor); + return Single.create(completableFuture); + } + + /** + * Stores the registered root instance. + * + * @return Single containing the root instance's objectId. + */ + public Single storeRoot() { + CompletableFuture completableFuture = CompletableFuture.supplyAsync(storage::storeRoot, executor); + return Single.create(completableFuture); + } + + /** + * Stores the passed object. + * + * @param object + * @return Single containing the object id representing the passed instance. + */ + public Single store(Object object) { + CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> { + return storage.store(object); + }, executor); + return Single.create(completableFuture); + } + + /** + * Creates a new CompletableFuture that executes in this context. + * + * @param the return type + * @param supplier a function returning the value to be used to complete the returned CompletableFuture + * @return the new CompletableFuture + */ + public CompletableFuture execute(Supplier supplier) { + CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> { + return supplier.get(); + }, executor); + return completableFuture; + } +} diff --git a/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/package-info.java b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/package-info.java new file mode 100644 index 00000000..5fa972bf --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/main/java/io/helidon/examples/integrations/microstream/greetings/se/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * An example that uses Microstream to persist a log entry for every greeting. + */ +package io.helidon.examples.integrations.microstream.greetings.se; diff --git a/examples/integrations/microstream/greetings-se/src/main/resources/application.yaml b/examples/integrations/microstream/greetings-se/src/main/resources/application.yaml new file mode 100644 index 00000000..d22a1bae --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/main/resources/application.yaml @@ -0,0 +1,26 @@ +# +# 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 + +microstream: + channel-count: 4 + housekeeping-interval: 2000ms diff --git a/examples/integrations/microstream/greetings-se/src/test/java/io/helidon/examples/integrations/microstream/greetings/se/MicrostreamExampleGreetingsSeTest.java b/examples/integrations/microstream/greetings-se/src/test/java/io/helidon/examples/integrations/microstream/greetings/se/MicrostreamExampleGreetingsSeTest.java new file mode 100644 index 00000000..cb10afed --- /dev/null +++ b/examples/integrations/microstream/greetings-se/src/test/java/io/helidon/examples/integrations/microstream/greetings/se/MicrostreamExampleGreetingsSeTest.java @@ -0,0 +1,82 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.microstream.greetings.se; + +import java.nio.file.Path; +import java.util.concurrent.TimeUnit; + +import javax.json.JsonArray; +import javax.json.JsonObject; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.notNullValue; +import static org.hamcrest.MatcherAssert.assertThat; + +public class MicrostreamExampleGreetingsSeTest { + + private static WebServer webServer; + private static WebClient webClient; + + @TempDir + static Path tempDir; + + @BeforeAll + static void startServer() throws Exception { + System.setProperty("microstream.storage-directory", tempDir.toString()); + + webServer = Main.startServer(); + + webClient = WebClient.builder().baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()).build(); + } + + @AfterAll + static void stopServer() throws Exception { + if (webServer != null) { + webServer.shutdown().await(10, TimeUnit.SECONDS); + } + } + + @Test + void testExample() { + JsonObject jsonObject = webClient + .get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(10, TimeUnit.SECONDS); + + assertThat(jsonObject.getString("message"), is("Hello Joe!")); + + JsonArray jsonArray = webClient + .get() + .path("/greet/logs") + .request(JsonArray.class) + .await(10, TimeUnit.SECONDS); + + assertThat(jsonArray.get(0).asJsonObject().getString("name"), is("Joe")); + assertThat(jsonArray.get(0).asJsonObject().getString("time"), notNullValue()); + } +} diff --git a/examples/integrations/microstream/pom.xml b/examples/integrations/microstream/pom.xml new file mode 100644 index 00000000..c9929b59 --- /dev/null +++ b/examples/integrations/microstream/pom.xml @@ -0,0 +1,38 @@ + + + + 4.0.0 + + io.helidon.examples.integrations + helidon-examples-integrations-project + 1.0.0-SNAPSHOT + + + io.helidon.examples.integrations.microstream + helidon-examples-integrations-microstream-project + Helidon Microstream Integration Examples + pom + + + greetings-se + greetings-mp + + diff --git a/examples/integrations/neo4j/neo4j-mp/.dockerignore b/examples/integrations/neo4j/neo4j-mp/.dockerignore new file mode 100644 index 00000000..c8b241f2 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/.dockerignore @@ -0,0 +1 @@ +target/* \ No newline at end of file diff --git a/examples/integrations/neo4j/neo4j-mp/Dockerfile b/examples/integrations/neo4j/neo4j-mp/Dockerfile new file mode 100644 index 00000000..2bb94aa5 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/Dockerfile @@ -0,0 +1,44 @@ +# +# 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-integration-neo4j-mp.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-examples-integration-neo4j-mp.jar"] + +EXPOSE 8080 diff --git a/examples/integrations/neo4j/neo4j-mp/Dockerfile.jlink b/examples/integrations/neo4j/neo4j-mp/Dockerfile.jlink new file mode 100644 index 00000000..ba809209 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/Dockerfile.jlink @@ -0,0 +1,40 @@ +# +# 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. +# + +# 1st stage, build the app +FROM maven:3.6.3-jdk-11-slim as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build to create the custom Java Runtime Image +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pjlink-image -DskipTests +RUN echo "done!" + +# 2nd stage, build the final image with the JRI built in the 1st stage + +FROM debian:stretch-slim +WORKDIR /helidon +COPY --from=build /helidon/target/helidon-examples-integration-neo4j-mp-jri ./ +ENTRYPOINT ["/bin/bash", "/helidon/bin/start"] +EXPOSE 8080 diff --git a/examples/integrations/neo4j/neo4j-mp/Dockerfile.native b/examples/integrations/neo4j/neo4j-mp/Dockerfile.native new file mode 100644 index 00000000..5a4170d0 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/Dockerfile.native @@ -0,0 +1,44 @@ +# +# 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. +# + +# 1st stage, build the app +FROM helidon/jdk11-graalvm-maven:20.2.0 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Pnative-image -Dnative.image.skip -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pnative-image -Dnative.image.buildStatic -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM scratch +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-integration-neo4j-mp . + +ENTRYPOINT ["./helidon-examples-integration-neo4j-mp"] + +EXPOSE 8080 diff --git a/examples/integrations/neo4j/neo4j-mp/README.md b/examples/integrations/neo4j/neo4j-mp/README.md new file mode 100644 index 00000000..e01c8534 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/README.md @@ -0,0 +1,166 @@ +# Helidon Quickstart MP Example + +This example implements a simple Neo4j REST service using MicroProfile. + +## Build and run + +Bring up a Neo4j instance via Docker + +```shell +docker run --publish=7474:7474 --publish=7687:7687 -e 'NEO4J_AUTH=neo4j/secret' neo4j:4.0 +``` + +Goto the Neo4j browser and play the first step of the movies graph: [`:play movies`](http://localhost:7474/browser/?cmd=play&arg=movies). + + +Then build +```shell +mvn package -DskipTests +java -jar target/helidon-examples-integration-neo4j-mp.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/movies +``` + +## Try health and metrics + +```shell +curl -s -X GET http://localhost:8080/health +#{"outcome":"UP",... +#. . . + +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics +# TYPE base:gc_g1_young_generation_count gauge +#. . . + +# JSON Format +curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics +#{"base":... +#. . . + +``` + +## Build the Docker Image + +```shell +docker build -t helidon-integrations-neo4j-mp . +``` + +## Start the application with Docker + +```shell +docker run --rm -p 8080:8080 helidon-integrations-neo4j-mp:latest +``` + +Exercise the application as described above + +## Deploy the application to Kubernetes + +```shell +kubectl cluster-info # Verify which cluster +kubectl get pods # Verify connectivity to cluster +kubectl create -f app.yaml # Deploy application +kubectl get service helidon-integrations-neo4j-mp # Verify deployed service +``` + +## Build a native image with GraalVM + +GraalVM allows you to compile your programs ahead-of-time into a native + executable. See https://www.graalvm.org/docs/reference-manual/aot-compilation/ + for more information. + +You can build a native executable in 2 different ways: +* With a local installation of GraalVM +* Using Docker + +### Local build + +Download Graal VM at https://www.graalvm.org/downloads. We recommend +version `20.1.0` or later. + +```shell +# Setup the environment +export GRAALVM_HOME=/path +# build the native executable +mvn package -Pnative-image +``` + +You can also put the Graal VM `bin` directory in your PATH, or pass + `-DgraalVMHome=/path` to the Maven command. + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-native-image + for more information. + +Start the application: + +```shell +./target/helidon-quickstart-mp +``` + +### Multi-stage Docker build + +Build the "native" Docker Image + +```shell +docker build -t helidon-integrations-neo4j-mp-native -f Dockerfile.native . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-integrations-neo4j-mp-native:latest +``` + + +## Build a Java Runtime Image using jlink + +You can build a custom Java Runtime Image (JRI) containing the application jars and the JDK modules +on which they depend. This image also: + +* Enables Class Data Sharing by default to reduce startup time. +* Contains a customized `start` script to simplify CDS usage and support debug and test modes. + +You can build a custom JRI in two different ways: +* Local +* Using Docker + + +### Local build + +```shell +# build the JRI +mvn package -Pjlink-image +``` + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-jlink-image + for more information. + +Start the application: + +```shell +./target/helidon-integrations-neo4j-mp-jri/bin/start +``` + +### Multi-stage Docker build + +Build the JRI as a Docker Image + +```shell +docker build -t helidon-integrations-neo4j-mp-jri -f Dockerfile.jlink . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-integrations-neo4j-mp-jri:latest +``` + +See the start script help: + +```shell +docker run --rm helidon-integrations-neo4j-mp-jri:latest --help +``` diff --git a/examples/integrations/neo4j/neo4j-mp/app.yaml b/examples/integrations/neo4j/neo4j-mp/app.yaml new file mode 100644 index 00000000..63d384a5 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/app.yaml @@ -0,0 +1,50 @@ +# +# 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: helidon-examples-integration-neo4j-mp + labels: + app: helidon-examples-integration-neo4j-mp +spec: + type: NodePort + selector: + app: helidon-examples-integration-neo4j-mp + ports: + - port: 8080 + targetPort: 8080 + name: http +--- +kind: Deployment +apiVersion: extensions/v1beta1 +metadata: + name: helidon-examples-integration-neo4j-mp +spec: + replicas: 1 + template: + metadata: + labels: + app: helidon-examples-integration-neo4j-mp + version: v1 + spec: + containers: + - name: helidon-examples-integration-neo4j-mp + image: helidon-examples-integration-neo4j-mp + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 +--- diff --git a/examples/integrations/neo4j/neo4j-mp/pom.xml b/examples/integrations/neo4j/neo4j-mp/pom.xml new file mode 100644 index 00000000..8d2767ec --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/pom.xml @@ -0,0 +1,154 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.neo4j + helidon-examples-integrations-neo4j-mp + 1.0.0-SNAPSHOT + Helidon Neo4j MP integration Example + + + 4.4.3 + 11.0.7 + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.integrations.neo4j + helidon-integrations-neo4j + + + io.helidon.integrations.neo4j + helidon-integrations-neo4j-metrics + + + io.helidon.integrations.neo4j + helidon-integrations-neo4j-health + + + + + org.jboss + jandex + runtime + true + + + + + + org.neo4j.test + neo4j-harness + ${neo4j-harness.version} + test + + + org.slf4j + slf4j-nop + + + org.junit.vintage + junit-vintage-engine + + + org.neo4j.app + neo4j-server + + + + + org.neo4j.app + neo4j-server + ${neo4j-harness.version} + test + + + * + * + + + + + org.eclipse.jetty + jetty-util + ${jetty-util.version} + test + + + org.junit.jupiter + junit-jupiter-api + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + + --add-exports=java.base/sun.nio.ch=ALL-UNNAMED + --add-opens=java.base/java.lang=ALL-UNNAMED + --add-opens=java.base/java.lang.reflect=ALL-UNNAMED + --add-opens=java.base/java.io=ALL-UNNAMED + --add-opens=java.base/java.nio=ALL-UNNAMED + --add-exports=jdk.unsupported/sun.misc=ALL-UNNAMED + + + + + + diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/Neo4jResource.java b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/Neo4jResource.java new file mode 100644 index 00000000..68a1759f --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/Neo4jResource.java @@ -0,0 +1,64 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.neo4j.mp; + +import java.util.List; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +import io.helidon.examples.integrations.neo4j.mp.domain.Movie; +import io.helidon.examples.integrations.neo4j.mp.domain.MovieRepository; + +/** + * REST endpoint for movies. + */ +@Path("/movies") +@RequestScoped +public class Neo4jResource { + /** + * The greeting message provider. + */ + private final MovieRepository movieRepository; + + /** + * Constructor. + * + * @param movieRepository + */ + @Inject + public Neo4jResource(MovieRepository movieRepository) { + this.movieRepository = movieRepository; + } + + /** + * All movies. + * + * @return json String with all movies + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public List getAllMovies() { + return movieRepository.findAll(); + } + +} + diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Actor.java b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Actor.java new file mode 100644 index 00000000..4fa2a047 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Actor.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.mp.domain; + +import java.util.ArrayList; +import java.util.List; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ + +/** + * The Actor class. + * + * @author Michael Simons + */ +public class Actor { + + private final String name; + + private final List roles; + + /** + * Constructor. + * + * @param name + * @param roles + */ + public Actor(String name, final List roles) { + this.name = name; + this.roles = new ArrayList<>(roles); + } +} diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Movie.java b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Movie.java new file mode 100644 index 00000000..1173c4ea --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Movie.java @@ -0,0 +1,99 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.mp.domain; + +import java.util.ArrayList; +import java.util.List; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ +/** + * The Movie class. + * + * @author Michael Simons + */ +public class Movie { + + private final String title; + + private final String description; + + private List actors = new ArrayList<>(); + + private List directors = new ArrayList<>(); + + private Integer released; + + /** + * Constructor. + * + * @param title + * @param description + */ + public Movie(String title, String description) { + this.title = title; + this.description = description; + } + + public String getTitle() { + return title; + } + + public List getActors() { + return actors; + } + + public void setActors(List actors) { + this.actors = actors; + } + + public String getDescription() { + return description; + } + + public List getDirectors() { + return directors; + } + + public void setDirectorss(List directors) { + this.directors = directors; + } + + public Integer getReleased() { + return released; + } + + public void setReleased(Integer released) { + this.released = released; + } +} diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/MovieRepository.java b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/MovieRepository.java new file mode 100644 index 00000000..ff822a45 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/MovieRepository.java @@ -0,0 +1,99 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.mp.domain; + +import java.util.List; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.neo4j.driver.Driver; +import org.neo4j.driver.Value; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ + +/** + * The Movies repository. + * + * @author Michael Simons + */ +@ApplicationScoped +public class MovieRepository { + + private final Driver driver; + + /** + * Constructor. + * @param driver + */ + @Inject + public MovieRepository(Driver driver) { + this.driver = driver; + } + + /** + * Return al Movies. + * @return list with movies + */ + public List findAll() { + + try (var session = driver.session()) { + + var query = "" + + "match (m:Movie) " + + "match (m) <- [:DIRECTED] - (d:Person) " + + "match (m) <- [r:ACTED_IN] - (a:Person) " + + "return m, collect(d) as directors, collect({name:a.name, roles: r.roles}) as actors"; + + return session.readTransaction(tx -> tx.run(query).list(r -> { + var movieNode = r.get("m").asNode(); + + var directors = r.get("directors").asList(v -> { + var personNode = v.asNode(); + return new Person(personNode.get("born").asInt(), personNode.get("name").asString()); + }); + + var actors = r.get("actors").asList(v -> { + return new Actor(v.get("name").asString(), v.get("roles").asList(Value::asString)); + }); + + var m = new Movie(movieNode.get("title").asString(), movieNode.get("tagline").asString()); + m.setReleased(movieNode.get("released").asInt()); + m.setDirectorss(directors); + m.setActors(actors); + return m; + })); + } + } +} diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Person.java b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Person.java new file mode 100644 index 00000000..e9bbf5ad --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/Person.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.mp.domain; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ + +/** + * The Person class. + * + * @author Michael Simons + */ +public class Person { + + private final String name; + + private Integer born; + + /** + * Person constructor. + * + * @param born + * @param name + */ + public Person(Integer born, String name) { + this.born = born; + this.name = name; + } + + public String getName() { + return name; + } + + public Integer getBorn() { + return born; + } + + public void setBorn(Integer born) { + this.born = born; + } + + @SuppressWarnings("checkstyle:OperatorWrap") + @Override + public String toString() { + return "Person{" + + "name='" + name + '\'' + + ", born=" + born + + '}'; + } +} diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/package-info.java b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/package-info.java new file mode 100644 index 00000000..eabe9a00 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/domain/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ +/** + * Domain objects for movie DB. + */ +package io.helidon.examples.integrations.neo4j.mp.domain; diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/package-info.java b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/package-info.java new file mode 100644 index 00000000..77f43f67 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * Resources. + */ +package io.helidon.examples.integrations.neo4j.mp; diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/resources/META-INF/beans.xml b/examples/integrations/neo4j/neo4j-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..d703ee7b --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/resources/META-INF/microprofile-config.properties b/examples/integrations/neo4j/neo4j-mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..70f63d64 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,31 @@ +# +# Copyright (c) 2021 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. +# + +# Application properties. This is the default greeting +app.greeting=Hello + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +# Enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=true + +# Neo4j settings +neo4j.uri=bolt://localhost:7687 +neo4j.authentication.username=neo4j +neo4j.authentication.password: secret +neo4j.pool.metricsEnabled: true diff --git a/examples/integrations/neo4j/neo4j-mp/src/main/resources/logging.properties b/examples/integrations/neo4j/neo4j-mp/src/main/resources/logging.properties new file mode 100644 index 00000000..548e2942 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/main/resources/logging.properties @@ -0,0 +1,27 @@ +# +# 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.common.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 diff --git a/examples/integrations/neo4j/neo4j-mp/src/test/java/io/helidon/examples/integrations/neo4j/mp/MainTest.java b/examples/integrations/neo4j/neo4j-mp/src/test/java/io/helidon/examples/integrations/neo4j/mp/MainTest.java new file mode 100644 index 00000000..051d289c --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/test/java/io/helidon/examples/integrations/neo4j/mp/MainTest.java @@ -0,0 +1,126 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.neo4j.mp; + +import javax.enterprise.inject.se.SeContainer; +import javax.enterprise.inject.spi.CDI; +import javax.json.JsonArray; +import javax.json.JsonObject; +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; + +import io.helidon.microprofile.server.Server; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.neo4j.harness.Neo4j; +import org.neo4j.harness.Neo4jBuilders; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Main tests of the application done here. + */ +class MainTest { + private static Server server; + private static Neo4j embeddedDatabaseServer; + + @BeforeAll + public static void startTheServer() throws Exception { + + embeddedDatabaseServer = Neo4jBuilders.newInProcessBuilder() + .withDisabledServer() + .withFixture(FIXTURE) + .build(); + + System.setProperty("neo4j.uri", embeddedDatabaseServer.boltURI().toString()); + + server = Server.create().start(); + + } + + @AfterAll + static void destroyClass() { + CDI current = CDI.current(); + ((SeContainer) current).close(); + embeddedDatabaseServer.close(); + } + + + @Test + void testMovies() { + + Client client = ClientBuilder.newClient(); + + JsonArray jsorArray = client + .target(getConnectionString("/movies")) + .request() + .get(JsonArray.class); + JsonObject first = jsorArray.getJsonObject(0); + assertThat(first.getString("title"), is("The Matrix Reloaded")); + + } + + private String getConnectionString(String path) { + return "http://localhost:" + server.port() + path; + } + + static final String FIXTURE = "" + + "CREATE (TheMatrix:Movie {title:'The Matrix', released:1999, tagline:'Welcome to the Real World'})\n" + + "CREATE (Keanu:Person {name:'Keanu Reeves', born:1964})\n" + + "CREATE (Carrie:Person {name:'Carrie-Anne Moss', born:1967})\n" + + "CREATE (Laurence:Person {name:'Laurence Fishburne', born:1961})\n" + + "CREATE (Hugo:Person {name:'Hugo Weaving', born:1960})\n" + + "CREATE (LillyW:Person {name:'Lilly Wachowski', born:1967})\n" + + "CREATE (LanaW:Person {name:'Lana Wachowski', born:1965})\n" + + "CREATE (JoelS:Person {name:'Joel Silver', born:1952})\n" + + "CREATE (KevinB:Person {name:'Kevin Bacon', born:1958})\n" + + "CREATE\n" + + "(Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrix),\n" + + "(Carrie)-[:ACTED_IN {roles:['Trinity']}]->(TheMatrix),\n" + + "(Laurence)-[:ACTED_IN {roles:['Morpheus']}]->(TheMatrix),\n" + + "(Hugo)-[:ACTED_IN {roles:['Agent Smith']}]->(TheMatrix),\n" + + "(LillyW)-[:DIRECTED]->(TheMatrix),\n" + + "(LanaW)-[:DIRECTED]->(TheMatrix),\n" + + "(JoelS)-[:PRODUCED]->(TheMatrix)\n" + + "\n" + + "CREATE (Emil:Person {name:\"Emil Eifrem\", born:1978})\n" + + "CREATE (Emil)-[:ACTED_IN {roles:[\"Emil\"]}]->(TheMatrix)\n" + + "\n" + + "CREATE (TheMatrixReloaded:Movie {title:'The Matrix Reloaded', released:2003, tagline:'Free your mind'})\n" + + "CREATE\n" + + "(Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixReloaded),\n" + + "(Carrie)-[:ACTED_IN {roles:['Trinity']}]->(TheMatrixReloaded),\n" + + "(Laurence)-[:ACTED_IN {roles:['Morpheus']}]->(TheMatrixReloaded),\n" + + "(Hugo)-[:ACTED_IN {roles:['Agent Smith']}]->(TheMatrixReloaded),\n" + + "(LillyW)-[:DIRECTED]->(TheMatrixReloaded),\n" + + "(LanaW)-[:DIRECTED]->(TheMatrixReloaded),\n" + + "(JoelS)-[:PRODUCED]->(TheMatrixReloaded)\n" + + "\n" + + "CREATE (TheMatrixRevolutions:Movie {title:'The Matrix Revolutions', released:2003, tagline:'Everything that has a beginning has an end'})\n" + + "CREATE\n" + + "(Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixRevolutions),\n" + + "(Carrie)-[:ACTED_IN {roles:['Trinity']}]->(TheMatrixRevolutions),\n" + + "(Laurence)-[:ACTED_IN {roles:['Morpheus']}]->(TheMatrixRevolutions),\n" + + "(KevinB)-[:ACTED_IN {roles:['Unknown']}]->(TheMatrixRevolutions),\n" + + "(Hugo)-[:ACTED_IN {roles:['Agent Smith']}]->(TheMatrixRevolutions),\n" + + "(LillyW)-[:DIRECTED]->(TheMatrixRevolutions),\n" + + "(LanaW)-[:DIRECTED]->(TheMatrixRevolutions),\n" + + "(JoelS)-[:PRODUCED]->(TheMatrixRevolutions)\n"; +} diff --git a/examples/integrations/neo4j/neo4j-mp/src/test/java/io/helidon/examples/integrations/neo4j/mp/package-info.java b/examples/integrations/neo4j/neo4j-mp/src/test/java/io/helidon/examples/integrations/neo4j/mp/package-info.java new file mode 100644 index 00000000..14f0fffb --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/test/java/io/helidon/examples/integrations/neo4j/mp/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * Tests for MP Neo4j app. + */ +package io.helidon.examples.integrations.neo4j.mp; \ No newline at end of file diff --git a/examples/integrations/neo4j/neo4j-mp/src/test/resources/META-INF/microprofile-config.properties b/examples/integrations/neo4j/neo4j-mp/src/test/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..0f7f7a9d --- /dev/null +++ b/examples/integrations/neo4j/neo4j-mp/src/test/resources/META-INF/microprofile-config.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2021 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. +# + + +# Override configuration to use a random port for the unit tests +config_ordinal=1000 +# Microprofile server properties +server.port=-1 +server.host=0.0.0.0 diff --git a/examples/integrations/neo4j/neo4j-se/.dockerignore b/examples/integrations/neo4j/neo4j-se/.dockerignore new file mode 100644 index 00000000..c8b241f2 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/.dockerignore @@ -0,0 +1 @@ +target/* \ No newline at end of file diff --git a/examples/integrations/neo4j/neo4j-se/Dockerfile b/examples/integrations/neo4j/neo4j-se/Dockerfile new file mode 100644 index 00000000..0588e5d7 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/Dockerfile @@ -0,0 +1,45 @@ +# +# 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-integration-neo4j-se.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-examples-integration-neo4j-se.jar"] + +EXPOSE 8080 diff --git a/examples/integrations/neo4j/neo4j-se/Dockerfile.jlink b/examples/integrations/neo4j/neo4j-se/Dockerfile.jlink new file mode 100644 index 00000000..5414ba07 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/Dockerfile.jlink @@ -0,0 +1,40 @@ +# +# 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. +# + +# 1st stage, build the app +FROM maven:3.6.3-jdk-11-slim as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build to create the custom Java Runtime Image +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pjlink-image -DskipTests +RUN echo "done!" + +# 2nd stage, build the final image with the JRI built in the 1st stage + +FROM debian:stretch-slim +WORKDIR /helidon +COPY --from=build /helidon/target/helidon-examples-integration-neo4j-se-jri ./ +ENTRYPOINT ["/bin/bash", "/helidon/bin/start"] +EXPOSE 8080 diff --git a/examples/integrations/neo4j/neo4j-se/Dockerfile.native b/examples/integrations/neo4j/neo4j-se/Dockerfile.native new file mode 100644 index 00000000..de1edd75 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/Dockerfile.native @@ -0,0 +1,44 @@ +# +# 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. +# + +# 1st stage, build the app +FROM helidon/jdk11-graalvm-maven:20.2.0 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Pnative-image -Dnative.image.skip -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pnative-image -Dnative.image.buildStatic -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM scratch +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-integration-neo4j-se . + +ENTRYPOINT ["./helidon-examples-integration-neo4j-se"] + +EXPOSE 8080 diff --git a/examples/integrations/neo4j/neo4j-se/README.md b/examples/integrations/neo4j/neo4j-se/README.md new file mode 100644 index 00000000..0a56a5a5 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/README.md @@ -0,0 +1,183 @@ +# Helidon SE integration with Neo4J example + +## Build and run + +Bring up a Neo4j instance via Docker + +```shell +docker run --publish=7474:7474 --publish=7687:7687 -e 'NEO4J_AUTH=neo4j/secret' neo4j:4.0 +``` + +Goto the Neo4j browser and play the first step of the movies graph: [`:play movies`](http://localhost:7474/browser/?cmd=play&arg=movies). + +Build and run with With JDK11+ +```shell +mvn package -DskipTests +java -jar target/helidon-examples-integration-neo4j-se.jar +``` + +Then access the rest API like this: + +```shell +curl localhost:8080/api/movies +``` + +#Health and metrics + +Heo4jSupport provides health checks and metrics reading from Neo4j. + +To enable them add to routing: +```java +// metrics +Neo4jMetricsSupport.builder() + .driver(neo4j.driver()) + .build() + .initialize(); +// health checks +HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .addReadiness(Neo4jHealthCheck.create(neo4j.driver())) + .build(); + +return Routing.builder() + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register(movieService) + .build(); +``` +and enable them in the driver: +```yaml + pool: + metricsEnabled: true +``` + + +```shell +curl localhost:8080/health +``` + +```shell +curl localhost:8080/metrics +``` + + + +## Build the Docker Image + +```shell +docker build -t helidon-integrations-heo4j-se . +``` + +## Start the application with Docker + +```shell +docker run --rm -p 8080:8080 helidon-integrations-heo4j-se:latest +``` + +Exercise the application as described above + +## Deploy the application to Kubernetes + +```shell +kubectl cluster-info # Verify which cluster +kubectl get pods # Verify connectivity to cluster +kubectl create -f app.yaml # Deply application +kubectl get service helidon-integrations-heo4j-se # Get service info +``` + +## Build a native image with GraalVM + +GraalVM allows you to compile your programs ahead-of-time into a native + executable. See https://www.graalvm.org/docs/reference-manual/aot-compilation/ + for more information. + +You can build a native executable in 2 different ways: +* With a local installation of GraalVM +* Using Docker + +### Local build + +Download Graal VM at https://www.graalvm.org/downloads. We recommend +version `20.1.0` or later. + +```shell +# Setup the environment +export GRAALVM_HOME=/path +# build the native executable +mvn package -Pnative-image +``` + +You can also put the Graal VM `bin` directory in your PATH, or pass + `-DgraalVMHome=/path` to the Maven command. + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-native-image + for more information. + +Start the application: + +```shell +./target/helidon-integrations-heo4j-se +``` + +### Multi-stage Docker build + +Build the "native" Docker Image + +```shell +docker build -t helidon-integrations-heo4j-se-native -f Dockerfile.native . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-integrations-heo4j-se-native:latest +``` + +## Build a Java Runtime Image using jlink + +You can build a custom Java Runtime Image (JRI) containing the application jars and the JDK modules +on which they depend. This image also: + +* Enables Class Data Sharing by default to reduce startup time. +* Contains a customized `start` script to simplify CDS usage and support debug and test modes. + +You can build a custom JRI in two different ways: +* Local +* Using Docker + + +### Local build + +```shell +# build the JRI +mvn package -Pjlink-image +``` + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-jlink-image + for more information. + +Start the application: + +```shell +./target/helidon-integrations-heo4j-se-jri/bin/start +``` + +### Multi-stage Docker build + +Build the JRI as a Docker Image + +```shell +docker build -t helidon-integrations-heo4j-se-jri -f Dockerfile.jlink . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-integrations-heo4j-se-jri:latest +``` + +See the start script help: + +```shell +docker run --rm helidon-integrations-heo4j-se-jri:latest --help +``` diff --git a/examples/integrations/neo4j/neo4j-se/app.yaml b/examples/integrations/neo4j/neo4j-se/app.yaml new file mode 100644 index 00000000..9cc722cb --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/app.yaml @@ -0,0 +1,50 @@ +# +# 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: helidon-examples-integration-neo4j-se + labels: + app: helidon-examples-integration-neo4j-se +spec: + type: NodePort + selector: + app: helidon-examples-integration-neo4j-se + ports: + - port: 8080 + targetPort: 8080 + name: http +--- +kind: Deployment +apiVersion: extensions/v1beta1 +metadata: + name: helidon-examples-integration-neo4j-se +spec: + replicas: 1 + template: + metadata: + labels: + app: helidon-examples-integration-neo4j-se + version: v1 + spec: + containers: + - name: helidon-examples-integration-neo4j-se + image: helidon-examples-integration-neo4j-se + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 +--- diff --git a/examples/integrations/neo4j/neo4j-se/pom.xml b/examples/integrations/neo4j/neo4j-se/pom.xml new file mode 100644 index 00000000..96ae30cf --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/pom.xml @@ -0,0 +1,143 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.integrations.neo4j + helidon-examples-integrations-neo4j-se + 1.0.0-SNAPSHOT + Helidon Integrations Neo4j SE Example + + + io.helidon.examples.integrations.neo4j.se.Main + 4.4.3 + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.media + helidon-media-jsonb + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + runtime + + + io.helidon.integrations.neo4j + helidon-integrations-neo4j + + + io.helidon.integrations.neo4j + helidon-integrations-neo4j-metrics + + + io.helidon.integrations.neo4j + helidon-integrations-neo4j-health + + + org.junit.jupiter + junit-jupiter-api + test + + + io.helidon.webclient + helidon-webclient + test + + + + org.neo4j.test + neo4j-harness + ${neo4j-harness.version} + test + + + org.junit.vintage + junit-vintage-engine + + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + + --add-exports=java.base/sun.nio.ch=ALL-UNNAMED + --add-opens=java.base/java.lang=ALL-UNNAMED + --add-opens=java.base/java.lang.reflect=ALL-UNNAMED + --add-opens=java.base/java.io=ALL-UNNAMED + --add-opens=java.base/java.nio=ALL-UNNAMED + --add-exports=jdk.unsupported/sun.misc=ALL-UNNAMED + + + + + + diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/Main.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/Main.java new file mode 100644 index 00000000..0fb6dfc8 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/Main.java @@ -0,0 +1,138 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.neo4j.se; + +import java.io.IOException; +import java.io.InputStream; +import java.util.logging.LogManager; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.examples.integrations.neo4j.se.domain.MovieRepository; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.integrations.neo4j.Neo4j; +import io.helidon.integrations.neo4j.health.Neo4jHealthCheck; +import io.helidon.integrations.neo4j.metrics.Neo4jMetricsSupport; +import io.helidon.media.jsonb.JsonbSupport; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.neo4j.driver.Driver; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + * @throws IOException if there are problems reading logging properties + */ + public static void main(final String[] args) throws IOException { + startServer(); + } + + /** + * Start the server. + * @return the created WebServer instance + */ + public static Single startServer() { + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + Single server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .addMediaSupport(JsonbSupport.create()) + .build() + .start(); + + server.thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/api/movies"); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + return server; + } + + /** + * Creates new Routing. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + + Neo4j neo4j = Neo4j.create(config.get("neo4j")); + + // registers all metrics + Neo4jMetricsSupport.builder() + .driver(neo4j.driver()) + .build() + .initialize(); + + Neo4jHealthCheck healthCheck = Neo4jHealthCheck.create(neo4j.driver()); + + Driver neo4jDriver = neo4j.driver(); + + MovieService movieService = new MovieService(new MovieRepository(neo4jDriver)); + + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .addReadiness(healthCheck) + .build(); + + return Routing.builder() + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register(movieService) + .build(); + } + + /** + * Configure logging from logging.properties file. + */ + private static void setupLogging() throws IOException { + try (InputStream is = Main.class.getResourceAsStream("/logging.properties")) { + LogManager.getLogManager().readConfiguration(is); + } + } + +} diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/MovieService.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/MovieService.java new file mode 100644 index 00000000..3f7c321a --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/MovieService.java @@ -0,0 +1,54 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.neo4j.se; + +import io.helidon.examples.integrations.neo4j.se.domain.MovieRepository; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * The Movie service. + * + */ +public class MovieService implements Service { + + private final MovieRepository movieRepository; + + /** + * The movies service. + * @param movieRepository + */ + public MovieService(MovieRepository movieRepository) { + this.movieRepository = movieRepository; + } + + /** + * Main routing done here. + * + * @param rules + */ + @Override + public void update(Routing.Rules rules) { + rules.get("/api/movies", this::findMoviesHandler); + } + + private void findMoviesHandler(ServerRequest request, ServerResponse response) { + response.send(this.movieRepository.findAll()); + } +} diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Actor.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Actor.java new file mode 100644 index 00000000..4b12dd61 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Actor.java @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.se.domain; + +import java.util.ArrayList; +import java.util.List; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ + +/** + * The Actor class. + * + * @author Michael Simons + */ +public class Actor { + + private final String name; + + private final List roles; + + /** + * Constructor for actor. + * + * @param name + * @param roles + */ + public Actor(String name, final List roles) { + this.name = name; + this.roles = new ArrayList<>(roles); + } + + public String getName() { + return name; + } + + public List getRoles() { + return roles; + } +} diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Movie.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Movie.java new file mode 100644 index 00000000..3ccc4270 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Movie.java @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.se.domain; + +import java.util.ArrayList; +import java.util.List; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ + +/** + * The Movie class. + * + * @author Michael Simons + */ +public class Movie { + + private final String title; + + private final String description; + + private List actors = new ArrayList<>(); + + private List directors = new ArrayList<>(); + + private Integer released; + + /** + * Constructor for Movie. + * + * @param title + * @param description + */ + public Movie(String title, String description) { + this.title = title; + this.description = description; + } + + public String getTitle() { + return title; + } + + public List getActors() { + return actors; + } + + public void setActors(List actors) { + this.actors = actors; + } + + public String getDescription() { + return description; + } + + public List getDirectors() { + return directors; + } + + public void setDirectorss(List directors) { + this.directors = directors; + } + + public Integer getReleased() { + return released; + } + + public void setReleased(Integer released) { + this.released = released; + } +} diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/MovieRepository.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/MovieRepository.java new file mode 100644 index 00000000..562bf49a --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/MovieRepository.java @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.se.domain; + +import java.util.List; + +import org.neo4j.driver.Driver; +import org.neo4j.driver.Value; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ + +/** + * The Movie repository. + * + * @author Michael Simons + */ +public final class MovieRepository { + + private final Driver driver; + + /** + * Constructor for the repo. + * + * @param driver + */ + public MovieRepository(Driver driver) { + this.driver = driver; + } + + /** + * Returns all the movies. + * @return List with movies + */ + public List findAll(){ + + try (var session = driver.session()) { + + var query = "" + + "match (m:Movie) " + + "match (m) <- [:DIRECTED] - (d:Person) " + + "match (m) <- [r:ACTED_IN] - (a:Person) " + + "return m, collect(d) as directors, collect({name:a.name, roles: r.roles}) as actors"; + + return session.readTransaction(tx -> tx.run(query).list(r -> { + var movieNode = r.get("m").asNode(); + + var directors = r.get("directors").asList(v -> { + var personNode = v.asNode(); + return new Person(personNode.get("born").asInt(), personNode.get("name").asString()); + }); + + var actors = r.get("actors").asList(v -> { + return new Actor(v.get("name").asString(), v.get("roles").asList(Value::asString)); + }); + + var m = new Movie(movieNode.get("title").asString(), movieNode.get("tagline").asString()); + m.setReleased(movieNode.get("released").asInt()); + m.setDirectorss(directors); + m.setActors(actors); + return m; + })); + } + } +} diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Person.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Person.java new file mode 100644 index 00000000..ebd5a7c0 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/Person.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2002-2020 "Neo4j," + * Neo4j Sweden AB [http://neo4j.com] + * This file is part of Neo4j. + * 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.integrations.neo4j.se.domain; + +/* + * Helidon changes are under the copyright of: + * + * Copyright (c) 2021, 2022 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. + */ + +/** + * The Person class. + * + * @author Michael Simons + */ +public class Person { + + private final String name; + + private Integer born; + + /** + * Constrictor for person. + * @param born + * @param name + */ + public Person(Integer born, String name) { + this.born = born; + this.name = name; + } + + public String getName() { + return name; + } + + public Integer getBorn() { + return born; + } + + public void setBorn(Integer born) { + this.born = born; + } + + @SuppressWarnings("checkstyle:OperatorWrap") + @Override + public String toString() { + return "Person{" + + "name='" + name + '\'' + + ", born=" + born + + '}'; + } +} diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/package-info.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/package-info.java new file mode 100644 index 00000000..bef777e2 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/domain/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * Domain objects for movies. + */ +package io.helidon.examples.integrations.neo4j.se.domain; diff --git a/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/package-info.java b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/package-info.java new file mode 100644 index 00000000..bab58c8c --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/java/io/helidon/examples/integrations/neo4j/se/package-info.java @@ -0,0 +1,23 @@ +/* + * 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. + */ + +/** + * SE Neo4j demo application. + *

+ * + * @see io.helidon.examples.integrations.neo4j.se.Main + */ +package io.helidon.examples.integrations.neo4j.se; diff --git a/examples/integrations/neo4j/neo4j-se/src/main/resources/application.yaml b/examples/integrations/neo4j/neo4j-se/src/main/resources/application.yaml new file mode 100644 index 00000000..74153354 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/resources/application.yaml @@ -0,0 +1,29 @@ +# +# 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. +# + + +server: + port: 8080 + host: 0.0.0.0 + + +neo4j: + uri: bolt://localhost:7687 + authentication: + username: neo4j + password: secret + pool: + metricsEnabled: true diff --git a/examples/integrations/neo4j/neo4j-se/src/main/resources/logging.properties b/examples/integrations/neo4j/neo4j-se/src/main/resources/logging.properties new file mode 100644 index 00000000..1395ed17 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/integrations/neo4j/neo4j-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java b/examples/integrations/neo4j/neo4j-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java new file mode 100644 index 00000000..8c7d76a4 --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java @@ -0,0 +1,152 @@ +/* + * 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. + */ + +package io.helidon.examples.quickstart.se; + +import java.util.concurrent.TimeUnit; + +import javax.json.JsonArray; + +import io.helidon.common.http.Http; +import io.helidon.examples.integrations.neo4j.se.Main; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.neo4j.harness.Neo4j; +import org.neo4j.harness.Neo4jBuilders; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Main test class for Neo4j Helidon SE quickstarter. + */ +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + + private static Neo4j embeddedDatabaseServer; + + @BeforeAll + static void startTheServer() { + + embeddedDatabaseServer = Neo4jBuilders.newInProcessBuilder() + .withDisabledServer() + .withFixture(FIXTURE) + .build(); + + System.setProperty("neo4j.uri", embeddedDatabaseServer.boltURI().toString()); + + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + if (embeddedDatabaseServer != null) { + embeddedDatabaseServer.close(); + } + } + + @Test + void testMovies() { + + JsonArray result = webClient.get() + .path("api/movies") + .request(JsonArray.class) + .await(); + + assertThat(result.getJsonObject(0).getString("title"), is("The Matrix Reloaded")); + } + + @Test + public void testHealth() { + + WebClientResponse response = webClient.get() + .path("/health") + .request() + .await(); + + assertThat(response.status(), is(Http.Status.OK_200)); + } + + @Test + public void testMetrics() { + WebClientResponse response = webClient.get() + .path("/metrics") + .request() + .await(); + + assertThat(response.status(), is(Http.Status.OK_200)); + } + + static final String FIXTURE = "" + + "CREATE (TheMatrix:Movie {title:'The Matrix', released:1999, tagline:'Welcome to the Real World'})\n" + + "CREATE (Keanu:Person {name:'Keanu Reeves', born:1964})\n" + + "CREATE (Carrie:Person {name:'Carrie-Anne Moss', born:1967})\n" + + "CREATE (Laurence:Person {name:'Laurence Fishburne', born:1961})\n" + + "CREATE (Hugo:Person {name:'Hugo Weaving', born:1960})\n" + + "CREATE (LillyW:Person {name:'Lilly Wachowski', born:1967})\n" + + "CREATE (LanaW:Person {name:'Lana Wachowski', born:1965})\n" + + "CREATE (JoelS:Person {name:'Joel Silver', born:1952})\n" + + "CREATE (KevinB:Person {name:'Kevin Bacon', born:1958})\n" + + "CREATE\n" + + "(Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrix),\n" + + "(Carrie)-[:ACTED_IN {roles:['Trinity']}]->(TheMatrix),\n" + + "(Laurence)-[:ACTED_IN {roles:['Morpheus']}]->(TheMatrix),\n" + + "(Hugo)-[:ACTED_IN {roles:['Agent Smith']}]->(TheMatrix),\n" + + "(LillyW)-[:DIRECTED]->(TheMatrix),\n" + + "(LanaW)-[:DIRECTED]->(TheMatrix),\n" + + "(JoelS)-[:PRODUCED]->(TheMatrix)\n" + + "\n" + + "CREATE (Emil:Person {name:\"Emil Eifrem\", born:1978})\n" + + "CREATE (Emil)-[:ACTED_IN {roles:[\"Emil\"]}]->(TheMatrix)\n" + + "\n" + + "CREATE (TheMatrixReloaded:Movie {title:'The Matrix Reloaded', released:2003, tagline:'Free your mind'})\n" + + "CREATE\n" + + "(Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixReloaded),\n" + + "(Carrie)-[:ACTED_IN {roles:['Trinity']}]->(TheMatrixReloaded),\n" + + "(Laurence)-[:ACTED_IN {roles:['Morpheus']}]->(TheMatrixReloaded),\n" + + "(Hugo)-[:ACTED_IN {roles:['Agent Smith']}]->(TheMatrixReloaded),\n" + + "(LillyW)-[:DIRECTED]->(TheMatrixReloaded),\n" + + "(LanaW)-[:DIRECTED]->(TheMatrixReloaded),\n" + + "(JoelS)-[:PRODUCED]->(TheMatrixReloaded)\n" + + "\n" + + "CREATE (TheMatrixRevolutions:Movie {title:'The Matrix Revolutions', released:2003, tagline:'Everything that has a beginning has an end'})\n" + + "CREATE\n" + + "(Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixRevolutions),\n" + + "(Carrie)-[:ACTED_IN {roles:['Trinity']}]->(TheMatrixRevolutions),\n" + + "(Laurence)-[:ACTED_IN {roles:['Morpheus']}]->(TheMatrixRevolutions),\n" + + "(KevinB)-[:ACTED_IN {roles:['Unknown']}]->(TheMatrixRevolutions),\n" + + "(Hugo)-[:ACTED_IN {roles:['Agent Smith']}]->(TheMatrixRevolutions),\n" + + "(LillyW)-[:DIRECTED]->(TheMatrixRevolutions),\n" + + "(LanaW)-[:DIRECTED]->(TheMatrixRevolutions),\n" + + "(JoelS)-[:PRODUCED]->(TheMatrixRevolutions)\n"; +} \ No newline at end of file diff --git a/examples/integrations/neo4j/neo4j-se/src/test/java/io/helidon/examples/quickstart/se/package-info.java b/examples/integrations/neo4j/neo4j-se/src/test/java/io/helidon/examples/quickstart/se/package-info.java new file mode 100644 index 00000000..69488a6b --- /dev/null +++ b/examples/integrations/neo4j/neo4j-se/src/test/java/io/helidon/examples/quickstart/se/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * Tests for Neo4j Helidon SE app. + */ +package io.helidon.examples.quickstart.se; diff --git a/examples/integrations/neo4j/pom.xml b/examples/integrations/neo4j/pom.xml new file mode 100644 index 00000000..fe81ccf5 --- /dev/null +++ b/examples/integrations/neo4j/pom.xml @@ -0,0 +1,38 @@ + + + + + 4.0.0 + + io.helidon.examples.integrations + helidon-examples-integrations-project + 1.0.0-SNAPSHOT + + io.helidon.examples.integrations.neo4j + helidon-examples-integrations-neo4j-project + Helidon Neo4j Integrations Examples + pom + + + neo4j-mp + neo4j-se + + + diff --git a/examples/integrations/oci/atp-cdi/README.md b/examples/integrations/oci/atp-cdi/README.md new file mode 100644 index 00000000..bcddc626 --- /dev/null +++ b/examples/integrations/oci/atp-cdi/README.md @@ -0,0 +1,28 @@ +# Helidon ATP MP Examples + +This example demonstrates how user can easily retrieve wallet from their ATP instance running in OCI and use information from that wallet to setup DataSource to do Database operations. + +It requires a running OCI ATP instance. + +Before running the test, make sure to update required properties in `application.yaml` + +- oci.atp.ocid: This is OCID of your running ATP instance. +- oci.atp.walletPassword: password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. +- oracle.ucp.jdbc.PoolDataSource.atp.tnsNetServiceName: netServiceName of your database running inside OCI ATP as can be found in `tnsnames.ora` file. +- oracle.ucp.jdbc.PoolDataSource.atp.user: User to access your database running inside OCI ATP. +- oracle.ucp.jdbc.PoolDataSource.atp.password: Password of user to access your database running inside OCI ATP. + +Once you have updated required properties, you can run the example: + +```shell +mvn clean install +java -jar ./target/helidon-examples-integrations-oci-atp-cdi.jar +``` + +To verify that, you can retrieve wallet and do database operation: + +```text +http://localhost:8080/atp/wallet +``` + +You should see `Hello world!!` \ No newline at end of file diff --git a/examples/integrations/oci/atp-cdi/pom.xml b/examples/integrations/oci/atp-cdi/pom.xml new file mode 100644 index 00000000..17bb6a16 --- /dev/null +++ b/examples/integrations/oci/atp-cdi/pom.xml @@ -0,0 +1,92 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-atp-cdi + 1.0.0-SNAPSHOT + Helidon Examples Integration OCI ATP CDI + CDI integration with OCI ATP. + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-ucp + + + com.oracle.database.jdbc + ojdbc8-production + pom + + + io.helidon.integrations.oci.sdk + helidon-integrations-oci-sdk-cdi + + + com.oracle.oci.sdk + oci-java-sdk-database + + + io.helidon.config + helidon-config-yaml-mp + + + org.jboss + jandex + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/oci/atp-cdi/src/main/java/io/helidon/examples/integrations/oci/atp/cdi/AtpResource.java b/examples/integrations/oci/atp-cdi/src/main/java/io/helidon/examples/integrations/oci/atp/cdi/AtpResource.java new file mode 100644 index 00000000..28572ceb --- /dev/null +++ b/examples/integrations/oci/atp-cdi/src/main/java/io/helidon/examples/integrations/oci/atp/cdi/AtpResource.java @@ -0,0 +1,185 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.atp.cdi; + +import java.io.BufferedInputStream; +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.security.KeyStore; +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.Objects; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.zip.ZipEntry; +import java.util.zip.ZipInputStream; + +import javax.inject.Inject; +import javax.inject.Named; +import javax.net.ssl.KeyManagerFactory; +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManagerFactory; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.core.Response; + +import com.oracle.bmc.database.Database; +import com.oracle.bmc.database.model.GenerateAutonomousDatabaseWalletDetails; +import com.oracle.bmc.database.requests.GenerateAutonomousDatabaseWalletRequest; +import com.oracle.bmc.database.responses.GenerateAutonomousDatabaseWalletResponse; +import oracle.security.pki.OraclePKIProvider; +import oracle.ucp.jdbc.PoolDataSource; +import org.eclipse.microprofile.config.inject.ConfigProperty; + +import static com.oracle.bmc.http.client.Options.shouldAutoCloseResponseInputStream; +/** + * JAX-RS resource - REST API for the atp example. + */ +@Path("/atp") +public class AtpResource { + private static final Logger LOGGER = Logger.getLogger(AtpResource.class.getName()); + + private final Database databaseClient; + private final PoolDataSource atpDataSource; + private final String atpTnsNetServiceName; + + private final String atpOcid; + private final String walletPassword; + + @Inject + AtpResource(Database databaseClient, @Named("atp") PoolDataSource atpDataSource, + @ConfigProperty(name = "oracle.ucp.jdbc.PoolDataSource.atp.tnsNetServiceName") String atpTnsNetServiceName, + @ConfigProperty(name = "oci.atp.ocid") String atpOcid, + @ConfigProperty(name = "oci.atp.walletPassword") String walletPassword) { + this.databaseClient = databaseClient; + this.atpDataSource = Objects.requireNonNull(atpDataSource); + this.atpTnsNetServiceName = atpTnsNetServiceName; + this.atpOcid = atpOcid; + this.walletPassword = walletPassword; + } + + /** + * Generate wallet file for the configured ATP. + * + * @return response containing wallet file + */ + @GET + @Path("/wallet") + public Response generateWallet() { + shouldAutoCloseResponseInputStream(false); + GenerateAutonomousDatabaseWalletResponse walletResponse = + databaseClient.generateAutonomousDatabaseWallet( + GenerateAutonomousDatabaseWalletRequest.builder() + .autonomousDatabaseId(this.atpOcid) + .generateAutonomousDatabaseWalletDetails( + GenerateAutonomousDatabaseWalletDetails.builder() + .password(this.walletPassword) + .build()) + .build()); + + if (walletResponse.getContentLength() == 0) { + LOGGER.log(Level.SEVERE, "GenerateAutonomousDatabaseWalletResponse is empty"); + return Response.status(Response.Status.NOT_FOUND).build(); + } + + byte[] walletContent = null; + try { + walletContent = walletResponse.getInputStream().readAllBytes(); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Error processing GenerateAutonomousDatabaseWalletResponse", e); + return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build(); + } + String returnEntity = null; + try { + this.atpDataSource.setSSLContext(getSSLContext(walletContent)); + this.atpDataSource.setURL(getJdbcUrl(walletContent, this.atpTnsNetServiceName)); + try ( + Connection connection = this.atpDataSource.getConnection(); + PreparedStatement ps = connection.prepareStatement("SELECT 'Hello world!!' FROM DUAL"); + ResultSet rs = ps.executeQuery() + ){ + rs.next(); + returnEntity = rs.getString(1); + } + } catch (SQLException e) { + LOGGER.log(Level.SEVERE, "Error setting up DataSource", e); + return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build(); + } + + return Response.status(Response.Status.OK).entity(returnEntity).build(); + } + + /** + * Returns SSLContext based on cwallet.sso in wallet. + * + * @param walletContent + * @return SSLContext + */ + private static SSLContext getSSLContext(byte[] walletContent) throws IllegalStateException { + SSLContext sslContext = null; + try (ZipInputStream zis = new ZipInputStream(new BufferedInputStream(new ByteArrayInputStream(walletContent)))) { + ZipEntry entry = null; + while ((entry = zis.getNextEntry()) != null) { + if (entry.getName().equals("cwallet.sso")) { + KeyStore keyStore = KeyStore.getInstance("SSO", new OraclePKIProvider()); + keyStore.load(zis, null); + TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance("PKIX"); + KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance("PKIX"); + trustManagerFactory.init(keyStore); + keyManagerFactory.init(keyStore, null); + sslContext = SSLContext.getInstance("TLS"); + sslContext.init(keyManagerFactory.getKeyManagers(), trustManagerFactory.getTrustManagers(), null); + } + zis.closeEntry(); + } + } catch (RuntimeException | Error throwMe) { + throw throwMe; + } catch (Exception e) { + throw new IllegalStateException("Error while getting SSLContext from wallet.", e); + } + return sslContext; + } + + /** + * Returns JDBC URL with connection description for the given service based on tnsnames.ora in wallet. + * + * @param walletContent + * @param tnsNetServiceName + * @return String + */ + private static String getJdbcUrl(byte[] walletContent, String tnsNetServiceName) throws IllegalStateException { + String jdbcUrl = null; + try (ZipInputStream zis = new ZipInputStream(new BufferedInputStream(new ByteArrayInputStream(walletContent)))) { + ZipEntry entry = null; + while ((entry = zis.getNextEntry()) != null) { + if (entry.getName().equals("tnsnames.ora")) { + jdbcUrl = new String(zis.readAllBytes(), StandardCharsets.UTF_8) + .replaceFirst(tnsNetServiceName + "\\s*=\\s*", "jdbc:oracle:thin:@") + .replaceAll("\\n[^\\n]+", ""); + } + zis.closeEntry(); + } + } catch (IOException e) { + throw new IllegalStateException("Error while getting JDBC URL from wallet.", e); + } + return jdbcUrl; + } +} + diff --git a/examples/integrations/oci/atp-cdi/src/main/java/io/helidon/examples/integrations/oci/atp/cdi/package-info.java b/examples/integrations/oci/atp-cdi/src/main/java/io/helidon/examples/integrations/oci/atp/cdi/package-info.java new file mode 100644 index 00000000..93ab0210 --- /dev/null +++ b/examples/integrations/oci/atp-cdi/src/main/java/io/helidon/examples/integrations/oci/atp/cdi/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of integration with OCI ATP in CDI application. + */ +package io.helidon.examples.integrations.oci.atp.cdi; diff --git a/examples/integrations/oci/atp-cdi/src/main/resources/META-INF/beans.xml b/examples/integrations/oci/atp-cdi/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..391c10c3 --- /dev/null +++ b/examples/integrations/oci/atp-cdi/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/oci/atp-cdi/src/main/resources/application.yaml b/examples/integrations/oci/atp-cdi/src/main/resources/application.yaml new file mode 100644 index 00000000..d7073eb2 --- /dev/null +++ b/examples/integrations/oci/atp-cdi/src/main/resources/application.yaml @@ -0,0 +1,37 @@ +# +# 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. +# + +# The values are read from +# ~/helidon/conf/examples.yaml +# or you can just update them here + +server: + port: 8080 + +oracle: + ucp: + jdbc: + PoolDataSource: + atp: + connectionFactoryClassName: oracle.jdbc.pool.OracleDataSource + tnsNetServiceName: "${atp.db.tnsNetServiceName}" + user: "${atp.db.user}" + password: "${atp.db.password}" + +oci: + atp: + ocid: "${oci.properties.atp-ocid}" + walletPassword: "${oci.properties.atp-walletPassword}" \ No newline at end of file diff --git a/examples/integrations/oci/atp-cdi/src/main/resources/logging.properties b/examples/integrations/oci/atp-cdi/src/main/resources/logging.properties new file mode 100644 index 00000000..6cbb2826 --- /dev/null +++ b/examples/integrations/oci/atp-cdi/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO +io.helidon.webclient.level=INFO diff --git a/examples/integrations/oci/atp-reactive/README.md b/examples/integrations/oci/atp-reactive/README.md new file mode 100644 index 00000000..a255a62c --- /dev/null +++ b/examples/integrations/oci/atp-reactive/README.md @@ -0,0 +1,28 @@ +# Helidon ATP Reactive Examples + +This example demonstrates how user can easily retrieve wallet from their ATP instance running in OCI and use information from that wallet to setup DataSource to do Database operations. + +It requires a running OCI ATP instance. + +Before running the test, make sure to update required properties in `application.yaml` + +- oci.atp.ocid: This is OCID of your running ATP instance. +- oci.atp.walletPassword: password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. +- db.tnsNetServiceName: netServiceName of your database running inside OCI ATP as can be found in `tnsnames.ora` file. +- db.userName: User to access your database running inside OCI ATP. +- db.password: Password of user to access your database running inside OCI ATP. + +Once you have updated required properties, you can run the example: + +```shell +mvn clean install +java -jar ./target/helidon-examples-integrations-oci-atp-reactive.jar +``` + +To verify that, you can retrieve wallet and do database operation: + +```text +http://localhost:8080/atp/wallet +``` + +You should see `Hello world!!` diff --git a/examples/integrations/oci/atp-reactive/pom.xml b/examples/integrations/oci/atp-reactive/pom.xml new file mode 100644 index 00000000..1336cce1 --- /dev/null +++ b/examples/integrations/oci/atp-reactive/pom.xml @@ -0,0 +1,88 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-atp-reactive + 1.0.0-SNAPSHOT + Helidon Examples Integration OCI ATP Reactive + Reactive integration with OCI ATP. + + + io.helidon.examples.integrations.oci.atp.reactive.OciAtpMain + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.dbclient + helidon-dbclient + + + io.helidon.dbclient + helidon-dbclient-jdbc + + + com.oracle.database.jdbc + ojdbc8-production + pom + + + io.helidon.config + helidon-config-yaml + + + com.oracle.oci.sdk + oci-java-sdk-database + + + + jakarta.inject + jakarta.inject-api + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/AtpService.java b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/AtpService.java new file mode 100644 index 00000000..d551608e --- /dev/null +++ b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/AtpService.java @@ -0,0 +1,198 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.atp.reactive; + +import java.io.BufferedInputStream; +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.security.KeyStore; +import java.sql.SQLException; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.zip.ZipEntry; +import java.util.zip.ZipInputStream; + +import javax.net.ssl.KeyManagerFactory; +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManagerFactory; + +import io.helidon.common.http.Http; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.dbclient.DbClient; +import io.helidon.dbclient.jdbc.JdbcDbClientProvider; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import com.oracle.bmc.database.DatabaseAsync; +import com.oracle.bmc.database.model.GenerateAutonomousDatabaseWalletDetails; +import com.oracle.bmc.database.requests.GenerateAutonomousDatabaseWalletRequest; +import com.oracle.bmc.database.responses.GenerateAutonomousDatabaseWalletResponse; +import oracle.jdbc.pool.OracleDataSource; +import oracle.security.pki.OraclePKIProvider; +import oracle.ucp.jdbc.PoolDataSource; +import oracle.ucp.jdbc.PoolDataSourceFactory; + +class AtpService implements Service { + private static final Logger LOGGER = Logger.getLogger(AtpService.class.getName()); + + private final DatabaseAsync databaseAsyncClient; + private final Config config; + + AtpService(DatabaseAsync databaseAsyncClient, Config config) { + this.databaseAsyncClient = databaseAsyncClient; + this.config = config; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/wallet", this::generateWallet); + } + + /** + * Generate wallet file for the configured ATP. + */ + private void generateWallet(ServerRequest req, ServerResponse res) { + OciResponseHandler walletHandler = + new OciResponseHandler<>(); + GenerateAutonomousDatabaseWalletResponse walletResponse = null; + try { + databaseAsyncClient.generateAutonomousDatabaseWallet( + GenerateAutonomousDatabaseWalletRequest.builder() + .autonomousDatabaseId(config.get("oci.atp.ocid").asString().get()) + .generateAutonomousDatabaseWalletDetails( + GenerateAutonomousDatabaseWalletDetails.builder() + .password(config.get("oci.atp.walletPassword").asString().get()) + .build()) + .build(), walletHandler); + walletResponse = walletHandler.waitForCompletion(); + } catch (Exception e) { + LOGGER.log(Level.SEVERE, "Error waiting for GenerateAutonomousDatabaseWalletResponse", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + + if (walletResponse.getContentLength() == 0) { + LOGGER.log(Level.SEVERE, "GenerateAutonomousDatabaseWalletResponse is empty"); + res.status(Http.Status.NOT_FOUND_404).send(); + return; + } + + byte[] walletContent = null; + try { + walletContent = walletResponse.getInputStream().readAllBytes(); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Error processing GenerateAutonomousDatabaseWalletResponse", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + + createDbClient(walletContent) + .flatMap(dbClient -> dbClient.execute(exec -> exec.query("SELECT 'Hello world!!' FROM DUAL"))) + .first() + .map(dbRow -> dbRow.column(1).as(String.class)) + .ifEmpty(() -> res.status(404).send()) + .onError(res::send) + .forSingle(res::send); + } + + Single createDbClient(byte[] walletContent) { + PoolDataSource pds = PoolDataSourceFactory.getPoolDataSource(); + try { + pds.setSSLContext(getSSLContext(walletContent)); + pds.setURL(getJdbcUrl(walletContent, config.get("db.tnsNetServiceName") + .as(String.class) + .orElseThrow(() -> new IllegalStateException("Missing tnsNetServiceName!!")))); + pds.setUser(config.get("db.userName").as(String.class).orElse("ADMIN")); + pds.setPassword(config.get("db.password") + .as(String.class) + .orElseThrow(() -> new IllegalStateException("Missing password!!"))); + pds.setConnectionFactoryClassName(OracleDataSource.class.getName()); + } catch (SQLException e) { + LOGGER.log(Level.SEVERE, "Error setting up PoolDataSource", e); + return Single.error(e); + } + return Single.just(new JdbcDbClientProvider().builder() + .connectionPool(() -> { + try { + return pds.getConnection(); + } catch (SQLException e) { + throw new IllegalStateException("Error while setting up new connection", e); + } + }) + .build()); + } + + /** + * Returns SSLContext based on cwallet.sso in wallet. + * + * @return SSLContext + */ + private static SSLContext getSSLContext(byte[] walletContent) throws IllegalStateException { + SSLContext sslContext = null; + try (ZipInputStream zis = new ZipInputStream(new BufferedInputStream(new ByteArrayInputStream(walletContent)))) { + ZipEntry entry = null; + while ((entry = zis.getNextEntry()) != null) { + if (entry.getName().equals("cwallet.sso")) { + KeyStore keyStore = KeyStore.getInstance("SSO", new OraclePKIProvider()); + keyStore.load(zis, null); + TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance("PKIX"); + KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance("PKIX"); + trustManagerFactory.init(keyStore); + keyManagerFactory.init(keyStore, null); + sslContext = SSLContext.getInstance("TLS"); + sslContext.init(keyManagerFactory.getKeyManagers(), trustManagerFactory.getTrustManagers(), null); + } + zis.closeEntry(); + } + } catch (RuntimeException | Error throwMe) { + throw throwMe; + } catch (Exception e) { + throw new IllegalStateException("Error while getting SSLContext from wallet.", e); + } + return sslContext; + } + + /** + * Returns JDBC URL with connection description for the given service based on tnsnames.ora in wallet. + * + * @param walletContent + * @param tnsNetServiceName + * @return String + */ + private static String getJdbcUrl(byte[] walletContent, String tnsNetServiceName) throws IllegalStateException { + String jdbcUrl = null; + try (ZipInputStream zis = new ZipInputStream(new BufferedInputStream(new ByteArrayInputStream(walletContent)))) { + ZipEntry entry = null; + while ((entry = zis.getNextEntry()) != null) { + if (entry.getName().equals("tnsnames.ora")) { + jdbcUrl = new String(zis.readAllBytes(), StandardCharsets.UTF_8) + .replaceFirst(tnsNetServiceName + "\\s*=\\s*", "jdbc:oracle:thin:@") + .replaceAll("\\n[^\\n]+", ""); + } + zis.closeEntry(); + } + } catch (IOException e) { + throw new IllegalStateException("Error while getting JDBC URL from wallet.", e); + } + return jdbcUrl; + } +} diff --git a/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/OciAtpMain.java b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/OciAtpMain.java new file mode 100644 index 00000000..fca14e5e --- /dev/null +++ b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/OciAtpMain.java @@ -0,0 +1,80 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.atp.reactive; + +import java.io.IOException; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import com.oracle.bmc.ConfigFileReader; +import com.oracle.bmc.auth.AuthenticationDetailsProvider; +import com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider; +import com.oracle.bmc.database.DatabaseAsync; +import com.oracle.bmc.database.DatabaseAsyncClient; +import com.oracle.bmc.model.BmcException; + +/** + * Main class of the example. + * This example sets up a web server to serve REST API to retrieve ATP wallet. + */ +public final class OciAtpMain { + /** + * Cannot be instantiated. + */ + private OciAtpMain() { + } + + /** + * Application main entry point. + * + * @param args command line arguments. + */ + public static void main(String[] args) throws IOException { + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // this requires OCI configuration in the usual place + // ~/.oci/config + AuthenticationDetailsProvider authProvider = new ConfigFileAuthenticationDetailsProvider(ConfigFileReader.parseDefault()); + DatabaseAsync databaseAsyncClient = DatabaseAsyncClient.builder().build(authProvider); + + // Prepare routing for the server + WebServer server = WebServer.builder() + .config(config.get("server")) + .routing(Routing.builder() + .register("/atp", new AtpService(databaseAsyncClient, config)) + // OCI SDK error handling + .error(BmcException.class, (req, res, ex) -> res.status(ex.getStatusCode()) + .send(ex.getMessage()))) + .build(); + + // Start the server and print some info. + server.start().thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/"); + }); + + // Server threads are not daemon. NO need to block. Just react. + server.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + } +} diff --git a/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/OciResponseHandler.java b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/OciResponseHandler.java new file mode 100644 index 00000000..7f8f4431 --- /dev/null +++ b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/OciResponseHandler.java @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2022, 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.integrations.oci.atp.reactive; + +import java.util.concurrent.CountDownLatch; + +import com.oracle.bmc.responses.AsyncHandler; + +final class OciResponseHandler implements AsyncHandler { + private OUT item; + private Throwable failed = null; + private CountDownLatch latch = new CountDownLatch(1); + + protected OUT waitForCompletion() throws Exception { + latch.await(); + if (failed != null) { + if (failed instanceof Exception) { + throw (Exception) failed; + } + throw (Error) failed; + } + return item; + } + + @Override + public void onSuccess(IN request, OUT response) { + item = response; + latch.countDown(); + } + + @Override + public void onError(IN request, Throwable error) { + failed = error; + latch.countDown(); + } +} diff --git a/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/package-info.java b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/package-info.java new file mode 100644 index 00000000..ce206570 --- /dev/null +++ b/examples/integrations/oci/atp-reactive/src/main/java/io/helidon/examples/integrations/oci/atp/reactive/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of integration with OCI ATP in reactive application. + */ +package io.helidon.examples.integrations.oci.atp.reactive; diff --git a/examples/integrations/oci/atp-reactive/src/main/resources/application.yaml b/examples/integrations/oci/atp-reactive/src/main/resources/application.yaml new file mode 100644 index 00000000..a5261a30 --- /dev/null +++ b/examples/integrations/oci/atp-reactive/src/main/resources/application.yaml @@ -0,0 +1,32 @@ +# +# 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. +# + +# The values are read from +# ~/helidon/conf/examples.yaml +# or you can just update them here + +server: + port: 8080 + +db: + userName: "${atp.db.userName}" + password: "${atp.db.password}" + tnsNetServiceName: "${atp.db.tnsNetServiceName}" + +oci: + atp: + ocid: "${oci.properties.atp-ocid}" + walletPassword: "${oci.properties.atp-walletPassword}" diff --git a/examples/integrations/oci/atp-reactive/src/main/resources/logging.properties b/examples/integrations/oci/atp-reactive/src/main/resources/logging.properties new file mode 100644 index 00000000..6cbb2826 --- /dev/null +++ b/examples/integrations/oci/atp-reactive/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO +io.helidon.webclient.level=INFO diff --git a/examples/integrations/oci/metrics-reactive/README.md b/examples/integrations/oci/metrics-reactive/README.md new file mode 100644 index 00000000..91191485 --- /dev/null +++ b/examples/integrations/oci/metrics-reactive/README.md @@ -0,0 +1,28 @@ +# Helidon Metrics Reactive Examples + +This example demonstrates how user can easily retrieve wallet from their ATP instance running in OCI and use information from that wallet to setup DataSource to do Database operations. + +It requires a running OCI ATP instance. + +Before running the test, make sure to update required properties in `application.yaml` + +- oci.atp.ocid: This is OCID of your running ATP instance. +- oci.atp.walletPassword: password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. +- db.tnsNetServiceName: netServiceName of your database running inside OCI ATP as can be found in `tnsnames.ora` file. +- db.userName: User to access your database running inside OCI ATP. +- db.password: Password of user to access your database running inside OCI ATP. + +Once you have updated required properties, you can run the example: + +```shell +mvn clean install +java -jar ./target/helidon-examples-integrations-oci-metrics-reactive.jar +``` + +To verify that, you can retrieve wallet and do database operation: + +```text +http://localhost:8080/metrics +``` + +You should see metrics output diff --git a/examples/integrations/oci/metrics-reactive/pom.xml b/examples/integrations/oci/metrics-reactive/pom.xml new file mode 100644 index 00000000..f4f9b654 --- /dev/null +++ b/examples/integrations/oci/metrics-reactive/pom.xml @@ -0,0 +1,75 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + + io.helidon.examples.integrations.oci.telemetry.reactive.OciMetricsMain + + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-metrics-reactive + 1.0.0-SNAPSHOT + Helidon Examples Integration OCI Metrics Reactive + Reactive integration with OCI Metrics. + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + com.oracle.oci.sdk + oci-java-sdk-monitoring + + + + jakarta.inject + jakarta.inject-api + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/integrations/oci/metrics-reactive/src/main/java/io/helidon/examples/integrations/oci/telemetry/reactive/OciMetricsMain.java b/examples/integrations/oci/metrics-reactive/src/main/java/io/helidon/examples/integrations/oci/telemetry/reactive/OciMetricsMain.java new file mode 100644 index 00000000..54bd51bc --- /dev/null +++ b/examples/integrations/oci/metrics-reactive/src/main/java/io/helidon/examples/integrations/oci/telemetry/reactive/OciMetricsMain.java @@ -0,0 +1,175 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.telemetry.reactive; + +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.Arrays; +import java.util.Date; +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.CountDownLatch; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; + +import com.oracle.bmc.ConfigFileReader; +import com.oracle.bmc.auth.AuthenticationDetailsProvider; +import com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider; +import com.oracle.bmc.monitoring.MonitoringAsync; +import com.oracle.bmc.monitoring.MonitoringAsyncClient; +import com.oracle.bmc.monitoring.model.Datapoint; +import com.oracle.bmc.monitoring.model.FailedMetricRecord; +import com.oracle.bmc.monitoring.model.MetricDataDetails; +import com.oracle.bmc.monitoring.model.PostMetricDataDetails; +import com.oracle.bmc.monitoring.model.PostMetricDataResponseDetails; +import com.oracle.bmc.monitoring.requests.PostMetricDataRequest; +import com.oracle.bmc.monitoring.responses.PostMetricDataResponse; +import com.oracle.bmc.responses.AsyncHandler; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * OCI Metrics example. + */ +public final class OciMetricsMain { + + private OciMetricsMain() { + } + + /** + * Main method. + * @param args ignored + */ + public static void main(String[] args) throws Exception { + LogConfig.configureRuntime(); + // as I cannot share my configuration of OCI, let's combine the configuration + // from my home directory with the one compiled into the jar + // when running this example, you can either update the application.yaml in resources directory + // or use the same approach + Config config = buildConfig(); + + // this requires OCI configuration in the usual place + // ~/.oci/config + AuthenticationDetailsProvider authProvider = new ConfigFileAuthenticationDetailsProvider(ConfigFileReader.parseDefault()); + MonitoringAsync monitoringAsyncClient = new MonitoringAsyncClient(authProvider); + monitoringAsyncClient.setEndpoint(monitoringAsyncClient.getEndpoint().replace("telemetry.", "telemetry-ingestion.")); + + PostMetricDataRequest postMetricDataRequest = PostMetricDataRequest.builder() + .postMetricDataDetails(getPostMetricDataDetails(config)) + .build(); + /* + * Invoke the API call. I use .await() to block the call, as otherwise our + * main method would finish without waiting for the response. + * In a real reactive application, this should not be done (as you would write the response + * to a server response or use other reactive/non-blocking APIs). + */ + ResponseHandler monitoringHandler = + new ResponseHandler<>(); + monitoringAsyncClient.postMetricData(postMetricDataRequest, monitoringHandler); + PostMetricDataResponse postMetricDataResponse = monitoringHandler.waitForCompletion(); + PostMetricDataResponseDetails postMetricDataResponseDetails = postMetricDataResponse.getPostMetricDataResponseDetails(); + int count = postMetricDataResponseDetails.getFailedMetricsCount(); + System.out.println("Failed count: " + count); + if (count > 0) { + System.out.println("Failed metrics:"); + for (FailedMetricRecord failedMetric : postMetricDataResponseDetails.getFailedMetrics()) { + System.out.println("\t" + failedMetric.getMessage() + ": " + failedMetric.getMetricData()); + } + } + } + + private static PostMetricDataDetails getPostMetricDataDetails(Config config) { + String compartmentId = config.get("oci.metrics.compartment-ocid").asString().get(); + Instant now = Instant.now(); + return PostMetricDataDetails.builder() + .metricData( + Arrays.asList( + MetricDataDetails.builder() + .compartmentId(compartmentId) + // Add a few data points to see something in the console + .datapoints( + Arrays.asList( + Datapoint.builder() + .timestamp(Date.from( + now.minus(10, ChronoUnit.SECONDS) + )) + .value(101.00) + .build(), + Datapoint.builder() + .timestamp(Date.from(now)) + .value(149.00) + .build() + )) + .dimensions( + makeMap("resourceId", "myresourceid", + "unit", "cm")) + .name("my_app.jump") + .namespace("helidon_examples") + .build() + )) + .batchAtomicity(PostMetricDataDetails.BatchAtomicity.NonAtomic).build(); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults that are built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } + + private static Map makeMap(String... data) { + Map map = new HashMap<>(); + for (int i = 0; i < data.length; i += 2) { + map.put(data[i], data[i + 1]); + } + return map; + } + + private static class ResponseHandler implements AsyncHandler { + private OUT item; + private Throwable failed = null; + private CountDownLatch latch = new CountDownLatch(1); + + private OUT waitForCompletion() throws Exception { + latch.await(); + if (failed != null) { + if (failed instanceof Exception) { + throw (Exception) failed; + } + throw (Error) failed; + } + return item; + } + + @Override + public void onSuccess(IN request, OUT response) { + item = response; + latch.countDown(); + } + + @Override + public void onError(IN request, Throwable error) { + failed = error; + latch.countDown(); + } + } +} diff --git a/examples/integrations/oci/metrics-reactive/src/main/java/io/helidon/examples/integrations/oci/telemetry/reactive/package-info.java b/examples/integrations/oci/metrics-reactive/src/main/java/io/helidon/examples/integrations/oci/telemetry/reactive/package-info.java new file mode 100644 index 00000000..6205863c --- /dev/null +++ b/examples/integrations/oci/metrics-reactive/src/main/java/io/helidon/examples/integrations/oci/telemetry/reactive/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 using OCI metrics reactive API. + */ +package io.helidon.examples.integrations.oci.telemetry.reactive; diff --git a/examples/integrations/oci/metrics-reactive/src/main/resources/application.yaml b/examples/integrations/oci/metrics-reactive/src/main/resources/application.yaml new file mode 100644 index 00000000..d8d67604 --- /dev/null +++ b/examples/integrations/oci/metrics-reactive/src/main/resources/application.yaml @@ -0,0 +1,23 @@ +# +# 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. +# + +# The values are read from +# ~/helidon/conf/examples.yaml +# or you can just update them here +oci: + metrics: + compartment-ocid: "${oci.properties.compartment-ocid}" + diff --git a/examples/integrations/oci/metrics-reactive/src/main/resources/logging.properties b/examples/integrations/oci/metrics-reactive/src/main/resources/logging.properties new file mode 100644 index 00000000..02a8f58f --- /dev/null +++ b/examples/integrations/oci/metrics-reactive/src/main/resources/logging.properties @@ -0,0 +1,27 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO diff --git a/examples/integrations/oci/objectstorage-cdi/README.md b/examples/integrations/oci/objectstorage-cdi/README.md new file mode 100644 index 00000000..fefde631 --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/README.md @@ -0,0 +1,11 @@ +The object storage (CDI) example. + +The example requires OCI config in some default place like ``.oci/config`` +Also properties from the ``src/main/resources/application.yaml`` shall be configured. +Like ``oci.objectstorage.bucketName`` + +Build and run the example by +```shell +mvn package +java -jar ./target/helidon-examples-integrations-oci-objectstorage-cdi.jar +``` \ No newline at end of file diff --git a/examples/integrations/oci/objectstorage-cdi/pom.xml b/examples/integrations/oci/objectstorage-cdi/pom.xml new file mode 100644 index 00000000..4b5cfcb0 --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/pom.xml @@ -0,0 +1,88 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-objectstorage-cdi + 1.0.0-SNAPSHOT + Helidon Examples Integration OCI Vault CDI + CDI integration with OCI Vault. + + + io.helidon.examples.integrations.oci.objectstorage.cdi.ObjectStorageCdiMain + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.integrations.oci.sdk + helidon-integrations-oci-sdk-cdi + + + com.oracle.oci.sdk + oci-java-sdk-objectstorage + + + io.helidon.config + helidon-config-yaml-mp + + + org.jboss + jandex + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + diff --git a/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/ObjectStorageCdiMain.java b/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/ObjectStorageCdiMain.java new file mode 100644 index 00000000..f8018256 --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/ObjectStorageCdiMain.java @@ -0,0 +1,67 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.objectstorage.cdi; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +import io.helidon.config.yaml.mp.YamlMpConfigSource; +import io.helidon.microprofile.cdi.Main; + +import org.eclipse.microprofile.config.Config; +import org.eclipse.microprofile.config.spi.ConfigProviderResolver; +import org.eclipse.microprofile.config.spi.ConfigSource; + +/** + * Main class of the example. + * This is only used to merge configuration from home directory with the one embedded on classpath. + */ +public final class ObjectStorageCdiMain { + private ObjectStorageCdiMain() { + } + + /** + * Main method. + * + * @param args ignored + */ + public static void main(String[] args) { + ConfigProviderResolver configProvider = ConfigProviderResolver.instance(); + + Config mpConfig = configProvider.getBuilder() + .addDefaultSources() + .withSources(examplesConfig()) + .addDiscoveredSources() + .addDiscoveredConverters() + .build(); + + // configure + configProvider.registerConfig(mpConfig, null); + + // start CDI + Main.main(args); + } + + private static ConfigSource[] examplesConfig() { + Path path = Paths.get(System.getProperty("user.home") + "/helidon/conf/examples.yaml"); + if (Files.exists(path)) { + return new ConfigSource[] {YamlMpConfigSource.create(path)}; + } + return new ConfigSource[0]; + } +} diff --git a/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/ObjectStorageResource.java b/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/ObjectStorageResource.java new file mode 100644 index 00000000..3d7b7b8c --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/ObjectStorageResource.java @@ -0,0 +1,160 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.objectstorage.cdi; + +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.core.Response; + +import io.helidon.common.http.Http; + +import com.oracle.bmc.objectstorage.ObjectStorage; +import com.oracle.bmc.objectstorage.requests.DeleteObjectRequest; +import com.oracle.bmc.objectstorage.requests.GetNamespaceRequest; +import com.oracle.bmc.objectstorage.requests.GetObjectRequest; +import com.oracle.bmc.objectstorage.requests.PutObjectRequest; +import com.oracle.bmc.objectstorage.responses.DeleteObjectResponse; +import com.oracle.bmc.objectstorage.responses.GetNamespaceResponse; +import com.oracle.bmc.objectstorage.responses.GetObjectResponse; +import com.oracle.bmc.objectstorage.responses.PutObjectResponse; +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * JAX-RS resource - REST API for the objecstorage example. + */ +@Path("/files") +public class ObjectStorageResource { + private static final Logger LOGGER = Logger.getLogger(ObjectStorageResource.class.getName()); + private final ObjectStorage objectStorageClient; + private final String namespaceName; + private final String bucketName; + + @Inject + ObjectStorageResource(ObjectStorage objectStorageClient, + @ConfigProperty(name = "oci.objectstorage.bucketName") + String bucketName) { + this.objectStorageClient = objectStorageClient; + this.bucketName = bucketName; + GetNamespaceResponse namespaceResponse = + this.objectStorageClient.getNamespace(GetNamespaceRequest.builder().build()); + this.namespaceName = namespaceResponse.getValue(); + } + + /** + * Download a file from object storage. + * + * @param fileName name of the object + * @return response + */ + @GET + @Path("/file/{file-name}") + public Response download(@PathParam("file-name") String fileName) { + GetObjectResponse getObjectResponse = + objectStorageClient.getObject( + GetObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .objectName(fileName) + .build()); + + if (getObjectResponse.getContentLength() == 0) { + LOGGER.log(Level.SEVERE, "GetObjectResponse is empty"); + return Response.status(Response.Status.NOT_FOUND).build(); + } + + try (InputStream fileStream = getObjectResponse.getInputStream()) { + byte[] objectContent = fileStream.readAllBytes(); + Response.ResponseBuilder ok = Response.ok(objectContent) + .header(Http.Header.CONTENT_DISPOSITION, "attachment; filename=\"" + fileName + "\"") + .header("opc-request-id", getObjectResponse.getOpcRequestId()) + .header("request-id", getObjectResponse.getOpcClientRequestId()) + .header(Http.Header.CONTENT_LENGTH, getObjectResponse.getContentLength()); + + return ok.build(); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Error processing GetObjectResponse", e); + return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build(); + } + } + + /** + * Upload a file to object storage. + * + * @param fileName name of the object + * @return response + */ + @POST + @Path("/file/{fileName}") + public Response upload(@PathParam("fileName") String fileName) { + + PutObjectRequest putObjectRequest = null; + try (InputStream stream = new FileInputStream(System.getProperty("user.dir") + File.separator + fileName)) { + byte[] contents = stream.readAllBytes(); + putObjectRequest = + PutObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .objectName(fileName) + .putObjectBody(new ByteArrayInputStream(contents)) + .contentLength(Long.valueOf(contents.length)) + .build(); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Error creating PutObjectRequest", e); + return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build(); + } + PutObjectResponse putObjectResponse = objectStorageClient.putObject(putObjectRequest); + + Response.ResponseBuilder ok = Response.ok() + .header("opc-request-id", putObjectResponse.getOpcRequestId()) + .header("request-id", putObjectResponse.getOpcClientRequestId()); + + return ok.build(); + } + + /** + * Delete a file from object storage. + * + * @param fileName object name + * @return response + */ + @DELETE + @Path("/file/{file-name}") + public Response delete(@PathParam("file-name") String fileName) { + DeleteObjectResponse deleteObjectResponse = objectStorageClient.deleteObject(DeleteObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .objectName(fileName) + .build()); + Response.ResponseBuilder ok = Response.ok() + .header("opc-request-id", deleteObjectResponse.getOpcRequestId()) + .header("request-id", deleteObjectResponse.getOpcClientRequestId()); + + return ok.build(); + } +} diff --git a/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/package-info.java b/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/package-info.java new file mode 100644 index 00000000..20453fd0 --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/src/main/java/io/helidon/examples/integrations/oci/objectstorage/cdi/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of integration with OCI object storage in a CDI application. + */ +package io.helidon.examples.integrations.oci.objectstorage.cdi; diff --git a/examples/integrations/oci/objectstorage-cdi/src/main/resources/META-INF/beans.xml b/examples/integrations/oci/objectstorage-cdi/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..391c10c3 --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/oci/objectstorage-cdi/src/main/resources/application.yaml b/examples/integrations/oci/objectstorage-cdi/src/main/resources/application.yaml new file mode 100644 index 00000000..097e8003 --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/src/main/resources/application.yaml @@ -0,0 +1,26 @@ +# +# 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. +# + +server: + port: 8080 + +# +# The following properties under oci are accessed by Helidon. Values +# under oci.properties.* are read from ~/helidon/conf/examples.yaml. +# +oci: + objectstorage: + bucketName: "${oci.properties.objectstorage-bucketName}" diff --git a/examples/integrations/oci/objectstorage-cdi/src/main/resources/logging.properties b/examples/integrations/oci/objectstorage-cdi/src/main/resources/logging.properties new file mode 100644 index 00000000..6cbb2826 --- /dev/null +++ b/examples/integrations/oci/objectstorage-cdi/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO +io.helidon.webclient.level=INFO diff --git a/examples/integrations/oci/objectstorage-reactive/README.md b/examples/integrations/oci/objectstorage-reactive/README.md new file mode 100644 index 00000000..f9b72ad9 --- /dev/null +++ b/examples/integrations/oci/objectstorage-reactive/README.md @@ -0,0 +1,9 @@ +The object storage example. + +The example requires OCI config in some default place like ``.oci/config`` + +Build and run the example by +```shell +mvn package +java -jar ./target/helidon-examples-integrations-oci-objectstorage-reactive.jar +``` \ No newline at end of file diff --git a/examples/integrations/oci/objectstorage-reactive/pom.xml b/examples/integrations/oci/objectstorage-reactive/pom.xml new file mode 100644 index 00000000..2d1cb974 --- /dev/null +++ b/examples/integrations/oci/objectstorage-reactive/pom.xml @@ -0,0 +1,75 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-objectstorage-reactive + 1.0.0-SNAPSHOT + Helidon Examples Integration OCI Object Storage Reactive + Reactive integration with OCI Object Storage. + + + io.helidon.examples.integrations.oci.objecstorage.reactive.OciObjectStorageMain + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + com.oracle.oci.sdk + oci-java-sdk-objectstorage + + + + jakarta.inject + jakarta.inject-api + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/ObjectStorageService.java b/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/ObjectStorageService.java new file mode 100644 index 00000000..ff4473ea --- /dev/null +++ b/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/ObjectStorageService.java @@ -0,0 +1,223 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.objecstorage.reactive; + +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.util.concurrent.CountDownLatch; +import java.util.logging.Level; +import java.util.logging.Logger; + +import io.helidon.common.http.Http; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import com.oracle.bmc.objectstorage.ObjectStorageAsync; +import com.oracle.bmc.objectstorage.model.RenameObjectDetails; +import com.oracle.bmc.objectstorage.requests.DeleteObjectRequest; +import com.oracle.bmc.objectstorage.requests.GetNamespaceRequest; +import com.oracle.bmc.objectstorage.requests.GetObjectRequest; +import com.oracle.bmc.objectstorage.requests.PutObjectRequest; +import com.oracle.bmc.objectstorage.requests.RenameObjectRequest; +import com.oracle.bmc.objectstorage.responses.DeleteObjectResponse; +import com.oracle.bmc.objectstorage.responses.GetNamespaceResponse; +import com.oracle.bmc.objectstorage.responses.GetObjectResponse; +import com.oracle.bmc.objectstorage.responses.PutObjectResponse; +import com.oracle.bmc.objectstorage.responses.RenameObjectResponse; +import com.oracle.bmc.responses.AsyncHandler; + +class ObjectStorageService implements Service { + private static final Logger LOGGER = Logger.getLogger(ObjectStorageService.class.getName()); + private final ObjectStorageAsync objectStorageAsyncClient; + private final String bucketName; + private final String namespaceName; + + ObjectStorageService(ObjectStorageAsync objectStorageAsyncClient, String bucketName) throws Exception { + this.objectStorageAsyncClient = objectStorageAsyncClient; + this.bucketName = bucketName; + ResponseHandler namespaceHandler = + new ResponseHandler<>(); + this.objectStorageAsyncClient.getNamespace(GetNamespaceRequest.builder().build(), namespaceHandler); + GetNamespaceResponse namespaceResponse = namespaceHandler.waitForCompletion(); + this.namespaceName = namespaceResponse.getValue(); + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/file/{file-name}", this::download) + .post("/file/{file-name}", this::upload) + .delete("/file/{file-name}", this::delete) + .get("/rename/{old-name}/{new-name}", this::rename); + } + + private void delete(ServerRequest req, ServerResponse res) { + String objectName = req.path().param("file-name"); + + ResponseHandler deleteObjectHandler = + new ResponseHandler<>(); + + objectStorageAsyncClient.deleteObject(DeleteObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .objectName(objectName).build(), deleteObjectHandler); + try { + DeleteObjectResponse deleteObjectResponse = deleteObjectHandler.waitForCompletion(); + res.status(Http.Status.OK_200) + .send(); + return; + } catch (Exception e) { + LOGGER.log(Level.SEVERE, "Error deleting object", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + } + + private void rename(ServerRequest req, ServerResponse res) { + String oldName = req.path().param("old-name"); + String newName = req.path().param("new-name"); + + RenameObjectRequest renameObjectRequest = RenameObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .renameObjectDetails(RenameObjectDetails.builder() + .newName(newName) + .sourceName(oldName) + .build()) + .build(); + + ResponseHandler renameObjectHandler = + new ResponseHandler<>(); + + try { + objectStorageAsyncClient.renameObject(renameObjectRequest, renameObjectHandler); + RenameObjectResponse renameObjectResponse = renameObjectHandler.waitForCompletion(); + res.status(Http.Status.OK_200) + .send(); + return; + } catch (Exception e) { + LOGGER.log(Level.SEVERE, "Error renaming object", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + } + + private void upload(ServerRequest req, ServerResponse res) { + String objectName = req.path().param("file-name"); + PutObjectRequest putObjectRequest = null; + try (InputStream stream = new FileInputStream(System.getProperty("user.dir") + File.separator + objectName)) { + byte[] contents = stream.readAllBytes(); + putObjectRequest = + PutObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .objectName(objectName) + .putObjectBody(new ByteArrayInputStream(contents)) + .contentLength(Long.valueOf(contents.length)) + .build(); + } catch (Exception e) { + LOGGER.log(Level.SEVERE, "Error creating PutObjectRequest", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + + ResponseHandler putObjectHandler = + new ResponseHandler<>(); + + try { + objectStorageAsyncClient.putObject(putObjectRequest, putObjectHandler); + PutObjectResponse putObjectResponse = putObjectHandler.waitForCompletion(); + res.status(Http.Status.OK_200).send(); + return; + } catch (Exception e) { + LOGGER.log(Level.SEVERE, "Error uploading object", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + } + + private void download(ServerRequest req, ServerResponse res) { + String objectName = req.path().param("file-name"); + ResponseHandler objectHandler = + new ResponseHandler<>(); + GetObjectRequest getObjectRequest = + GetObjectRequest.builder() + .namespaceName(namespaceName) + .bucketName(bucketName) + .objectName(objectName) + .build(); + GetObjectResponse getObjectResponse = null; + try { + objectStorageAsyncClient.getObject(getObjectRequest, objectHandler); + getObjectResponse = objectHandler.waitForCompletion(); + } catch (Exception e) { + LOGGER.log(Level.SEVERE, "Error getting object", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + + if (getObjectResponse.getContentLength() == 0) { + LOGGER.log(Level.SEVERE, "GetObjectResponse is empty"); + res.status(Http.Status.NOT_FOUND_404).send(); + return; + } + + try (InputStream fileStream = getObjectResponse.getInputStream()) { + byte[] objectContent = fileStream.readAllBytes(); + res.addHeader(Http.Header.CONTENT_DISPOSITION, "attachment; filename=\"" + objectName + "\"") + .status(Http.Status.OK_200).send(objectContent); + return; + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Error processing GetObjectResponse", e); + res.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(); + return; + } + } + + private static class ResponseHandler implements AsyncHandler { + private OUT item; + private Throwable failed = null; + private CountDownLatch latch = new CountDownLatch(1); + + private OUT waitForCompletion() throws Exception { + latch.await(); + if (failed != null) { + if (failed instanceof Exception) { + throw (Exception) failed; + } + throw (Error) failed; + } + return item; + } + + @Override + public void onSuccess(IN request, OUT response) { + item = response; + latch.countDown(); + } + + @Override + public void onError(IN request, Throwable error) { + failed = error; + latch.countDown(); + } + } +} diff --git a/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/OciObjectStorageMain.java b/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/OciObjectStorageMain.java new file mode 100644 index 00000000..a0a2541d --- /dev/null +++ b/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/OciObjectStorageMain.java @@ -0,0 +1,86 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.objecstorage.reactive; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import com.oracle.bmc.ConfigFileReader; +import com.oracle.bmc.auth.AuthenticationDetailsProvider; +import com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider; +import com.oracle.bmc.model.BmcException; +import com.oracle.bmc.objectstorage.ObjectStorageAsync; +import com.oracle.bmc.objectstorage.ObjectStorageAsyncClient; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * Main class of the example. + * This example sets up a web server to serve REST API to upload/download/delete objects. + */ +public final class OciObjectStorageMain { + private OciObjectStorageMain() { + } + + /** + * Main method. + * + * @param args ignored + */ + public static void main(String[] args) throws Exception { + LogConfig.configureRuntime(); + // as I cannot share my configuration of OCI, let's combine the configuration + // from my home directory with the one compiled into the jar + // when running this example, you can either update the application.yaml in resources directory + // or use the same approach + Config config = buildConfig(); + + Config ociConfig = config.get("oci"); + + // this requires OCI configuration in the usual place + // ~/.oci/config + AuthenticationDetailsProvider authProvider = new ConfigFileAuthenticationDetailsProvider(ConfigFileReader.parseDefault()); + ObjectStorageAsync objectStorageAsyncClient = new ObjectStorageAsyncClient(authProvider); + + // the following parameters are required + String bucketName = ociConfig.get("objectstorage").get("bucketName").asString().get(); + + WebServer.builder() + .config(config.get("server")) + .routing(Routing.builder() + .register("/files", new ObjectStorageService(objectStorageAsyncClient, bucketName)) + // OCI SDK error handling + .error(BmcException.class, (req, res, ex) -> res.status(ex.getStatusCode()) + .send(ex.getMessage()))) + .build() + .start() + .await(); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults that are built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } +} diff --git a/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/package-info.java b/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/package-info.java new file mode 100644 index 00000000..20f841bc --- /dev/null +++ b/examples/integrations/oci/objectstorage-reactive/src/main/java/io/helidon/examples/integrations/oci/objecstorage/reactive/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of integration with OCI object storage in reactive application. + */ +package io.helidon.examples.integrations.oci.objecstorage.reactive; diff --git a/examples/integrations/oci/objectstorage-reactive/src/main/resources/application.yaml b/examples/integrations/oci/objectstorage-reactive/src/main/resources/application.yaml new file mode 100644 index 00000000..2e4b34c1 --- /dev/null +++ b/examples/integrations/oci/objectstorage-reactive/src/main/resources/application.yaml @@ -0,0 +1,26 @@ +# +# 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. +# + +# The values are read from +# ~/helidon/conf/examples.yaml +# or you can just update them here + +server: + port: 8080 + +oci: + objectstorage: + bucketName: "${oci.properties.objectstorage-bucketName}" diff --git a/examples/integrations/oci/objectstorage-reactive/src/main/resources/logging.properties b/examples/integrations/oci/objectstorage-reactive/src/main/resources/logging.properties new file mode 100644 index 00000000..6cbb2826 --- /dev/null +++ b/examples/integrations/oci/objectstorage-reactive/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO +io.helidon.webclient.level=INFO diff --git a/examples/integrations/oci/pom.xml b/examples/integrations/oci/pom.xml new file mode 100644 index 00000000..af92568f --- /dev/null +++ b/examples/integrations/oci/pom.xml @@ -0,0 +1,44 @@ + + + + 4.0.0 + + io.helidon.examples.integrations + helidon-examples-integrations-project + 1.0.0-SNAPSHOT + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-project + pom + Helidon Examples Integration OCI + Examples of integration with OCI (Oracle Cloud). + + + atp-reactive + atp-cdi + metrics-reactive + objectstorage-reactive + objectstorage-cdi + vault-reactive + vault-cdi + + diff --git a/examples/integrations/oci/vault-cdi/README.md b/examples/integrations/oci/vault-cdi/README.md new file mode 100644 index 00000000..e54a3fda --- /dev/null +++ b/examples/integrations/oci/vault-cdi/README.md @@ -0,0 +1,12 @@ +The vault (CDI) example. + +The example requires OCI config in some default place like ``.oci/config`` + +Also properties from the ``src/main/resources/application.yaml`` shall be configured. +Like ``oci.properties.compartment-ocid`` + +Build and run the example by +```shell +mvn package +java -jar ./target/helidon-examples-integrations-oci-vault-cdi.jar +``` \ No newline at end of file diff --git a/examples/integrations/oci/vault-cdi/pom.xml b/examples/integrations/oci/vault-cdi/pom.xml new file mode 100644 index 00000000..98c83c0d --- /dev/null +++ b/examples/integrations/oci/vault-cdi/pom.xml @@ -0,0 +1,102 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-vault-cdi + 1.0.0-SNAPSHOT + Helidon Examples Integration OCI Object Storage CDI + CDI integration with OCI Object Storage. + + + io.helidon.examples.integrations.oci.vault.cdi.VaultCdiMain + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.integrations.oci.sdk + helidon-integrations-oci-sdk-cdi + + + com.oracle.oci.sdk + oci-java-sdk-keymanagement + + + com.oracle.oci.sdk + oci-java-sdk-secrets + + + com.oracle.oci.sdk + oci-java-sdk-vault + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + diff --git a/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/CryptoClientProducer.java b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/CryptoClientProducer.java new file mode 100644 index 00000000..b8c8e00f --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/CryptoClientProducer.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2022, 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.integrations.oci.vault.cdi; + +import javax.enterprise.context.ApplicationScoped; +import javax.enterprise.inject.Produces; +import javax.inject.Inject; + +import com.oracle.bmc.keymanagement.KmsCryptoClient; +import com.oracle.bmc.keymanagement.KmsCryptoClientBuilder; +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * KMS crypto client (used for encryption, decryption and signatures) requires additional configuration, that cannot + * be done automatically by the SDK. + */ +@ApplicationScoped +class CryptoClientProducer { + private final String cryptoEndpoint; + + @Inject + CryptoClientProducer(@ConfigProperty(name = "app.vault.cryptographic-endpoint") + String cryptoEndpoint) { + this.cryptoEndpoint = cryptoEndpoint; + } + + @Produces + KmsCryptoClientBuilder clientBuilder() { + return KmsCryptoClient.builder() + .endpoint(cryptoEndpoint); + } +} diff --git a/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/ErrorHandlerProvider.java b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/ErrorHandlerProvider.java new file mode 100644 index 00000000..f8d4df1a --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/ErrorHandlerProvider.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2022, 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.integrations.oci.vault.cdi; + +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; +import javax.ws.rs.ext.Provider; + +import com.oracle.bmc.model.BmcException; + +/** + * Maps SDK errors to HTTP errors, as otherwise any exception is manifested as an internal server error. + * This mapper is not part of integration with OCI SDK, as each application may require a different entity format. + * This mapper simply uses the response code as HTTP status code, and error message as entity. + */ +@Provider +class ErrorHandlerProvider implements ExceptionMapper { + @Override + public Response toResponse(BmcException e) { + return Response.status(e.getStatusCode()) + .entity(e.getMessage()) + .build(); + } +} diff --git a/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/VaultCdiMain.java b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/VaultCdiMain.java new file mode 100644 index 00000000..64193408 --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/VaultCdiMain.java @@ -0,0 +1,66 @@ +/* + * 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. + */ +package io.helidon.examples.integrations.oci.vault.cdi; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +import io.helidon.config.yaml.mp.YamlMpConfigSource; +import io.helidon.microprofile.cdi.Main; + +import org.eclipse.microprofile.config.Config; +import org.eclipse.microprofile.config.spi.ConfigProviderResolver; +import org.eclipse.microprofile.config.spi.ConfigSource; + +/** + * Main class of the example. + * Used only to set up configuration. + */ +public final class VaultCdiMain { + private VaultCdiMain() { + } + + /** + * Main method. + * + * @param args ignored + */ + public static void main(String[] args) { + ConfigProviderResolver configProvider = ConfigProviderResolver.instance(); + + Config mpConfig = configProvider.getBuilder() + .addDefaultSources() + .withSources(examplesConfig()) + .addDiscoveredSources() + .addDiscoveredConverters() + .build(); + + // configure + configProvider.registerConfig(mpConfig, null); + + // start CDI + Main.main(args); + } + + private static ConfigSource[] examplesConfig() { + Path path = Paths.get(System.getProperty("user.home") + "/helidon/conf/examples.yaml"); + if (Files.exists(path)) { + return new ConfigSource[] {YamlMpConfigSource.create(path)}; + } + return new ConfigSource[0]; + } +} diff --git a/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/VaultResource.java b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/VaultResource.java new file mode 100644 index 00000000..aceca6a2 --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/VaultResource.java @@ -0,0 +1,248 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.vault.cdi; + +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.Date; + +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.InternalServerErrorException; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; + +import io.helidon.common.Base64Value; + +import com.oracle.bmc.keymanagement.KmsCrypto; +import com.oracle.bmc.keymanagement.model.DecryptDataDetails; +import com.oracle.bmc.keymanagement.model.EncryptDataDetails; +import com.oracle.bmc.keymanagement.model.SignDataDetails; +import com.oracle.bmc.keymanagement.model.VerifyDataDetails; +import com.oracle.bmc.keymanagement.requests.DecryptRequest; +import com.oracle.bmc.keymanagement.requests.EncryptRequest; +import com.oracle.bmc.keymanagement.requests.SignRequest; +import com.oracle.bmc.keymanagement.requests.VerifyRequest; +import com.oracle.bmc.secrets.Secrets; +import com.oracle.bmc.secrets.model.Base64SecretBundleContentDetails; +import com.oracle.bmc.secrets.model.SecretBundleContentDetails; +import com.oracle.bmc.secrets.requests.GetSecretBundleRequest; +import com.oracle.bmc.vault.Vaults; +import com.oracle.bmc.vault.model.Base64SecretContentDetails; +import com.oracle.bmc.vault.model.CreateSecretDetails; +import com.oracle.bmc.vault.model.ScheduleSecretDeletionDetails; +import com.oracle.bmc.vault.model.SecretContentDetails; +import com.oracle.bmc.vault.requests.CreateSecretRequest; +import com.oracle.bmc.vault.requests.ScheduleSecretDeletionRequest; +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * JAX-RS resource - REST API of the example. + */ +@Path("/vault") +public class VaultResource { + private final Secrets secrets; + private final KmsCrypto crypto; + private final Vaults vaults; + private final String vaultOcid; + private final String compartmentOcid; + private final String encryptionKeyOcid; + private final String signatureKeyOcid; + + @Inject + VaultResource(Secrets secrets, + KmsCrypto crypto, + Vaults vaults, + @ConfigProperty(name = "app.vault.vault-ocid") + String vaultOcid, + @ConfigProperty(name = "app.vault.compartment-ocid") + String compartmentOcid, + @ConfigProperty(name = "app.vault.encryption-key-ocid") + String encryptionKeyOcid, + @ConfigProperty(name = "app.vault.signature-key-ocid") + String signatureKeyOcid) { + this.secrets = secrets; + this.crypto = crypto; + this.vaults = vaults; + this.vaultOcid = vaultOcid; + this.compartmentOcid = compartmentOcid; + this.encryptionKeyOcid = encryptionKeyOcid; + this.signatureKeyOcid = signatureKeyOcid; + } + + /** + * Encrypt a string. + * + * @param secret secret to encrypt + * @return cipher text + */ + @GET + @Path("/encrypt/{text}") + public String encrypt(@PathParam("text") String secret) { + return crypto.encrypt(EncryptRequest.builder() + .encryptDataDetails(EncryptDataDetails.builder() + .keyId(encryptionKeyOcid) + .plaintext(Base64Value.create(secret).toBase64()) + .build()) + .build()) + .getEncryptedData() + .getCiphertext(); + } + + /** + * Decrypt a cipher text. + * + * @param cipherText cipher text to decrypt + * @return original secret + */ + @GET + @Path("/decrypt/{text: .*}") + public String decrypt(@PathParam("text") String cipherText) { + return Base64Value.createFromEncoded(crypto.decrypt(DecryptRequest.builder() + .decryptDataDetails(DecryptDataDetails.builder() + .keyId(encryptionKeyOcid) + .ciphertext(cipherText) + .build()) + .build()) + .getDecryptedData() + .getPlaintext()) + .toDecodedString(); + } + + /** + * Sign data. + * + * @param dataToSign data to sign (must be a String) + * @return signature text + */ + @GET + @Path("/sign/{text}") + public String sign(@PathParam("text") String dataToSign) { + return crypto.sign(SignRequest.builder() + .signDataDetails(SignDataDetails.builder() + .keyId(signatureKeyOcid) + .signingAlgorithm(SignDataDetails.SigningAlgorithm.Sha224RsaPkcsPss) + .message(Base64Value.create(dataToSign).toBase64()) + .build()) + .build()) + .getSignedData() + .getSignature(); + } + + /** + * Verify a signature. The base64 encoded signature is the entity + * + * @param dataToVerify data that was signed + * @param signature signature text + * @return whether the signature is valid or not + */ + @POST + @Path("/verify/{text}") + public String verify(@PathParam("text") String dataToVerify, + String signature) { + VerifyDataDetails.SigningAlgorithm algorithm = VerifyDataDetails.SigningAlgorithm.Sha224RsaPkcsPss; + + boolean valid = crypto.verify(VerifyRequest.builder() + .verifyDataDetails(VerifyDataDetails.builder() + .keyId(signatureKeyOcid) + .signingAlgorithm(algorithm) + .message(Base64Value.create(dataToVerify).toBase64()) + .signature(signature) + .build()) + .build()) + .getVerifiedData() + .getIsSignatureValid(); + + return valid ? "Signature valid" : "Signature not valid"; + } + + /** + * Get secret content from Vault. + * + * @param secretOcid OCID of the secret to get + * @return content of the secret + */ + @GET + @Path("/secret/{id}") + public String getSecret(@PathParam("id") String secretOcid) { + SecretBundleContentDetails content = secrets.getSecretBundle(GetSecretBundleRequest.builder() + .secretId(secretOcid) + .build()) + .getSecretBundle() + .getSecretBundleContent(); + + if (content instanceof Base64SecretBundleContentDetails) { + // the only supported type + return Base64Value.createFromEncoded(((Base64SecretBundleContentDetails) content).getContent()).toDecodedString(); + } else { + throw new InternalServerErrorException("Invalid secret content type"); + } + } + + /** + * Delete a secret from Vault. + * This operation actually marks a secret for deletion, and the minimal time is 30 days. + * + * @param secretOcid OCID of the secret to delete + * @return short message + */ + @DELETE + @Path("/secret/{id}") + public String deleteSecret(@PathParam("id") String secretOcid) { + // has to be for quite a long period of time - did not work with less than 30 days + Date deleteTime = Date.from(Instant.now().plus(30, ChronoUnit.DAYS)); + + vaults.scheduleSecretDeletion(ScheduleSecretDeletionRequest.builder() + .secretId(secretOcid) + .scheduleSecretDeletionDetails(ScheduleSecretDeletionDetails.builder() + .timeOfDeletion(deleteTime) + .build()) + .build()); + + return "Secret " + secretOcid + " was marked for deletion"; + } + + /** + * Create a new secret. + * + * @param name name of the secret + * @param secretText secret content + * @return OCID of the created secret + */ + @POST + @Path("/secret/{name}") + public String createSecret(@PathParam("name") String name, + String secretText) { + SecretContentDetails content = Base64SecretContentDetails.builder() + .content(Base64Value.create(secretText).toBase64()) + .build(); + + return vaults.createSecret(CreateSecretRequest.builder() + .createSecretDetails(CreateSecretDetails.builder() + .secretName(name) + .vaultId(vaultOcid) + .compartmentId(compartmentOcid) + .keyId(encryptionKeyOcid) + .secretContent(content) + .build()) + .build()) + .getSecret() + .getId(); + } +} diff --git a/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/package-info.java b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/package-info.java new file mode 100644 index 00000000..2cdf8f23 --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/java/io/helidon/examples/integrations/oci/vault/cdi/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of OCI Vault integration in CDI. + */ +package io.helidon.examples.integrations.oci.vault.cdi; diff --git a/examples/integrations/oci/vault-cdi/src/main/resources/META-INF/beans.xml b/examples/integrations/oci/vault-cdi/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..391c10c3 --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/oci/vault-cdi/src/main/resources/application.yaml b/examples/integrations/oci/vault-cdi/src/main/resources/application.yaml new file mode 100644 index 00000000..8e3c1e70 --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/resources/application.yaml @@ -0,0 +1,31 @@ +# +# 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. +# + +server: + port: 8080 + +# +# The following properties under oci are accessed by Helidon. Values +# under oci.properties.* are read from ~/helidon/conf/examples.yaml. +# +app: + vault: + # Vault OCID (the vault you want to use for this example) + vault-ocid: "${oci.properties.vault-ocid}" + compartment-ocid: "${oci.properties.compartment-ocid}" + encryption-key-ocid: "${oci.properties.vault-key-ocid}" + signature-key-ocid: "${oci.properties.vault-rsa-key-ocid}" + cryptographic-endpoint: "${oci.properties.cryptographic-endpoint}" \ No newline at end of file diff --git a/examples/integrations/oci/vault-cdi/src/main/resources/logging.properties b/examples/integrations/oci/vault-cdi/src/main/resources/logging.properties new file mode 100644 index 00000000..02a8f58f --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/main/resources/logging.properties @@ -0,0 +1,27 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO diff --git a/examples/integrations/oci/vault-cdi/src/test/java/io/helidon/examples/integrations/oci/vault/cdi/VaultCdiTest.java b/examples/integrations/oci/vault-cdi/src/test/java/io/helidon/examples/integrations/oci/vault/cdi/VaultCdiTest.java new file mode 100644 index 00000000..3d16c8a8 --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/test/java/io/helidon/examples/integrations/oci/vault/cdi/VaultCdiTest.java @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2022, 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.integrations.oci.vault.cdi; + +import javax.inject.Inject; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * This test is not validating OCI integration code itself, as OCI authentication + * and configuration must be present for it to work. + * This test just starts the server and makes sure it is available. + */ +@HelidonTest +class VaultCdiTest { + private final WebTarget target; + + @Inject + VaultCdiTest(WebTarget target) { + this.target = target; + } + + @Test + void testServerUp() { + try (Response response = target.path("/health") + .request() + .get()) { + assertThat(response.getStatus(), is(200)); + } + } +} diff --git a/examples/integrations/oci/vault-cdi/src/test/resources/META-INF/microprofile-config.properties b/examples/integrations/oci/vault-cdi/src/test/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..51a275d6 --- /dev/null +++ b/examples/integrations/oci/vault-cdi/src/test/resources/META-INF/microprofile-config.properties @@ -0,0 +1,21 @@ +# +# Copyright (c) 2022 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. +# + +oci.properties.vault-ocid=a +oci.properties.compartment-ocid=a +oci.properties.vault-key-ocid=a +oci.properties.vault-rsa-key-ocid=a +oci.properties.cryptographic-endpoint=a diff --git a/examples/integrations/oci/vault-reactive/README.md b/examples/integrations/oci/vault-reactive/README.md new file mode 100644 index 00000000..4e6e4406 --- /dev/null +++ b/examples/integrations/oci/vault-reactive/README.md @@ -0,0 +1,9 @@ +The vault example. + +The example requires OCI config in some default place like ``.oci/config`` + +Build and run the example by +```shell +mvn package +java -jar ./target/helidon-examples-integrations-oci-vault-reactive.jar +``` \ No newline at end of file diff --git a/examples/integrations/oci/vault-reactive/pom.xml b/examples/integrations/oci/vault-reactive/pom.xml new file mode 100644 index 00000000..11a00f32 --- /dev/null +++ b/examples/integrations/oci/vault-reactive/pom.xml @@ -0,0 +1,84 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.oci + helidon-examples-integrations-oci-vault-reactive + 1.0.0-SNAPSHOT + Helidon Examples Integration OCI Vault Reactive + Reactive integration with OCI Vault. + + + io.helidon.examples.integrations.oci.vault.reactive.OciVaultMain + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + com.oracle.oci.sdk + oci-java-sdk-keymanagement + + + com.oracle.oci.sdk + oci-java-sdk-secrets + + + com.oracle.oci.sdk + oci-java-sdk-vault + + + + jakarta.inject + jakarta.inject-api + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/OciHandler.java b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/OciHandler.java new file mode 100644 index 00000000..3524162b --- /dev/null +++ b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/OciHandler.java @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2022, 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.integrations.oci.vault.reactive; + +import java.util.function.Consumer; +import java.util.logging.Level; +import java.util.logging.Logger; + +import com.oracle.bmc.responses.AsyncHandler; + +final class OciHandler { + private static final Logger LOGGER = Logger.getLogger(OciHandler.class.getName()); + + private OciHandler() { + } + + static AsyncHandler ociHandler(Consumer handler) { + return new AsyncHandler<>() { + @Override + public void onSuccess(REQ req, RES res) { + handler.accept(res); + } + + @Override + public void onError(REQ req, Throwable error) { + LOGGER.log(Level.WARNING, "OCI Exception", error); + if (error instanceof Error) { + throw (Error) error; + } + if (error instanceof RuntimeException) { + throw (RuntimeException) error; + } + throw new RuntimeException(error); + } + }; + } +} diff --git a/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/OciVaultMain.java b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/OciVaultMain.java new file mode 100644 index 00000000..9cdd5432 --- /dev/null +++ b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/OciVaultMain.java @@ -0,0 +1,106 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.vault.reactive; + +import java.io.IOException; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import com.oracle.bmc.ConfigFileReader; +import com.oracle.bmc.auth.AuthenticationDetailsProvider; +import com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider; +import com.oracle.bmc.keymanagement.KmsCryptoAsync; +import com.oracle.bmc.keymanagement.KmsCryptoAsyncClient; +import com.oracle.bmc.model.BmcException; +import com.oracle.bmc.secrets.SecretsAsync; +import com.oracle.bmc.secrets.SecretsAsyncClient; +import com.oracle.bmc.vault.VaultsAsync; +import com.oracle.bmc.vault.VaultsAsyncClient; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * Main class of the example. + * Boots a web server and provides REST API for Vault interactions. + */ +public final class OciVaultMain { + private OciVaultMain() { + } + + /** + * Main method. + * @param args ignored + */ + public static void main(String[] args) throws IOException { + LogConfig.configureRuntime(); + + // as I cannot share my configuration of OCI, let's combine the configuration + // from my home directory with the one compiled into the jar + // when running this example, you can either update the application.yaml in resources directory + // or use the same approach + Config config = buildConfig(); + + Config vaultConfig = config.get("oci.vault"); + // the following three parameters are required + String vaultOcid = vaultConfig.get("vault-ocid").asString().get(); + String compartmentOcid = vaultConfig.get("compartment-ocid").asString().get(); + String encryptionKey = vaultConfig.get("encryption-key-ocid").asString().get(); + String signatureKey = vaultConfig.get("signature-key-ocid").asString().get(); + String cryptoEndpoint = vaultConfig.get("cryptographic-endpoint").asString().get(); + + // this requires OCI configuration in the usual place + // ~/.oci/config + AuthenticationDetailsProvider authProvider = new ConfigFileAuthenticationDetailsProvider(ConfigFileReader.parseDefault()); + + SecretsAsync secrets = SecretsAsyncClient.builder().build(authProvider); + KmsCryptoAsync crypto = KmsCryptoAsyncClient.builder() + .endpoint(cryptoEndpoint) + .build(authProvider); + VaultsAsync vaults = VaultsAsyncClient.builder().build(authProvider); + + WebServer.builder() + .config(config.get("server")) + .routing(Routing.builder() + .register("/vault", new VaultService(secrets, + vaults, + crypto, + vaultOcid, + compartmentOcid, + encryptionKey, + signatureKey)) + // OCI SDK error handling + .error(BmcException.class, (req, res, ex) -> res.status(ex.getStatusCode()) + .send(ex.getMessage()))) + .build() + .start() + .await(); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults that are built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } +} diff --git a/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/VaultService.java b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/VaultService.java new file mode 100644 index 00000000..a04ec509 --- /dev/null +++ b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/VaultService.java @@ -0,0 +1,184 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.oci.vault.reactive; + +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.Date; + +import io.helidon.common.Base64Value; +import io.helidon.webserver.Handler; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import com.oracle.bmc.keymanagement.KmsCryptoAsync; +import com.oracle.bmc.keymanagement.model.DecryptDataDetails; +import com.oracle.bmc.keymanagement.model.EncryptDataDetails; +import com.oracle.bmc.keymanagement.model.SignDataDetails; +import com.oracle.bmc.keymanagement.model.VerifyDataDetails; +import com.oracle.bmc.keymanagement.requests.DecryptRequest; +import com.oracle.bmc.keymanagement.requests.EncryptRequest; +import com.oracle.bmc.keymanagement.requests.SignRequest; +import com.oracle.bmc.keymanagement.requests.VerifyRequest; +import com.oracle.bmc.secrets.SecretsAsync; +import com.oracle.bmc.secrets.model.Base64SecretBundleContentDetails; +import com.oracle.bmc.secrets.model.SecretBundleContentDetails; +import com.oracle.bmc.secrets.requests.GetSecretBundleRequest; +import com.oracle.bmc.vault.VaultsAsync; +import com.oracle.bmc.vault.model.Base64SecretContentDetails; +import com.oracle.bmc.vault.model.CreateSecretDetails; +import com.oracle.bmc.vault.model.ScheduleSecretDeletionDetails; +import com.oracle.bmc.vault.model.SecretContentDetails; +import com.oracle.bmc.vault.requests.CreateSecretRequest; +import com.oracle.bmc.vault.requests.ScheduleSecretDeletionRequest; + +import static io.helidon.examples.integrations.oci.vault.reactive.OciHandler.ociHandler; + +class VaultService implements Service { + private final SecretsAsync secrets; + private final VaultsAsync vaults; + private final KmsCryptoAsync crypto; + private final String vaultOcid; + private final String compartmentOcid; + private final String encryptionKeyOcid; + private final String signatureKeyOcid; + + VaultService(SecretsAsync secrets, + VaultsAsync vaults, + KmsCryptoAsync crypto, + String vaultOcid, + String compartmentOcid, + String encryptionKeyOcid, + String signatureKeyOcid) { + this.secrets = secrets; + this.vaults = vaults; + this.crypto = crypto; + this.vaultOcid = vaultOcid; + this.compartmentOcid = compartmentOcid; + this.encryptionKeyOcid = encryptionKeyOcid; + this.signatureKeyOcid = signatureKeyOcid; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/encrypt/{text:.*}", this::encrypt) + .get("/decrypt/{text:.*}", this::decrypt) + .get("/sign/{text}", this::sign) + .post("/verify/{text}", Handler.create(String.class, this::verify)) + .get("/secret/{id}", this::getSecret) + .post("/secret/{name}", Handler.create(String.class, this::createSecret)) + .delete("/secret/{id}", this::deleteSecret); + } + + private void getSecret(ServerRequest req, ServerResponse res) { + secrets.getSecretBundle(GetSecretBundleRequest.builder() + .secretId(req.path().param("id")) + .build(), ociHandler(ociRes -> { + SecretBundleContentDetails content = ociRes.getSecretBundle().getSecretBundleContent(); + if (content instanceof Base64SecretBundleContentDetails) { + // the only supported type + res.send(Base64Value.createFromEncoded(((Base64SecretBundleContentDetails) content).getContent()) + .toDecodedString()); + } else { + req.next(new Exception("Invalid secret content type")); + } + })); + } + + private void deleteSecret(ServerRequest req, ServerResponse res) { + // has to be for quite a long period of time - did not work with less than 30 days + Date deleteTime = Date.from(Instant.now().plus(30, ChronoUnit.DAYS)); + + String secretOcid = req.path().param("id"); + + vaults.scheduleSecretDeletion(ScheduleSecretDeletionRequest.builder() + .secretId(secretOcid) + .scheduleSecretDeletionDetails(ScheduleSecretDeletionDetails.builder() + .timeOfDeletion(deleteTime) + .build()) + .build(), ociHandler(ociRes -> res.send("Secret " + secretOcid + + " was marked for deletion"))); + } + + private void createSecret(ServerRequest req, ServerResponse res, String secretText) { + SecretContentDetails content = Base64SecretContentDetails.builder() + .content(Base64Value.create(secretText).toBase64()) + .build(); + + vaults.createSecret(CreateSecretRequest.builder() + .createSecretDetails(CreateSecretDetails.builder() + .secretName(req.path().param("name")) + .vaultId(vaultOcid) + .compartmentId(compartmentOcid) + .keyId(encryptionKeyOcid) + .secretContent(content) + .build()) + .build(), ociHandler(ociRes -> res.send(ociRes.getSecret().getId()))); + } + + private void verify(ServerRequest req, ServerResponse res, String signature) { + String text = req.path().param("text"); + VerifyDataDetails.SigningAlgorithm algorithm = VerifyDataDetails.SigningAlgorithm.Sha224RsaPkcsPss; + + crypto.verify(VerifyRequest.builder() + .verifyDataDetails(VerifyDataDetails.builder() + .keyId(signatureKeyOcid) + .signingAlgorithm(algorithm) + .message(Base64Value.create(text).toBase64()) + .signature(signature) + .build()) + .build(), + ociHandler(ociRes -> { + boolean valid = ociRes.getVerifiedData() + .getIsSignatureValid(); + res.send(valid ? "Signature valid" : "Signature not valid"); + })); + } + + private void sign(ServerRequest req, ServerResponse res) { + crypto.sign(SignRequest.builder() + .signDataDetails(SignDataDetails.builder() + .keyId(signatureKeyOcid) + .signingAlgorithm(SignDataDetails.SigningAlgorithm.Sha224RsaPkcsPss) + .message(Base64Value.create(req.path().param("text")).toBase64()) + .build()) + .build(), ociHandler(ociRes -> res.send(ociRes.getSignedData() + .getSignature()))); + } + + private void encrypt(ServerRequest req, ServerResponse res) { + crypto.encrypt(EncryptRequest.builder() + .encryptDataDetails(EncryptDataDetails.builder() + .keyId(encryptionKeyOcid) + .plaintext(Base64Value.create(req.path().param("text")).toBase64()) + .build()) + .build(), ociHandler(ociRes -> res.send(ociRes.getEncryptedData().getCiphertext()))); + } + + private void decrypt(ServerRequest req, ServerResponse res) { + crypto.decrypt(DecryptRequest.builder() + .decryptDataDetails(DecryptDataDetails.builder() + .keyId(encryptionKeyOcid) + .ciphertext(req.path().param("text")) + .build()) + .build(), ociHandler(ociRes -> res.send(Base64Value.createFromEncoded(ociRes.getDecryptedData() + .getPlaintext()) + .toDecodedString()))); + } +} diff --git a/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/package-info.java b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/package-info.java new file mode 100644 index 00000000..8a3411ad --- /dev/null +++ b/examples/integrations/oci/vault-reactive/src/main/java/io/helidon/examples/integrations/oci/vault/reactive/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of OCI Vault integration in a reactive application. + */ +package io.helidon.examples.integrations.oci.vault.reactive; diff --git a/examples/integrations/oci/vault-reactive/src/main/resources/application.yaml b/examples/integrations/oci/vault-reactive/src/main/resources/application.yaml new file mode 100644 index 00000000..eaf0fff5 --- /dev/null +++ b/examples/integrations/oci/vault-reactive/src/main/resources/application.yaml @@ -0,0 +1,31 @@ +# +# 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. +# + +server: + port: 8080 + +# +# The following properties under oci are accessed by Helidon. Values +# under oci.properties.* are read from ~/helidon/conf/examples.yaml. +# +oci: + vault: + # Vault OCID (the vault you want to use for this example + vault-ocid: "${oci.properties.vault-ocid}" + compartment-ocid: "${oci.properties.compartment-ocid}" + encryption-key-ocid: "${oci.properties.vault-key-ocid}" + signature-key-ocid: "${oci.properties.vault-rsa-key-ocid}" + cryptographic-endpoint: "${oci.properties.cryptographic-endpoint}" diff --git a/examples/integrations/oci/vault-reactive/src/main/resources/logging.properties b/examples/integrations/oci/vault-reactive/src/main/resources/logging.properties new file mode 100644 index 00000000..02a8f58f --- /dev/null +++ b/examples/integrations/oci/vault-reactive/src/main/resources/logging.properties @@ -0,0 +1,27 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO diff --git a/examples/integrations/pom.xml b/examples/integrations/pom.xml new file mode 100644 index 00000000..c8fcc7ec --- /dev/null +++ b/examples/integrations/pom.xml @@ -0,0 +1,43 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.integrations + helidon-examples-integrations-project + Helidon Integrations Examples + pom + + + cdi + micronaut + neo4j + micrometer + oci + vault + microstream + + + diff --git a/examples/integrations/vault/hcp-cdi/README.md b/examples/integrations/vault/hcp-cdi/README.md new file mode 100644 index 00000000..e32863c4 --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/README.md @@ -0,0 +1,26 @@ +HCP Vault Integration with Reactive APIs +--- + +This example expects an empty Vault. It uses the token to create all required resources. + +To run this example: + +1. Run a docker image with a known root token + +```shell +docker run --cap-add=IPC_LOCK -e VAULT_DEV_ROOT_TOKEN_ID=myroot -d --name=vault -p8200:8200 vault +``` + +2. Build this application + +```shell +mvn clean package +``` + +3. Start this application + +```shell +java -jar ./target/helidon-examples-integrations-vault-hcp-cdi.jar +``` + +4. Exercise the endpoints \ No newline at end of file diff --git a/examples/integrations/vault/hcp-cdi/pom.xml b/examples/integrations/vault/hcp-cdi/pom.xml new file mode 100644 index 00000000..e5a68fa8 --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/pom.xml @@ -0,0 +1,101 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.vault + helidon-examples-integrations-vault-hcp-cdi + 1.0.0-SNAPSHOT + Helidon Examples Integration Vault CDI + CDI integration with Vault. + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.integrations.vault + helidon-integrations-vault-cdi + + + io.helidon.config + helidon-config-yaml + + + io.helidon.integrations.vault.auths + helidon-integrations-vault-auths-token + + + io.helidon.integrations.vault.auths + helidon-integrations-vault-auths-approle + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-kv1 + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-kv2 + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-cubbyhole + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-transit + + + io.helidon.integrations.vault.sys + helidon-integrations-vault-sys + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/CubbyholeResource.java b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/CubbyholeResource.java new file mode 100644 index 00000000..d56f4c92 --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/CubbyholeResource.java @@ -0,0 +1,100 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.cdi; + +import java.util.Map; +import java.util.Optional; + +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.core.Response; + +import io.helidon.integrations.vault.Secret; +import io.helidon.integrations.vault.secrets.cubbyhole.CreateCubbyhole; +import io.helidon.integrations.vault.secrets.cubbyhole.CubbyholeSecrets; +import io.helidon.integrations.vault.secrets.cubbyhole.DeleteCubbyhole; + +/** + * JAX-RS resource for Cubbyhole secrets engine operations. + */ +@Path("/cubbyhole") +public class CubbyholeResource { + private final CubbyholeSecrets secrets; + + @Inject + CubbyholeResource(CubbyholeSecrets secrets) { + this.secrets = secrets; + } + + /** + * Create a secret from request entity, the name of the value is {@code secret}. + * + * @param path path of the secret taken from request path + * @param secret secret from the entity + * @return response + */ + @POST + @Path("/secrets/{path: .*}") + public Response createSecret(@PathParam("path") String path, String secret) { + CreateCubbyhole.Response response = secrets.create(path, Map.of("secret", secret)); + + return Response.ok() + .entity("Created secret on path: " + path + ", key is \"secret\", original status: " + response.status().code()) + .build(); + } + + /** + * Delete the secret on a specified path. + * + * @param path path of the secret taken from request path + * @return response + */ + @DELETE + @Path("/secrets/{path: .*}") + public Response deleteSecret(@PathParam("path") String path) { + DeleteCubbyhole.Response response = secrets.delete(path); + + return Response.ok() + .entity("Deleted secret on path: " + path + ". Original status: " + response.status().code()) + .build(); + } + + /** + * Get the secret on a specified path. + * + * @param path path of the secret taken from request path + * @return response + */ + @GET + @Path("/secrets/{path: .*}") + public Response getSecret(@PathParam("path") String path) { + Optional secret = secrets.get(path); + + if (secret.isPresent()) { + Secret kv1Secret = secret.get(); + return Response.ok() + .entity("Secret: " + secret.get().values().toString()) + .build(); + } else { + return Response.status(Response.Status.NOT_FOUND).build(); + } + } +} diff --git a/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/Kv1Resource.java b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/Kv1Resource.java new file mode 100644 index 00000000..82bc2571 --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/Kv1Resource.java @@ -0,0 +1,134 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.util.Map; +import java.util.Optional; + +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.core.Response; + +import io.helidon.integrations.vault.Secret; +import io.helidon.integrations.vault.secrets.kv1.CreateKv1; +import io.helidon.integrations.vault.secrets.kv1.DeleteKv1; +import io.helidon.integrations.vault.secrets.kv1.Kv1Secrets; +import io.helidon.integrations.vault.secrets.kv1.Kv1SecretsRx; +import io.helidon.integrations.vault.sys.DisableEngine; +import io.helidon.integrations.vault.sys.EnableEngine; +import io.helidon.integrations.vault.sys.Sys; + +/** + * JAX-RS resource for Key/Value version 1 secrets engine operations. + */ +@Path("/kv1") +public class Kv1Resource { + private final Sys sys; + private final Kv1Secrets secrets; + + @Inject + Kv1Resource(Sys sys, Kv1Secrets secrets) { + this.sys = sys; + this.secrets = secrets; + } + + /** + * Enable the secrets engine on the default path. + * + * @return response + */ + @Path("/engine") + @GET + public Response enableEngine() { + EnableEngine.Response response = sys.enableEngine(Kv1SecretsRx.ENGINE); + + return Response.ok() + .entity("Key/value version 1 secret engine is now enabled. Original status: " + response.status().code()) + .build(); + } + + /** + * Disable the secrets engine on the default path. + * @return response + */ + @Path("/engine") + @DELETE + public Response disableEngine() { + DisableEngine.Response response = sys.disableEngine(Kv1SecretsRx.ENGINE); + return Response.ok() + .entity("Key/value version 1 secret engine is now disabled. Original status: " + response.status().code()) + .build(); + } + + /** + * Create a secret from request entity, the name of the value is {@code secret}. + * + * @param path path of the secret taken from request path + * @param secret secret from the entity + * @return response + */ + @POST + @Path("/secrets/{path: .*}") + public Response createSecret(@PathParam("path") String path, String secret) { + CreateKv1.Response response = secrets.create(path, Map.of("secret", secret)); + + return Response.ok() + .entity("Created secret on path: " + path + ", key is \"secret\", original status: " + response.status().code()) + .build(); + } + + /** + * Delete the secret on a specified path. + * + * @param path path of the secret taken from request path + * @return response + */ + @DELETE + @Path("/secrets/{path: .*}") + public Response deleteSecret(@PathParam("path") String path) { + DeleteKv1.Response response = secrets.delete(path); + + return Response.ok() + .entity("Deleted secret on path: " + path + ". Original status: " + response.status().code()) + .build(); + } + + /** + * Get the secret on a specified path. + * + * @param path path of the secret taken from request path + * @return response + */ + @GET + @Path("/secrets/{path: .*}") + public Response getSecret(@PathParam("path") String path) { + Optional secret = secrets.get(path); + + if (secret.isPresent()) { + Secret kv1Secret = secret.get(); + return Response.ok() + .entity("Secret: " + secret.get().values().toString()) + .build(); + } else { + return Response.status(Response.Status.NOT_FOUND).build(); + } + } +} diff --git a/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/Kv2Resource.java b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/Kv2Resource.java new file mode 100644 index 00000000..d2adca90 --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/Kv2Resource.java @@ -0,0 +1,101 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.cdi; + +import java.util.Map; +import java.util.Optional; + +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.core.Response; + +import io.helidon.integrations.vault.secrets.kv2.CreateKv2; +import io.helidon.integrations.vault.secrets.kv2.DeleteAllKv2; +import io.helidon.integrations.vault.secrets.kv2.Kv2Secret; +import io.helidon.integrations.vault.secrets.kv2.Kv2Secrets; + +/** + * JAX-RS resource for Key/Value version 2 secrets engine operations. + */ +@Path("/kv2") +public class Kv2Resource { + private final Kv2Secrets secrets; + + @Inject + Kv2Resource(Kv2Secrets secrets) { + this.secrets = secrets; + } + + /** + * Create a secret from request entity, the name of the value is {@code secret}. + * + * @param path path of the secret taken from request path + * @param secret secret from the entity + * @return response + */ + @POST + @Path("/secrets/{path: .*}") + public Response createSecret(@PathParam("path") String path, String secret) { + CreateKv2.Response response = secrets.create(path, Map.of("secret", secret)); + + return Response.ok() + .entity("Created secret on path: " + path + ", key is \"secret\", original status: " + response.status().code()) + .build(); + } + + /** + * Delete the secret on a specified path. + * + * @param path path of the secret taken from request path + * @return response + */ + @DELETE + @Path("/secrets/{path: .*}") + public Response deleteSecret(@PathParam("path") String path) { + DeleteAllKv2.Response response = secrets.deleteAll(path); + + return Response.ok() + .entity("Deleted secret on path: " + path + ". Original status: " + response.status().code()) + .build(); + } + + /** + * Get the secret on a specified path. + * + * @param path path of the secret taken from request path + * @return response + */ + @GET + @Path("/secrets/{path: .*}") + public Response getSecret(@PathParam("path") String path) { + + Optional secret = secrets.get(path); + + if (secret.isPresent()) { + Kv2Secret kv2Secret = secret.get(); + return Response.ok() + .entity("Version " + kv2Secret.metadata().version() + ", secret: " + kv2Secret.values().toString()) + .build(); + } else { + return Response.status(Response.Status.NOT_FOUND).build(); + } + } +} diff --git a/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/TransitResource.java b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/TransitResource.java new file mode 100644 index 00000000..e83dcdc0 --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/TransitResource.java @@ -0,0 +1,231 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.cdi; + +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.core.Response; + +import io.helidon.common.Base64Value; +import io.helidon.integrations.vault.secrets.transit.CreateKey; +import io.helidon.integrations.vault.secrets.transit.Decrypt; +import io.helidon.integrations.vault.secrets.transit.DeleteKey; +import io.helidon.integrations.vault.secrets.transit.Encrypt; +import io.helidon.integrations.vault.secrets.transit.Hmac; +import io.helidon.integrations.vault.secrets.transit.Sign; +import io.helidon.integrations.vault.secrets.transit.TransitSecrets; +import io.helidon.integrations.vault.secrets.transit.TransitSecretsRx; +import io.helidon.integrations.vault.secrets.transit.UpdateKeyConfig; +import io.helidon.integrations.vault.secrets.transit.Verify; +import io.helidon.integrations.vault.sys.DisableEngine; +import io.helidon.integrations.vault.sys.EnableEngine; +import io.helidon.integrations.vault.sys.Sys; + +/** + * JAX-RS resource for Transit secrets engine operations. + */ +@Path("/transit") +public class TransitResource { + private static final String ENCRYPTION_KEY = "encryption-key"; + private static final String SIGNATURE_KEY = "signature-key"; + + private final Sys sys; + private final TransitSecrets secrets; + + @Inject + TransitResource(Sys sys, TransitSecrets secrets) { + this.sys = sys; + this.secrets = secrets; + } + + /** + * Enable the secrets engine on the default path. + * + * @return response + */ + @Path("/engine") + @GET + public Response enableEngine() { + EnableEngine.Response response = sys.enableEngine(TransitSecretsRx.ENGINE); + + return Response.ok() + .entity("Transit secret engine is now enabled. Original status: " + response.status().code()) + .build(); + } + + /** + * Disable the secrets engine on the default path. + * @return response + */ + @Path("/engine") + @DELETE + public Response disableEngine() { + DisableEngine.Response response = sys.disableEngine(TransitSecretsRx.ENGINE); + + return Response.ok() + .entity("Transit secret engine is now disabled. Original status: " + response.status()) + .build(); + } + + /** + * Create the encrypting and signature keys. + * + * @return response + */ + @Path("/keys") + @GET + public Response createKeys() { + secrets.createKey(CreateKey.Request.builder() + .name(ENCRYPTION_KEY)); + + secrets.createKey(CreateKey.Request.builder() + .name(SIGNATURE_KEY) + .type("rsa-2048")); + + return Response.ok() + .entity("Created encryption (and HMAC), and signature keys") + .build(); + } + + /** + * Delete the encryption and signature keys. + * + * @return response + */ + @Path("/keys") + @DELETE + public Response deleteKeys() { + // we must first enable deletion of the key (by default it cannot be deleted) + secrets.updateKeyConfig(UpdateKeyConfig.Request.builder() + .name(ENCRYPTION_KEY) + .allowDeletion(true)); + + secrets.updateKeyConfig(UpdateKeyConfig.Request.builder() + .name(SIGNATURE_KEY) + .allowDeletion(true)); + + secrets.deleteKey(DeleteKey.Request.create(ENCRYPTION_KEY)); + secrets.deleteKey(DeleteKey.Request.create(SIGNATURE_KEY)); + + return Response.ok() + .entity("Deleted encryption (and HMAC), and signature keys") + .build(); + } + + /** + * Encrypt a secret. + * + * @param secret provided as part of the path + * @return cipher text + */ + @Path("/encrypt/{secret: .*}") + @GET + public String encryptSecret(@PathParam("secret") String secret) { + return secrets.encrypt(Encrypt.Request.builder() + .encryptionKeyName(ENCRYPTION_KEY) + .data(Base64Value.create(secret))) + .encrypted() + .cipherText(); + } + + /** + * Decrypt a secret. + * + * @param cipherText provided as part of the path + * @return decrypted secret text + */ + @Path("/decrypt/{cipherText: .*}") + @GET + public String decryptSecret(@PathParam("cipherText") String cipherText) { + return secrets.decrypt(Decrypt.Request.builder() + .encryptionKeyName(ENCRYPTION_KEY) + .cipherText(cipherText)) + .decrypted() + .toDecodedString(); + } + + /** + * Create an HMAC for text. + * + * @param text text to do HMAC for + * @return hmac string that can be used to {@link #verifyHmac(String, String)} + */ + @Path("/hmac/{text}") + @GET + public String hmac(@PathParam("text") String text) { + return secrets.hmac(Hmac.Request.builder() + .hmacKeyName(ENCRYPTION_KEY) + .data(Base64Value.create(text))) + .hmac(); + } + + /** + * Create a signature for text. + * + * @param text text to sign + * @return signature string that can be used to {@link #verifySignature(String, String)} + */ + @Path("/sign/{text}") + @GET + public String sign(@PathParam("text") String text) { + return secrets.sign(Sign.Request.builder() + .signatureKeyName(SIGNATURE_KEY) + .data(Base64Value.create(text))) + .signature(); + } + + /** + * Verify HMAC. + * + * @param secret secret that was used to {@link #hmac(String)} + * @param hmac HMAC text + * @return {@code HMAC Valid} or {@code HMAC Invalid} + */ + @Path("/verify/hmac/{secret}/{hmac: .*}") + @GET + public String verifyHmac(@PathParam("secret") String secret, @PathParam("hmac") String hmac) { + boolean isValid = secrets.verify(Verify.Request.builder() + .digestKeyName(ENCRYPTION_KEY) + .data(Base64Value.create(secret)) + .hmac(hmac)) + .isValid(); + + return (isValid ? "HMAC Valid" : "HMAC Invalid"); + } + + /** + * Verify signature. + * + * @param secret secret that was used to {@link #sign(String)} + * @param signature signature + * @return {@code Signature Valid} or {@code Signature Invalid} + */ + @Path("/verify/sign/{secret}/{signature: .*}") + @GET + public String verifySignature(@PathParam("secret") String secret, @PathParam("signature") String signature) { + boolean isValid = secrets.verify(Verify.Request.builder() + .digestKeyName(SIGNATURE_KEY) + .data(Base64Value.create(secret)) + .signature(signature)) + .isValid(); + + return (isValid ? "Signature Valid" : "Signature Invalid"); + } +} diff --git a/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/VaultCdiMain.java b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/VaultCdiMain.java new file mode 100644 index 00000000..0d14ae1c --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/VaultCdiMain.java @@ -0,0 +1,66 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.cdi; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +import io.helidon.config.yaml.mp.YamlMpConfigSource; +import io.helidon.microprofile.cdi.Main; + +import org.eclipse.microprofile.config.Config; +import org.eclipse.microprofile.config.spi.ConfigProviderResolver; +import org.eclipse.microprofile.config.spi.ConfigSource; + +/** + * Main class of example. + */ +public final class VaultCdiMain { + private VaultCdiMain() { + } + + /** + * Main method of example. + * + * @param args ignored + */ + public static void main(String[] args) { + ConfigProviderResolver configProvider = ConfigProviderResolver.instance(); + + Config mpConfig = configProvider.getBuilder() + .addDefaultSources() + .withSources(examplesConfig()) + .addDiscoveredSources() + .addDiscoveredConverters() + .build(); + + // configure + configProvider.registerConfig(mpConfig, null); + + // start CDI + Main.main(args); + } + + private static ConfigSource[] examplesConfig() { + Path path = Paths.get(System.getProperty("user.home") + "/helidon/conf/examples.yaml"); + if (Files.exists(path)) { + return new ConfigSource[] {YamlMpConfigSource.create(path)}; + } + return new ConfigSource[0]; + } +} diff --git a/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/package-info.java b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/package-info.java new file mode 100644 index 00000000..34e9215f --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/java/io/helidon/examples/integrations/vault/hcp/cdi/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of Helidon integration with Hashicorp Vault within CDI. + */ +package io.helidon.examples.integrations.vault.hcp.cdi; diff --git a/examples/integrations/vault/hcp-cdi/src/main/resources/META-INF/beans.xml b/examples/integrations/vault/hcp-cdi/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..391c10c3 --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/integrations/vault/hcp-cdi/src/main/resources/application.yaml b/examples/integrations/vault/hcp-cdi/src/main/resources/application.yaml new file mode 100644 index 00000000..67fdf52e --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/resources/application.yaml @@ -0,0 +1,27 @@ +# +# 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. +# + +server.port: 8080 + +vault: + default: + address: "http://localhost:8200" + token: "myroot" + auth: + app-role: + enabled: false + token: + enabled: true diff --git a/examples/integrations/vault/hcp-cdi/src/main/resources/logging.properties b/examples/integrations/vault/hcp-cdi/src/main/resources/logging.properties new file mode 100644 index 00000000..02a8f58f --- /dev/null +++ b/examples/integrations/vault/hcp-cdi/src/main/resources/logging.properties @@ -0,0 +1,27 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO diff --git a/examples/integrations/vault/hcp-reactive/README.md b/examples/integrations/vault/hcp-reactive/README.md new file mode 100644 index 00000000..f980900b --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/README.md @@ -0,0 +1,26 @@ +HCP Vault Integration with Reactive APIs +--- + +This example expects an empty Vault. It uses the token to create all required resources. + +To run this example: + +1. Run a docker image with a known root token + +```shell +docker run --cap-add=IPC_LOCK -e VAULT_DEV_ROOT_TOKEN_ID=myroot -d --name=vault -p8200:8200 vault +``` + +2. Build this application + +```shell +mvn clean package +``` + +3. Start this application + +```shell +java -jar ./target/helidon-examples-integrations-vault-hcp-reactive.jar +``` + +4. Exercise the endpoints \ No newline at end of file diff --git a/examples/integrations/vault/hcp-reactive/pom.xml b/examples/integrations/vault/hcp-reactive/pom.xml new file mode 100644 index 00000000..5b699155 --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/pom.xml @@ -0,0 +1,100 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.integrations.vault + helidon-examples-integrations-vault-hcp-reactive + 1.0.0-SNAPSHOT + Helidon Examples Integration Vault Reactive + Reactive integration with Vault. + + + io.helidon.examples.integrations.vault.hcp.reactive.ReactiveVaultMain + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.integrations.vault + helidon-integrations-vault + + + io.helidon.config + helidon-config-yaml + + + io.helidon.integrations.vault.auths + helidon-integrations-vault-auths-token + + + io.helidon.integrations.vault.auths + helidon-integrations-vault-auths-approle + + + io.helidon.integrations.vault.auths + helidon-integrations-vault-auths-k8s + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-kv1 + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-kv2 + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-cubbyhole + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-transit + + + io.helidon.integrations.vault.sys + helidon-integrations-vault-sys + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/AppRoleExample.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/AppRoleExample.java new file mode 100644 index 00000000..de2d3184 --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/AppRoleExample.java @@ -0,0 +1,127 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.time.Duration; +import java.util.Map; +import java.util.concurrent.atomic.AtomicReference; + +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.integrations.common.rest.ApiResponse; +import io.helidon.integrations.vault.Vault; +import io.helidon.integrations.vault.auths.approle.AppRoleAuthRx; +import io.helidon.integrations.vault.auths.approle.AppRoleVaultAuth; +import io.helidon.integrations.vault.auths.approle.CreateAppRole; +import io.helidon.integrations.vault.auths.approle.GenerateSecretId; +import io.helidon.integrations.vault.secrets.kv2.Kv2Secret; +import io.helidon.integrations.vault.secrets.kv2.Kv2SecretsRx; +import io.helidon.integrations.vault.sys.EnableAuth; +import io.helidon.integrations.vault.sys.SysRx; + +class AppRoleExample { + private static final String SECRET_PATH = "approle/example/secret"; + private static final String ROLE_NAME = "approle_role"; + private static final String POLICY_NAME = "approle_policy"; + private static final String CUSTOM_APP_ROLE_PATH = "customapprole"; + + private final Vault tokenVault; + private final Config config; + private final SysRx sys; + + private Vault appRoleVault; + + AppRoleExample(Vault tokenVault, Config config) { + this.tokenVault = tokenVault; + this.config = config; + + this.sys = tokenVault.sys(SysRx.API); + } + + public Single run() { + /* + The following tasks must be run before we authenticate + */ + return enableAppRoleAuth() + // Now we can login using AppRole + .flatMapSingle(ignored -> workWithSecrets()) + // Now back to token based Vault, as we will clean up + .flatMapSingle(ignored -> disableAppRoleAuth()) + .map(ignored -> "AppRole example finished successfully."); + } + + private Single workWithSecrets() { + Kv2SecretsRx secrets = appRoleVault.secrets(Kv2SecretsRx.ENGINE); + + return secrets.create(SECRET_PATH, Map.of("secret-key", "secretValue", + "secret-user", "username")) + .flatMapSingle(ignored -> secrets.get(SECRET_PATH)) + .peek(secret -> { + if (secret.isPresent()) { + Kv2Secret kv2Secret = secret.get(); + System.out.println("appRole first secret: " + kv2Secret.value("secret-key")); + System.out.println("appRole second secret: " + kv2Secret.value("secret-user")); + } else { + System.out.println("appRole secret not found"); + } + }).flatMapSingle(ignored -> secrets.deleteAll(SECRET_PATH)); + } + + private Single disableAppRoleAuth() { + return sys.deletePolicy(POLICY_NAME) + .flatMapSingle(ignored -> sys.disableAuth(CUSTOM_APP_ROLE_PATH)); + } + + private Single enableAppRoleAuth() { + AtomicReference roleId = new AtomicReference<>(); + AtomicReference secretId = new AtomicReference<>(); + + // enable the method + return sys.enableAuth(EnableAuth.Request.builder() + .auth(AppRoleAuthRx.AUTH_METHOD) + // must be aligned with path configured in application.yaml + .path(CUSTOM_APP_ROLE_PATH)) + // add policy + .flatMapSingle(ignored -> sys.createPolicy(POLICY_NAME, VaultPolicy.POLICY)) + .flatMapSingle(ignored -> tokenVault.auth(AppRoleAuthRx.AUTH_METHOD, CUSTOM_APP_ROLE_PATH) + .createAppRole(CreateAppRole.Request.builder() + .roleName(ROLE_NAME) + .addTokenPolicy(POLICY_NAME) + .tokenExplicitMaxTtl(Duration.ofMinutes(1)))) + .flatMapSingle(ignored -> tokenVault.auth(AppRoleAuthRx.AUTH_METHOD, CUSTOM_APP_ROLE_PATH) + .readRoleId(ROLE_NAME)) + .peek(it -> it.ifPresent(roleId::set)) + .flatMapSingle(ignored -> tokenVault.auth(AppRoleAuthRx.AUTH_METHOD, CUSTOM_APP_ROLE_PATH) + .generateSecretId(GenerateSecretId.Request.builder() + .roleName(ROLE_NAME) + .addMetadata("name", "helidon"))) + .map(GenerateSecretId.Response::secretId) + .peek(secretId::set) + .peek(ignored -> { + System.out.println("roleId: " + roleId.get()); + System.out.println("secretId: " + secretId.get()); + appRoleVault = Vault.builder() + .config(config) + .addVaultAuth(AppRoleVaultAuth.builder() + .path(CUSTOM_APP_ROLE_PATH) + .appRoleId(roleId.get()) + .secretId(secretId.get()) + .build()) + .build(); + }); + } +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/CubbyholeService.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/CubbyholeService.java new file mode 100644 index 00000000..0f9caeba --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/CubbyholeService.java @@ -0,0 +1,65 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.util.Map; + +import io.helidon.common.http.Http; +import io.helidon.integrations.vault.secrets.cubbyhole.CubbyholeSecretsRx; +import io.helidon.integrations.vault.sys.SysRx; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +class CubbyholeService implements Service { + private final SysRx sys; + private final CubbyholeSecretsRx secrets; + + CubbyholeService(SysRx sys, CubbyholeSecretsRx secrets) { + this.sys = sys; + this.secrets = secrets; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/create", this::createSecrets) + .get("/secrets/{path:.*}", this::getSecret); + } + + private void createSecrets(ServerRequest req, ServerResponse res) { + secrets.create("first/secret", Map.of("key", "secretValue")) + .thenAccept(ignored -> res.send("Created secret on path /first/secret")) + .exceptionally(res::send); + } + + private void getSecret(ServerRequest req, ServerResponse res) { + String path = req.path().param("path"); + + secrets.get(path) + .thenAccept(secret -> { + if (secret.isPresent()) { + // using toString so we do not need to depend on JSON-B + res.send(secret.get().values().toString()); + } else { + res.status(Http.Status.NOT_FOUND_404); + res.send(); + } + }) + .exceptionally(res::send); + } +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/K8sExample.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/K8sExample.java new file mode 100644 index 00000000..01d3011c --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/K8sExample.java @@ -0,0 +1,103 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.util.Map; +import java.util.function.Function; + +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.integrations.common.rest.ApiResponse; +import io.helidon.integrations.vault.Vault; +import io.helidon.integrations.vault.auths.k8s.ConfigureK8s; +import io.helidon.integrations.vault.auths.k8s.CreateRole; +import io.helidon.integrations.vault.auths.k8s.K8sAuthRx; +import io.helidon.integrations.vault.secrets.kv2.Kv2Secret; +import io.helidon.integrations.vault.secrets.kv2.Kv2SecretsRx; +import io.helidon.integrations.vault.sys.SysRx; + +class K8sExample { + private static final String SECRET_PATH = "k8s/example/secret"; + private static final String POLICY_NAME = "k8s_policy"; + + private final Vault tokenVault; + private final String k8sAddress; + private final Config config; + private final SysRx sys; + + private Vault k8sVault; + + K8sExample(Vault tokenVault, Config config) { + this.tokenVault = tokenVault; + this.sys = tokenVault.sys(SysRx.API); + this.k8sAddress = config.get("cluster-address").asString().get(); + this.config = config; + } + + public Single run() { + /* + The following tasks must be run before we authenticate + */ + return enableK8sAuth() + // Now we can login using k8s - must run within a k8s cluster (or you need the k8s configuration files locally) + .flatMapSingle(ignored -> workWithSecrets()) + // Now back to token based Vault, as we will clean up + .flatMapSingle(ignored -> disableK8sAuth()) + .map(ignored -> "k8s example finished successfully."); + } + + private Single workWithSecrets() { + Kv2SecretsRx secrets = k8sVault.secrets(Kv2SecretsRx.ENGINE); + + return secrets.create(SECRET_PATH, Map.of("secret-key", "secretValue", + "secret-user", "username")) + .flatMapSingle(ignored -> secrets.get(SECRET_PATH)) + .peek(secret -> { + if (secret.isPresent()) { + Kv2Secret kv2Secret = secret.get(); + System.out.println("k8s first secret: " + kv2Secret.value("secret-key")); + System.out.println("k8s second secret: " + kv2Secret.value("secret-user")); + } else { + System.out.println("k8s secret not found"); + } + }).flatMapSingle(ignored -> secrets.deleteAll(SECRET_PATH)); + } + + private Single disableK8sAuth() { + return sys.deletePolicy(POLICY_NAME) + .flatMapSingle(ignored -> sys.disableAuth(K8sAuthRx.AUTH_METHOD.defaultPath())); + } + + private Single enableK8sAuth() { + // enable the method + return sys.enableAuth(K8sAuthRx.AUTH_METHOD) + // add policy + .flatMapSingle(ignored -> sys.createPolicy(POLICY_NAME, VaultPolicy.POLICY)) + .flatMapSingle(ignored -> tokenVault.auth(K8sAuthRx.AUTH_METHOD) + .configure(ConfigureK8s.Request.builder() + .address(k8sAddress))) + .flatMapSingle(ignored -> tokenVault.auth(K8sAuthRx.AUTH_METHOD) + // this must be the same role name as is defined in application.yaml + .createRole(CreateRole.Request.builder() + .roleName("my-role") + .addBoundServiceAccountName("*") + .addBoundServiceAccountNamespace("default") + .addTokenPolicy(POLICY_NAME))) + .peek(ignored -> k8sVault = Vault.create(config)) + .map(Function.identity()); + } +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/Kv1Service.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/Kv1Service.java new file mode 100644 index 00000000..4401b841 --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/Kv1Service.java @@ -0,0 +1,87 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.util.Map; + +import io.helidon.common.http.Http; +import io.helidon.integrations.vault.secrets.kv1.Kv1SecretsRx; +import io.helidon.integrations.vault.sys.SysRx; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +class Kv1Service implements Service { + private final SysRx sys; + private final Kv1SecretsRx secrets; + + Kv1Service(SysRx sys, Kv1SecretsRx secrets) { + this.sys = sys; + this.secrets = secrets; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/enable", this::enableEngine) + .get("/create", this::createSecrets) + .get("/secrets/{path:.*}", this::getSecret) + .delete("/secrets/{path:.*}", this::deleteSecret) + .get("/disable", this::disableEngine); + } + + private void disableEngine(ServerRequest req, ServerResponse res) { + sys.disableEngine(Kv1SecretsRx.ENGINE) + .thenAccept(ignored -> res.send("KV1 Secret engine disabled")) + .exceptionally(res::send); + } + + private void enableEngine(ServerRequest req, ServerResponse res) { + sys.enableEngine(Kv1SecretsRx.ENGINE) + .thenAccept(ignored -> res.send("KV1 Secret engine enabled")) + .exceptionally(res::send); + } + + private void createSecrets(ServerRequest req, ServerResponse res) { + secrets.create("first/secret", Map.of("key", "secretValue")) + .thenAccept(ignored -> res.send("Created secret on path /first/secret")) + .exceptionally(res::send); + } + + private void deleteSecret(ServerRequest req, ServerResponse res) { + String path = req.path().param("path"); + + secrets.delete(path) + .thenAccept(ignored -> res.send("Deleted secret on path " + path)); + } + + private void getSecret(ServerRequest req, ServerResponse res) { + String path = req.path().param("path"); + + secrets.get(path) + .thenAccept(secret -> { + if (secret.isPresent()) { + // using toString so we do not need to depend on JSON-B + res.send(secret.get().values().toString()); + } else { + res.status(Http.Status.NOT_FOUND_404); + res.send(); + } + }) + .exceptionally(res::send); + } +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/Kv2Service.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/Kv2Service.java new file mode 100644 index 00000000..9a97bb98 --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/Kv2Service.java @@ -0,0 +1,75 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.util.Map; + +import io.helidon.common.http.Http; +import io.helidon.integrations.vault.secrets.kv2.Kv2Secret; +import io.helidon.integrations.vault.secrets.kv2.Kv2SecretsRx; +import io.helidon.integrations.vault.sys.SysRx; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +class Kv2Service implements Service { + private final SysRx sys; + private final Kv2SecretsRx secrets; + + Kv2Service(SysRx sys, Kv2SecretsRx secrets) { + this.sys = sys; + this.secrets = secrets; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/create", this::createSecrets) + .get("/secrets/{path:.*}", this::getSecret) + .delete("/secrets/{path:.*}", this::deleteSecret); + } + + private void createSecrets(ServerRequest req, ServerResponse res) { + secrets.create("first/secret", Map.of("key", "secretValue")) + .thenAccept(ignored -> res.send("Created secret on path /first/secret")) + .exceptionally(res::send); + } + + private void deleteSecret(ServerRequest req, ServerResponse res) { + String path = req.path().param("path"); + + secrets.deleteAll(path) + .thenAccept(ignored -> res.send("Deleted secret on path " + path)); + } + + private void getSecret(ServerRequest req, ServerResponse res) { + String path = req.path().param("path"); + + secrets.get(path) + .thenAccept(secret -> { + if (secret.isPresent()) { + // using toString so we do not need to depend on JSON-B + Kv2Secret kv2Secret = secret.get(); + res.send("Version " + kv2Secret.metadata().version() + ", secret: " + kv2Secret.values().toString()); + } else { + res.status(Http.Status.NOT_FOUND_404); + res.send(); + } + }) + .exceptionally(res::send); + } +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/ReactiveVaultMain.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/ReactiveVaultMain.java new file mode 100644 index 00000000..c9990c2c --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/ReactiveVaultMain.java @@ -0,0 +1,149 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.util.concurrent.TimeUnit; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.CompletionAwaitable; +import io.helidon.config.Config; +import io.helidon.integrations.vault.Vault; +import io.helidon.integrations.vault.secrets.cubbyhole.CubbyholeSecretsRx; +import io.helidon.integrations.vault.secrets.kv1.Kv1SecretsRx; +import io.helidon.integrations.vault.secrets.kv2.Kv2SecretsRx; +import io.helidon.integrations.vault.secrets.transit.TransitSecretsRx; +import io.helidon.integrations.vault.sys.SysRx; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * Main class of example. + */ +public final class ReactiveVaultMain { + private ReactiveVaultMain() { + } + + /** + * Main method of example. + * + * @param args ignored + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + // as I cannot share my secret configuration, let's combine the configuration + // from my home directory with the one compiled into the jar + // when running this example, you can either update the application.yaml in resources directory + // or use the same approach + Config config = buildConfig(); + + // we have three configurations available + // 1. Token based authentication + Vault tokenVault = Vault.builder() + .config(config.get("vault.token")) + .updateWebClient(it -> it.connectTimeout(5, TimeUnit.SECONDS) + .readTimeout(5, TimeUnit.SECONDS)) + .build(); + + // 2. App role based authentication - must be created after we obtain the role id an token + // 3. Kubernetes (k8s) based authentication (requires to run on k8s) - must be created after we create + // the authentication method + + // the tokenVault is using the root token and can be used to enable engines and + // other authentication mechanisms + + CompletionAwaitable k8sFuture = new K8sExample(tokenVault, config.get("vault.k8s")) + .run() + .forSingle(System.out::println); + + CompletionAwaitable appRoleFuture = new AppRoleExample(tokenVault, config.get("vault.approle")) + .run() + .forSingle(System.out::println); + + /* + We do not need to block here for our examples, as the server started below will keep the process running + */ + + SysRx sys = tokenVault.sys(SysRx.API); + // we use await for webserver, as we do not care if we block the main thread - it is not used + // for anything + WebServer webServer = WebServer.builder() + .config(config.get("server")) + .routing(Routing.builder() + .register("/cubbyhole", new CubbyholeService(sys, tokenVault.secrets(CubbyholeSecretsRx.ENGINE))) + .register("/kv1", new Kv1Service(sys, tokenVault.secrets(Kv1SecretsRx.ENGINE))) + .register("/kv2", new Kv2Service(sys, tokenVault.secrets(Kv2SecretsRx.ENGINE))) + .register("/transit", new TransitService(sys, tokenVault.secrets(TransitSecretsRx.ENGINE)))) + .build() + .start() + .await(); + + try { + appRoleFuture.await(); + } catch (Exception e) { + System.err.println("AppRole example failed"); + e.printStackTrace(); + } + + try { + k8sFuture.await(); + } catch (Exception e) { + System.err.println("Kubernetes example failed"); + e.printStackTrace(); + } + + String baseAddress = "http://localhost:" + webServer.port() + "/"; + System.out.println("Server started on " + baseAddress); + System.out.println(); + System.out.println("Key/Value Version 1 Secrets Engine"); + System.out.println("\t" + baseAddress + "kv1/enable"); + System.out.println("\t" + baseAddress + "kv1/create"); + System.out.println("\t" + baseAddress + "kv1/secrets/first/secret"); + System.out.println("\tcurl -i -X DELETE " + baseAddress + "kv1/secrets/first/secret"); + System.out.println("\t" + baseAddress + "kv1/disable"); + System.out.println(); + System.out.println("Key/Value Version 2 Secrets Engine"); + System.out.println("\t" + baseAddress + "kv2/create"); + System.out.println("\t" + baseAddress + "kv2/secrets/first/secret"); + System.out.println("\tcurl -i -X DELETE " + baseAddress + "kv2/secrets/first/secret"); + System.out.println(); + System.out.println("Transit Secrets Engine"); + System.out.println("\t" + baseAddress + "transit/enable"); + System.out.println("\t" + baseAddress + "transit/keys"); + System.out.println("\t" + baseAddress + "transit/encrypt/secret_text"); + System.out.println("\t" + baseAddress + "transit/decrypt/cipher_text"); + System.out.println("\t" + baseAddress + "transit/sign"); + System.out.println("\t" + baseAddress + "transit/verify/sign/signature_text"); + System.out.println("\t" + baseAddress + "transit/hmac"); + System.out.println("\t" + baseAddress + "transit/verify/hmac/hmac_text"); + System.out.println("\tcurl -i -X DELETE " + baseAddress + "transit/keys"); + System.out.println("\t" + baseAddress + "transit/disable"); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults that are built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/TransitService.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/TransitService.java new file mode 100644 index 00000000..05046d03 --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/TransitService.java @@ -0,0 +1,193 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +import java.util.List; + +import io.helidon.common.Base64Value; +import io.helidon.integrations.vault.secrets.transit.CreateKey; +import io.helidon.integrations.vault.secrets.transit.Decrypt; +import io.helidon.integrations.vault.secrets.transit.DecryptBatch; +import io.helidon.integrations.vault.secrets.transit.DeleteKey; +import io.helidon.integrations.vault.secrets.transit.Encrypt; +import io.helidon.integrations.vault.secrets.transit.EncryptBatch; +import io.helidon.integrations.vault.secrets.transit.Hmac; +import io.helidon.integrations.vault.secrets.transit.Sign; +import io.helidon.integrations.vault.secrets.transit.TransitSecretsRx; +import io.helidon.integrations.vault.secrets.transit.UpdateKeyConfig; +import io.helidon.integrations.vault.secrets.transit.Verify; +import io.helidon.integrations.vault.sys.SysRx; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +class TransitService implements Service { + private static final String ENCRYPTION_KEY = "encryption-key"; + private static final String SIGNATURE_KEY = "signature-key"; + private static final Base64Value SECRET_STRING = Base64Value.create("Hello World"); + private final SysRx sys; + private final TransitSecretsRx secrets; + + TransitService(SysRx sys, TransitSecretsRx secrets) { + this.sys = sys; + this.secrets = secrets; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/enable", this::enableEngine) + .get("/keys", this::createKeys) + .delete("/keys", this::deleteKeys) + .get("/batch", this::batch) + .get("/encrypt/{text:.*}", this::encryptSecret) + .get("/decrypt/{text:.*}", this::decryptSecret) + .get("/sign", this::sign) + .get("/hmac", this::hmac) + .get("/verify/sign/{text:.*}", this::verify) + .get("/verify/hmac/{text:.*}", this::verifyHmac) + .get("/disable", this::disableEngine); + } + + private void enableEngine(ServerRequest req, ServerResponse res) { + sys.enableEngine(TransitSecretsRx.ENGINE) + .thenAccept(ignored -> res.send("Transit Secret engine enabled")) + .exceptionally(res::send); + } + + private void disableEngine(ServerRequest req, ServerResponse res) { + sys.disableEngine(TransitSecretsRx.ENGINE) + .thenAccept(ignored -> res.send("Transit Secret engine disabled")) + .exceptionally(res::send); + } + + private void createKeys(ServerRequest req, ServerResponse res) { + CreateKey.Request request = CreateKey.Request.builder() + .name(ENCRYPTION_KEY); + + secrets.createKey(request) + .flatMapSingle(ignored -> secrets.createKey(CreateKey.Request.builder() + .name(SIGNATURE_KEY) + .type("rsa-2048"))) + .forSingle(ignored -> res.send("Created keys")) + .exceptionally(res::send); + } + + private void deleteKeys(ServerRequest req, ServerResponse res) { + + secrets.updateKeyConfig(UpdateKeyConfig.Request.builder() + .name(ENCRYPTION_KEY) + .allowDeletion(true)) + .peek(ignored -> System.out.println("Updated key config")) + .flatMapSingle(ignored -> secrets.deleteKey(DeleteKey.Request.create(ENCRYPTION_KEY))) + .forSingle(ignored -> res.send("Deleted key.")) + .exceptionally(res::send); + } + + private void decryptSecret(ServerRequest req, ServerResponse res) { + String encrypted = req.path().param("text"); + + secrets.decrypt(Decrypt.Request.builder() + .encryptionKeyName(ENCRYPTION_KEY) + .cipherText(encrypted)) + .forSingle(response -> res.send(String.valueOf(response.decrypted().toDecodedString()))) + .exceptionally(res::send); + } + + private void encryptSecret(ServerRequest req, ServerResponse res) { + String secret = req.path().param("text"); + + secrets.encrypt(Encrypt.Request.builder() + .encryptionKeyName(ENCRYPTION_KEY) + .data(Base64Value.create(secret))) + .forSingle(response -> res.send(response.encrypted().cipherText())) + .exceptionally(res::send); + } + + private void hmac(ServerRequest req, ServerResponse res) { + secrets.hmac(Hmac.Request.builder() + .hmacKeyName(ENCRYPTION_KEY) + .data(SECRET_STRING)) + .forSingle(response -> res.send(response.hmac())) + .exceptionally(res::send); + } + + private void sign(ServerRequest req, ServerResponse res) { + secrets.sign(Sign.Request.builder() + .signatureKeyName(SIGNATURE_KEY) + .data(SECRET_STRING)) + .forSingle(response -> res.send(response.signature())) + .exceptionally(res::send); + } + + private void verifyHmac(ServerRequest req, ServerResponse res) { + String hmac = req.path().param("text"); + + secrets.verify(Verify.Request.builder() + .digestKeyName(ENCRYPTION_KEY) + .data(SECRET_STRING) + .hmac(hmac)) + .forSingle(response -> res.send("Valid: " + response.isValid())) + .exceptionally(res::send); + } + + private void verify(ServerRequest req, ServerResponse res) { + String signature = req.path().param("text"); + + secrets.verify(Verify.Request.builder() + .digestKeyName(SIGNATURE_KEY) + .data(SECRET_STRING) + .signature(signature)) + .forSingle(response -> res.send("Valid: " + response.isValid())) + .exceptionally(res::send); + } + + private void batch(ServerRequest req, ServerResponse res) { + String[] data = new String[] {"one", "two", "three", "four"}; + EncryptBatch.Request request = EncryptBatch.Request.builder() + .encryptionKeyName(ENCRYPTION_KEY); + DecryptBatch.Request decryptRequest = DecryptBatch.Request.builder() + .encryptionKeyName(ENCRYPTION_KEY); + + for (String dato : data) { + request.addEntry(EncryptBatch.BatchEntry.create(Base64Value.create(dato))); + } + secrets.encrypt(request) + .map(EncryptBatch.Response::batchResult) + .flatMapSingle(batchResult -> { + for (Encrypt.Encrypted encrypted : batchResult) { + System.out.println("Encrypted: " + encrypted.cipherText()); + decryptRequest.addEntry(DecryptBatch.BatchEntry.create(encrypted.cipherText())); + } + return secrets.decrypt(decryptRequest); + }) + .forSingle(response -> { + List base64Values = response.batchResult(); + for (int i = 0; i < data.length; i++) { + String decryptedValue = base64Values.get(i).toDecodedString(); + if (!data[i].equals(decryptedValue)) { + res.send("Data at index " + i + " is invalid. Decrypted " + decryptedValue + + ", expected: " + data[i]); + return; + } + } + res.send("Batch encryption/decryption completed"); + }) + .exceptionally(res::send); + } + +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/VaultPolicy.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/VaultPolicy.java new file mode 100644 index 00000000..75b874d2 --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/VaultPolicy.java @@ -0,0 +1,79 @@ +/* + * 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. + */ + +package io.helidon.examples.integrations.vault.hcp.reactive; + +final class VaultPolicy { + private VaultPolicy() { + } + static final String POLICY = "# Enable and manage authentication methods\n" + + "path \"auth/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"update\", \"delete\", \"sudo\"]\n" + + "}\n" + + "\n" + + "# Create, update, and delete auth methods\n" + + "path \"sys/auth/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"update\", \"delete\", \"sudo\"]\n" + + "}\n" + + "\n" + + "# List auth methods\n" + + "path \"sys/auth\"\n" + + "{\n" + + " capabilities = [\"read\"]\n" + + "}\n" + + "\n" + + "# Enable and manage the key/value secrets engine at `secret/` path\n" + + "\n" + + "# List, create, update, and delete key/value secrets\n" + + "path \"secret/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"read\", \"update\", \"delete\", \"list\", \"sudo\"]\n" + + "}\n" + + "\n" + + "path \"kv1/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"read\", \"update\", \"delete\", \"list\", \"sudo\"]\n" + + "}\n" + + "\n" + + "path \"cubbyhole/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"read\", \"update\", \"delete\", \"list\", \"sudo\"]\n" + + "}\n" + + "\n" + + "path \"database/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"read\", \"update\", \"delete\", \"list\", \"sudo\"]\n" + + "}\n" + + "\n" + + "path \"kv/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"read\", \"update\", \"delete\", \"list\", \"sudo\"]\n" + + "}\n" + + "\n" + + "# Manage secrets engines\n" + + "path \"sys/mounts/*\"\n" + + "{\n" + + " capabilities = [\"create\", \"read\", \"update\", \"delete\", \"list\", \"sudo\"]\n" + + "}\n" + + "\n" + + "# List existing secrets engines.\n" + + "path \"sys/mounts\"\n" + + "{\n" + + " capabilities = [\"read\"]\n" + + "}\n"; +} diff --git a/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/package-info.java b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/package-info.java new file mode 100644 index 00000000..fe6ea6ee --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/java/io/helidon/examples/integrations/vault/hcp/reactive/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of Helidon integration with Hashicorp Vault in a reactive environment. + */ +package io.helidon.examples.integrations.vault.hcp.reactive; diff --git a/examples/integrations/vault/hcp-reactive/src/main/resources/application.yaml b/examples/integrations/vault/hcp-reactive/src/main/resources/application.yaml new file mode 100644 index 00000000..718109f3 --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/resources/application.yaml @@ -0,0 +1,59 @@ +# +# 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. +# + +server.port: 8080 + +vault: + properties: + address: "http://localhost:8200" + k8s: + address: "${vault.properties.address}" + # please change this to your k8s cluster address + # cluster-address: "https://kubernetes.docker.internal:6443" + cluster-address: "https://10.96.0.1" + auth: + k8s: + enabled: true + # this role is created in the code, must be the same value + token-role: my-role + service-account-token: "${vault.properties.k8s.service-account-token}" + app-role: + enabled: false + token: + enabled: false + token: + token: "myroot" + address: "${vault.properties.address}" + auth: + k8s: + enabled: false + app-role: + enabled: false + token: + enabled: true + approle: + address: "${vault.properties.address}" + auth: + k8s: + enabled: false + app-role: + # this is not needed, as we use a builder, + # it is here to show how this could be used to define a + # custom path for vault authentication (same can be done for k8s) + path: "customapprole" + enabled: true + token: + enabled: false \ No newline at end of file diff --git a/examples/integrations/vault/hcp-reactive/src/main/resources/logging.properties b/examples/integrations/vault/hcp-reactive/src/main/resources/logging.properties new file mode 100644 index 00000000..02a8f58f --- /dev/null +++ b/examples/integrations/vault/hcp-reactive/src/main/resources/logging.properties @@ -0,0 +1,27 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO diff --git a/examples/integrations/vault/pom.xml b/examples/integrations/vault/pom.xml new file mode 100644 index 00000000..90332c59 --- /dev/null +++ b/examples/integrations/vault/pom.xml @@ -0,0 +1,38 @@ + + + + + 4.0.0 + + io.helidon.examples.integrations + helidon-examples-integrations-project + 1.0.0-SNAPSHOT + + io.helidon.examples.integrations.vault + helidon-examples-integrations-vault-project + pom + Helidon Examples Integration Vault + Examples of integration with Vault. + + + hcp-reactive + hcp-cdi + + diff --git a/examples/istio/Helidon-Istio.png b/examples/istio/Helidon-Istio.png new file mode 100644 index 00000000..03145ce5 Binary files /dev/null and b/examples/istio/Helidon-Istio.png differ diff --git a/examples/istio/README.md b/examples/istio/README.md new file mode 100644 index 00000000..5a0f2fa2 --- /dev/null +++ b/examples/istio/README.md @@ -0,0 +1,206 @@ +# Helidon Istio + +This example showcases how you can setup Helidon microservices inside Istio service mesh and setup communication amongst services inside mesh as well as access a service from outside the mesh. + +![Helidon Istio](helidon-istio.png?raw=true "Helidon Istio") + +# Environment Setup + +Setup Kubernetes cluster (1.21.5) on your machine. We used docker-for-desktop (4.2.0) for this example. See for more details https://docs.docker.com/desktop/kubernetes/ + +Install Istio (1.12.0) following https://istio.io/latest/docs/setup/getting-started/#download. You don't need to follow "Deploy the sample application" onwards. + +Following instructions have been verified with Istio 1.12 on Kubernetes 1.21 + +# MySQL Setup + +For the purpose of this example, we are running MySQL in a container outside Kubernetes using docker-for-desktop. + +```shell +docker run --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD= -e MYSQL_USER=user -e MYSQL_PASSWORD= -e MYSQL_DATABASE=helloworld mysql:8 +``` + +Please refer to https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/docker-mysql-getting-started.html for detailed instructions. + +# helidon-config application + +helidon-config is a Helidon MP project that showcases how to load helidon config from a kubernetes configmap. + +```shell +cd helidon-config +``` + +## Build the Docker Image + +```shell +docker build -f Dockerfile -t helidon-config . +``` + +## Deploy the application to Kubernetes + +```shell +kubectl cluster-info # Verify which cluster +kubectl get pods # Verify connectivity to cluster +kubectl apply -f app.yaml # Deploy application +kubectl get pods # Wait for quickstart pod to be RUNNING +kubectl get service helidon-config-np # Verify deployed service +``` + +Note the PORTs. You can now exercise the application as following but use the second +port number (the NodePort) instead of 7001. + +## Exercise the application + +```shell +curl -X GET http://localhost:/first +Hello +``` + +# helidon-jps application + +helidon-jps is a Helidon MP project that showcases how to invoke another microservice using RestClient as well as JPA integration (esp. stored procedure call) + +```shell +cd ../helidon-jpa +``` + +## Build the Docker Image + +Update MySQL related properties in `microprofile-config.properties`. Host IP is usually the IP of your laptop and port would be 3306, if you used the command provided above. + +```shell +docker build -f Dockerfile -t helidon-jpa . +``` + +## Deploy the application to Kubernetes + +Let's first make external MySQL available to application. Update MySQL related properties in `istio-mysql-se.yaml`. Host IP is usually the IP of your laptop and port would be 3306, if you used the command provided above. + +```shell +kubectl apply -f istio-mysql-se.yaml # Creates ServiceEntry inside the mesh +``` + +Now deploy helidon-jpa application +```shell +kubectl apply -f app.yaml # Deploy application +kubectl get pods # Wait for quickstart pod to be RUNNING +``` + +Expose helidon-jpa application to outside world +```shell +kubectl apply -f istio-gateway-vs.yaml # Creates Gateway associated with Istio's ingressgeteway and VirtualService +``` + +## Exercise the application + +In a different Terminal, create the stored procedure in MySQL that will be used by the application. +```shell +docker exec -it mysql bash +mysql -u root -p + +USE helloworld; +Delimiter // +Create Procedure getAllPersons() + -> BEGIN + -> Select * from Person; # Person table is created when we run the application. + -> END// +Delimiter ; +Call getAllPersons; # Verify that stored procedure works +``` + +Now verify simple greeting: +```shell +curl -X GET http://localhost/greet +``` +returned response should be: +```json +{"message":"Hello World!"} +``` +We are using localhost above, as it is the EXTERNAL-IP for `istio-ingressgateway` service. + +Add new person to the database +```shell +curl -X POST -H "Content-Type: application/json" \ + -d '{"nick":"bob","name":"Bobby Fischer"}' \ + http://localhost/greet +``` +returned response should be: +```json +{"nick":"bob","name":"Bobby Fischer"} +``` + +Greet new person: +```shell +curl -X GET http://localhost/greet/bob +``` +returned response should be: +```json +{"message":"Hello Bobby Fischer!"} +``` + +# Let's enable security + +We are going to enable access based on a JSON Web Token (JWT). Please refer to https://istio.io/latest/docs/tasks/security/authorization/authz-jwt/ for detailed instructions. + +The following command creates `ingress-jwt-auth` request authentication policy for all `ingressgateway` workload. This policy accepts a JWT issued by `testing@secure.istio.io` +```shell +kubectl apply -f istio-request-auth.yaml +``` + +Verify that a request with an invalid JWT is denied: +```shell +curl --header "Authorization: Bearer invalidToken" -X GET http://localhost/greet +``` +returned response should be: +```text +Jwt is not in the form of Header.Payload.Signature with two dots and 3 sections +``` + +Verify that a request without a JWT is allowed because there is no authorization policy: +```shell +curl -X GET http://localhost/greet +``` +returned response should be: +```json +{"message":"Hello World!"} +``` + +The following command creates `ingress-jwt-must` authorization policy for all `ingressgateway` workload. The policy requires all requests to have a valid JWT. +```shell +kubectl apply -f istio-auth-policy.yaml +``` + +Get the JWT for `testing@secure.istio.io` +```shell +TOKEN=$(curl https://raw.githubusercontent.com/istio/istio/release-1.12/security/tools/jwt/samples/demo.jwt -s) +``` + +Verify that a request with a valid JWT is allowed: +```shell +curl --header "Authorization: Bearer $TOKEN" -X GET http://localhost/greet +``` +returned response should be: +```json +{"message":"Hello World!"} +``` + +Verify that a request without a JWT is denied: +```shell +curl -X GET http://localhost/greet +``` +returned response should be: +```text +RBAC: access denied +``` + +# After you’re done, cleanup. + +```shell +kubectl delete -f istio-auth-policy.yaml +kubectl delete -f istio-request-auth.yaml +kubectl delete -f istio-gateway-vs.yaml +kubectl delete -f app.yaml +kubectl delete -f istio-mysql-se.yaml +cd ../helidon-config +kubectl delete -f app.yaml +``` \ No newline at end of file diff --git a/examples/istio/helidon-config/Dockerfile b/examples/istio/helidon-config/Dockerfile new file mode 100644 index 00000000..d440fcc0 --- /dev/null +++ b/examples/istio/helidon-config/Dockerfile @@ -0,0 +1,43 @@ +# +# 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. +# + +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-config.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-config.jar"] + +EXPOSE 7001 \ No newline at end of file diff --git a/examples/istio/helidon-config/app.yaml b/examples/istio/helidon-config/app.yaml new file mode 100644 index 00000000..df90c7cf --- /dev/null +++ b/examples/istio/helidon-config/app.yaml @@ -0,0 +1,77 @@ +# +# 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. +# + +kind: ConfigMap +apiVersion: v1 +metadata: + name: helidon-config-cm +data: + config-properties.yaml: | + app.greeting: Hello +--- +apiVersion: v1 +kind: Service +metadata: + name: helidon-config +spec: + selector: + app: helidon-config + ports: + - port: 7001 + targetPort: 7001 +--- +kind: Service +apiVersion: v1 +metadata: + name: helidon-config-np +spec: + type: NodePort + selector: + app: helidon-config + ports: + - port: 7001 + targetPort: 7001 + name: http +--- +kind: Deployment +apiVersion: apps/v1 +metadata: + name: helidon-config +spec: + replicas: 1 + selector: + matchLabels: + app: helidon-config + template: + metadata: + labels: + app: helidon-config + version: v1 + spec: + containers: + - name: helidon-config + image: helidon-config + imagePullPolicy: IfNotPresent + ports: + - containerPort: 7001 + volumeMounts: + - mountPath: /conf + name: config-volume + volumes: + - name: config-volume + configMap: + name: helidon-config-cm +--- diff --git a/examples/istio/helidon-config/pom.xml b/examples/istio/helidon-config/pom.xml new file mode 100644 index 00000000..7d74068c --- /dev/null +++ b/examples/istio/helidon-config/pom.xml @@ -0,0 +1,75 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples + helidon-config + 1.0-SNAPSHOT + helidon-config + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + jakarta.activation + jakarta.activation-api + runtime + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/istio/helidon-config/src/main/java/io/helidon/examples/config/GreetResource.java b/examples/istio/helidon-config/src/main/java/io/helidon/examples/config/GreetResource.java new file mode 100644 index 00000000..57f5300b --- /dev/null +++ b/examples/istio/helidon-config/src/main/java/io/helidon/examples/config/GreetResource.java @@ -0,0 +1,60 @@ +/* + * 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. + */ +package io.helidon.examples.config; + +import java.util.function.Supplier; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * A simple JAX-RS resource to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/first + * + * The message is returned as a String. + */ +@Path("/first") +@RequestScoped +public class GreetResource { + private final Supplier message; + + /** + * Using constructor injection to get a configuration property. + * + * @param message the configured greeting message + */ + @Inject + public GreetResource(@ConfigProperty(name = "app.greeting") Supplier message) { + this.message = message; + } + + /** + * Return a worldly greeting message. + * + * @return {@link String} + */ + @GET + public String getMessage() { + return this.message.get(); + } + +} diff --git a/examples/istio/helidon-config/src/main/java/io/helidon/examples/config/package-info.java b/examples/istio/helidon-config/src/main/java/io/helidon/examples/config/package-info.java new file mode 100644 index 00000000..9de139e0 --- /dev/null +++ b/examples/istio/helidon-config/src/main/java/io/helidon/examples/config/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * Helidon Istio Example. + */ +package io.helidon.examples.config; diff --git a/examples/istio/helidon-config/src/main/resources/META-INF/beans.xml b/examples/istio/helidon-config/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..01c12fc2 --- /dev/null +++ b/examples/istio/helidon-config/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + diff --git a/examples/istio/helidon-config/src/main/resources/logging.properties b/examples/istio/helidon-config/src/main/resources/logging.properties new file mode 100644 index 00000000..1395ed17 --- /dev/null +++ b/examples/istio/helidon-config/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/istio/helidon-config/src/main/resources/mp-meta-config.yaml b/examples/istio/helidon-config/src/main/resources/mp-meta-config.yaml new file mode 100644 index 00000000..70a65c90 --- /dev/null +++ b/examples/istio/helidon-config/src/main/resources/mp-meta-config.yaml @@ -0,0 +1,25 @@ +# +# Copyright (c) 2020, 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. +# + +profile: "test" + +sources: + - type: "system-properties" + - type: "environment-variables" + - type: "yaml" + path: "/conf/config-properties.yaml" + optional: true + diff --git a/examples/istio/helidon-jpa/Dockerfile b/examples/istio/helidon-jpa/Dockerfile new file mode 100644 index 00000000..25564c62 --- /dev/null +++ b/examples/istio/helidon-jpa/Dockerfile @@ -0,0 +1,44 @@ +# +# 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-jpa.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-jpa.jar"] + +EXPOSE 8080 diff --git a/examples/istio/helidon-jpa/app.yaml b/examples/istio/helidon-jpa/app.yaml new file mode 100644 index 00000000..b8ecd4e0 --- /dev/null +++ b/examples/istio/helidon-jpa/app.yaml @@ -0,0 +1,64 @@ +# +# 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: helidon-jpa-service +spec: + selector: + app: helidon-jpa + ports: + - port: 8080 + targetPort: 8080 + name: http +--- +kind: Service +apiVersion: v1 +metadata: + name: helidon-jpa-service-np +spec: + type: NodePort + selector: + app: helidon-jpa + ports: + - port: 8080 + targetPort: 8080 + name: http +--- +kind: Deployment +apiVersion: apps/v1 +metadata: + name: helidon-jpa-deploy + labels: + app: helidon-jpa-deploy +spec: + replicas: 1 + selector: + matchLabels: + app: helidon-jpa + template: + metadata: + labels: + app: helidon-jpa + spec: + containers: + - name: helidon-jpa + image: helidon-jpa + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 +--- diff --git a/examples/istio/helidon-jpa/istio-auth-policy.yaml b/examples/istio/helidon-jpa/istio-auth-policy.yaml new file mode 100644 index 00000000..007d6255 --- /dev/null +++ b/examples/istio/helidon-jpa/istio-auth-policy.yaml @@ -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. +# + +apiVersion: security.istio.io/v1beta1 +kind: AuthorizationPolicy +metadata: + name: "ingress-jwt-must" + namespace: istio-system +spec: + selector: + matchLabels: + istio: ingressgateway + action: DENY + rules: + - from: + - source: + notRequestPrincipals: ["*"] diff --git a/examples/istio/helidon-jpa/istio-gateway-vs.yaml b/examples/istio/helidon-jpa/istio-gateway-vs.yaml new file mode 100644 index 00000000..b1b5a259 --- /dev/null +++ b/examples/istio/helidon-jpa/istio-gateway-vs.yaml @@ -0,0 +1,50 @@ +# +# 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. +# + +apiVersion: networking.istio.io/v1alpha3 +kind: Gateway +metadata: + name: helidon-jpa-gw +spec: + selector: + istio: ingressgateway + servers: + - port: + number: 80 + name: http + protocol: HTTP + hosts: + - "*" +--- +apiVersion: networking.istio.io/v1alpha3 +kind: VirtualService +metadata: + name: helidon-jpa-vs +spec: + hosts: + - "*" + gateways: + - helidon-jpa-gw + http: + - match: + - uri: + prefix: /greet + route: + - destination: + host: helidon-jpa-service + port: + number: 8080 +--- diff --git a/examples/istio/helidon-jpa/istio-mysql-se.yaml b/examples/istio/helidon-jpa/istio-mysql-se.yaml new file mode 100644 index 00000000..61deb2f2 --- /dev/null +++ b/examples/istio/helidon-jpa/istio-mysql-se.yaml @@ -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. +# + +apiVersion: networking.istio.io/v1alpha3 +kind: ServiceEntry +metadata: + name: mysql-external +spec: + hosts: + - mysql.external + addresses: + - + ports: + - name: tcp + number: + protocol: tcp + location: MESH_EXTERNAL \ No newline at end of file diff --git a/examples/istio/helidon-jpa/istio-request-auth.yaml b/examples/istio/helidon-jpa/istio-request-auth.yaml new file mode 100644 index 00000000..a250dfa1 --- /dev/null +++ b/examples/istio/helidon-jpa/istio-request-auth.yaml @@ -0,0 +1,28 @@ +# +# 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. +# + +apiVersion: security.istio.io/v1beta1 +kind: RequestAuthentication +metadata: + name: "ingress-jwt-auth" + namespace: istio-system +spec: + selector: + matchLabels: + istio: ingressgateway + jwtRules: + - issuer: "testing@secure.istio.io" + jwksUri: "https://raw.githubusercontent.com/istio/istio/release-1.11/security/tools/jwt/samples/jwks.json" \ No newline at end of file diff --git a/examples/istio/helidon-jpa/pom.xml b/examples/istio/helidon-jpa/pom.xml new file mode 100644 index 00000000..4e0c48dd --- /dev/null +++ b/examples/istio/helidon-jpa/pom.xml @@ -0,0 +1,122 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples + helidon-jpa + 1.0-SNAPSHOT + helidon-jpa + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.integrations.cdi + helidon-integrations-cdi-hibernate + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jta + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jta-weld + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-hikaricp + runtime + + + io.helidon.integrations.cdi + helidon-integrations-cdi-jpa + runtime + + + io.helidon.integrations.db + helidon-integrations-db-mysql + ${project.parent.version} + + + com.mysql + mysql-connector-j + runtime + + + org.jboss + jandex + runtime + true + + + jakarta.activation + jakarta.activation-api + runtime + + + jakarta.persistence + jakarta.persistence-api + 2.2.2 + + + javax.transaction + javax.transaction-api + 1.2 + + + org.junit.jupiter + junit-jupiter-api + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetResource.java b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetResource.java new file mode 100644 index 00000000..9e954c9f --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetResource.java @@ -0,0 +1,182 @@ +/* + * 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. + */ +package io.helidon.examples.istio; + +import java.util.List; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; +import javax.persistence.PersistenceException; +import javax.persistence.StoredProcedureQuery; +import javax.transaction.Transactional; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import org.eclipse.microprofile.rest.client.inject.RestClient; + +/** + * A simple JAX-RS resource to greet you. + * Requires helidon-config microservice to be deployed. + * + * Examples: + *

+ * Get default greeting message: + * curl -X GET http://localhost:8080/greet + *

+ * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + *

+ * The message is returned as a JSON object. + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + @PersistenceContext(unitName = "hello") + private EntityManager em; + + @Inject + @RestClient + private GreetingProvider greetingProvider; + + /** + * Default Constructor. + */ + public GreetResource() { + } + + /** + * Return a worldly greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param nick the nick to greet + * @return {@link GreetingMessage} + */ + @Path("/{nick}") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Transactional + public Response getMessage(@PathParam("nick") String nick) { + Person entity = em.find(Person.class, nick); + if (entity == null) { + GreetingMessage message = new GreetingMessage(String.format("Nick %s was not found", nick)); + return Response + .status(Response.Status.CONFLICT) + .entity(message) + .build(); + } + GreetingMessage responseEntity = createResponse(entity.getName()); + return Response + .status(Response.Status.OK) + .entity(responseEntity) + .build(); + } + + /** + * Return all persons info, if available. + * + * @return {@link GreetingMessage} + */ + @Path("/all") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Transactional + public Response getAll() { + + StoredProcedureQuery getAllProcedure = + em.createNamedStoredProcedureQuery("GetAllPersons"); + + List persons = getAllProcedure.getResultList(); + GreetingMessage message = new GreetingMessage(); + + if (persons == null || persons.isEmpty()) { + message.setMessage("No person was not found"); + return Response + .status(Response.Status.CONFLICT) + .entity(message) + .build(); + } + + StringBuilder msg = new StringBuilder("The Persons are:"); + //Looping through the Resultant list + for (Person person : persons) { + System.out.println(person.toString()); + msg.append(person); + } + message.setMessage(msg.toString()); + + return Response + .status(Response.Status.OK) + .entity(message) + .build(); + } + + /** + * Store a new person for greetings. + * + * @param person Person to store + * @return HTTPrequest result + */ + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + @Transactional + @POST + public Response createPerson(Person person) { + if (person == null || person.getNick() == null + || person.getName() == null) { + return Response + .status(Response.Status.fromStatusCode(422)) + .build(); + } + try { + em.persist(person); + return Response.status(Response.Status.OK) + .entity(person) + .build(); + } catch (PersistenceException pe) { + pe.printStackTrace(); + GreetingMessage message = new GreetingMessage("Error: " + pe.getMessage()); + return Response + .status(Response.Status.CONFLICT) + .entity(message) + .build(); + } + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new GreetingMessage(msg); + } + +} diff --git a/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetingMessage.java b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetingMessage.java new file mode 100644 index 00000000..da14d3ea --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023, 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.istio; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetingProvider.java b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetingProvider.java new file mode 100644 index 00000000..a685e955 --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/GreetingProvider.java @@ -0,0 +1,40 @@ +/* + * 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. + */ +package io.helidon.examples.istio; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.GET; +import javax.ws.rs.Path; + +import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +@RegisterRestClient(configKey = "GreetingProvider") +public interface GreetingProvider { + + /** + * Get message. + * + * @return message + */ + @GET + @Path("/first") + String getMessage(); + +} diff --git a/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/Person.java b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/Person.java new file mode 100644 index 00000000..452339e1 --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/Person.java @@ -0,0 +1,104 @@ +/* + * 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. + */ +package io.helidon.examples.istio; + +import javax.persistence.Column; +import javax.persistence.Entity; +import javax.persistence.Id; +import javax.persistence.NamedStoredProcedureQueries; +import javax.persistence.NamedStoredProcedureQuery; + +/** + * Person JPA entity. + */ +@Entity +@NamedStoredProcedureQueries({ + @NamedStoredProcedureQuery( + name = "GetAllPersons", + procedureName = "getAllPersons", + resultClasses = {Person.class} + ) +}) +public class Person { + + @Id + @Column(columnDefinition = "VARCHAR(32)", nullable = false) + private String nick; + + @Column + private String name; + + /** + * Default contructor. + */ + public Person() { + } + + /** + * Construct a person given a nickname and a name. + * + * @param nick Nickname + * @param name Name + */ + public Person(String nick, String name) { + this.nick = nick; + this.name = name; + } + + /** + * Get nickname. + * @return nickname + */ + public String getNick() { + return nick; + } + + /** + * Set nickname. + * @param nick nickname + */ + public void setNick(String nick) { + this.nick = nick; + } + + + /** + * Get name. + * @return name + */ + public String getName() { + return name; + } + + /** + * Set name. + * @param name Name + */ + public void setName(String name) { + this.name = name; + } + + /** + * Convert to string. + * + * @return string representation + */ + @Override + public String toString() { + return "Person [nick=" + nick + ", name=" + name + "]"; + } + +} diff --git a/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/package-info.java b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/package-info.java new file mode 100644 index 00000000..9b9ed620 --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/java/io/helidon/examples/istio/package-info.java @@ -0,0 +1,21 @@ +/* + * 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. + */ + + +/** + * Helidon Istio Example. + */ +package io.helidon.examples.istio; diff --git a/examples/istio/helidon-jpa/src/main/resources/META-INF/beans.xml b/examples/istio/helidon-jpa/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..01c12fc2 --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + diff --git a/examples/istio/helidon-jpa/src/main/resources/META-INF/microprofile-config.properties b/examples/istio/helidon-jpa/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..4ce3f7bb --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,29 @@ +# +# Copyright (c) 2021 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 + +#RestClient configuration +GreetingProvider/mp-rest/url=http://helidon-config:7001 + +# Database JDBC driver configuration +javax.sql.DataSource.test.dataSource.url=jdbc:mysql:///helloworld?useSSL=false&allowPublicKeyRetrieval=true +javax.sql.DataSource.test.dataSource.user= +javax.sql.DataSource.test.dataSource.password= +javax.sql.DataSource.test.dataSourceClassName=com.mysql.cj.jdbc.MysqlDataSource + diff --git a/examples/istio/helidon-jpa/src/main/resources/META-INF/persistence.xml b/examples/istio/helidon-jpa/src/main/resources/META-INF/persistence.xml new file mode 100644 index 00000000..217c2f2d --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/resources/META-INF/persistence.xml @@ -0,0 +1,34 @@ + + + + + io.helidon.examples.istio.Person + + + + + + + + + diff --git a/examples/istio/helidon-jpa/src/main/resources/hibernate.properties b/examples/istio/helidon-jpa/src/main/resources/hibernate.properties new file mode 100644 index 00000000..9e9785d6 --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/resources/hibernate.properties @@ -0,0 +1,17 @@ +# +# 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. +# + +hibernate.bytecode.provider=none diff --git a/examples/istio/helidon-jpa/src/main/resources/logging.properties b/examples/istio/helidon-jpa/src/main/resources/logging.properties new file mode 100644 index 00000000..1395ed17 --- /dev/null +++ b/examples/istio/helidon-jpa/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/istio/pom.xml b/examples/istio/pom.xml new file mode 100644 index 00000000..2011e603 --- /dev/null +++ b/examples/istio/pom.xml @@ -0,0 +1,38 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.istio + helidon-examples-istio-project + Helidon Istio Examples + pom + + + helidon-config + helidon-jpa + + + diff --git a/examples/jbatch/README.md b/examples/jbatch/README.md new file mode 100644 index 00000000..081bd3b4 --- /dev/null +++ b/examples/jbatch/README.md @@ -0,0 +1,16 @@ +# Helidon + jBatch + +Minimal Helidon MP + jBatch PoC. + +## Build and run + +```shell +mvn package +java -jar target/helidon-jbatch-example.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/batch +``` \ No newline at end of file diff --git a/examples/jbatch/pom.xml b/examples/jbatch/pom.xml new file mode 100644 index 00000000..860718fa --- /dev/null +++ b/examples/jbatch/pom.xml @@ -0,0 +1,136 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.jbatch + helidon-examples-jbatch + 1.0.0-SNAPSHOT + jbatch-example + + + 1.0.1 + 1.0.3 + 10.13.1.1 + 2.3.2 + + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + jakarta.json + jakarta.json-api + + + + javax.batch + javax.batch-api + ${version.lib.jbatch-api} + + + com.ibm.jbatch + com.ibm.jbatch.spi + ${version.lib.jbatch.container} + + + org.glassfish.jaxb + jaxb-runtime + ${version.lib.jaxb-api} + + + jakarta.xml.bind + jakarta.xml.bind-api + ${version.lib.jaxb-api} + + + + + jakarta.activation + jakarta.activation-api + runtime + + + org.jboss + jandex + runtime + true + + + com.ibm.jbatch + com.ibm.jbatch.container + ${version.lib.jbatch.container} + runtime + + + org.apache.derby + derby + ${version.lib.derby} + runtime + + + + org.junit.jupiter + junit-jupiter-api + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + org.hamcrest + hamcrest-core + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/BatchResource.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/BatchResource.java new file mode 100644 index 00000000..5f5269ca --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/BatchResource.java @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2022, 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.jbatch.example; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Properties; + +import javax.batch.operations.JobOperator; +import javax.batch.runtime.JobExecution; +import javax.batch.runtime.StepExecution; +import javax.enterprise.context.ApplicationScoped; +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +import com.ibm.jbatch.spi.BatchSPIManager; + +import static javax.batch.runtime.BatchRuntime.getJobOperator; + + +/** + * Trigger a batch process using resource. + */ +@Path("/batch") +@ApplicationScoped +public class BatchResource { + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private JobOperator jobOperator; + + /** + * Run a JBatch process when endpoint called. + * @return JsonObject with the result. + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public JsonObject executeBatch() { + + BatchSPIManager batchSPIManager = BatchSPIManager.getInstance(); + batchSPIManager.registerPlatformMode(BatchSPIManager.PlatformMode.SE); + batchSPIManager.registerExecutorServiceProvider(new HelidonExecutorServiceProvider()); + + jobOperator = getJobOperator(); + Long executionId = jobOperator.start("myJob", new Properties()); + + return JSON.createObjectBuilder() + .add("Started a job with Execution ID: ", executionId) + .build(); + } + + /** + * Check the job status. + * @param executionId the job ID. + * @return JsonObject with status. + */ + @GET + @Path("/status/{execution-id}") + public JsonObject status(@PathParam("execution-id") Long executionId){ + JobExecution jobExecution = jobOperator.getJobExecution(executionId); + + List stepExecutions = jobOperator.getStepExecutions(executionId); + List executedSteps = new ArrayList<>(); + for (StepExecution stepExecution : stepExecutions) { + executedSteps.add(stepExecution.getStepName()); + } + + return JSON.createObjectBuilder() + .add("Steps executed", Arrays.toString(executedSteps.toArray())) + .add("Status", jobExecution.getBatchStatus().toString()) + .build(); + } +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/HelidonExecutorServiceProvider.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/HelidonExecutorServiceProvider.java new file mode 100644 index 00000000..0352c968 --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/HelidonExecutorServiceProvider.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2022, 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.jbatch.example; + +import java.util.concurrent.ExecutorService; + +import io.helidon.common.configurable.ThreadPoolSupplier; + +import com.ibm.jbatch.spi.ExecutorServiceProvider; + + +/** + * Executor service for batch processing. + */ +public class HelidonExecutorServiceProvider implements ExecutorServiceProvider { + @Override + public ExecutorService getExecutorService() { + return ThreadPoolSupplier.builder().corePoolSize(2).build().get(); + } +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyBatchlet.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyBatchlet.java new file mode 100644 index 00000000..dbb2649c --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyBatchlet.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2022, 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.jbatch.example.jobs; + +import javax.batch.api.AbstractBatchlet; + +/** + * Batchlet example. + */ +public class MyBatchlet extends AbstractBatchlet { + + /** + * Run inside a batchlet. + * + * @return String with status. + */ + @Override + public String process() { + System.out.println("Running inside a batchlet"); + return "COMPLETED"; + } + +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyInputRecord.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyInputRecord.java new file mode 100644 index 00000000..1aa28d92 --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyInputRecord.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2022, 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.jbatch.example.jobs; + +/** + * Example of an Input Record. + */ +public class MyInputRecord { + private int id; + + /** + * Constructor for Input Record. + * @param id + */ + public MyInputRecord(int id) { + this.id = id; + } + + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + @Override + public String toString() { + return "MyInputRecord: " + id; + } +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemProcessor.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemProcessor.java new file mode 100644 index 00000000..bf77f2fa --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemProcessor.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2022, 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.jbatch.example.jobs; + +import javax.batch.api.chunk.ItemProcessor; + +/** + * Example Item Processor. + */ +public class MyItemProcessor implements ItemProcessor { + + @Override + public MyOutputRecord processItem(Object t) { + System.out.println("processItem: " + t); + + return (((MyInputRecord) t).getId() % 2 == 0) ? null : new MyOutputRecord(((MyInputRecord) t).getId() * 2); + } +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemReader.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemReader.java new file mode 100644 index 00000000..0d8dd3c5 --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemReader.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2022, 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.jbatch.example.jobs; + +import java.util.StringTokenizer; + +import javax.batch.api.chunk.AbstractItemReader; + + +/** + * Example Item Reader. + */ +public class MyItemReader extends AbstractItemReader { + + private final StringTokenizer tokens; + + /** + * Constructor for Item Reader. + */ + public MyItemReader() { + tokens = new StringTokenizer("1,2,3,4,5,6,7,8,9,10", ","); + } + + /** + * Perform read Item. + * @return Stage result. + */ + @Override + public MyInputRecord readItem() { + if (tokens.hasMoreTokens()) { + return new MyInputRecord(Integer.valueOf(tokens.nextToken())); + } + return null; + } +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemWriter.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemWriter.java new file mode 100644 index 00000000..9620ff62 --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyItemWriter.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2022, 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.jbatch.example.jobs; + +import java.util.List; + +import javax.batch.api.chunk.AbstractItemWriter; + + + +/** + * Example Item Writer. + */ +public class MyItemWriter extends AbstractItemWriter { + + @Override + public void writeItems(List list) { + System.out.println("writeItems: " + list); + } +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyOutputRecord.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyOutputRecord.java new file mode 100644 index 00000000..d7faf11c --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/MyOutputRecord.java @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2022, 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.jbatch.example.jobs; + +/** + * Example Output Processor. + */ +public class MyOutputRecord { + + private int id; + + /** + * Constructor for Output Record. + * @param id + */ + public MyOutputRecord(int id) { + this.id = id; + } + + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + @Override + public String toString() { + return "MyOutputRecord: " + id; + } +} diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/package-info.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/package-info.java new file mode 100644 index 00000000..f0347817 --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/jobs/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * JBatch specific classes. + */ +package io.helidon.jbatch.example.jobs; diff --git a/examples/jbatch/src/main/java/io/helidon/jbatch/example/package-info.java b/examples/jbatch/src/main/java/io/helidon/jbatch/example/package-info.java new file mode 100644 index 00000000..747ca7e3 --- /dev/null +++ b/examples/jbatch/src/main/java/io/helidon/jbatch/example/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2022, 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 application showing support for JBatch and HelidonMP. + */ +package io.helidon.jbatch.example; diff --git a/examples/jbatch/src/main/resources/META-INF/batch-jobs/myJob.xml b/examples/jbatch/src/main/resources/META-INF/batch-jobs/myJob.xml new file mode 100644 index 00000000..22482bed --- /dev/null +++ b/examples/jbatch/src/main/resources/META-INF/batch-jobs/myJob.xml @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + diff --git a/examples/jbatch/src/main/resources/META-INF/beans.xml b/examples/jbatch/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..1c09dd0c --- /dev/null +++ b/examples/jbatch/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + diff --git a/examples/jbatch/src/main/resources/META-INF/microprofile-config.properties b/examples/jbatch/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..52cd57f8 --- /dev/null +++ b/examples/jbatch/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2022 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 + +# Change the following to true to enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=false diff --git a/examples/jbatch/src/main/resources/logging.properties b/examples/jbatch/src/main/resources/logging.properties new file mode 100644 index 00000000..86676508 --- /dev/null +++ b/examples/jbatch/src/main/resources/logging.properties @@ -0,0 +1,37 @@ +# +# Copyright (c) 2022, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/jbatch/src/test/java/io/helidon/examples/jbatch/TestJBatchEndpoint.java b/examples/jbatch/src/test/java/io/helidon/examples/jbatch/TestJBatchEndpoint.java new file mode 100644 index 00000000..f1af0b26 --- /dev/null +++ b/examples/jbatch/src/test/java/io/helidon/examples/jbatch/TestJBatchEndpoint.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2022, 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.jbatch; + +import io.helidon.microprofile.tests.junit5.HelidonTest; +import org.junit.jupiter.api.Test; + +import javax.inject.Inject; +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MediaType; +import java.util.Collections; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.notNullValue; +import static org.hamcrest.MatcherAssert.assertThat; + + +@HelidonTest +public class TestJBatchEndpoint { + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + @Inject + private WebTarget webTarget; + + @Test + public void runJob() throws InterruptedException { + + JsonObject expectedJson = JSON.createObjectBuilder() + .add("Steps executed", "[step1, step2]") + .add("Status", "COMPLETED") + .build(); + + //Start the job + JsonObject jsonObject = webTarget + .path("/batch") + .request(MediaType.APPLICATION_JSON_TYPE) + .get(JsonObject.class); + + Integer responseJobId = jsonObject.getInt("Started a job with Execution ID: "); + assertThat(responseJobId, is(notNullValue())); + JsonObject result = null; + for (int i = 1; i < 10; i++) { + //Wait a bit for it to complete + Thread.sleep(i*1000); + + //Examine the results + result = webTarget + .path("batch/status/" + responseJobId) + .request(MediaType.APPLICATION_JSON_TYPE) + .get(JsonObject.class); + + if (result.equals(expectedJson)){ + break; + } + + } + + assertThat(result, equalTo(expectedJson)); + } +} diff --git a/examples/k8s/zipkin.yaml b/examples/k8s/zipkin.yaml new file mode 100644 index 00000000..5b632ff7 --- /dev/null +++ b/examples/k8s/zipkin.yaml @@ -0,0 +1,73 @@ +# +# Copyright (c) 2019, 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. +# + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: zipkin + labels: + app: zipkin +spec: + selector: + matchLabels: + app: zipkin + replicas: 1 + template: + metadata: + labels: + app: zipkin + spec: + containers: + - name: zipkin + image: openzipkin/zipkin:2 + imagePullPolicy: Always + ports: + - containerPort: 9411 +--- + +apiVersion: v1 +kind: Service +metadata: + name: zipkin + labels: + app: zipkin +spec: + type: ClusterIP + selector: + app: zipkin + ports: + - port: 9411 + targetPort: 9411 + name: http + +--- + +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: zipkin-ingress +spec: + rules: + - host: localhost + http: + paths: + - path: /zipkin + pathType: Prefix + backend: + service: + name: zipkin + port: + number: 9411 diff --git a/examples/logging/jul/README.md b/examples/logging/jul/README.md new file mode 100644 index 00000000..3675ab4d --- /dev/null +++ b/examples/logging/jul/README.md @@ -0,0 +1,52 @@ +JUL Example +--- + +This example shows how to use Java Util Logging with MDC + using Helidon API. + +The example can be built using GraalVM native image as well. + +# Running as jar + +Build this application: +```shell +mvn clean package +``` + +Run from command line: +```shell +java -jar target/helidon-examples-logging-jul.jar +``` + +Expected output should be similar to the following: +```text +2020.11.19 15:37:28 INFO io.helidon.common.LogConfig Thread[main,5,main]: Logging at initialization configured using classpath: /logging.properties "" +2020.11.19 15:37:28 INFO io.helidon.examples.logging.jul.Main Thread[main,5,main]: Starting up "startup" +2020.11.19 15:37:28 INFO io.helidon.examples.logging.jul.Main Thread[pool-1-thread-1,5,main]: Running on another thread "propagated" +2020.11.19 15:37:28 INFO io.helidon.common.HelidonFeatures Thread[features-thread,5,main]: Helidon SE 2.2.0 features: [Config, WebServer] "" +2020.11.19 15:37:28 INFO io.helidon.webserver.NettyWebServer Thread[nioEventLoopGroup-2-1,10,main]: Channel '@default' started: [id: 0x8a5f5634, L:/0:0:0:0:0:0:0:0:8080] "" +``` + +# Running as native image +You must use GraalVM with native image installed as your JDK, +or you can specify an environment variable `GRAALVM_HOME` that points +to such an installation. + +Build this application: +```shell +mvn clean package -Pnative-image +``` + +Run from command line: +```shell +target/helidon-examples-logging-jul +``` + +Expected output should be similar to the following: +```text +2020.11.19 15:38:14 INFO io.helidon.common.LogConfig Thread[main,5,main]: Logging at runtime configured using classpath: /logging.properties "" +2020.11.19 15:38:14 INFO io.helidon.examples.logging.jul.Main Thread[main,5,main]: Starting up "startup" +2020.11.19 15:38:14 INFO io.helidon.examples.logging.jul.Main Thread[pool-1-thread-1,5,main]: Running on another thread "propagated" +2020.11.19 15:38:14 INFO io.helidon.common.HelidonFeatures Thread[features-thread,5,main]: Helidon SE 2.2.0 features: [Config, WebServer] "" +2020.11.19 15:38:14 INFO io.helidon.webserver.NettyWebServer Thread[nioEventLoopGroup-2-1,10,main]: Channel '@default' started: [id: 0x2b929906, L:/0:0:0:0:0:0:0:0:8080] "" +``` \ No newline at end of file diff --git a/examples/logging/jul/pom.xml b/examples/logging/jul/pom.xml new file mode 100644 index 00000000..fb833d4b --- /dev/null +++ b/examples/logging/jul/pom.xml @@ -0,0 +1,67 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.logging + helidon-examples-logging-jul + 1.0.0-SNAPSHOT + Helidon Examples Logging Java Util Logging + + + Example of logging and MDC using JUL + + + + io.helidon.examples.logging.jul.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.logging + helidon-logging-jul + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/logging/jul/src/main/java/io/helidon/examples/logging/jul/Main.java b/examples/logging/jul/src/main/java/io/helidon/examples/logging/jul/Main.java new file mode 100644 index 00000000..f6648a59 --- /dev/null +++ b/examples/logging/jul/src/main/java/io/helidon/examples/logging/jul/Main.java @@ -0,0 +1,87 @@ +/* + * Copyright (c) 2020, 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.logging.jul; + +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.logging.Logger; + +import io.helidon.common.LogConfig; +import io.helidon.common.context.Context; +import io.helidon.common.context.Contexts; +import io.helidon.logging.common.HelidonMdc; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Main class of the example, runnable from command line. + */ +public final class Main { + private static final Logger LOGGER = Logger.getLogger(Main.class.getName()); + + private Main() { + } + + /** + * Starts the example. + * + * @param args not used + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + // the Helidon context is used to propagate MDC across threads + // if running within Helidon WebServer, you do not need to runInContext, as that is already + // done by the webserver + Contexts.runInContext(Context.create(), Main::logging); + + WebServer.builder() + .routing(Routing.builder() + .get("/", (req, res) -> { + HelidonMdc.set("name", String.valueOf(req.requestId())); + LOGGER.info("Running in webserver, id:"); + res.send("Hello"); + }) + .build()) + .port(8080) + .build() + .start() + .await(10, TimeUnit.SECONDS); + } + + private static void logging() { + HelidonMdc.set("name", "startup"); + LOGGER.info("Starting up"); + + // now let's see propagation across executor service boundary + HelidonMdc.set("name", "propagated"); + // wrap executor so it supports Helidon context, this is done for all built-in executors in Helidon + ExecutorService es = Contexts.wrap(Executors.newSingleThreadExecutor()); + + Future submit = es.submit(() -> { + LOGGER.info("Running on another thread"); + }); + try { + submit.get(); + } catch (Exception e) { + e.printStackTrace(); + } + es.shutdown(); + } +} diff --git a/examples/logging/jul/src/main/java/io/helidon/examples/logging/jul/package-info.java b/examples/logging/jul/src/main/java/io/helidon/examples/logging/jul/package-info.java new file mode 100644 index 00000000..a7fe560e --- /dev/null +++ b/examples/logging/jul/src/main/java/io/helidon/examples/logging/jul/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Java util logging example with Mapped diagnostics context in Helidon. + */ +package io.helidon.examples.logging.jul; diff --git a/examples/logging/jul/src/main/resources/logging.properties b/examples/logging/jul/src/main/resources/logging.properties new file mode 100644 index 00000000..90de19dd --- /dev/null +++ b/examples/logging/jul/src/main/resources/logging.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2020, 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. +# + +# Send messages to the console +handlers=io.helidon.logging.jul.HelidonConsoleHandler + +# !thread! is replaced by Helidon with the thread name +# any %X{...} is replaced by a value from MDC +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 "%X{name}"%n + +# Global logging level. Can be overridden by specific loggers +.level=INFO diff --git a/examples/logging/log4j/README.md b/examples/logging/log4j/README.md new file mode 100644 index 00000000..af4b9fde --- /dev/null +++ b/examples/logging/log4j/README.md @@ -0,0 +1,56 @@ +Log4j Example +--- + +This example shows how to use log4j with MDC (`ThreadContext`) + using Helidon API. + +The example moves all Java Util Logging to log4j. + +The example can be built using GraalVM native image as well. + +# Running as jar + +Build this application: +```shell +mvn clean package +``` + +Run from command line: +```shell +java -jar target/helidon-examples-logging-log4j.jar +``` + +Expected output should be similar to the following: +```text +2020-11-19 15:44:48,561 main INFO Registered Log4j as the java.util.logging.LogManager. +15:44:48.596 INFO [main] io.helidon.examples.logging.log4j.Main - Starting up "startup" +15:44:48.598 INFO [main] io.helidon.examples.logging.log4j.Main - Using JUL logger "startup" +15:44:48.600 INFO [pool-2-thread-1] io.helidon.examples.logging.log4j.Main - Running on another thread "propagated" +15:44:48.704 INFO [features-thread] io.helidon.common.HelidonFeatures - Helidon SE 2.2.0 features: [Config, WebServer] "" +15:44:48.801 INFO [nioEventLoopGroup-2-1] io.helidon.webserver.NettyWebServer - Channel '@default' started: [id: 0xa215c23d, L:/0:0:0:0:0:0:0:0:8080] "" +``` + +# Running as native image +You must use GraalVM with native image installed as your JDK, +or you can specify an environment variable `GRAALVM_HOME` that points +to such an installation. + +Build this application: +```shell +mvn clean package -Pnative-image +``` + +Run from command line: +```shell +java -jar target/helidon-examples-logging-log4j +``` + +*In native image, we can only replace loggers initialized after reconfiguration of logging system +This unfortunately means that Helidon logging would not be available* + +Expected output should be similar to the following: +```text +15:47:53.033 INFO [main] io.helidon.examples.logging.log4j.Main - Starting up "startup" +15:47:53.033 INFO [main] io.helidon.examples.logging.log4j.Main - Using JUL logger "startup" +15:47:53.033 INFO [pool-2-thread-1] io.helidon.examples.logging.log4j.Main - Running on another thread "propagated" +``` \ No newline at end of file diff --git a/examples/logging/log4j/pom.xml b/examples/logging/log4j/pom.xml new file mode 100644 index 00000000..81de7b7c --- /dev/null +++ b/examples/logging/log4j/pom.xml @@ -0,0 +1,79 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.logging + helidon-examples-logging-log4j + 1.0.0-SNAPSHOT + Helidon Examples Logging Log4j + + + Example of logging and MDC using Log4j + + + + io.helidon.examples.logging.log4j.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.logging + helidon-logging-log4j + + + org.apache.logging.log4j + log4j-api + + + org.apache.logging.log4j + log4j-core + + + org.apache.logging.log4j + log4j-jul + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/logging/log4j/src/main/java/io/helidon/examples/logging/log4j/Main.java b/examples/logging/log4j/src/main/java/io/helidon/examples/logging/log4j/Main.java new file mode 100644 index 00000000..9eb7cf80 --- /dev/null +++ b/examples/logging/log4j/src/main/java/io/helidon/examples/logging/log4j/Main.java @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2020, 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.logging.log4j; + +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.context.Context; +import io.helidon.common.context.Contexts; +import io.helidon.logging.common.HelidonMdc; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.apache.logging.log4j.Level; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.apache.logging.log4j.ThreadContext; +import org.apache.logging.log4j.core.appender.ConsoleAppender; +import org.apache.logging.log4j.core.config.Configurator; +import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory; + +/** + * Main class of the example, runnable from command line. + * There is a limitation of log4j in native image - we only have loggers that are + * initialized after we configure logging, which unfortunately excludes Helidon loggers. + * You would need to use JUL or slf4j to have Helidon logs combined with application logs. + */ +public final class Main { + static { + // replace JUL log manager with Log4j log manager, so we log all to it + System.setProperty("java.util.logging.manager", "org.apache.logging.log4j.jul.LogManager"); + } + + private static java.util.logging.Logger julLogger; + private static Logger logger; + + private Main() { + } + + /** + * Starts the example. + * + * @param args not used + */ + public static void main(String[] args) { + // file based logging configuration does not work + // with native image! + configureLogging(); + // get logger after configuration + logger = LogManager.getLogger(Main.class.getName()); + julLogger = java.util.logging.Logger.getLogger(Main.class.getName()); + + // the Helidon context is used to propagate MDC across threads + // if running within Helidon WebServer, you do not need to runInContext, as that is already + // done by the webserver + Contexts.runInContext(Context.create(), Main::logging); + + WebServer.builder() + .routing(Routing.builder() + .get("/", (req, res) -> { + HelidonMdc.set("name", String.valueOf(req.requestId())); + logger.info("Running in webserver, id:"); + res.send("Hello"); + }) + .build()) + .port(8080) + .build() + .start() + .await(10, TimeUnit.SECONDS); + } + + private static void logging() { + HelidonMdc.set("name", "startup"); + logger.info("Starting up"); + julLogger.info("Using JUL logger"); + + // now let's see propagation across executor service boundary, we can also use Log4j's ThreadContext + ThreadContext.put("name", "propagated"); + // wrap executor so it supports Helidon context, this is done for all built-in executors in Helidon + ExecutorService es = Contexts.wrap(Executors.newSingleThreadExecutor()); + + Future submit = es.submit(Main::log); + try { + submit.get(); + } catch (Exception e) { + e.printStackTrace(); + } + es.shutdown(); + } + + private static void log() { + logger.info("Running on another thread"); + } + + private static void configureLogging() { + // configure log4j + final var builder = ConfigurationBuilderFactory.newConfigurationBuilder(); + builder.setConfigurationName("root"); + builder.setStatusLevel(Level.INFO); + final var appenderComponentBuilder = builder.newAppender("Stdout", "CONSOLE") + .addAttribute("target", ConsoleAppender.Target.SYSTEM_OUT); + appenderComponentBuilder.add(builder.newLayout("PatternLayout") + .addAttribute("pattern", "%d{HH:mm:ss.SSS} %-5level [%t] %logger{36} - %msg " + + "\"%X{name}\"%n")); + builder.add(appenderComponentBuilder); + builder.add(builder.newRootLogger(Level.INFO) + .add(builder.newAppenderRef("Stdout"))); + Configurator.initialize(builder.build()); + } +} diff --git a/examples/logging/log4j/src/main/java/io/helidon/examples/logging/log4j/package-info.java b/examples/logging/log4j/src/main/java/io/helidon/examples/logging/log4j/package-info.java new file mode 100644 index 00000000..dfbef7be --- /dev/null +++ b/examples/logging/log4j/src/main/java/io/helidon/examples/logging/log4j/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Log4j example with Mapped diagnostics context (ThreadContext) in Helidon. + */ +package io.helidon.examples.logging.log4j; diff --git a/examples/logging/logback-aot/README.md b/examples/logging/logback-aot/README.md new file mode 100644 index 00000000..99ddc708 --- /dev/null +++ b/examples/logging/logback-aot/README.md @@ -0,0 +1,60 @@ +Slf4j/Logback Example +--- + +This example shows how to use slf4j with MDC backed by Logback + using Helidon API. + +The example moves all Java Util Logging to slf4j and supports more advance configuration of logback. + +# AOT (native image) +To support native image, we need to use a different logback configuration at build time and at runtime. +To achieve this, we bundle `logback.xml` on classpath, and then have `logback-runtime.xml` with +configuration that requires started threads (which is not supported at build time). + +The implementation will re-configure logback (see method `setupLogging` in `Main.java). + +To see that configuration works as expected at runtime, change the log level of our package to `debug`. +Within 30 seconds the configuration should be reloaded, and next request will have two more debug messages. + +Expected output should be similar to the following (for both hotspot and native): +```text +15:40:44.240 INFO [main] i.h.examples.logging.slf4j.Main - Starting up startup +15:40:44.241 INFO [main] i.h.examples.logging.slf4j.Main - Using JUL logger startup +15:40:44.245 INFO [pool-1-thread-1] i.h.examples.logging.slf4j.Main - Running on another thread propagated +15:40:44.395 INFO [features-thread] io.helidon.common.HelidonFeatures - Helidon SE 2.2.0 features: [Config, WebServer] +15:40:44.538 INFO [nioEventLoopGroup-2-1] io.helidon.webserver.NettyWebServer - Channel '@default' started: [id: 0x8e516487, L:/0:0:0:0:0:0:0:0:8080] +``` + +The output is also logged into `helidon.log`. + +# Running as jar + +Build this application: +```shell +mvn clean package +``` + +Run from command line: +```shell +java -jar target/helidon-examples-logging-slf4j-aot.jar +``` + +Execute endpoint: +```shell +curl -i http://localhost:8080 +``` + +# Running as native image +You must use GraalVM with native image installed as your JDK, +or you can specify an environment variable `GRAALVM_HOME` that points +to such an installation. + +Build this application: +```shell +mvn clean package -Pnative-image +``` + +Run from command line: +```shell +./target/helidon-examples-logging-sfl4j +``` diff --git a/examples/logging/logback-aot/logback-runtime.xml b/examples/logging/logback-aot/logback-runtime.xml new file mode 100644 index 00000000..942479a5 --- /dev/null +++ b/examples/logging/logback-aot/logback-runtime.xml @@ -0,0 +1,60 @@ + + + + + + + helidon.log + true + false + + helidon.%d{yyyy-MM-dd}.gz + 10 + 5GB + + + + ${defaultPattern} + + + + + + 2048 + 15000 + true + true + + + + + ${defaultPattern} + + + + + + + + + + + + + + + diff --git a/examples/logging/logback-aot/pom.xml b/examples/logging/logback-aot/pom.xml new file mode 100644 index 00000000..a0edea40 --- /dev/null +++ b/examples/logging/logback-aot/pom.xml @@ -0,0 +1,80 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.logging + helidon-examples-logging-slf4j-aot + 1.0.0-SNAPSHOT + Helidon Examples Logging Slf4j AOT + + + Example of logging and MDC using Slf4j ready for Ahead of time compilation + using GraalVM native image + + + + io.helidon.examples.logging.logback.aot.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.logging + helidon-logging-slf4j + + + org.slf4j + slf4j-api + + + org.slf4j + jul-to-slf4j + + + ch.qos.logback + logback-classic + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/logging/logback-aot/src/main/java/io/helidon/examples/logging/logback/aot/Main.java b/examples/logging/logback-aot/src/main/java/io/helidon/examples/logging/logback/aot/Main.java new file mode 100644 index 00000000..bad9f8ce --- /dev/null +++ b/examples/logging/logback-aot/src/main/java/io/helidon/examples/logging/logback/aot/Main.java @@ -0,0 +1,139 @@ +/* + * 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. + */ + +package io.helidon.examples.logging.logback.aot; + +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.context.Context; +import io.helidon.common.context.Contexts; +import io.helidon.logging.common.HelidonMdc; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import ch.qos.logback.classic.LoggerContext; +import ch.qos.logback.classic.joran.JoranConfigurator; +import ch.qos.logback.core.joran.spi.JoranException; +import ch.qos.logback.core.util.StatusPrinter; +import org.slf4j.ILoggerFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.slf4j.MDC; +import org.slf4j.bridge.SLF4JBridgeHandler; + +/** + * Main class of the example, runnable from command line. + */ +public final class Main { + private static final Logger LOGGER = LoggerFactory.getLogger(Main.class); + private static final java.util.logging.Logger JUL_LOGGER = java.util.logging.Logger.getLogger(Main.class.getName()); + + private Main() { + } + + /** + * Starts the example. + * + * @param args not used + */ + public static void main(String[] args) { + // use slf4j for JUL as well + setupLogging(); + + // the Helidon context is used to propagate MDC across threads + // if running within Helidon WebServer, you do not need to runInContext, as that is already + // done by the webserver + Contexts.runInContext(Context.create(), Main::logging); + + WebServer.builder() + .routing(Routing.builder() + .get("/", (req, res) -> { + HelidonMdc.set("name", String.valueOf(req.requestId())); + LOGGER.debug("Debug message to show runtime reloading works"); + LOGGER.info("Running in webserver, id:"); + res.send("Hello") + .forSingle(ignored -> LOGGER.debug("Response sent")); + }) + .build()) + .port(8080) + .build() + .start() + .await(10, TimeUnit.SECONDS); + } + + private static void setupLogging() { + String location = System.getProperty("logback.configurationFile"); + location = (location == null) ? "logback-runtime.xml" : location; + // we cannot use anything that starts threads at build time, must re-configure here + resetLogging(location); + + SLF4JBridgeHandler.removeHandlersForRootLogger(); + SLF4JBridgeHandler.install(); + } + + private static void resetLogging(String location) { + ILoggerFactory loggerFactory = LoggerFactory.getILoggerFactory(); + if (loggerFactory instanceof LoggerContext) { + resetLogging(location, (LoggerContext) loggerFactory); + } else { + LOGGER.warn("Expecting a logback implementation, but got " + loggerFactory.getClass().getName()); + } + } + + private static void resetLogging(String location, LoggerContext loggerFactory) { + JoranConfigurator configurator = new JoranConfigurator(); + + configurator.setContext(loggerFactory); + loggerFactory.reset(); + + try { + configurator.doConfigure(location); + + Logger instance = LoggerFactory.getLogger(Main.class); + instance.info("Runtime logging configured from file \"{}\".", location); + StatusPrinter.print(loggerFactory); + } catch (JoranException e) { + LOGGER.warn("Failed to reload logging from " + location, e); + e.printStackTrace(); + } + } + + private static void logging() { + HelidonMdc.set("name", "startup"); + LOGGER.info("Starting up"); + JUL_LOGGER.info("Using JUL logger"); + + // now let's see propagation across executor service boundary, we can also use Log4j's ThreadContext + MDC.put("name", "propagated"); + // wrap executor so it supports Helidon context, this is done for all built-in executors in Helidon + ExecutorService es = Contexts.wrap(Executors.newSingleThreadExecutor()); + + Future submit = es.submit(Main::log); + try { + submit.get(); + } catch (Exception e) { + e.printStackTrace(); + } + es.shutdown(); + } + + private static void log() { + LOGGER.info("Running on another thread"); + } +} diff --git a/examples/logging/logback-aot/src/main/java/io/helidon/examples/logging/logback/aot/package-info.java b/examples/logging/logback-aot/src/main/java/io/helidon/examples/logging/logback/aot/package-info.java new file mode 100644 index 00000000..6e718eaf --- /dev/null +++ b/examples/logging/logback-aot/src/main/java/io/helidon/examples/logging/logback/aot/package-info.java @@ -0,0 +1,21 @@ +/* + * 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. + */ + +/** + * Slf4j example with Mapped diagnostics context (MDC) in Helidon ready for + * complex runtime configuration in native image. + */ +package io.helidon.examples.logging.logback.aot; diff --git a/examples/logging/logback-aot/src/main/resources/logback.xml b/examples/logging/logback-aot/src/main/resources/logback.xml new file mode 100644 index 00000000..6d50d18e --- /dev/null +++ b/examples/logging/logback-aot/src/main/resources/logback.xml @@ -0,0 +1,31 @@ + + + + + + + + %d{HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg %X{name}%n + + + + + + + + \ No newline at end of file diff --git a/examples/logging/pom.xml b/examples/logging/pom.xml new file mode 100644 index 00000000..78d93f09 --- /dev/null +++ b/examples/logging/pom.xml @@ -0,0 +1,44 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.logging + helidon-examples-logging-project + Helidon Examples Logging + pom + + + Examples of Helidon Logging + + + + jul + log4j + slf4j + logback-aot + + diff --git a/examples/logging/slf4j/README.md b/examples/logging/slf4j/README.md new file mode 100644 index 00000000..6c1bf233 --- /dev/null +++ b/examples/logging/slf4j/README.md @@ -0,0 +1,45 @@ +Slf4j Example +--- + +This example shows how to use slf4j with MDC + using Helidon API. + +The example moves all Java Util Logging to slf4j + +The example can be built using GraalVM native image as well. + +Expected output should be similar to the following (for both hotspot and native): +```text +15:40:44.240 INFO [main] i.h.examples.logging.slf4j.Main - Starting up startup +15:40:44.241 INFO [main] i.h.examples.logging.slf4j.Main - Using JUL logger startup +15:40:44.245 INFO [pool-1-thread-1] i.h.examples.logging.slf4j.Main - Running on another thread propagated +15:40:44.395 INFO [features-thread] io.helidon.common.HelidonFeatures - Helidon SE 2.2.0 features: [Config, WebServer] +15:40:44.538 INFO [nioEventLoopGroup-2-1] io.helidon.webserver.NettyWebServer - Channel '@default' started: [id: 0x8e516487, L:/0:0:0:0:0:0:0:0:8080] +``` + +# Running as jar + +Build this application: +```shell +mvn clean package +``` + +Run from command line: +```shell +java -jar target/helidon-examples-logging-slf4j.jar +``` + +# Running as native image +You must use GraalVM with native image installed as your JDK, +or you can specify an environment variable `GRAALVM_HOME` that points +to such an installation. + +Build this application: +```shell +mvn clean package -Pnative-image +``` + +Run from command line: +```shell +./target/helidon-examples-logging-sfl4j +``` diff --git a/examples/logging/slf4j/pom.xml b/examples/logging/slf4j/pom.xml new file mode 100644 index 00000000..a4ce2b89 --- /dev/null +++ b/examples/logging/slf4j/pom.xml @@ -0,0 +1,79 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.logging + helidon-examples-logging-slf4j + 1.0.0-SNAPSHOT + Helidon Examples Logging Slf4j + + + Example of logging and MDC using Slf4j + + + + io.helidon.examples.logging.slf4j.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.logging + helidon-logging-slf4j + + + org.slf4j + slf4j-api + + + org.slf4j + jul-to-slf4j + + + ch.qos.logback + logback-classic + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/logging/slf4j/src/main/java/io/helidon/examples/logging/slf4j/Main.java b/examples/logging/slf4j/src/main/java/io/helidon/examples/logging/slf4j/Main.java new file mode 100644 index 00000000..afc2ef0e --- /dev/null +++ b/examples/logging/slf4j/src/main/java/io/helidon/examples/logging/slf4j/Main.java @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2020, 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.logging.slf4j; + +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.context.Context; +import io.helidon.common.context.Contexts; +import io.helidon.logging.common.HelidonMdc; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.slf4j.MDC; +import org.slf4j.bridge.SLF4JBridgeHandler; + +/** + * Main class of the example, runnable from command line. + */ +public final class Main { + private static final Logger LOGGER = LoggerFactory.getLogger(Main.class); + private static final java.util.logging.Logger JUL_LOGGER = java.util.logging.Logger.getLogger(Main.class.getName()); + + private Main() { + } + + /** + * Starts the example. + * + * @param args not used + */ + public static void main(String[] args) { + // use slf4j for JUL as well + setupLogging(); + + // the Helidon context is used to propagate MDC across threads + // if running within Helidon WebServer, you do not need to runInContext, as that is already + // done by the webserver + Contexts.runInContext(Context.create(), Main::logging); + + WebServer.builder() + .routing(Routing.builder() + .get("/", (req, res) -> { + HelidonMdc.set("name", String.valueOf(req.requestId())); + LOGGER.info("Running in webserver, id:"); + res.send("Hello"); + }) + .build()) + .port(8080) + .build() + .start() + .await(10, TimeUnit.SECONDS); + } + + private static void setupLogging() { + SLF4JBridgeHandler.removeHandlersForRootLogger(); + SLF4JBridgeHandler.install(); + } + + private static void logging() { + HelidonMdc.set("name", "startup"); + LOGGER.info("Starting up"); + JUL_LOGGER.info("Using JUL logger"); + + // now let's see propagation across executor service boundary, we can also use Log4j's ThreadContext + MDC.put("name", "propagated"); + // wrap executor so it supports Helidon context, this is done for all built-in executors in Helidon + ExecutorService es = Contexts.wrap(Executors.newSingleThreadExecutor()); + + Future submit = es.submit(Main::log); + try { + submit.get(); + } catch (Exception e) { + e.printStackTrace(); + } + es.shutdown(); + } + + private static void log() { + LOGGER.info("Running on another thread"); + } +} diff --git a/examples/logging/slf4j/src/main/java/io/helidon/examples/logging/slf4j/package-info.java b/examples/logging/slf4j/src/main/java/io/helidon/examples/logging/slf4j/package-info.java new file mode 100644 index 00000000..a0d60f40 --- /dev/null +++ b/examples/logging/slf4j/src/main/java/io/helidon/examples/logging/slf4j/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Slf4j example with Mapped diagnostics context (MDC) in Helidon. + */ +package io.helidon.examples.logging.slf4j; diff --git a/examples/logging/slf4j/src/main/resources/logback.xml b/examples/logging/slf4j/src/main/resources/logback.xml new file mode 100644 index 00000000..d23974ee --- /dev/null +++ b/examples/logging/slf4j/src/main/resources/logback.xml @@ -0,0 +1,31 @@ + + + + + + + + %d{HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg %X{name}%n + + + + + + + + \ No newline at end of file diff --git a/examples/media/multipart/README.md b/examples/media/multipart/README.md new file mode 100644 index 00000000..eb7ee218 --- /dev/null +++ b/examples/media/multipart/README.md @@ -0,0 +1,23 @@ +# Helidon SE MultiPart Example + +This example demonstrates how to use `MultiPartSupport` with both the `WebServer` + and `WebClient` APIs. + +This project implements a simple file service web application that supports uploading +and downloading files. The unit test uses the `WebClient` API to test the endpoints. + +## Build + +```shell +mvn package +``` + +## Run + +First, start the server: + +```shell +java -jar target/helidon-examples-media-multipart.jar +``` + +Then open in your browser. diff --git a/examples/media/multipart/pom.xml b/examples/media/multipart/pom.xml new file mode 100644 index 00000000..510ffd6a --- /dev/null +++ b/examples/media/multipart/pom.xml @@ -0,0 +1,94 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.media + helidon-examples-media-multipart + 1.0.0-SNAPSHOT + Helidon Examples Media Support Multipart + + + Example of a form based file upload. + + + + io.helidon.examples.media.multipart.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.media + helidon-media-multipart + + + io.helidon.media + helidon-media-jsonp + + + org.glassfish + jakarta.json + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/FileService.java b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/FileService.java new file mode 100644 index 00000000..48a49491 --- /dev/null +++ b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/FileService.java @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2020, 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.media.multipart; + +import java.nio.file.Path; +import java.util.Arrays; +import java.util.Map; +import java.util.concurrent.ExecutorService; + +import javax.json.Json; +import javax.json.JsonArrayBuilder; +import javax.json.JsonBuilderFactory; + +import io.helidon.common.configurable.ThreadPoolSupplier; +import io.helidon.common.http.DataChunk; +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.common.reactive.IoMulti; +import io.helidon.media.multipart.ContentDisposition; +import io.helidon.media.multipart.ReadableBodyPart; +import io.helidon.webserver.ResponseHeaders; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * File service. + */ +public final class FileService implements Service { + + private static final JsonBuilderFactory JSON_FACTORY = Json.createBuilderFactory(Map.of()); + private final FileStorage storage; + private final ExecutorService executor = ThreadPoolSupplier.create("multipart-thread-pool").get(); + + + /** + * Create a new file upload service instance. + */ + FileService() { + storage = new FileStorage(); + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/", this::list) + .get("/{fname}", this::download) + .post("/", this::upload); + } + + private void list(ServerRequest req, ServerResponse res) { + JsonArrayBuilder arrayBuilder = JSON_FACTORY.createArrayBuilder(); + storage.listFiles().forEach(arrayBuilder::add); + res.send(JSON_FACTORY.createObjectBuilder().add("files", arrayBuilder).build()); + } + + private void download(ServerRequest req, ServerResponse res) { + Path filePath = storage.lookup(req.path().param("fname")); + ResponseHeaders headers = res.headers(); + headers.contentType(MediaType.APPLICATION_OCTET_STREAM); + headers.put(Http.Header.CONTENT_DISPOSITION, ContentDisposition.builder() + .filename(filePath.getFileName().toString()) + .build() + .toString()); + res.send(filePath); + } + + private void upload(ServerRequest req, ServerResponse res) { + req.content().asStream(ReadableBodyPart.class) + .forEach(part -> { + if ("file[]".equals(part.name())) { + part.content().map(DataChunk::data) + .flatMapIterable(Arrays::asList) + .to(IoMulti.writeToFile(storage.create(part.filename())) + .executor(executor) + .build()); + } else { + // when streaming unconsumed parts needs to be drained + part.drain(); + } + }) + .onError(res::send) + .onComplete(() -> { + res.status(Http.Status.MOVED_PERMANENTLY_301); + res.headers().put(Http.Header.LOCATION, "/ui"); + res.send(); + }).ignoreElement(); + } +} diff --git a/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/FileStorage.java b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/FileStorage.java new file mode 100644 index 00000000..a3349d0b --- /dev/null +++ b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/FileStorage.java @@ -0,0 +1,111 @@ +/* + * 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. + */ +package io.helidon.examples.media.multipart; + +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import io.helidon.webserver.BadRequestException; +import io.helidon.webserver.NotFoundException; + +/** + * Simple bean to managed a directory based storage. + */ +public class FileStorage { + + private final Path storageDir; + + /** + * Create a new instance. + */ + public FileStorage() { + try { + storageDir = Files.createTempDirectory("fileupload"); + } catch (IOException ex) { + throw new UncheckedIOException(ex); + } + } + + /** + * Get the storage directory. + * + * @return directory + */ + public Path storageDir() { + return storageDir; + } + + /** + * Get the names of the files in the storage directory. + * + * @return Stream of file names + */ + public Stream listFiles() { + try { + return Files.walk(storageDir) + .filter(Files::isRegularFile) + .map(storageDir::relativize) + .map(java.nio.file.Path::toString); + } catch (IOException ex) { + throw new UncheckedIOException(ex); + } + } + + /** + * Create a new file in the storage. + * + * @param fname file name + * @return file + * @throws BadRequestException if the resolved file is not contained in the storage directory + */ + public Path create(String fname) { + Path file = storageDir.resolve(fname); + if (!file.getParent().equals(storageDir)) { + throw new BadRequestException("Invalid file name"); + } + try { + Files.createFile(file); + } catch (IOException ex) { + throw new UncheckedIOException(ex); + } + return file; + } + + /** + * Lookup an existing file in the storage. + * + * @param fname file name + * @return file + * @throws NotFoundException If the resolved file does not exist + * @throws BadRequestException if the resolved file is not contained in the storage directory + */ + public Path lookup(String fname) { + Path file = storageDir.resolve(fname); + if (!file.getParent().equals(storageDir)) { + throw new BadRequestException("Invalid file name"); + } + if (!Files.exists(file)) { + throw new NotFoundException("file not found"); + } + if (!Files.isRegularFile(file)) { + throw new BadRequestException("Not a file"); + } + return file; + } +} diff --git a/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/Main.java b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/Main.java new file mode 100644 index 00000000..a9298384 --- /dev/null +++ b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/Main.java @@ -0,0 +1,87 @@ +/* + * Copyright (c) 2020, 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.media.multipart; + +import io.helidon.common.http.Http; +import io.helidon.common.reactive.Single; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.media.multipart.MultiPartSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +/** + * This application provides a simple file upload service with a UI to exercise multipart. + */ +public final class Main { + + private Main() { + } + + /** + * Creates new {@link Routing}. + * + * @return the new instance + */ + static Routing createRouting() { + return Routing.builder() + .any("/", (req, res) -> { + res.status(Http.Status.MOVED_PERMANENTLY_301); + res.headers().put(Http.Header.LOCATION, "/ui"); + res.send(); + }) + .register("/ui", StaticContentSupport.builder("WEB") + .welcomeFileName("index.html") + .build()) + .register("/api", new FileService()) + .build(); + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + WebServer server = WebServer.builder(createRouting()) + .port(8080) + .addMediaSupport(MultiPartSupport.create()) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Start the server and print some info. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port()); + }); + + // Server threads are not demon. NO need to block. Just react. + server.whenShutdown() + .thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + + return webserver; + } + + +} diff --git a/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/package-info.java b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/package-info.java new file mode 100644 index 00000000..6479921e --- /dev/null +++ b/examples/media/multipart/src/main/java/io/helidon/examples/media/multipart/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Helidon Examples Media MultiPart. + */ +package io.helidon.examples.media.multipart; diff --git a/examples/media/multipart/src/main/resources/WEB/index.html b/examples/media/multipart/src/main/resources/WEB/index.html new file mode 100644 index 00000000..c6bb338f --- /dev/null +++ b/examples/media/multipart/src/main/resources/WEB/index.html @@ -0,0 +1,59 @@ + + + + + + Helidon Examples Media Multipart + + + + + +

Uploaded files

+
+ +

Upload (stream)

+
+ Select a file to upload: + + +
+ + + + diff --git a/examples/media/multipart/src/test/java/io/helidon/examples/media/multipart/FileServiceTest.java b/examples/media/multipart/src/test/java/io/helidon/examples/media/multipart/FileServiceTest.java new file mode 100644 index 00000000..3bce29bc --- /dev/null +++ b/examples/media/multipart/src/test/java/io/helidon/examples/media/multipart/FileServiceTest.java @@ -0,0 +1,139 @@ +/* + * 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. + */ +package io.helidon.examples.media.multipart; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import java.util.concurrent.TimeUnit; + +import javax.json.JsonObject; +import javax.json.JsonString; + +import io.helidon.common.http.MediaType; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.media.multipart.FileFormParams; +import io.helidon.media.multipart.MultiPartSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.hamcrest.Matchers; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.MethodOrderer.OrderAnnotation; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestMethodOrder; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.hasItem; +import static org.hamcrest.Matchers.notNullValue; + +/** + * Tests {@link FileService}. + */ +@TestMethodOrder(OrderAnnotation.class) +public class FileServiceTest { + + private static WebServer webServer; + private static WebClient webClient; + + @BeforeAll + public static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:8080/api") + .addMediaSupport(MultiPartSupport.create()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + @Order(1) + public void testUpload() throws IOException { + Path file = Files.write( Files.createTempFile(null, null), "bar\n".getBytes(StandardCharsets.UTF_8)); + WebClientResponse response = webClient + .post() + .contentType(MediaType.MULTIPART_FORM_DATA) + .submit(FileFormParams.builder() + .addFile("file[]", "foo.txt", file) + .build()) + .await(); + assertThat(response.status().code(), is(301)); + } + + @Test + @Order(2) + public void testStreamUpload() throws IOException { + Path file = Files.write( Files.createTempFile(null, null), "stream bar\n".getBytes(StandardCharsets.UTF_8)); + Path file2 = Files.write( Files.createTempFile(null, null), "stream foo\n".getBytes(StandardCharsets.UTF_8)); + WebClientResponse response = webClient + .post() + .queryParam("stream", "true") + .contentType(MediaType.MULTIPART_FORM_DATA) + .submit(FileFormParams.builder() + .addFile("file[]", "streamed-foo.txt", file) + .addFile("otherPart", "streamed-foo2.txt", file2) + .build()) + .await(2, TimeUnit.SECONDS); + assertThat(response.status().code(), is(301)); + } + + @Test + @Order(3) + public void testList() { + WebClientResponse response = webClient + .get() + .contentType(MediaType.APPLICATION_JSON) + .request() + .await(); + assertThat(response.status().code(), Matchers.is(200)); + JsonObject json = response.content().as(JsonObject.class).await(); + assertThat(json, Matchers.is(notNullValue())); + List files = json.getJsonArray("files").getValuesAs(v -> ((JsonString) v).getString()); + assertThat(files, hasItem("foo.txt")); + } + + @Test + @Order(4) + public void testDownload() { + WebClientResponse response = webClient + .get() + .path("foo.txt") + .accept(MediaType.APPLICATION_OCTET_STREAM) + .request() + .await(); + assertThat(response.status().code(), is(200)); + assertThat(response.headers().first("Content-Disposition").orElse(null), + containsString("filename=\"foo.txt\"")); + byte[] bytes = response.content().as(byte[].class).await(); + assertThat(new String(bytes, StandardCharsets.UTF_8), Matchers.is("bar\n")); + } +} diff --git a/examples/media/pom.xml b/examples/media/pom.xml new file mode 100644 index 00000000..69e2cfbe --- /dev/null +++ b/examples/media/pom.xml @@ -0,0 +1,41 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.media + helidon-examples-media-project + Helidon Examples Media Support + pom + + + Examples of Helidon Media usage + + + + multipart + + diff --git a/examples/messaging/README.md b/examples/messaging/README.md new file mode 100644 index 00000000..36665820 --- /dev/null +++ b/examples/messaging/README.md @@ -0,0 +1,55 @@ +# Helidon Messaging Examples + +## Prerequisites +* Docker +* Java 11+ + +### Test Kafka server +To make examples easily runnable, +small, pocket size and pre-configured testing Kafka server Docker image is available. + +* To run it locally: `./kafkaRun.sh` + * Pre-configured topics: + * `messaging-test-topic-1` + * `messaging-test-topic-2` + * Stop it with `Ctrl+c` + +* Send messages manually with: `./kafkaProduce.sh [topic-name]` +* Consume messages manually with: `./kafkaConsume.sh [topic-name]` + +### Test JMS server +* Start ActiveMQ server locally: +```shell +docker run --name='activemq' --rm -p 61616:61616 -p 8161:8161 rmohr/activemq +``` + +### Test Oracle database +* Start ActiveMQ server locally: +```shell +cd ./docker/oracle-aq-18-xe +./buildAndRun.sh +``` + +For stopping Oracle database container use: +```shell +cd ./docker/oracle-aq-18-xe +./stopAndClean.sh +``` + +## Helidon SE Reactive Messaging with Kafka Example +For demonstration of Helidon SE Messaging with Kafka connector, +continue to [Kafka with WebSocket SE Example](kafka-websocket-se/README.md) + +## Helidon MP Reactive Messaging with Kafka Example +For demonstration of Helidon MP Messaging with Kafka connector, +continue to [Kafka with WebSocket MP Example](kafka-websocket-mp/README.md) + +## Helidon MP Reactive Messaging with JMS Example +For demonstration of Helidon MP Messaging with JMS connector, +continue to [JMS with WebSocket MP Example](jms-websocket-mp/README.md) + +## Helidon MP Reactive Messaging with Oracle AQ Example +For demonstration of Helidon MP Messaging with Oracle Advance Queueing connector, +continue to [Oracle AQ with WebSocket MP Example](oracle-aq-websocket-mp/README.md) + + diff --git a/examples/messaging/docker/kafka/Dockerfile.kafka b/examples/messaging/docker/kafka/Dockerfile.kafka new file mode 100644 index 00000000..d90e453c --- /dev/null +++ b/examples/messaging/docker/kafka/Dockerfile.kafka @@ -0,0 +1,51 @@ +# +# Copyright (c) 2019, 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. +# + +FROM openjdk:11-jre-slim-buster + +ENV VERSION=2.7.0 +ENV SCALA_VERSION=2.13 + +RUN apt-get -qq update && apt-get -qq -y install bash curl wget netcat jq + +RUN REL_PATH=kafka/${VERSION}/kafka_${SCALA_VERSION}-${VERSION}.tgz \ +&& BACKUP_ARCHIVE=https://archive.apache.org/dist/ \ +&& echo "Looking for closest mirror ..." \ +&& MIRROR=$(curl -s 'https://www.apache.org/dyn/closer.cgi?as_json=1' | jq -r '.http[0]') \ +&& echo "Checking if version ${VERSION} is available on the mirror: ${MIRROR} ..." \ +&& MIRROR_RESPONSE=$(curl -L --write-out '%{http_code}' --silent --output /dev/null ${MIRROR}kafka/${VERSION}) \ +&& if [ $MIRROR_RESPONSE -eq 200 ]; then BIN_URL=${MIRROR}${REL_PATH}; else BIN_URL=${BACKUP_ARCHIVE}${REL_PATH}; fi \ +&& if [ $MIRROR_RESPONSE -ne 200 ]; then echo "Version ${VERSION} not found on the mirror ${MIRROR}, defaulting to archive ${BACKUP_ARCHIVE}."; fi \ +&& wget -q -O kafka.tar.gz ${BIN_URL} \ +&& tar -xzf kafka.tar.gz -C /opt && rm kafka.tar.gz \ +&& mv /opt/kafka* /opt/kafka + +WORKDIR /opt/kafka + +COPY start_kafka.sh start_kafka.sh +COPY init_topics.sh init_topics.sh + +RUN chmod a+x ./*.sh + +RUN echo listener.security.protocol.map=INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT >> config/server.properties \ +&& echo advertised.listeners=INSIDE://localhost:9092,OUTSIDE://localhost:29092 >> config/server.properties \ +&& echo listeners=INSIDE://0.0.0.0:9092,OUTSIDE://0.0.0.0:29092 >> config/server.properties \ +&& echo inter.broker.listener.name=INSIDE >> config/server.properties + +# Expose Zookeeper and Kafka ports +EXPOSE 2181 9092 29092 + +CMD bash start_kafka.sh diff --git a/examples/messaging/docker/kafka/init_topics.sh b/examples/messaging/docker/kafka/init_topics.sh new file mode 100644 index 00000000..f127e365 --- /dev/null +++ b/examples/messaging/docker/kafka/init_topics.sh @@ -0,0 +1,50 @@ +#!/bin/bash +# +# Copyright (c) 2020, 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. +# + +# +# Wait for Kafka to start and create test topics: +# topic messaging-test-topic-1 and topic messaging-test-topic-2 +# + +ZOOKEEPER_URL=localhost:2181 +KAFKA_TOPICS="/opt/kafka/bin/kafka-topics.sh --if-not-exists --zookeeper $ZOOKEEPER_URL" + +while sleep 2; do + brokers=$(echo dump | nc localhost 2181 | grep brokers | wc -l) + echo "Checking if Kafka is up: ${brokers}" + if [[ "$brokers" -gt "0" ]]; then + echo "KAFKA IS UP !!!" + + echo "Creating test topics" + bash $KAFKA_TOPICS \ + --create \ + --replication-factor 1 \ + --partitions 10 \ + --topic messaging-test-topic-1 + bash $KAFKA_TOPICS \ + --create \ + --replication-factor 1 \ + --partitions 10 \ + --topic messaging-test-topic-2 + + echo + echo "Example topics messaging-test-topic-1 and messaging-test-topic-2 created" + echo + echo "================== Kafka is ready, stop it with Ctrl+C ==================" + exit 0 + fi +done diff --git a/examples/messaging/docker/kafka/start_kafka.sh b/examples/messaging/docker/kafka/start_kafka.sh new file mode 100644 index 00000000..875987b5 --- /dev/null +++ b/examples/messaging/docker/kafka/start_kafka.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# +# Copyright (c) 2020, 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. +# + +# +# Start Zookeeper, wait for it to come up and start Kafka. +# + +# Allow ruok +echo "4lw.commands.whitelist=*" >>/opt/kafka/config/zookeeper.properties + +# Start Zookeeper +/opt/kafka/bin/zookeeper-server-start.sh /opt/kafka/config/zookeeper.properties & + +while sleep 2; do + isOk=$(echo ruok | nc localhost 2181) + echo "Checking if Zookeeper is up: ${isOk}" + if [ "${isOk}" = "imok" ]; then + echo "ZOOKEEPER IS UP !!!" + break + fi +done + +# Create test topics when Kafka is ready +/opt/kafka/init_topics.sh & + +# Start Kafka +/opt/kafka/bin/kafka-server-start.sh /opt/kafka/config/server.properties +state=$? +if [ $state -ne 0 ]; then + echo "Kafka stopped." + exit $state +fi + +# Keep Kafka up till Ctrl+C +read ; diff --git a/examples/messaging/docker/oracle-aq-18-xe/Dockerfile b/examples/messaging/docker/oracle-aq-18-xe/Dockerfile new file mode 100644 index 00000000..ed27c31b --- /dev/null +++ b/examples/messaging/docker/oracle-aq-18-xe/Dockerfile @@ -0,0 +1,20 @@ +# +# Copyright (c) 2020, 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. +# + +FROM oracle/database:18.4.0-xe as base + + +COPY init.sql /docker-entrypoint-initdb.d/setup/ \ No newline at end of file diff --git a/examples/messaging/docker/oracle-aq-18-xe/buildAndRun.sh b/examples/messaging/docker/oracle-aq-18-xe/buildAndRun.sh new file mode 100644 index 00000000..0d9d3334 --- /dev/null +++ b/examples/messaging/docker/oracle-aq-18-xe/buildAndRun.sh @@ -0,0 +1,102 @@ +#!/bin/bash +# +# Copyright (c) 2020, 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. +# + +CURR_DIR=$(pwd) +TEMP_DIR=../../target +IMAGES_DIR=${TEMP_DIR}/ora-images +COMMIT="a69fe9b08ff147bb746d16af76cc5279ea5baf7a"; +IMAGES_ZIP_URL=https://github.com/oracle/docker-images/archive/${COMMIT:0:7}.zip +IMAGES_ZIP_DIR=docker-images-${COMMIT}/OracleDatabase/SingleInstance/dockerfiles +ORA_DB_VERSION=18.4.0 +BASE_IMAGE_NAME=oracle/database:${ORA_DB_VERSION}-xe +IMAGE_NAME=helidon/oracle-aq-example +CONTAINER_NAME=oracle-aq-example +ORACLE_PWD=frank + +printf "%-100s" "Checking if base image ${BASE_IMAGE_NAME} is available in local repository" +if [[ "$(docker images -q ${BASE_IMAGE_NAME} 2>/dev/null)" == "" ]]; then + printf "NOK\n" + + echo Base image ${BASE_IMAGE_NAME} not found. Building ... + + # cleanup + mkdir -p ${TEMP_DIR} + rm -rf ${IMAGES_DIR} + rm -f ${TEMP_DIR}/ora-images.zip + + # download official oracle docker images + curl -LJ -o ${TEMP_DIR}/ora-images.zip ${IMAGES_ZIP_URL} + # unzip only image for Oracle database 18.4.0 + unzip -qq ${TEMP_DIR}/ora-images.zip "${IMAGES_ZIP_DIR}/*" -d ${IMAGES_DIR} + mv ${IMAGES_DIR}/${IMAGES_ZIP_DIR}/${ORA_DB_VERSION} ${IMAGES_DIR}/ + mv ${IMAGES_DIR}/${IMAGES_ZIP_DIR}/buildContainerImage.sh ${IMAGES_DIR}/ + + # cleanup + rm -rf ${IMAGES_DIR}/docker-images-${COMMIT} + rm ${TEMP_DIR}/ora-images.zip + + # build base image + # can take long(15 minutes or so) + cd ${IMAGES_DIR} || exit + bash ./buildContainerImage.sh -v ${ORA_DB_VERSION} -x || exit + cd ${CURR_DIR} || exit +else + printf "OK\n" +fi + +printf "%-100s" "Checking if image ${IMAGE_NAME} is available in local repository" +if [[ "$(docker images -q ${IMAGE_NAME} 2>/dev/null)" == "" ]]; then + printf "NOK\n" + + echo Image ${IMAGE_NAME} not found. Building ... + docker build -t ${IMAGE_NAME} . || exit +else + printf "OK\n" +fi + +printf "%-100s" "Checking if container ${CONTAINER_NAME} is ready" +if [[ $(docker ps -a --filter "name=^/${CONTAINER_NAME}$" --format '{{.Names}}') != "${CONTAINER_NAME}" ]]; then + printf "NOK\n" + + echo "Container ${CONTAINER_NAME} not found. Running ..." + echo "!!! Be aware first time database initialization can take tens of minutes." + echo "!!! Follow docker logs -f ${CONTAINER_NAME} for 'DATABASE IS READY TO USE' message" + + docker run -d --name ${CONTAINER_NAME} \ + -p 1521:1521 \ + -p 5500:5500 \ + -e ORACLE_PWD=${ORACLE_PWD} \ + ${IMAGE_NAME} || exit +else + printf "OK\n" + printf "%-100s" "Checking if container ${CONTAINER_NAME} is started" + if [[ $(docker ps --filter "name=^/${CONTAINER_NAME}$" --format '{{.Names}}') != "${CONTAINER_NAME}" ]]; then + printf "NOK\n" + + echo "Container ${CONTAINER_NAME} not started. Starting ..." + docker start ${CONTAINER_NAME} || exit + else + printf "OK\n" + fi +fi + +echo "Container ${CONTAINER_NAME} with Oracle database ${ORA_DB_VERSION} XE populated with example AQ queues is either started or starting." +echo "For more info about the state of the database investigate logs:" +echo " docker logs -f ${CONTAINER_NAME}" +echo "Url: jdbc:oracle:thin:@localhost:1521:XE" +echo "user: frank" +echo "pass: frank" diff --git a/examples/messaging/docker/oracle-aq-18-xe/examples.sql b/examples/messaging/docker/oracle-aq-18-xe/examples.sql new file mode 100644 index 00000000..9a89352b --- /dev/null +++ b/examples/messaging/docker/oracle-aq-18-xe/examples.sql @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2020 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. + */ + + +-- SEND MESSAGE AS RAW BYTES +DECLARE + id pls_integer; + enqueue_options DBMS_AQ.ENQUEUE_OPTIONS_T; + message_properties DBMS_AQ.MESSAGE_PROPERTIES_T; + message_handle RAW(16); + msg sys.aq$_jms_bytes_message; +BEGIN + msg := sys.aq$_jms_bytes_message.construct; + id := msg.clear_body(-1); + msg.write_bytes(id, UTL_RAW.CAST_TO_RAW('Hello raw bytes!')); + msg.flush(id); + DBMS_AQ.ENQUEUE( + queue_name => 'FRANK.EXAMPLE_QUEUE_BYTES', + enqueue_options => enqueue_options, + message_properties => message_properties, + payload => msg, + msgid => message_handle); + COMMIT; +END; + +-- SEND TEXT MESSAGE +DECLARE + enqueue_options DBMS_AQ.ENQUEUE_OPTIONS_T; + message_properties DBMS_AQ.MESSAGE_PROPERTIES_T; + message_handle RAW(16); + msg SYS.AQ$_JMS_TEXT_MESSAGE; +BEGIN + msg := SYS.AQ$_JMS_TEXT_MESSAGE.construct; + msg.set_text('Hello from PLSQL !'); + DBMS_AQ.ENQUEUE( + queue_name => 'FRANK.EXAMPLE_QUEUE_1', + enqueue_options => enqueue_options, + message_properties => message_properties, + payload => msg, + msgid => message_handle); + COMMIT; +END; + +-- SEND MAP MESSAGE +DECLARE + id pls_integer; + enqueue_options DBMS_AQ.ENQUEUE_OPTIONS_T; + message_properties DBMS_AQ.MESSAGE_PROPERTIES_T; + message_handle RAW(16); + msg SYS.AQ$_JMS_MAP_MESSAGE; +BEGIN + msg := SYS.AQ$_JMS_MAP_MESSAGE.construct; + id := msg.clear_body(-1); + msg.set_string(id, 'head', 'Hello'); + msg.set_bytes(id, 'body', UTL_RAW.CAST_TO_RAW('this is map')); + msg.set_string(id, 'tail', 'message!'); + msg.flush(id); + DBMS_AQ.ENQUEUE( + queue_name => 'FRANK.EXAMPLE_QUEUE_MAP', + enqueue_options => enqueue_options, + message_properties => message_properties, + payload => msg, + msgid => message_handle); + COMMIT; +END; \ No newline at end of file diff --git a/examples/messaging/docker/oracle-aq-18-xe/init.sql b/examples/messaging/docker/oracle-aq-18-xe/init.sql new file mode 100644 index 00000000..01d6300a --- /dev/null +++ b/examples/messaging/docker/oracle-aq-18-xe/init.sql @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2020 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. + */ + + +alter session set "_ORACLE_SCRIPT"= true; +create user frank identified by frank; +grant dba to frank; + +grant execute on dbms_aq to frank; +grant execute on dbms_aqadm to frank; +grant execute on dbms_aqin to frank; + +CREATE OR REPLACE PROCEDURE create_queue(queueName IN VARCHAR2, qType IN VARCHAR2) IS +BEGIN + dbms_aqadm.create_queue_table('FRANK.'||queueName||'_TAB', qType); + dbms_aqadm.create_queue('FRANK.'||queueName,'FRANK.'||queueName||'_TAB'); + dbms_aqadm.start_queue('FRANK.'||queueName); +END; +/ + +-- Setup example AQ queues FRANK.EXAMPLE_QUEUE_1, FRANK.EXAMPLE_QUEUE_2, FRANK.EXAMPLE_QUEUE_3 +begin + CREATE_QUEUE('example_queue_1', 'SYS.AQ$_JMS_TEXT_MESSAGE'); + CREATE_QUEUE('example_queue_2', 'SYS.AQ$_JMS_TEXT_MESSAGE'); + CREATE_QUEUE('example_queue_3', 'SYS.AQ$_JMS_TEXT_MESSAGE'); + CREATE_QUEUE('example_queue_bytes', 'SYS.AQ$_JMS_BYTES_MESSAGE'); + CREATE_QUEUE('example_queue_map', 'SYS.AQ$_JMS_MAP_MESSAGE'); +end; +/ + +-- Setup example table +CREATE TABLE FRANK.MESSAGE_LOG ( + id NUMBER(15) PRIMARY KEY, + message VARCHAR2(255) NOT NULL, + insert_date DATE DEFAULT (sysdate)); +COMMENT ON TABLE FRANK.MESSAGE_LOG IS 'Manually logged messages'; + +CREATE SEQUENCE FRANK.MSG_LOG_SEQ START WITH 1; + +CREATE OR REPLACE TRIGGER MESSAGE_LOG_ID + BEFORE INSERT ON FRANK.MESSAGE_LOG + FOR EACH ROW + +BEGIN + SELECT FRANK.MSG_LOG_SEQ.NEXTVAL + INTO :new.id + FROM dual; +END; +/ diff --git a/examples/messaging/docker/oracle-aq-18-xe/stopAndClean.sh b/examples/messaging/docker/oracle-aq-18-xe/stopAndClean.sh new file mode 100644 index 00000000..4ba52254 --- /dev/null +++ b/examples/messaging/docker/oracle-aq-18-xe/stopAndClean.sh @@ -0,0 +1,20 @@ +#!/bin/bash +# +# Copyright (c) 2020, 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. +# + +docker stop oracle-aq-example +docker container rm oracle-aq-example +docker image rm helidon/oracle-aq-example:latest \ No newline at end of file diff --git a/examples/messaging/jms-websocket-mp/README.md b/examples/messaging/jms-websocket-mp/README.md new file mode 100644 index 00000000..8641a2d9 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/README.md @@ -0,0 +1,14 @@ +# Helidon Messaging with JMS Example + +## Prerequisites +* Java 11+ +* Docker +* [ActiveMQ server](../README.md) running on `localhost:61616` + +## Build & Run +```shell +mvn clean install +java -jar target/helidon-examples-jms-websocket-mp.jar +``` +Visit http://localhost:7001 + diff --git a/examples/messaging/jms-websocket-mp/pom.xml b/examples/messaging/jms-websocket-mp/pom.xml new file mode 100644 index 00000000..3d1ee6b6 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/pom.xml @@ -0,0 +1,76 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.jms + helidon-examples-jms-websocket-mp + 1.0-SNAPSHOT + jms-websocket-mp + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.messaging + helidon-microprofile-messaging + + + io.helidon.messaging.jms + helidon-messaging-jms + + + io.helidon.microprofile.websocket + helidon-microprofile-websocket + + + org.jboss + jandex + runtime + true + + + org.apache.activemq + activemq-client + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java new file mode 100644 index 00000000..6fb3ab52 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2020, 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.messaging.mp; + +import java.util.concurrent.SubmissionPublisher; + +import javax.enterprise.context.ApplicationScoped; + +import io.helidon.common.reactive.Multi; +import io.helidon.messaging.connectors.jms.JmsMessage; + +import org.eclipse.microprofile.reactive.messaging.Incoming; +import org.eclipse.microprofile.reactive.messaging.Message; +import org.eclipse.microprofile.reactive.messaging.Outgoing; +import org.eclipse.microprofile.reactive.streams.operators.ProcessorBuilder; +import org.eclipse.microprofile.reactive.streams.operators.ReactiveStreams; +import org.reactivestreams.FlowAdapters; +import org.reactivestreams.Publisher; + +/** + * Bean for message processing. + */ +@ApplicationScoped +public class MsgProcessingBean { + + private final SubmissionPublisher emitter = new SubmissionPublisher<>(); + private final SubmissionPublisher broadCaster = new SubmissionPublisher<>(); + + /** + * Create a publisher for the emitter. + * + * @return A Publisher from the emitter + */ + @Outgoing("multiplyVariants") + public Publisher preparePublisher() { + // Create new publisher for emitting to by this::process + return ReactiveStreams + .fromPublisher(FlowAdapters.toPublisher(Multi.create(emitter))) + .buildRs(); + } + + /** + * Returns a builder for a processor that maps a string into three variants. + * + * @return ProcessorBuilder + */ + @Incoming("multiplyVariants") + @Outgoing("toJms") + public ProcessorBuilder> multiply() { + // Multiply to 3 variants of same message + return ReactiveStreams.builder() + .flatMap(o -> + ReactiveStreams.of( + // upper case variant + o.toUpperCase(), + // repeat twice variant + o.repeat(2), + // reverse chars 'tnairav' + new StringBuilder(o).reverse().toString()) + ).map(Message::of); + } + + /** + * Broadcasts an event. + * + * @param msg Message to broadcast + */ + @Incoming("fromJms") + public void broadcast(JmsMessage msg) { + // Broadcast to all subscribers + broadCaster.submit(msg.getPayload()); + } + + /** + * Same JMS session, different connector. + * + * @param msg Message to broadcast + */ + @Incoming("fromJmsSameSession") + public void sameSession(JmsMessage msg) { + // Broadcast to all subscribers + broadCaster.submit(msg.getPayload()); + } + + /** + * Subscribe new Multi to broadcasting publisher. + * + * @return new Multi subscribed to broadcaster + */ + public Multi subscribeMulti() { + return Multi.create(broadCaster); + } + + /** + * Emit a message. + * + * @param msg message to emit + */ + public void process(final String msg) { + emitter.submit(msg); + } +} diff --git a/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java new file mode 100644 index 00000000..7b58409f --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2020, 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.messaging.mp; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +/** + * Expose send method for publishing to messaging. + */ +@Path("rest/messages") +@RequestScoped +public class SendingResource { + private final MsgProcessingBean msgBean; + + /** + * Constructor injection of field values. + * + * @param msgBean Messaging example bean + */ + @Inject + public SendingResource(MsgProcessingBean msgBean) { + this.msgBean = msgBean; + } + + /** + * Send message through Messaging to JMS. + * + * @param msg message to process + */ + @Path("/send/{msg}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public void getSend(@PathParam("msg") String msg) { + msgBean.process(msg); + } +} diff --git a/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java new file mode 100644 index 00000000..f3d8df32 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java @@ -0,0 +1,95 @@ + +/* + * Copyright (c) 2020, 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.messaging.mp; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.inject.Inject; +import javax.websocket.CloseReason; +import javax.websocket.EndpointConfig; +import javax.websocket.OnClose; +import javax.websocket.OnOpen; +import javax.websocket.Session; +import javax.websocket.server.ServerEndpoint; + +import io.helidon.common.reactive.Single; + +/** + * Register all WebSocket connection as subscribers + * of broadcasting {@link java.util.concurrent.SubmissionPublisher} + * in the {@link MsgProcessingBean}. + *

+ * When connection is closed, cancel subscription and remove reference. + */ +@ServerEndpoint("/ws/messages") +public class WebSocketEndpoint { + + private static final Logger LOGGER = Logger.getLogger(WebSocketEndpoint.class.getName()); + + private final Map> subscriberRegister = new HashMap<>(); + + @Inject + private MsgProcessingBean msgProcessingBean; + + /** + * On WebSocket session is opened. + * + * @param session web socket session + * @param endpointConfig endpoint config + */ + @OnOpen + public void onOpen(Session session, EndpointConfig endpointConfig) { + System.out.println("New WebSocket client connected with session " + session.getId()); + + Single single = msgProcessingBean.subscribeMulti() + // Watch for errors coming from upstream + .onError(throwable -> LOGGER.log(Level.SEVERE, "Upstream error!", throwable)) + // Send every item coming from upstream over web socket + .forEach(s -> sendTextMessage(session, s)); + + //Save forEach single promise for later cancellation + subscriberRegister.put(session.getId(), single); + } + + /** + * When WebSocket session is closed. + * + * @param session web socket session + * @param closeReason web socket close reason + */ + @OnClose + public void onClose(final Session session, final CloseReason closeReason) { + LOGGER.info("Closing session " + session.getId()); + // Properly unsubscribe from SubmissionPublisher + Optional.ofNullable(subscriberRegister.remove(session.getId())) + .ifPresent(Single::cancel); + } + + private void sendTextMessage(Session session, String msg) { + try { + session.getBasicRemote().sendText(msg); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Message sending over WebSocket failed", e); + } + } +} diff --git a/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java new file mode 100644 index 00000000..d2ddab5b --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java @@ -0,0 +1,21 @@ + +/* + * Copyright (c) 2020, 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. + */ + +/** + * Reactive Messaging JMS example. + */ +package io.helidon.examples.messaging.mp; diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/META-INF/beans.xml b/examples/messaging/jms-websocket-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..b5fbc9d5 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + + diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/WEB/favicon.ico b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/favicon.ico new file mode 100644 index 00000000..d91659fd Binary files /dev/null and b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/favicon.ico differ diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/arrow-1.png b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/arrow-1.png new file mode 100644 index 00000000..bbba0aef Binary files /dev/null and b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/arrow-1.png differ diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/arrow-2.png b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/arrow-2.png new file mode 100644 index 00000000..0b1096b0 Binary files /dev/null and b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/arrow-2.png differ diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/cloud.png b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/cloud.png new file mode 100644 index 00000000..3e04833c Binary files /dev/null and b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/cloud.png differ diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/frank.png b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/frank.png new file mode 100644 index 00000000..51a13d8d Binary files /dev/null and b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/img/frank.png differ diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/WEB/index.html b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/index.html new file mode 100644 index 00000000..b35aed46 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/index.html @@ -0,0 +1,127 @@ + + + + + + + + Helidon Reactive Messaging + + + + + + + + +

+
+
+ +
+
Send
+
+
+
+
+
REST call /rest/messages/send/{msg}
+
+
+
Messages received from JMS over websocket
+
+
+
+
+ 
+            
+
+
+
+ + + + + \ No newline at end of file diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/WEB/main.css b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/main.css new file mode 100644 index 00000000..5fdb4879 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/resources/WEB/main.css @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2020, 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. + */ + +#root { + background-color: #36ABF2; + font-family: Roboto,sans-serif; + color: #fff; + position: absolute; + overflow-x: hidden; + -ms-overflow-style: none; /* Internet Explorer 10+ */ + scrollbar-width: none; /* Firefox */ + top: 0; + left: 0; + width: 100%; + height: 100%; +} +#root::-webkit-scrollbar { + display: none; /* Safari and Chrome */ +} + +#helidon { + width: 509px; + height: 273px; + position: relative; + left: -509px; + z-index: 4; + background: url('img/frank.png'); +} + +#rest-tip { + position: relative; + top: -80px; + left: 160px; +} + +#rest-tip-arrow { + width: 205px; + height: 304px; + z-index: 4; + top: -20px; + background: url('img/arrow-1.png'); +} +#rest-tip-label { + position: absolute; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; + left: -60px; +} + +#sse-tip { + position: absolute; + overflow: hidden; + display: flex; + width: auto; + height: auto; + top: 5%; + right: 10%; + z-index: 0; +} + +#sse-tip-arrow { + position: relative; + top: -30px; + width: 296px; + height: 262px; + z-index: 4; + background: url('img/arrow-2.png'); +} +#sse-tip-label { + position: relative; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; +} + +#producer { + float: left; + position: relative; + width: 300px; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 99; +} + +#msgBox { + position: absolute; + width: 300px; + top: 25%; + right: 3%; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 20; +} + +#input { + width: 210px; + height: 22px; + top: 58px; + left: 30px; + background-color: white; + border-radius: 10px; + border-style: solid; + border-color: white; + position: absolute; + z-index: 10; +} + +#inputCloud { + position: relative; + width: 310px; + height: 150px; + background: url('img/cloud.png'); +} + +#msg { + background-color: #D2EBFC; + color: #1A9BF4; + border-radius: 10px; + width: 300px; + height: 50px; + margin: 5px; + display: flex; + padding-left: 10px; + justify-content: center; + align-items: center; + z-index: 99; +} + +#submit { + font-weight: bold; + background-color: aqua; + color: #1A9BF4; + border-radius: 12px; + width: 100px; + height: 30px; + display: flex; + justify-content: center; + align-items: center; + margin: 5px; + cursor: pointer; +} + +#snippet { + position: absolute; + top: 15%; + left: 30%; + width: 40%; + z-index: 5; +} + +.hljs { + border-radius: 10px; + font-size: 12px; +} \ No newline at end of file diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/application.yaml b/examples/messaging/jms-websocket-mp/src/main/resources/application.yaml new file mode 100644 index 00000000..803e8862 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/resources/application.yaml @@ -0,0 +1,49 @@ +# +# Copyright (c) 2020, 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. +# + +server: + port: 7001 + host: 0.0.0.0 + static.classpath: + location: /WEB + welcome: index.html + +mp.messaging: + connector.helidon-jms: + jndi: + jms-factory: ConnectionFactory + env-properties: + java.naming.factory.initial: org.apache.activemq.jndi.ActiveMQInitialContextFactory + java.naming.provider.url: tcp://127.0.0.1:61616 + + outgoing: + toJms: + connector: helidon-jms + destination: messaging-queue-topic-2 + type: queue + + incoming: + fromJms: + connector: helidon-jms + destination: messaging-test-queue-1 + session-group-id: session-group-1 + type: queue + + fromJmsSameSession: + connector: helidon-jms + destination: messaging-queue-topic-2 + session-group-id: session-group-1 + type: queue diff --git a/examples/messaging/jms-websocket-mp/src/main/resources/logging.properties b/examples/messaging/jms-websocket-mp/src/main/resources/logging.properties new file mode 100644 index 00000000..86ca67e9 --- /dev/null +++ b/examples/messaging/jms-websocket-mp/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2020, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/messaging/jms-websocket-se/README.md b/examples/messaging/jms-websocket-se/README.md new file mode 100644 index 00000000..6fe9ff41 --- /dev/null +++ b/examples/messaging/jms-websocket-se/README.md @@ -0,0 +1,14 @@ +# Helidon Messaging with JMS Example + +## Prerequisites +* Java 11+ +* Docker +* [ActiveMQ server](../README.md) running on `localhost:61616` + +## Build & Run +```shell +mvn clean install +java -jar target/helidon-examples-jms-websocket-se.jar +``` +Visit http://localhost:7001 + diff --git a/examples/messaging/jms-websocket-se/pom.xml b/examples/messaging/jms-websocket-se/pom.xml new file mode 100644 index 00000000..b89ed492 --- /dev/null +++ b/examples/messaging/jms-websocket-se/pom.xml @@ -0,0 +1,86 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.jms + helidon-examples-jms-websocket-se + 1.0-SNAPSHOT + jms-websocket-se + + + io.helidon.examples.messaging.se.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.messaging + helidon-messaging + + + io.helidon.messaging.jms + helidon-messaging-jms + + + jakarta.websocket + jakarta.websocket-api + + + io.helidon.webserver + helidon-webserver-tyrus + + + io.helidon.config + helidon-config-yaml + + + org.apache.activemq + activemq-client + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/Main.java b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/Main.java new file mode 100644 index 00000000..9a8ede18 --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/Main.java @@ -0,0 +1,123 @@ + +/* + * Copyright (c) 2020, 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.messaging.se; + +import java.io.IOException; +import java.io.InputStream; +import java.util.logging.LogManager; + +import javax.websocket.server.ServerEndpointConfig; + +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; +import io.helidon.webserver.tyrus.TyrusSupport; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * + * @param args command line arguments. + * @throws IOException if there are problems reading logging properties + */ + public static void main(final String[] args) throws IOException { + startServer(); + } + + /** + * Start the server. + * + * @return the created {@link WebServer} instance + * @throws IOException if there are problems reading logging properties + */ + static WebServer startServer() throws IOException { + // load logging configuration + setupLogging(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + SendingService sendingService = new SendingService(config); + + WebServer server = WebServer.builder(createRouting(sendingService)) + .config(config.get("server")) + .build(); + + server.start() + .thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port()); + ws.whenShutdown().thenRun(() + -> { + // Stop messaging properly + sendingService.shutdown(); + System.out.println("WEB server is DOWN. Good bye!"); + }); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + // Server threads are not daemon. No need to block. Just react. + return server; + } + + /** + * Creates new {@link Routing}. + * + * @param sendingService the service + */ + private static Routing createRouting(SendingService sendingService) { + + return Routing.builder() + // register static content support (on "/") + .register(StaticContentSupport.builder("/WEB").welcomeFileName("index.html")) + // register rest endpoint for sending to Jms + .register("/rest/messages", sendingService) + // register WebSocket endpoint to push messages coming from Jms to client + .register("/ws", + TyrusSupport.builder().register( + ServerEndpointConfig.Builder.create( + WebSocketEndpoint.class, "/messages") + .build()) + .build()) + .build(); + } + + /** + * Configure logging from logging.properties file. + */ + private static void setupLogging() throws IOException { + try (InputStream is = Main.class.getResourceAsStream("/logging.properties")) { + LogManager.getLogManager().readConfiguration(is); + } + } +} diff --git a/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java new file mode 100644 index 00000000..489056bd --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2020, 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.messaging.se; + +import io.helidon.config.Config; +import io.helidon.messaging.Channel; +import io.helidon.messaging.Emitter; +import io.helidon.messaging.Messaging; +import io.helidon.messaging.connectors.jms.JmsConnector; +import io.helidon.messaging.connectors.jms.Type; +import io.helidon.webserver.Routing; +import io.helidon.webserver.Service; + +import org.apache.activemq.jndi.ActiveMQInitialContextFactory; + +class SendingService implements Service { + + private final Emitter emitter; + private final Messaging messaging; + + SendingService(Config config) { + + String url = config.get("app.jms.url").asString().get(); + String destination = config.get("app.jms.destination").asString().get(); + + // Prepare channel for connecting processor -> jms connector with specific subscriber configuration, + // channel -> connector mapping is automatic when using JmsConnector.configBuilder() + Channel toJms = Channel.builder() + .subscriberConfig(JmsConnector.configBuilder() + .jndiInitialFactory(ActiveMQInitialContextFactory.class.getName()) + .jndiProviderUrl(url) + .type(Type.QUEUE) + .destination(destination) + .build() + ).build(); + + // Prepare channel for connecting emitter -> processor + Channel toProcessor = Channel.create(); + + // Prepare Jms connector, can be used by any channel + JmsConnector jmsConnector = JmsConnector.create(); + + // Prepare emitter for manual publishing to channel + emitter = Emitter.create(toProcessor); + + messaging = Messaging.builder() + .emitter(emitter) + // Processor connect two channels together + .processor(toProcessor, toJms, payload -> { + // Transforming to upper-case before sending to jms + return payload.toUpperCase(); + }) + .connector(jmsConnector) + .build() + .start(); + } + + /** + * A service registers itself by updating the routing rules. + * + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + // Listen for GET /example/send/{msg} + // to send it thru messaging to Jms + rules.get("/send/{msg}", (req, res) -> { + String msg = req.path().param("msg"); + System.out.println("Emitting: " + msg); + emitter.send(msg); + res.send(); + }); + } + + /** + * Gracefully terminate messaging. + */ + public void shutdown() { + messaging.stop(); + } +} diff --git a/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java new file mode 100644 index 00000000..e074d0aa --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2020, 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.messaging.se; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.websocket.CloseReason; +import javax.websocket.Endpoint; +import javax.websocket.EndpointConfig; +import javax.websocket.Session; + +import io.helidon.config.Config; +import io.helidon.messaging.Channel; +import io.helidon.messaging.Messaging; +import io.helidon.messaging.connectors.jms.JmsConnector; +import io.helidon.messaging.connectors.jms.Type; + +import org.apache.activemq.jndi.ActiveMQInitialContextFactory; + +/** + * WebSocket endpoint. + */ +public class WebSocketEndpoint extends Endpoint { + + private static final Logger LOGGER = Logger.getLogger(WebSocketEndpoint.class.getName()); + + private final Map messagingRegister = new HashMap<>(); + private final Config config = Config.create(); + + @Override + public void onOpen(Session session, EndpointConfig endpointConfig) { + + System.out.println("Session " + session.getId()); + + String url = config.get("app.jms.url").asString().get(); + String destination = config.get("app.jms.destination").asString().get(); + + // Prepare channel for connecting jms connector with specific publisher configuration -> listener, + // channel -> connector mapping is automatic when using JmsConnector.configBuilder() + Channel fromJms = Channel.builder() + .name("from-jms") + .publisherConfig(JmsConnector.configBuilder() + .jndiInitialFactory(ActiveMQInitialContextFactory.class.getName()) + .jndiProviderUrl(url) + .type(Type.QUEUE) + .destination(destination) + .build() + ) + .build(); + + // Prepare Jms connector, can be used by any channel + JmsConnector jmsConnector = JmsConnector.create(); + + Messaging messaging = Messaging.builder() + .connector(jmsConnector) + .listener(fromJms, payload -> { + System.out.println("Jms says: " + payload); + // Send message received from Jms over websocket + sendTextMessage(session, payload); + }) + .build() + .start(); + + //Save the messaging instance for proper shutdown + // when websocket connection is terminated + messagingRegister.put(session.getId(), messaging); + } + + @Override + public void onClose(final Session session, final CloseReason closeReason) { + super.onClose(session, closeReason); + LOGGER.info("Closing session " + session.getId()); + // Properly stop messaging when websocket connection is terminated + Optional.ofNullable(messagingRegister.remove(session.getId())) + .ifPresent(Messaging::stop); + } + + private void sendTextMessage(Session session, String msg) { + try { + session.getBasicRemote().sendText(msg); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Message sending failed", e); + } + } +} diff --git a/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/package-info.java b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/package-info.java new file mode 100644 index 00000000..0dca3162 --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Helidon SE Reactive Messaging with Jms Example. + */ +package io.helidon.examples.messaging.se; diff --git a/examples/messaging/jms-websocket-se/src/main/resources/WEB/favicon.ico b/examples/messaging/jms-websocket-se/src/main/resources/WEB/favicon.ico new file mode 100644 index 00000000..d91659fd Binary files /dev/null and b/examples/messaging/jms-websocket-se/src/main/resources/WEB/favicon.ico differ diff --git a/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/arrow-1.png b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/arrow-1.png new file mode 100644 index 00000000..bbba0aef Binary files /dev/null and b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/arrow-1.png differ diff --git a/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/arrow-2.png b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/arrow-2.png new file mode 100644 index 00000000..0b1096b0 Binary files /dev/null and b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/arrow-2.png differ diff --git a/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/cloud.png b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/cloud.png new file mode 100644 index 00000000..3e04833c Binary files /dev/null and b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/cloud.png differ diff --git a/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/frank.png b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/frank.png new file mode 100644 index 00000000..51a13d8d Binary files /dev/null and b/examples/messaging/jms-websocket-se/src/main/resources/WEB/img/frank.png differ diff --git a/examples/messaging/jms-websocket-se/src/main/resources/WEB/index.html b/examples/messaging/jms-websocket-se/src/main/resources/WEB/index.html new file mode 100644 index 00000000..94e417ab --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/resources/WEB/index.html @@ -0,0 +1,127 @@ + + + + + + + + Helidon Reactive Messaging + + + + + + + + +
+
+
+ +
+
Send
+
+
+
+
+
REST call /rest/messages/send/{msg}
+
+
+
Messages received from Jms over websocket
+
+
+
+
+ 
+            
+
+
+
+ + + + + \ No newline at end of file diff --git a/examples/messaging/jms-websocket-se/src/main/resources/WEB/main.css b/examples/messaging/jms-websocket-se/src/main/resources/WEB/main.css new file mode 100644 index 00000000..5fdb4879 --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/resources/WEB/main.css @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2020, 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. + */ + +#root { + background-color: #36ABF2; + font-family: Roboto,sans-serif; + color: #fff; + position: absolute; + overflow-x: hidden; + -ms-overflow-style: none; /* Internet Explorer 10+ */ + scrollbar-width: none; /* Firefox */ + top: 0; + left: 0; + width: 100%; + height: 100%; +} +#root::-webkit-scrollbar { + display: none; /* Safari and Chrome */ +} + +#helidon { + width: 509px; + height: 273px; + position: relative; + left: -509px; + z-index: 4; + background: url('img/frank.png'); +} + +#rest-tip { + position: relative; + top: -80px; + left: 160px; +} + +#rest-tip-arrow { + width: 205px; + height: 304px; + z-index: 4; + top: -20px; + background: url('img/arrow-1.png'); +} +#rest-tip-label { + position: absolute; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; + left: -60px; +} + +#sse-tip { + position: absolute; + overflow: hidden; + display: flex; + width: auto; + height: auto; + top: 5%; + right: 10%; + z-index: 0; +} + +#sse-tip-arrow { + position: relative; + top: -30px; + width: 296px; + height: 262px; + z-index: 4; + background: url('img/arrow-2.png'); +} +#sse-tip-label { + position: relative; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; +} + +#producer { + float: left; + position: relative; + width: 300px; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 99; +} + +#msgBox { + position: absolute; + width: 300px; + top: 25%; + right: 3%; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 20; +} + +#input { + width: 210px; + height: 22px; + top: 58px; + left: 30px; + background-color: white; + border-radius: 10px; + border-style: solid; + border-color: white; + position: absolute; + z-index: 10; +} + +#inputCloud { + position: relative; + width: 310px; + height: 150px; + background: url('img/cloud.png'); +} + +#msg { + background-color: #D2EBFC; + color: #1A9BF4; + border-radius: 10px; + width: 300px; + height: 50px; + margin: 5px; + display: flex; + padding-left: 10px; + justify-content: center; + align-items: center; + z-index: 99; +} + +#submit { + font-weight: bold; + background-color: aqua; + color: #1A9BF4; + border-radius: 12px; + width: 100px; + height: 30px; + display: flex; + justify-content: center; + align-items: center; + margin: 5px; + cursor: pointer; +} + +#snippet { + position: absolute; + top: 15%; + left: 30%; + width: 40%; + z-index: 5; +} + +.hljs { + border-radius: 10px; + font-size: 12px; +} \ No newline at end of file diff --git a/examples/messaging/jms-websocket-se/src/main/resources/application.yaml b/examples/messaging/jms-websocket-se/src/main/resources/application.yaml new file mode 100644 index 00000000..38d4767c --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# Copyright (c) 2020, 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. +# + +app: + jms: + url: tcp://127.0.0.1:61616 + destination: se-example-queue-1 + +server: + port: 7001 + host: 0.0.0.0 + static: + classpath: + location: /WEB + welcome: index.html diff --git a/examples/messaging/jms-websocket-se/src/main/resources/logging.properties b/examples/messaging/jms-websocket-se/src/main/resources/logging.properties new file mode 100644 index 00000000..86ca67e9 --- /dev/null +++ b/examples/messaging/jms-websocket-se/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2020, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/messaging/kafka-websocket-mp/README.md b/examples/messaging/kafka-websocket-mp/README.md new file mode 100644 index 00000000..cf01c5ec --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/README.md @@ -0,0 +1,13 @@ +# Helidon MP Reactive Messaging with Kafka Example + +## Prerequisites +* Docker +* Java 11+ +* [Kafka bootstrap server](../README.md) running on `localhost:9092` + +## Build & Run +```shell +mvn clean install +java -jar target/kafka-websocket-mp.jar +``` +Visit http://localhost:7001 \ No newline at end of file diff --git a/examples/messaging/kafka-websocket-mp/pom.xml b/examples/messaging/kafka-websocket-mp/pom.xml new file mode 100644 index 00000000..f80ae8fb --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/pom.xml @@ -0,0 +1,81 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.messaging.mp + kafka-websocket-mp + 1.0-SNAPSHOT + kafka-websocket-mp + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.messaging + helidon-microprofile-messaging + + + io.helidon.messaging.kafka + helidon-messaging-kafka + + + io.helidon.microprofile.websocket + helidon-microprofile-websocket + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java new file mode 100644 index 00000000..f01a766d --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2020, 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.messaging.mp; + +import java.util.concurrent.SubmissionPublisher; + +import javax.enterprise.context.ApplicationScoped; + +import io.helidon.common.reactive.Multi; + +import org.eclipse.microprofile.reactive.messaging.Incoming; +import org.eclipse.microprofile.reactive.messaging.Message; +import org.eclipse.microprofile.reactive.messaging.Outgoing; +import org.eclipse.microprofile.reactive.streams.operators.ProcessorBuilder; +import org.eclipse.microprofile.reactive.streams.operators.ReactiveStreams; +import org.reactivestreams.FlowAdapters; +import org.reactivestreams.Publisher; + +/** + * Bean for message processing. + */ +@ApplicationScoped +public class MsgProcessingBean { + + private final SubmissionPublisher emitter = new SubmissionPublisher<>(); + private final SubmissionPublisher broadCaster = new SubmissionPublisher<>(); + + /** + * Create a publisher for the emitter. + * + * @return A Publisher from the emitter + */ + @Outgoing("multiplyVariants") + public Publisher preparePublisher() { + // Create new publisher for emitting to by this::process + return ReactiveStreams + .fromPublisher(FlowAdapters.toPublisher(Multi.create(emitter))) + .buildRs(); + } + + /** + * Returns a builder for a processor that maps a string into three variants. + * + * @return ProcessorBuilder + */ + @Incoming("multiplyVariants") + @Outgoing("toKafka") + public ProcessorBuilder> multiply() { + // Multiply to 3 variants of same message + return ReactiveStreams.builder() + .flatMap(o -> + ReactiveStreams.of( + // upper case variant + o.toUpperCase(), + // repeat twice variant + o.repeat(2), + // reverse chars 'tnairav' + new StringBuilder(o).reverse().toString()) + ).map(Message::of); + } + + /** + * Broadcasts an event. + * + * @param msg Message to broadcast + */ + @Incoming("fromKafka") + public void broadcast(String msg) { + // Broadcast to all subscribers + broadCaster.submit(msg); + } + + /** + * Subscribe new Multi to broadcasting publisher. + * + * @return new Multi subscribed to broadcaster + */ + public Multi subscribeMulti() { + return Multi.create(broadCaster); + } + + /** + * Emit a message. + * + * @param msg message to emit + */ + public void process(final String msg) { + emitter.submit(msg); + } +} diff --git a/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java new file mode 100644 index 00000000..d409ad5b --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2020, 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.messaging.mp; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +/** + * Expose send method for publishing to messaging. + */ +@Path("rest/messages") +@RequestScoped +public class SendingResource { + private final MsgProcessingBean msgBean; + + /** + * Constructor injection of field values. + * + * @param msgBean Messaging example bean + */ + @Inject + public SendingResource(MsgProcessingBean msgBean) { + this.msgBean = msgBean; + } + + + /** + * Send message through Messaging to Kafka. + * + * @param msg message to process + */ + @Path("/send/{msg}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public void getSend(@PathParam("msg") String msg) { + msgBean.process(msg); + } +} diff --git a/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java new file mode 100644 index 00000000..f3d8df32 --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java @@ -0,0 +1,95 @@ + +/* + * Copyright (c) 2020, 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.messaging.mp; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.inject.Inject; +import javax.websocket.CloseReason; +import javax.websocket.EndpointConfig; +import javax.websocket.OnClose; +import javax.websocket.OnOpen; +import javax.websocket.Session; +import javax.websocket.server.ServerEndpoint; + +import io.helidon.common.reactive.Single; + +/** + * Register all WebSocket connection as subscribers + * of broadcasting {@link java.util.concurrent.SubmissionPublisher} + * in the {@link MsgProcessingBean}. + *

+ * When connection is closed, cancel subscription and remove reference. + */ +@ServerEndpoint("/ws/messages") +public class WebSocketEndpoint { + + private static final Logger LOGGER = Logger.getLogger(WebSocketEndpoint.class.getName()); + + private final Map> subscriberRegister = new HashMap<>(); + + @Inject + private MsgProcessingBean msgProcessingBean; + + /** + * On WebSocket session is opened. + * + * @param session web socket session + * @param endpointConfig endpoint config + */ + @OnOpen + public void onOpen(Session session, EndpointConfig endpointConfig) { + System.out.println("New WebSocket client connected with session " + session.getId()); + + Single single = msgProcessingBean.subscribeMulti() + // Watch for errors coming from upstream + .onError(throwable -> LOGGER.log(Level.SEVERE, "Upstream error!", throwable)) + // Send every item coming from upstream over web socket + .forEach(s -> sendTextMessage(session, s)); + + //Save forEach single promise for later cancellation + subscriberRegister.put(session.getId(), single); + } + + /** + * When WebSocket session is closed. + * + * @param session web socket session + * @param closeReason web socket close reason + */ + @OnClose + public void onClose(final Session session, final CloseReason closeReason) { + LOGGER.info("Closing session " + session.getId()); + // Properly unsubscribe from SubmissionPublisher + Optional.ofNullable(subscriberRegister.remove(session.getId())) + .ifPresent(Single::cancel); + } + + private void sendTextMessage(Session session, String msg) { + try { + session.getBasicRemote().sendText(msg); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Message sending over WebSocket failed", e); + } + } +} diff --git a/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java new file mode 100644 index 00000000..30fb29b3 --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Helidon MP Reactive Messaging with Kafka Example. + */ +package io.helidon.examples.messaging.mp; diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/META-INF/beans.xml b/examples/messaging/kafka-websocket-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..b2ef0add --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + + diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/META-INF/microprofile-config.properties b/examples/messaging/kafka-websocket-mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..1c88f678 --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,36 @@ +# +# Copyright (c) 2020 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. +# + +server.port=7001 +server.host=0.0.0.0 +server.static.classpath.location=/WEB +server.static.classpath.welcome=index.html + +# Configure channel fromKafka to ask Kafka connector for publisher +mp.messaging.incoming.fromKafka.connector=helidon-kafka +mp.messaging.incoming.fromKafka.enable.auto.commit=true +mp.messaging.incoming.fromKafka.group.id=websocket-mp-example-1 + +# Configure channel toKafka to ask Kafka connector for subscriber +mp.messaging.outgoing.toKafka.connector=helidon-kafka + +# Connector config properties are common to all channels +mp.messaging.connector.helidon-kafka.bootstrap.servers=localhost:9092 +mp.messaging.connector.helidon-kafka.topic=messaging-test-topic-1 +mp.messaging.connector.helidon-kafka.key.deserializer=org.apache.kafka.common.serialization.StringDeserializer +mp.messaging.connector.helidon-kafka.value.deserializer=org.apache.kafka.common.serialization.StringDeserializer +mp.messaging.connector.helidon-kafka.key.serializer=org.apache.kafka.common.serialization.StringSerializer +mp.messaging.connector.helidon-kafka.value.serializer=org.apache.kafka.common.serialization.StringSerializer diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/favicon.ico b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/favicon.ico new file mode 100644 index 00000000..d91659fd Binary files /dev/null and b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/favicon.ico differ diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/arrow-1.png b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/arrow-1.png new file mode 100644 index 00000000..bbba0aef Binary files /dev/null and b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/arrow-1.png differ diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/arrow-2.png b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/arrow-2.png new file mode 100644 index 00000000..0b1096b0 Binary files /dev/null and b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/arrow-2.png differ diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/cloud.png b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/cloud.png new file mode 100644 index 00000000..3e04833c Binary files /dev/null and b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/cloud.png differ diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/frank.png b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/frank.png new file mode 100644 index 00000000..51a13d8d Binary files /dev/null and b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/img/frank.png differ diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/index.html b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/index.html new file mode 100644 index 00000000..de0d967f --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/index.html @@ -0,0 +1,127 @@ + + + + + + + + Helidon Reactive Messaging + + + + + + + + +

+
+
+ +
+
Send
+
+
+
+
+
REST call /rest/messages/send/{msg}
+
+
+
Messages received from Kafka over websocket
+
+
+
+
+ 
+            
+
+
+
+ + + + + \ No newline at end of file diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/main.css b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/main.css new file mode 100644 index 00000000..5fdb4879 --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/resources/WEB/main.css @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2020, 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. + */ + +#root { + background-color: #36ABF2; + font-family: Roboto,sans-serif; + color: #fff; + position: absolute; + overflow-x: hidden; + -ms-overflow-style: none; /* Internet Explorer 10+ */ + scrollbar-width: none; /* Firefox */ + top: 0; + left: 0; + width: 100%; + height: 100%; +} +#root::-webkit-scrollbar { + display: none; /* Safari and Chrome */ +} + +#helidon { + width: 509px; + height: 273px; + position: relative; + left: -509px; + z-index: 4; + background: url('img/frank.png'); +} + +#rest-tip { + position: relative; + top: -80px; + left: 160px; +} + +#rest-tip-arrow { + width: 205px; + height: 304px; + z-index: 4; + top: -20px; + background: url('img/arrow-1.png'); +} +#rest-tip-label { + position: absolute; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; + left: -60px; +} + +#sse-tip { + position: absolute; + overflow: hidden; + display: flex; + width: auto; + height: auto; + top: 5%; + right: 10%; + z-index: 0; +} + +#sse-tip-arrow { + position: relative; + top: -30px; + width: 296px; + height: 262px; + z-index: 4; + background: url('img/arrow-2.png'); +} +#sse-tip-label { + position: relative; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; +} + +#producer { + float: left; + position: relative; + width: 300px; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 99; +} + +#msgBox { + position: absolute; + width: 300px; + top: 25%; + right: 3%; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 20; +} + +#input { + width: 210px; + height: 22px; + top: 58px; + left: 30px; + background-color: white; + border-radius: 10px; + border-style: solid; + border-color: white; + position: absolute; + z-index: 10; +} + +#inputCloud { + position: relative; + width: 310px; + height: 150px; + background: url('img/cloud.png'); +} + +#msg { + background-color: #D2EBFC; + color: #1A9BF4; + border-radius: 10px; + width: 300px; + height: 50px; + margin: 5px; + display: flex; + padding-left: 10px; + justify-content: center; + align-items: center; + z-index: 99; +} + +#submit { + font-weight: bold; + background-color: aqua; + color: #1A9BF4; + border-radius: 12px; + width: 100px; + height: 30px; + display: flex; + justify-content: center; + align-items: center; + margin: 5px; + cursor: pointer; +} + +#snippet { + position: absolute; + top: 15%; + left: 30%; + width: 40%; + z-index: 5; +} + +.hljs { + border-radius: 10px; + font-size: 12px; +} \ No newline at end of file diff --git a/examples/messaging/kafka-websocket-mp/src/main/resources/logging.properties b/examples/messaging/kafka-websocket-mp/src/main/resources/logging.properties new file mode 100644 index 00000000..5d79bdb7 --- /dev/null +++ b/examples/messaging/kafka-websocket-mp/src/main/resources/logging.properties @@ -0,0 +1,32 @@ +# +# Copyright (c) 2020, 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.common.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 + +# Kafka client has exhaustive logs +org.apache.kafka.clients.level=WARNING +org.apache.kafka.clients.consumer.ConsumerConfig.level=SEVERE +org.apache.kafka.clients.producer.ProducerConfig.level=SEVERE diff --git a/examples/messaging/kafka-websocket-se/README.md b/examples/messaging/kafka-websocket-se/README.md new file mode 100644 index 00000000..58cc8d18 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/README.md @@ -0,0 +1,14 @@ +# Helidon Messaging with Kafka Examples + +## Prerequisites +* Java 11+ +* Docker +* [Kafka bootstrap server](../README.md) running on `localhost:9092` + +## Build & Run +```shell +mvn clean install +java -jar target/kafka-websocket-se.jar +``` +3. Visit http://localhost:7001 + diff --git a/examples/messaging/kafka-websocket-se/pom.xml b/examples/messaging/kafka-websocket-se/pom.xml new file mode 100644 index 00000000..b127f176 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/pom.xml @@ -0,0 +1,82 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.messaging.se + kafka-websocket-se + 1.0-SNAPSHOT + kafka-websocket-se + + + io.helidon.examples.messaging.se.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.messaging + helidon-messaging + + + io.helidon.messaging.kafka + helidon-messaging-kafka + + + jakarta.websocket + jakarta.websocket-api + + + io.helidon.webserver + helidon-webserver-tyrus + + + io.helidon.config + helidon-config-yaml + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/Main.java b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/Main.java new file mode 100644 index 00000000..1c625d12 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/Main.java @@ -0,0 +1,109 @@ +/* + * Copyright (c) 2020, 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.messaging.se; + +import javax.websocket.server.ServerEndpointConfig; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; +import io.helidon.webserver.tyrus.TyrusSupport; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * + * @return the created {@link WebServer} instance + */ + static WebServer startServer() { + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + SendingService sendingService = new SendingService(config); + + WebServer server = WebServer.builder(createRouting(sendingService)) + .config(config.get("server")) + .build(); + + server.start() + .thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port()); + ws.whenShutdown().thenRun(() + -> { + // Stop messaging properly + sendingService.shutdown(); + System.out.println("WEB server is DOWN. Good bye!"); + }); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + // Server threads are not daemon. No need to block. Just react. + return server; + } + + /** + * Creates new {@link Routing}. + * + * @param sendingService service to configure + * @return routing configured with JSON support, a health check, and a service + */ + private static Routing createRouting(SendingService sendingService) { + + return Routing.builder() + // register static content support (on "/") + .register(StaticContentSupport.builder("/WEB").welcomeFileName("index.html")) + // register rest endpoint for sending to Kafka + .register("/rest/messages", sendingService) + // register WebSocket endpoint to push messages coming from Kafka to client + .register("/ws", + TyrusSupport.builder().register( + ServerEndpointConfig.Builder.create( + WebSocketEndpoint.class, "/messages") + .build()) + .build()) + .build(); + } +} diff --git a/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java new file mode 100644 index 00000000..120f5904 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java @@ -0,0 +1,94 @@ +/* + * Copyright (c) 2020, 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.messaging.se; + +import io.helidon.config.Config; +import io.helidon.messaging.Channel; +import io.helidon.messaging.Emitter; +import io.helidon.messaging.Messaging; +import io.helidon.messaging.connectors.kafka.KafkaConnector; +import io.helidon.webserver.Routing; +import io.helidon.webserver.Service; + +import org.apache.kafka.common.serialization.StringSerializer; + +class SendingService implements Service { + + private final Emitter emitter; + private final Messaging messaging; + + SendingService(Config config) { + + String kafkaServer = config.get("app.kafka.bootstrap.servers").asString().get(); + String topic = config.get("app.kafka.topic").asString().get(); + + // Prepare channel for connecting processor -> kafka connector with specific subscriber configuration, + // channel -> connector mapping is automatic when using KafkaConnector.configBuilder() + Channel toKafka = Channel.builder() + .subscriberConfig(KafkaConnector.configBuilder() + .bootstrapServers(kafkaServer) + .topic(topic) + .keySerializer(StringSerializer.class) + .valueSerializer(StringSerializer.class) + .build() + ).build(); + + // Prepare channel for connecting emitter -> processor + Channel toProcessor = Channel.create(); + + // Prepare Kafka connector, can be used by any channel + KafkaConnector kafkaConnector = KafkaConnector.create(); + + // Prepare emitter for manual publishing to channel + emitter = Emitter.create(toProcessor); + + messaging = Messaging.builder() + .emitter(emitter) + // Processor connect two channels together + .processor(toProcessor, toKafka, payload -> { + // Transforming to upper-case before sending to kafka + return payload.toUpperCase(); + }) + .connector(kafkaConnector) + .build() + .start(); + } + + /** + * A service registers itself by updating the routing rules. + * + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + // Listen for GET /example/send/{msg} + // to send it thru messaging to Kafka + rules.get("/send/{msg}", (req, res) -> { + String msg = req.path().param("msg"); + System.out.println("Emitting: " + msg); + emitter.send(msg); + res.send(); + }); + } + + /** + * Gracefully terminate messaging. + */ + public void shutdown() { + messaging.stop(); + } +} diff --git a/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java new file mode 100644 index 00000000..cdde0f5c --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java @@ -0,0 +1,107 @@ +/* + * Copyright (c) 2020, 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.messaging.se; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.websocket.CloseReason; +import javax.websocket.Endpoint; +import javax.websocket.EndpointConfig; +import javax.websocket.Session; + +import io.helidon.config.Config; +import io.helidon.messaging.Channel; +import io.helidon.messaging.Messaging; +import io.helidon.messaging.connectors.kafka.KafkaConfigBuilder; +import io.helidon.messaging.connectors.kafka.KafkaConnector; + +import org.apache.kafka.common.serialization.StringDeserializer; + +/** + * Web socket endpoint. + */ +public class WebSocketEndpoint extends Endpoint { + + private static final Logger LOGGER = Logger.getLogger(WebSocketEndpoint.class.getName()); + + private final Map messagingRegister = new HashMap<>(); + private final Config config = Config.create(); + + @Override + public void onOpen(Session session, EndpointConfig endpointConfig) { + + System.out.println("Session " + session.getId()); + + String kafkaServer = config.get("app.kafka.bootstrap.servers").asString().get(); + String topic = config.get("app.kafka.topic").asString().get(); + + // Prepare channel for connecting kafka connector with specific publisher configuration -> listener, + // channel -> connector mapping is automatic when using KafkaConnector.configBuilder() + Channel fromKafka = Channel.builder() + .name("from-kafka") + .publisherConfig(KafkaConnector.configBuilder() + .bootstrapServers(kafkaServer) + .groupId("example-group-" + session.getId()) + .topic(topic) + .autoOffsetReset(KafkaConfigBuilder.AutoOffsetReset.LATEST) + .enableAutoCommit(true) + .keyDeserializer(StringDeserializer.class) + .valueDeserializer(StringDeserializer.class) + .build() + ) + .build(); + + // Prepare Kafka connector, can be used by any channel + KafkaConnector kafkaConnector = KafkaConnector.create(); + + Messaging messaging = Messaging.builder() + .connector(kafkaConnector) + .listener(fromKafka, payload -> { + System.out.println("Kafka says: " + payload); + // Send message received from Kafka over websocket + sendTextMessage(session, payload); + }) + .build() + .start(); + + //Save the messaging instance for proper shutdown + // when websocket connection is terminated + messagingRegister.put(session.getId(), messaging); + } + + @Override + public void onClose(final Session session, final CloseReason closeReason) { + super.onClose(session, closeReason); + LOGGER.info("Closing session " + session.getId()); + // Properly stop messaging when websocket connection is terminated + Optional.ofNullable(messagingRegister.remove(session.getId())) + .ifPresent(Messaging::stop); + } + + private void sendTextMessage(Session session, String msg) { + try { + session.getBasicRemote().sendText(msg); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Message sending failed", e); + } + } +} diff --git a/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/package-info.java b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/package-info.java new file mode 100644 index 00000000..c4771f97 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Helidon SE Reactive Messaging with Kafka Example. + */ +package io.helidon.examples.messaging.se; diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/WEB/favicon.ico b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/favicon.ico new file mode 100644 index 00000000..d91659fd Binary files /dev/null and b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/favicon.ico differ diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/arrow-1.png b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/arrow-1.png new file mode 100644 index 00000000..bbba0aef Binary files /dev/null and b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/arrow-1.png differ diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/arrow-2.png b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/arrow-2.png new file mode 100644 index 00000000..0b1096b0 Binary files /dev/null and b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/arrow-2.png differ diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/cloud.png b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/cloud.png new file mode 100644 index 00000000..3e04833c Binary files /dev/null and b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/cloud.png differ diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/frank.png b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/frank.png new file mode 100644 index 00000000..51a13d8d Binary files /dev/null and b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/img/frank.png differ diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/WEB/index.html b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/index.html new file mode 100644 index 00000000..de0d967f --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/index.html @@ -0,0 +1,127 @@ + + + + + + + + Helidon Reactive Messaging + + + + + + + + +
+
+
+ +
+
Send
+
+
+
+
+
REST call /rest/messages/send/{msg}
+
+
+
Messages received from Kafka over websocket
+
+
+
+
+ 
+            
+
+
+
+ + + + + \ No newline at end of file diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/WEB/main.css b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/main.css new file mode 100644 index 00000000..5fdb4879 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/resources/WEB/main.css @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2020, 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. + */ + +#root { + background-color: #36ABF2; + font-family: Roboto,sans-serif; + color: #fff; + position: absolute; + overflow-x: hidden; + -ms-overflow-style: none; /* Internet Explorer 10+ */ + scrollbar-width: none; /* Firefox */ + top: 0; + left: 0; + width: 100%; + height: 100%; +} +#root::-webkit-scrollbar { + display: none; /* Safari and Chrome */ +} + +#helidon { + width: 509px; + height: 273px; + position: relative; + left: -509px; + z-index: 4; + background: url('img/frank.png'); +} + +#rest-tip { + position: relative; + top: -80px; + left: 160px; +} + +#rest-tip-arrow { + width: 205px; + height: 304px; + z-index: 4; + top: -20px; + background: url('img/arrow-1.png'); +} +#rest-tip-label { + position: absolute; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; + left: -60px; +} + +#sse-tip { + position: absolute; + overflow: hidden; + display: flex; + width: auto; + height: auto; + top: 5%; + right: 10%; + z-index: 0; +} + +#sse-tip-arrow { + position: relative; + top: -30px; + width: 296px; + height: 262px; + z-index: 4; + background: url('img/arrow-2.png'); +} +#sse-tip-label { + position: relative; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; +} + +#producer { + float: left; + position: relative; + width: 300px; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 99; +} + +#msgBox { + position: absolute; + width: 300px; + top: 25%; + right: 3%; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 20; +} + +#input { + width: 210px; + height: 22px; + top: 58px; + left: 30px; + background-color: white; + border-radius: 10px; + border-style: solid; + border-color: white; + position: absolute; + z-index: 10; +} + +#inputCloud { + position: relative; + width: 310px; + height: 150px; + background: url('img/cloud.png'); +} + +#msg { + background-color: #D2EBFC; + color: #1A9BF4; + border-radius: 10px; + width: 300px; + height: 50px; + margin: 5px; + display: flex; + padding-left: 10px; + justify-content: center; + align-items: center; + z-index: 99; +} + +#submit { + font-weight: bold; + background-color: aqua; + color: #1A9BF4; + border-radius: 12px; + width: 100px; + height: 30px; + display: flex; + justify-content: center; + align-items: center; + margin: 5px; + cursor: pointer; +} + +#snippet { + position: absolute; + top: 15%; + left: 30%; + width: 40%; + z-index: 5; +} + +.hljs { + border-radius: 10px; + font-size: 12px; +} \ No newline at end of file diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/application.yaml b/examples/messaging/kafka-websocket-se/src/main/resources/application.yaml new file mode 100644 index 00000000..637ea410 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# Copyright (c) 2020, 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. +# + +app: + kafka: + bootstrap.servers: localhost:9092 + topic: messaging-test-topic-1 + +server: + port: 7001 + host: 0.0.0.0 + static: + classpath: + location: /WEB + welcome: index.html diff --git a/examples/messaging/kafka-websocket-se/src/main/resources/logging.properties b/examples/messaging/kafka-websocket-se/src/main/resources/logging.properties new file mode 100644 index 00000000..86ca67e9 --- /dev/null +++ b/examples/messaging/kafka-websocket-se/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2020, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/messaging/kafkaConsume.sh b/examples/messaging/kafkaConsume.sh new file mode 100755 index 00000000..27ef1b23 --- /dev/null +++ b/examples/messaging/kafkaConsume.sh @@ -0,0 +1,29 @@ +#!/bin/bash +# +# Copyright (c) 2020, 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. +# + +TOPIC="messaging-test-topic-1" +SERVER="localhost:9092" +CONTAINER="helidon_kafka" + +if [ -z "$1" ]; then + echo "No argument supplied, defaulting to topic ${TOPIC}" +else + TOPIC="$1" +fi + +docker exec -it ${CONTAINER} sh -c \ +"/opt/kafka/bin/kafka-console-consumer.sh --topic ${TOPIC} --bootstrap-server ${SERVER}" diff --git a/examples/messaging/kafkaProduce.sh b/examples/messaging/kafkaProduce.sh new file mode 100755 index 00000000..6da1e3e9 --- /dev/null +++ b/examples/messaging/kafkaProduce.sh @@ -0,0 +1,29 @@ +#!/bin/bash +# +# Copyright (c) 2020, 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. +# + +TOPIC="messaging-test-topic-1" +SERVER="localhost:9092" +CONTAINER="helidon_kafka" + +if [ -z "$1" ]; then + echo "No argument supplied, defaulting to topic ${TOPIC}" +else + TOPIC="$1" +fi + +docker exec -it ${CONTAINER} sh -c \ +"/opt/kafka/bin/kafka-console-producer.sh --topic ${TOPIC} --bootstrap-server ${SERVER}" diff --git a/examples/messaging/kafkaRun.sh b/examples/messaging/kafkaRun.sh new file mode 100755 index 00000000..e40e3f4a --- /dev/null +++ b/examples/messaging/kafkaRun.sh @@ -0,0 +1,36 @@ +#!/bin/bash +# +# Copyright (c) 2020, 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. +# + +if [[ "$(docker images -q helidon-test-kafka 2>/dev/null)" == "" ]]; then + # helidon:test-kafka not found, build it + docker build ./docker/kafka -t helidon-test-kafka -f ./docker/kafka/Dockerfile.kafka +fi + +if [ ! "$(docker ps -q -f name=helidon_kafka)" ]; then + if [ "$(docker ps -aq -f status=exited -f name=helidon_kafka)" ]; then + # Clean up exited container + docker rm helidon_kafka + fi + # Run test Kafka in new container, stop it by pressing Ctrl+C + docker run -it \ + --rm \ + --publish 2181:2181 \ + --publish 29092:9092 \ + --publish 9092:29092 \ + --name helidon_kafka \ + helidon-test-kafka +fi diff --git a/examples/messaging/oracle-aq-websocket-mp/README.md b/examples/messaging/oracle-aq-websocket-mp/README.md new file mode 100644 index 00000000..c94cc550 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/README.md @@ -0,0 +1,14 @@ +# Helidon Messaging with Oracle AQ Example + +## Prerequisites +* Java 11+ +* Docker +* [Oracle database](../README.md) running on `localhost:1521` + +## Build & Run +```shell +mvn clean install +java -jar target/aq-websocket-mp.jar +``` +Visit http://localhost:7001 + diff --git a/examples/messaging/oracle-aq-websocket-mp/pom.xml b/examples/messaging/oracle-aq-websocket-mp/pom.xml new file mode 100644 index 00000000..a1d24337 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/pom.xml @@ -0,0 +1,77 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.messaging.aq + aq-websocket-mp + 1.0-SNAPSHOT + oracle-aq-websocket-mp + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.messaging + helidon-microprofile-messaging + + + io.helidon.messaging.aq + helidon-messaging-aq + + + io.helidon.integrations.cdi + helidon-integrations-cdi-datasource-ucp + runtime + + + io.helidon.microprofile.websocket + helidon-microprofile-websocket + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java new file mode 100644 index 00000000..a4467e1a --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/MsgProcessingBean.java @@ -0,0 +1,130 @@ +/* + * Copyright (c) 2020, 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.messaging.mp; + +import java.sql.PreparedStatement; +import java.sql.SQLException; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionStage; +import java.util.concurrent.SubmissionPublisher; + +import javax.enterprise.context.ApplicationScoped; +import javax.jms.JMSException; +import javax.jms.MapMessage; + +import io.helidon.common.reactive.BufferedEmittingPublisher; +import io.helidon.common.reactive.Multi; +import io.helidon.messaging.connectors.aq.AqMessage; + +import org.eclipse.microprofile.reactive.messaging.Acknowledgment; +import org.eclipse.microprofile.reactive.messaging.Incoming; +import org.eclipse.microprofile.reactive.messaging.Outgoing; +import org.eclipse.microprofile.reactive.streams.operators.ReactiveStreams; +import org.reactivestreams.FlowAdapters; +import org.reactivestreams.Publisher; + +/** + * Bean for message processing. + */ +@ApplicationScoped +public class MsgProcessingBean { + + private final BufferedEmittingPublisher emitter = BufferedEmittingPublisher.create(); + private final SubmissionPublisher broadCaster = new SubmissionPublisher<>(); + + /** + * Create a publisher for the emitter. + * + * @return A Publisher from the emitter + */ + @Outgoing("to-queue-1") + public Publisher toFirstQueue() { + // Create new publisher for emitting to by this::process + return ReactiveStreams + .fromPublisher(FlowAdapters.toPublisher(emitter)) + .buildRs(); + } + + /** + * Example of resending message from one queue to another and logging the payload to DB in the process. + * + * @param msg received message + * @return message to be sent + */ + @Incoming("from-queue-1") + @Outgoing("to-queue-2") + //Leave commit by ack to outgoing connector + @Acknowledgment(Acknowledgment.Strategy.NONE) + public CompletionStage> betweenQueues(AqMessage msg) { + return CompletableFuture.supplyAsync(() -> { + try { + PreparedStatement statement = msg.getDbConnection() + .prepareStatement("INSERT INTO frank.message_log (message) VALUES (?)"); + statement.setString(1, msg.getPayload()); + statement.executeUpdate(); + } catch (SQLException e) { + //Gets caught by messaging engine and translated to onError signal + throw new RuntimeException("Error when saving message to log table.", e); + } + return msg; + }); + } + + /** + * Broadcasts an event. + * + * @param msg Message to broadcast + */ + @Incoming("from-queue-2") + public void fromSecondQueue(AqMessage msg) { + // Broadcast to all subscribers + broadCaster.submit(msg.getPayload()); + } + + /** + * Example of receiving a byte message. + * + * @param bytes received byte array + */ + @Incoming("from-byte-queue") + public void fromByteQueue(byte[] bytes) { + broadCaster.submit(new String(bytes)); + } + + /** + * Example of receiving a map message. + * + * @param msg received JMS MapMessage + * @throws JMSException when error arises during work with JMS message + */ + @Incoming("from-map-queue") + public void fromMapQueue(MapMessage msg) throws JMSException { + String head = msg.getString("head"); + byte[] body = msg.getBytes("body"); + String tail = msg.getString("tail"); + broadCaster.submit(String.join(" ", List.of(head, new String(body), tail))); + } + + Multi subscribeMulti() { + return Multi.create(broadCaster).log(); + } + + void process(final String msg) { + emitter.emit(msg); + } +} diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java new file mode 100644 index 00000000..7b58409f --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/SendingResource.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2020, 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.messaging.mp; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +/** + * Expose send method for publishing to messaging. + */ +@Path("rest/messages") +@RequestScoped +public class SendingResource { + private final MsgProcessingBean msgBean; + + /** + * Constructor injection of field values. + * + * @param msgBean Messaging example bean + */ + @Inject + public SendingResource(MsgProcessingBean msgBean) { + this.msgBean = msgBean; + } + + /** + * Send message through Messaging to JMS. + * + * @param msg message to process + */ + @Path("/send/{msg}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public void getSend(@PathParam("msg") String msg) { + msgBean.process(msg); + } +} diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java new file mode 100644 index 00000000..f3d8df32 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/WebSocketEndpoint.java @@ -0,0 +1,95 @@ + +/* + * Copyright (c) 2020, 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.messaging.mp; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.inject.Inject; +import javax.websocket.CloseReason; +import javax.websocket.EndpointConfig; +import javax.websocket.OnClose; +import javax.websocket.OnOpen; +import javax.websocket.Session; +import javax.websocket.server.ServerEndpoint; + +import io.helidon.common.reactive.Single; + +/** + * Register all WebSocket connection as subscribers + * of broadcasting {@link java.util.concurrent.SubmissionPublisher} + * in the {@link MsgProcessingBean}. + *

+ * When connection is closed, cancel subscription and remove reference. + */ +@ServerEndpoint("/ws/messages") +public class WebSocketEndpoint { + + private static final Logger LOGGER = Logger.getLogger(WebSocketEndpoint.class.getName()); + + private final Map> subscriberRegister = new HashMap<>(); + + @Inject + private MsgProcessingBean msgProcessingBean; + + /** + * On WebSocket session is opened. + * + * @param session web socket session + * @param endpointConfig endpoint config + */ + @OnOpen + public void onOpen(Session session, EndpointConfig endpointConfig) { + System.out.println("New WebSocket client connected with session " + session.getId()); + + Single single = msgProcessingBean.subscribeMulti() + // Watch for errors coming from upstream + .onError(throwable -> LOGGER.log(Level.SEVERE, "Upstream error!", throwable)) + // Send every item coming from upstream over web socket + .forEach(s -> sendTextMessage(session, s)); + + //Save forEach single promise for later cancellation + subscriberRegister.put(session.getId(), single); + } + + /** + * When WebSocket session is closed. + * + * @param session web socket session + * @param closeReason web socket close reason + */ + @OnClose + public void onClose(final Session session, final CloseReason closeReason) { + LOGGER.info("Closing session " + session.getId()); + // Properly unsubscribe from SubmissionPublisher + Optional.ofNullable(subscriberRegister.remove(session.getId())) + .ifPresent(Single::cancel); + } + + private void sendTextMessage(Session session, String msg) { + try { + session.getBasicRemote().sendText(msg); + } catch (IOException e) { + LOGGER.log(Level.SEVERE, "Message sending over WebSocket failed", e); + } + } +} diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java new file mode 100644 index 00000000..d2ddab5b --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/java/io/helidon/examples/messaging/mp/package-info.java @@ -0,0 +1,21 @@ + +/* + * Copyright (c) 2020, 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. + */ + +/** + * Reactive Messaging JMS example. + */ +package io.helidon.examples.messaging.mp; diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/META-INF/beans.xml b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..b5fbc9d5 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + + diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/META-INF/microprofile-config.properties b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..0c719b02 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,52 @@ +# +# Copyright (c) 2020 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. +# + +server.port=7001 +server.host=0.0.0.0 +server.static.classpath.location=/WEB +server.static.classpath.welcome=index.html + +javax.sql.DataSource.aq-test-ds.connectionFactoryClassName=oracle.jdbc.pool.OracleDataSource +javax.sql.DataSource.aq-test-ds.URL=jdbc:oracle:thin:@localhost:1521:XE +javax.sql.DataSource.aq-test-ds.user=frank +javax.sql.DataSource.aq-test-ds.password=frank + +mp.messaging.connector.helidon-aq.acknowledge-mode=CLIENT_ACKNOWLEDGE +mp.messaging.connector.helidon-aq.data-source=aq-test-ds + +mp.messaging.outgoing.to-queue-1.connector=helidon-aq +mp.messaging.outgoing.to-queue-1.destination=EXAMPLE_QUEUE_1 +mp.messaging.outgoing.to-queue-1.type=queue + +mp.messaging.incoming.from-queue-1.connector=helidon-aq +mp.messaging.incoming.from-queue-1.destination=EXAMPLE_QUEUE_1 +mp.messaging.incoming.from-queue-1.type=queue + +mp.messaging.outgoing.to-queue-2.connector=helidon-aq +mp.messaging.outgoing.to-queue-2.destination=EXAMPLE_QUEUE_2 +mp.messaging.outgoing.to-queue-2.type=queue + +mp.messaging.incoming.from-queue-2.connector=helidon-aq +mp.messaging.incoming.from-queue-2.destination=EXAMPLE_QUEUE_2 +mp.messaging.incoming.from-queue-2.type=queue + +mp.messaging.incoming.from-byte-queue.connector=helidon-aq +mp.messaging.incoming.from-byte-queue.destination=example_queue_bytes +mp.messaging.incoming.from-byte-queue.type=queue + +mp.messaging.incoming.from-map-queue.connector=helidon-aq +mp.messaging.incoming.from-map-queue.destination=example_queue_map +mp.messaging.incoming.from-map-queue.type=queue diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/favicon.ico b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/favicon.ico new file mode 100644 index 00000000..d91659fd Binary files /dev/null and b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/favicon.ico differ diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/arrow-1.png b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/arrow-1.png new file mode 100644 index 00000000..bbba0aef Binary files /dev/null and b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/arrow-1.png differ diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/arrow-2.png b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/arrow-2.png new file mode 100644 index 00000000..0b1096b0 Binary files /dev/null and b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/arrow-2.png differ diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/cloud.png b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/cloud.png new file mode 100644 index 00000000..3e04833c Binary files /dev/null and b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/cloud.png differ diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/frank.png b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/frank.png new file mode 100644 index 00000000..51a13d8d Binary files /dev/null and b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/img/frank.png differ diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/index.html b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/index.html new file mode 100644 index 00000000..b35aed46 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/index.html @@ -0,0 +1,127 @@ + + + + + + + + Helidon Reactive Messaging + + + + + + + + +

+
+
+ +
+
Send
+
+
+
+
+
REST call /rest/messages/send/{msg}
+
+
+
Messages received from JMS over websocket
+
+
+
+
+ 
+            
+
+
+
+ + + + + \ No newline at end of file diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/main.css b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/main.css new file mode 100644 index 00000000..5fdb4879 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/WEB/main.css @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2020, 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. + */ + +#root { + background-color: #36ABF2; + font-family: Roboto,sans-serif; + color: #fff; + position: absolute; + overflow-x: hidden; + -ms-overflow-style: none; /* Internet Explorer 10+ */ + scrollbar-width: none; /* Firefox */ + top: 0; + left: 0; + width: 100%; + height: 100%; +} +#root::-webkit-scrollbar { + display: none; /* Safari and Chrome */ +} + +#helidon { + width: 509px; + height: 273px; + position: relative; + left: -509px; + z-index: 4; + background: url('img/frank.png'); +} + +#rest-tip { + position: relative; + top: -80px; + left: 160px; +} + +#rest-tip-arrow { + width: 205px; + height: 304px; + z-index: 4; + top: -20px; + background: url('img/arrow-1.png'); +} +#rest-tip-label { + position: absolute; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; + left: -60px; +} + +#sse-tip { + position: absolute; + overflow: hidden; + display: flex; + width: auto; + height: auto; + top: 5%; + right: 10%; + z-index: 0; +} + +#sse-tip-arrow { + position: relative; + top: -30px; + width: 296px; + height: 262px; + z-index: 4; + background: url('img/arrow-2.png'); +} +#sse-tip-label { + position: relative; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; +} + +#producer { + float: left; + position: relative; + width: 300px; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 99; +} + +#msgBox { + position: absolute; + width: 300px; + top: 25%; + right: 3%; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 20; +} + +#input { + width: 210px; + height: 22px; + top: 58px; + left: 30px; + background-color: white; + border-radius: 10px; + border-style: solid; + border-color: white; + position: absolute; + z-index: 10; +} + +#inputCloud { + position: relative; + width: 310px; + height: 150px; + background: url('img/cloud.png'); +} + +#msg { + background-color: #D2EBFC; + color: #1A9BF4; + border-radius: 10px; + width: 300px; + height: 50px; + margin: 5px; + display: flex; + padding-left: 10px; + justify-content: center; + align-items: center; + z-index: 99; +} + +#submit { + font-weight: bold; + background-color: aqua; + color: #1A9BF4; + border-radius: 12px; + width: 100px; + height: 30px; + display: flex; + justify-content: center; + align-items: center; + margin: 5px; + cursor: pointer; +} + +#snippet { + position: absolute; + top: 15%; + left: 30%; + width: 40%; + z-index: 5; +} + +.hljs { + border-radius: 10px; + font-size: 12px; +} \ No newline at end of file diff --git a/examples/messaging/oracle-aq-websocket-mp/src/main/resources/logging.properties b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/logging.properties new file mode 100644 index 00000000..86ca67e9 --- /dev/null +++ b/examples/messaging/oracle-aq-websocket-mp/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2020, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/messaging/pom.xml b/examples/messaging/pom.xml new file mode 100644 index 00000000..e5706666 --- /dev/null +++ b/examples/messaging/pom.xml @@ -0,0 +1,44 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.messaging + helidon-examples-messaging-project + Helidon Examples Reactive Messaging + pom + + + Examples of Reactive Messaging usage + + + + kafka-websocket-mp + kafka-websocket-se + jms-websocket-mp + jms-websocket-se + oracle-aq-websocket-mp + + diff --git a/examples/metrics/exemplar/README.md b/examples/metrics/exemplar/README.md new file mode 100644 index 00000000..19909f6a --- /dev/null +++ b/examples/metrics/exemplar/README.md @@ -0,0 +1,68 @@ +# Helidon Metrics Exemplar SE Example + +This project implements a simple Hello World REST service using Helidon SE and demonstrates the +optional metrics exemplar support. + +## Start Zipkin (optional) +If you do not start Zipkin, the example app will still function correctly but it will log a warning +when it cannot contact the Zipkin server to report the tracing spans. Even so, the metrics output +will contain valid exemplars. + +With Docker: +```shell +docker run --name zipkin -d -p 9411:9411 openzipkin/zipkin +``` + +## Build and run + +With JDK11+ +```shell +mvn package +java -jar target/helidon-examples-metrics-exemplar.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} + +curl -X GET http://localhost:8080/greet +#{"message":"Hola World!"} +``` + +## Retrieve application metrics + +```shell +# Prometheus format with exemplars + +curl -s -X GET http://localhost:8080/metrics/application +# TYPE application_counterForPersonalizedGreetings_total counter +# HELP application_counterForPersonalizedGreetings_total +#application_counterForPersonalizedGreetings_total 2 # {trace_id="78e61eed351f4c9d"} 1 1617812495.016000 +#. . . +# TYPE application_timerForGets_mean_seconds gauge +#application_timerForGets_mean_seconds 0.005772598385062112 # {trace_id="b22f13c37ba8b879"} 0.001563945 1617812578.687000 +# TYPE application_timerForGets_max_seconds gauge +#application_timerForGets_max_seconds 0.028018165 # {trace_id="a1b127002725143c"} 0.028018165 1617812467.524000 +``` +The examplars contain `trace_id` values tying them to specific samples. +Note that the exemplar for the counter refers to the most recent update to the counter. + +For the timer, the value for the `max` is exactly the same as the value for its exemplar, +because the `max` value has to come from at least one sample. +In contrast, Helidon calculates the `mean` value from possibly multiple samples. The exemplar for +`mean` is a sample with value as close as that of other samples to the mean. + +## Browse the Zipkin traces +If you started the Zipkin server, visit `http://localhost:9411` and click `Run Query` to see all +the spans your Helidon application reported to Zipkin. +You can compare the trace IDs in the Zipkin display to those in the metrics output. diff --git a/examples/metrics/exemplar/pom.xml b/examples/metrics/exemplar/pom.xml new file mode 100644 index 00000000..94d85f97 --- /dev/null +++ b/examples/metrics/exemplar/pom.xml @@ -0,0 +1,111 @@ + + + + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + 4.0.0 + + io.helidon.examples.metrics + helidon-examples-metrics-exemplar + 1.0.0-SNAPSHOT + + Helidon Examples Metrics Exemplar + + + io.helidon.examples.metrics.exemplar.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.metrics + helidon-metrics-api + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.tracing + helidon-tracing + + + io.helidon.metrics + helidon-metrics-trace-exemplar + runtime + + + io.helidon.tracing + helidon-tracing-zipkin + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-params + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/GreetService.java b/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/GreetService.java new file mode 100644 index 00000000..2804b5a8 --- /dev/null +++ b/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/GreetService.java @@ -0,0 +1,196 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.exemplar; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.Metadata; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.MetricType; +import org.eclipse.microprofile.metrics.MetricUnits; +import org.eclipse.microprofile.metrics.Timer; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + static final String TIMER_FOR_GETS = "timerForGets"; + static final String COUNTER_FOR_PERSONALIZED_GREETINGS = "counterForPersonalizedGreetings"; + + private final Timer timerForGets; + + private final Counter personalizedGreetingsCounter; + + private final Config config; + + GreetService(Config config) { + this.config = config; + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + MetricRegistry registry = RegistryFactory.getInstance().getRegistry(MetricRegistry.Type.APPLICATION); + Metadata metadata = Metadata.builder() + .withName(TIMER_FOR_GETS) + .withUnit(MetricUnits.NANOSECONDS) + .withType(MetricType.TIMER) + .build(); + timerForGets = registry.timer(metadata); + + metadata = Metadata.builder() + .withName(COUNTER_FOR_PERSONALIZED_GREETINGS) + .withUnit(MetricUnits.NONE) + .withType(MetricType.COUNTER) + .build(); + personalizedGreetingsCounter = registry.counter(metadata); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::timeGet, this::getDefaultMessageHandler) + .get("/{name}", this::countPersonalized, this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException){ + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } + + private void timeGet(ServerRequest request, ServerResponse response) { + timerForGets.time((Runnable) request::next); + } + + private void countPersonalized(ServerRequest request, ServerResponse response) { + personalizedGreetingsCounter.inc(); + request.next(); + } +} diff --git a/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/Main.java b/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/Main.java new file mode 100644 index 00000000..0cad5606 --- /dev/null +++ b/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/Main.java @@ -0,0 +1,151 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.exemplar; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.api.MetricsSettings; +import io.helidon.metrics.api.RegistrySettings; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.eclipse.microprofile.metrics.MetricRegistry; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(true); + } + + static Single startServer(String configFile) { + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.just(ConfigSources.classpath("/" + configFile)); + + WebServer server = WebServer.builder() + .tracer(TracerBuilder.create(config.get("tracing"))) + .routing(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Start the server. + * @param isStrictExemplars whether to use strict exemplar handling + * @return the created {@link WebServer} instance + */ + static Single startServer(boolean isStrictExemplars) { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder() + .tracer(TracerBuilder.create(config.get("tracing"))) + .routing(createRouting(config, isStrictExemplars)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config, boolean isStrictExemplars) { + + MetricsSupport metrics = MetricsSupport.create(MetricsSettings.builder() + .registrySettings(MetricRegistry.Type.APPLICATION, + RegistrySettings.builder() + .strictExemplars(isStrictExemplars) + .build()) + .build()); + GreetService greetService = new GreetService(config); + + return Routing.builder() + .register(metrics) // Metrics at "/metrics" + .register("/greet", greetService) + .build(); + } + + private static Routing createRouting(Config config) { + MetricsSupport metrics = MetricsSupport.create(MetricsSettings.builder() + .config(config.get("metrics")) + .build()); + GreetService greetService = new GreetService(config); + + return Routing.builder() + .register(metrics) + .register("/greet", greetService) + .build(); + } +} diff --git a/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/package-info.java b/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/package-info.java new file mode 100644 index 00000000..2407f345 --- /dev/null +++ b/examples/metrics/exemplar/src/main/java/io/helidon/examples/metrics/exemplar/package-info.java @@ -0,0 +1,24 @@ +/* + * 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. + */ + +/** + * Quickstart demo application + *

+ * Start with {@link io.helidon.examples.metrics.exemplar.Main} class. + *

+ * @see io.helidon.examples.metrics.exemplar.Main + */ +package io.helidon.examples.metrics.exemplar; diff --git a/examples/metrics/exemplar/src/main/resources/application.yaml b/examples/metrics/exemplar/src/main/resources/application.yaml new file mode 100644 index 00000000..25681841 --- /dev/null +++ b/examples/metrics/exemplar/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 +# experimental: +# http2: +# enable: true +# max-content-length: 16384 +tracing: + service: "hello-world" diff --git a/examples/metrics/exemplar/src/main/resources/logging.properties b/examples/metrics/exemplar/src/main/resources/logging.properties new file mode 100644 index 00000000..1395ed17 --- /dev/null +++ b/examples/metrics/exemplar/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/metrics/exemplar/src/test/java/io/helidon/examples/metrics/exemplar/MainTest.java b/examples/metrics/exemplar/src/test/java/io/helidon/examples/metrics/exemplar/MainTest.java new file mode 100644 index 00000000..6634790d --- /dev/null +++ b/examples/metrics/exemplar/src/test/java/io/helidon/examples/metrics/exemplar/MainTest.java @@ -0,0 +1,217 @@ +/* + * Copyright (c) 2018, 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.metrics.exemplar; + +import java.io.LineNumberReader; +import java.io.StringReader; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.jupiter.api.Assertions.assertLinesMatch; + +public class MainTest { + + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + + static { + TEST_JSON_OBJECT = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + private static WebServer startTheServer(boolean isStrictExemplars) { + return Main.startServer(isStrictExemplars).await(); + } + + private static WebServer startTheServer() { + return Main.startServer("test-app.yaml").await(); + } + + private static void shutdownServer(WebServer webServer) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + + private static WebClient webClient(WebServer webServer) { + return WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @Test + public void testHelloWorld() { + WebServer webServer = startTheServer(true); + WebClient webClient = webClient(webServer); + try { + JsonObject jsonObject; + WebClientResponse response; + + jsonObject = webClient.get() + .path("/greet") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello World!")); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello Joe!")); + + response = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + assertThat(response.status().code(), is(204)); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hola Joe!")); + + response = webClient.get() + .path("/metrics") + .request() + .await(); + assertThat(response.status().code(), is(200)); + } finally { + shutdownServer(webServer); + } + } + + @ParameterizedTest + @ValueSource(booleans = {true, false}) + void testMetricsExemplars(boolean isStrictExemplars) { + WebServer webServer = startTheServer(isStrictExemplars); + WebClient webClient = webClient(webServer); + try { + WebClientResponse response; + + String get = webClient.get() + .path("/greet") + .request(String.class) + .await(); + + assertThat(get, containsString("Hello World!")); + + get = webClient.get() + .path("/greet/Joe") + .request(String.class) + .await(); + + assertThat(get, containsString("Hello Joe!")); + + String openMetricsOutput = webClient.get() + .path("/metrics/application") + .request(String.class) + .await(); + + LineNumberReader reader = new LineNumberReader(new StringReader(openMetricsOutput)); + List returnedLines = reader.lines() + .collect(Collectors.toList()); + + List expected = List.of(">> skip to timer total >>", + "# TYPE application_" + GreetService.TIMER_FOR_GETS + "_mean_seconds gauge", + valueMatcher("mean", isStrictExemplars), + ">> end of output >>"); + assertLinesMatch(expected, returnedLines, GreetService.TIMER_FOR_GETS + "_mean_seconds TYPE and value"); + + expected = List.of(">> skip to max >>", + "# TYPE application_" + GreetService.TIMER_FOR_GETS + "_max_seconds gauge", + valueMatcher("max", isStrictExemplars), + ">> end of output >>"); + assertLinesMatch(expected, returnedLines, GreetService.TIMER_FOR_GETS + "_max_seconds TYPE and value"); + } finally { + webServer.shutdown().await(10, TimeUnit.SECONDS); + } + } + + @Test + void testConfiguredLaxExemplars() { + WebServer webServer = startTheServer(); + WebClient webClient = webClient(webServer); + try { + WebClientResponse response; + + String get = webClient.get() + .path("/greet") + .request(String.class) + .await(); + + assertThat(get, containsString("Hello World!")); + + get = webClient.get() + .path("/greet/Joe") + .request(String.class) + .await(); + + assertThat(get, containsString("Hello Joe!")); + + String openMetricsOutput = webClient.get() + .path("/metrics/application") + .request(String.class) + .await(); + + LineNumberReader reader = new LineNumberReader(new StringReader(openMetricsOutput)); + List returnedLines = reader.lines() + .collect(Collectors.toList()); + + List expected = List.of(">> skip to timer total >>", + "# TYPE application_" + GreetService.TIMER_FOR_GETS + "_mean_seconds gauge", + valueMatcher("mean", false), + ">> end of output >>"); + assertLinesMatch(expected, returnedLines, GreetService.TIMER_FOR_GETS + "_mean_seconds TYPE and value"); + + expected = List.of(">> skip to max >>", + "# TYPE application_" + GreetService.TIMER_FOR_GETS + "_max_seconds gauge", + valueMatcher("max", false), + ">> end of output >>"); + assertLinesMatch(expected, returnedLines, GreetService.TIMER_FOR_GETS + "_max_seconds TYPE and value"); + } finally { + webServer.shutdown().await(10, TimeUnit.SECONDS); + } + } + + private static String valueMatcher(String statName, boolean isStrictExemplar) { + // application_timerForGets_mean_seconds 0.010275403147594316 # {trace_id="cfd13196e6a9fb0c"} 0.002189822 1617799841.963000 + return "application_" + GreetService.TIMER_FOR_GETS + + "_" + statName + "_seconds [\\d\\.]+" + + (isStrictExemplar ? "" : " # \\{trace_id=\"[^\"]+\"} .+"); + } + +} diff --git a/examples/metrics/exemplar/src/test/resources/test-app.yaml b/examples/metrics/exemplar/src/test/resources/test-app.yaml new file mode 100644 index 00000000..f2d2bd12 --- /dev/null +++ b/examples/metrics/exemplar/src/test/resources/test-app.yaml @@ -0,0 +1,29 @@ +# +# Copyright (c) 2023, 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 +tracing: + service: "hello-world" +metrics: + registries: + - type: application + exemplars: + strict: false \ No newline at end of file diff --git a/examples/metrics/filtering/mp/README.md b/examples/metrics/filtering/mp/README.md new file mode 100644 index 00000000..c0ad8057 --- /dev/null +++ b/examples/metrics/filtering/mp/README.md @@ -0,0 +1,47 @@ +# Helidon Metrics Filtering MP Example + +This project implements a simple Hello World REST service using Helidon SE and demonstrates the +optional metrics exemplar support. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-metrics-filtering-mp.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#Output: {"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#Output: {"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#Output: {"message":"Hola Jose!"} + +curl -X GET http://localhost:8080/greet +#Output: {"message":"Hola World!"} +``` + +## Retrieve application metrics + +```shell +# Prometheus format with exemplars + +curl -s -X GET http://localhost:8080/metrics/application +``` +``` +# TYPE application_counterForPersonalizedGreetings_total counter +# HELP application_counterForPersonalizedGreetings_total +application_counterForPersonalizedGreetings_total 2 # {trace_id="78e61eed351f4c9d"} 1 1617812495.016000 +. . . +# TYPE application_timerForGets_mean_seconds gauge +application_timerForGets_mean_seconds 0.005772598385062112 # {trace_id="b22f13c37ba8b879"} 0.001563945 1617812578.687000 +# TYPE application_timerForGets_max_seconds gauge +application_timerForGets_max_seconds 0.028018165 # {trace_id="a1b127002725143c"} 0.028018165 1617812467.524000 +``` \ No newline at end of file diff --git a/examples/metrics/filtering/mp/pom.xml b/examples/metrics/filtering/mp/pom.xml new file mode 100644 index 00000000..49374b5c --- /dev/null +++ b/examples/metrics/filtering/mp/pom.xml @@ -0,0 +1,99 @@ + + + + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + 4.0.0 + + io.helidon.examples.metrics.filtering + helidon-examples-metrics-filtering-mp + 1.0.0-SNAPSHOT + Helidon Examples Metrics MP Filtering + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.metrics + helidon-microprofile-metrics + + + io.helidon.media + helidon-media-jsonp + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + check-for-inflight-with-config-settings + + test + + + + true + + + + + + + + diff --git a/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetResource.java b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetResource.java new file mode 100644 index 00000000..c75365c9 --- /dev/null +++ b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetResource.java @@ -0,0 +1,111 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.filtering.mp; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import org.eclipse.microprofile.metrics.annotation.Counted; +import org.eclipse.microprofile.metrics.annotation.Timed; + +/** + * A simple JAX-RS resource to greet you with filtered metrics support. + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + + static final String TIMER_FOR_GETS = "timerForGets"; + static final String COUNTER_FOR_PERSONALIZED_GREETINGS = "counterForPersonalizedGreetings"; + + /** + * The greeting message provider. + */ + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a worldly greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + @Timed(name = TIMER_FOR_GETS, absolute = true, reusable = true) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link GreetingMessage} + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Timed(name = TIMER_FOR_GETS, absolute = true, reusable = true) + public GreetingMessage getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message JSON containing the new greeting + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + @Counted(name = COUNTER_FOR_PERSONALIZED_GREETINGS, absolute = true) + public Response updateGreeting(GreetingMessage message) { + + if (message.getMessage() == null) { + GreetingMessage entity = new GreetingMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); + } + greetingProvider.setMessage(message.getMessage()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new GreetingMessage(msg); + } +} diff --git a/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetingMessage.java b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetingMessage.java new file mode 100644 index 00000000..f280b0fa --- /dev/null +++ b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023, 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.metrics.filtering.mp; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetingProvider.java b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetingProvider.java new file mode 100644 index 00000000..ba9c8439 --- /dev/null +++ b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/GreetingProvider.java @@ -0,0 +1,49 @@ +/* + * 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. + */ +package io.helidon.examples.metrics.filtering.mp; + +import java.util.concurrent.atomic.AtomicReference; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +public class GreetingProvider { + private final AtomicReference message = new AtomicReference<>(); + + /** + * Create a new greeting provider, reading the message from configuration. + * + * @param message greeting to use + */ + @Inject + public GreetingProvider(@ConfigProperty(name = "app.greeting") String message) { + this.message.set(message); + } + + String getMessage() { + return message.get(); + } + + void setMessage(String message) { + this.message.set(message); + } +} diff --git a/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/package-info.java b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/package-info.java new file mode 100644 index 00000000..947e97fe --- /dev/null +++ b/examples/metrics/filtering/mp/src/main/java/io/helidon/examples/metrics/filtering/mp/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** + * Helidon MicroProfile metrics filtering example. + */ +package io.helidon.examples.metrics.filtering.mp; diff --git a/examples/metrics/filtering/mp/src/main/resources/META-INF/beans.xml b/examples/metrics/filtering/mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..d703ee7b --- /dev/null +++ b/examples/metrics/filtering/mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/metrics/filtering/mp/src/main/resources/META-INF/microprofile-config.properties b/examples/metrics/filtering/mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..b7f79348 --- /dev/null +++ b/examples/metrics/filtering/mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2021 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. +# +app.greeting=Hello + +# Override configuration to use a random port for the unit tests +config_ordinal=1000 +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +metrics.registries.0.type = application +metrics.registries.0.filter.exclude = .*Gets diff --git a/examples/metrics/filtering/mp/src/main/resources/logging.properties b/examples/metrics/filtering/mp/src/main/resources/logging.properties new file mode 100644 index 00000000..05813f37 --- /dev/null +++ b/examples/metrics/filtering/mp/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.common.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 + +# Component specific log levels +#io.helidon.webserver.cors.level=INFO diff --git a/examples/metrics/filtering/mp/src/test/java/io/helidon/examples/metrics/filtering/mp/MainTest.java b/examples/metrics/filtering/mp/src/test/java/io/helidon/examples/metrics/filtering/mp/MainTest.java new file mode 100644 index 00000000..33e6fe31 --- /dev/null +++ b/examples/metrics/filtering/mp/src/test/java/io/helidon/examples/metrics/filtering/mp/MainTest.java @@ -0,0 +1,56 @@ +/* + * 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. + */ +package io.helidon.examples.metrics.filtering.mp; + +import java.util.concurrent.TimeUnit; + +import javax.inject.Inject; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.Timer; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +@HelidonTest +public class MainTest { + + @Inject + private MetricRegistry appRegistry; + + @Test + void checkEnabledMetric() { + Counter personalizedGreetingsCounter = appRegistry.counter(GreetResource.COUNTER_FOR_PERSONALIZED_GREETINGS); + long before = personalizedGreetingsCounter.getCount(); + personalizedGreetingsCounter.inc(); + assertThat("Enabled counter value change", + personalizedGreetingsCounter.getCount() - before, is(1L)); + } + + @Test + void checkDisabledMetric() { + Timer getsTimer = appRegistry.timer(GreetResource.TIMER_FOR_GETS); + long before = getsTimer.getCount(); + getsTimer.update(1L, TimeUnit.SECONDS); + assertThat("Disabled timer value change", + getsTimer.getCount() - before, + is(0L)); + } +} diff --git a/examples/metrics/filtering/pom.xml b/examples/metrics/filtering/pom.xml new file mode 100644 index 00000000..1684cae0 --- /dev/null +++ b/examples/metrics/filtering/pom.xml @@ -0,0 +1,38 @@ + + + + + + helidon-examples-metrics-project + io.helidon.examples + 1.0.0-SNAPSHOT + + 4.0.0 + pom + + helidon-examples-metrics-filtering + Helidon Metrics Filtering Examples + + + se + mp + + diff --git a/examples/metrics/filtering/se/README.md b/examples/metrics/filtering/se/README.md new file mode 100644 index 00000000..41a9330c --- /dev/null +++ b/examples/metrics/filtering/se/README.md @@ -0,0 +1,47 @@ +# Helidon Filtering Metrics SE Example + +This project implements a simple Hello World REST service using Helidon SE and demonstrates the +optional metrics exemplar support. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-metrics-se.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#Output: {"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#Output: {"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#Output: {"message":"Hola Jose!"} + +curl -X GET http://localhost:8080/greet +#Output: {"message":"Hola World!"} +``` + +## Retrieve application metrics + +```shell +# Prometheus format with exemplars + +curl -s -X GET http://localhost:8080/metrics/application +``` +``` +# TYPE application_counterForPersonalizedGreetings_total counter +# HELP application_counterForPersonalizedGreetings_total +application_counterForPersonalizedGreetings_total 2 # {trace_id="78e61eed351f4c9d"} 1 1617812495.016000 +. . . +# TYPE application_timerForGets_mean_seconds gauge +application_timerForGets_mean_seconds 0.005772598385062112 # {trace_id="b22f13c37ba8b879"} 0.001563945 1617812578.687000 +# TYPE application_timerForGets_max_seconds gauge +application_timerForGets_max_seconds 0.028018165 # {trace_id="a1b127002725143c"} 0.028018165 1617812467.524000 +``` \ No newline at end of file diff --git a/examples/metrics/filtering/se/pom.xml b/examples/metrics/filtering/se/pom.xml new file mode 100644 index 00000000..b53b72a0 --- /dev/null +++ b/examples/metrics/filtering/se/pom.xml @@ -0,0 +1,111 @@ + + + + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + 4.0.0 + + io.helidon.examples.metrics.filtering + helidon-examples-metrics-se + 1.0.0-SNAPSHOT + Helidon Examples Metrics SE Filtering + + io.helidon.examples.metrics.filtering.se.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.metrics + helidon-metrics-api + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + check-for-inflight-with-config-settings + + test + + + + true + + + + + + + + diff --git a/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/GreetService.java b/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/GreetService.java new file mode 100644 index 00000000..ecf1d479 --- /dev/null +++ b/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/GreetService.java @@ -0,0 +1,199 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.filtering.se; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.Metadata; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.MetricType; +import org.eclipse.microprofile.metrics.MetricUnits; +import org.eclipse.microprofile.metrics.Timer; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + static final String TIMER_FOR_GETS = "timerForGets"; + static final String COUNTER_FOR_PERSONALIZED_GREETINGS = "counterForPersonalizedGreetings"; + + private final Timer timerForGets; + + private final Counter personalizedGreetingsCounter; + + private final Config config; + + private final MetricRegistry appRegistry; + + GreetService(Config config, MetricRegistry appRegistry) { + this.config = config; + this.appRegistry = appRegistry; + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + MetricRegistry registry = RegistryFactory.getInstance().getRegistry(MetricRegistry.Type.APPLICATION); + Metadata metadata = Metadata.builder() + .withName(TIMER_FOR_GETS) + .withUnit(MetricUnits.NANOSECONDS) + .withType(MetricType.TIMER) + .build(); + timerForGets = registry.timer(metadata); + + metadata = Metadata.builder() + .withName(COUNTER_FOR_PERSONALIZED_GREETINGS) + .withUnit(MetricUnits.NONE) + .withType(MetricType.COUNTER) + .build(); + personalizedGreetingsCounter = registry.counter(metadata); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::timeGet, this::getDefaultMessageHandler) + .get("/{name}", this::countPersonalized, this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException){ + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } + + private void timeGet(ServerRequest request, ServerResponse response) { + timerForGets.time((Runnable) request::next); + } + + private void countPersonalized(ServerRequest request, ServerResponse response) { + personalizedGreetingsCounter.inc(); + request.next(); + } +} diff --git a/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/Main.java b/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/Main.java new file mode 100644 index 00000000..5ecce323 --- /dev/null +++ b/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/Main.java @@ -0,0 +1,116 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.filtering.se; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.api.MetricsSettings; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.metrics.api.RegistryFilterSettings; +import io.helidon.metrics.api.RegistrySettings; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.eclipse.microprofile.metrics.MetricRegistry; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link io.helidon.webserver.WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // Ignore the "gets" timer. + RegistryFilterSettings.Builder registryFilterSettingsBuilder = RegistryFilterSettings.builder() + .exclude(GreetService.TIMER_FOR_GETS); + + RegistrySettings.Builder registrySettingsBuilder = RegistrySettings.builder() + .filterSettings(registryFilterSettingsBuilder); + + MetricsSettings.Builder metricsSettingsBuilder = MetricsSettings.builder() + .registrySettings(MetricRegistry.Type.APPLICATION, registrySettingsBuilder.build()); + + WebServer server = WebServer.builder() + .routing(createRouting(config, metricsSettingsBuilder)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link io.helidon.webserver.Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config, MetricsSettings.Builder metricsSettingsBuilder) { + MetricsSupport metricsSupport = MetricsSupport.builder() + .metricsSettings(metricsSettingsBuilder) + .build(); + MetricRegistry appRegistry = RegistryFactory.getInstance(metricsSettingsBuilder.build()) + .getRegistry(MetricRegistry.Type.APPLICATION); + + GreetService greetService = new GreetService(config, appRegistry); + + return Routing.builder() + .register(metricsSupport) // Metrics at "/metrics" + .register("/greet", greetService) + .build(); + } +} diff --git a/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/package-info.java b/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/package-info.java new file mode 100644 index 00000000..2767bc4a --- /dev/null +++ b/examples/metrics/filtering/se/src/main/java/io/helidon/examples/metrics/filtering/se/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ +/** + * Helidon SE example of controlling metrics using filtering. + */ +package io.helidon.examples.metrics.filtering.se; diff --git a/examples/metrics/filtering/se/src/main/resources/application.yaml b/examples/metrics/filtering/se/src/main/resources/application.yaml new file mode 100644 index 00000000..25681841 --- /dev/null +++ b/examples/metrics/filtering/se/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 +# experimental: +# http2: +# enable: true +# max-content-length: 16384 +tracing: + service: "hello-world" diff --git a/examples/metrics/filtering/se/src/main/resources/logging.properties b/examples/metrics/filtering/se/src/main/resources/logging.properties new file mode 100644 index 00000000..1395ed17 --- /dev/null +++ b/examples/metrics/filtering/se/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/metrics/filtering/se/src/test/java/io/helidon/examples/metrics/filtering/se/MainTest.java b/examples/metrics/filtering/se/src/test/java/io/helidon/examples/metrics/filtering/se/MainTest.java new file mode 100644 index 00000000..3af9a5e2 --- /dev/null +++ b/examples/metrics/filtering/se/src/test/java/io/helidon/examples/metrics/filtering/se/MainTest.java @@ -0,0 +1,133 @@ +/* + * Copyright (c) 2018, 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.metrics.filtering.se; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.not; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + + static { + TEST_JSON_OBJECT = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + @BeforeAll + public static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + public void testHelloWorld() { + JsonObject jsonObject; + WebClientResponse response; + + jsonObject = webClient.get() + .path("/greet") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello World!")); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello Joe!")); + + response = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + assertThat(response.status().code(), is(204)); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hola Joe!")); + + response = webClient.get() + .path("/metrics") + .request() + .await(); + assertThat(response.status().code(), is(200)); + } + + @Test + public void testMetrics() { + WebClientResponse response; + + String get = webClient.get() + .path("/greet") + .request(String.class) + .await(); + + assertThat(get, containsString("Hello World!")); + + get = webClient.get() + .path("/greet/Joe") + .request(String.class) + .await(); + + assertThat(get, containsString("Hello Joe!")); + + String openMetricsOutput = webClient.get() + .path("/metrics/application") + .request(String.class) + .await(); + + assertThat("Metrics output", openMetricsOutput, not(containsString(GreetService.TIMER_FOR_GETS))); + assertThat("Metrics output", openMetricsOutput, containsString(GreetService.COUNTER_FOR_PERSONALIZED_GREETINGS)); + } +} diff --git a/examples/metrics/http-status-count-se/README.md b/examples/metrics/http-status-count-se/README.md new file mode 100644 index 00000000..987d6478 --- /dev/null +++ b/examples/metrics/http-status-count-se/README.md @@ -0,0 +1,101 @@ +# http-status-count-se + +This Helidon SE project illustrates a service which updates a family of counters based on the HTTP status returned in each response. + +The main source in this example is identical to that in the Helidon SE QuickStart application except in these ways: +* The `HttpStatusMetricService` class creates and updates the status metrics. +* The `Main` class has a two small enhancements: + * The `createRouting` method instantiates `HttpStatusMetricService` and sets up routing for it. + * The `startServer` method has an additional variant to simplify a new unit test. + +## Incorporating status metrics into your own application +Use this example for inspiration in writing your own service or just use the `HttpStatusMetricService` directly in your own application. + +1. Copy and paste the `HttpStatusMetricService` class into your application, adjusting the package declaration as needed. +2. Register routing for an instance of `HttpStatusMetricService`, as shown here: + ```java + Routing.Builder builder = Routing.builder() + ... + .register(HttpStatusMetricService.create() + ... + ``` + +## Build and run + + +```shell +mvn package +java -jar target/http-status-count-se.jar +``` + +## Exercise the application +```shell +curl -X GET http://localhost:8080/simple-greet +``` +```json +{"message":"Hello World!"} +``` + +```shell +curl -X GET http://localhost:8080/greet +``` +```json +{"message":"Hello World!"} +``` +```shell +curl -X GET http://localhost:8080/greet/Joe +``` +```listing +{"message":"Hello Joe!"} +``` +```shell +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +``` +```json +{"message":"Hola Jose!"} +``` + +## Try metrics +```shell +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics/application +``` + +```listing +... +# TYPE application_httpStatus_total counter +# HELP application_httpStatus_total Counts the number of HTTP responses in each status category (1xx, 2xx, etc.) +application_httpStatus_total{range="1xx"} 0 +application_httpStatus_total{range="2xx"} 5 +application_httpStatus_total{range="3xx"} 0 +application_httpStatus_total{range="4xx"} 0 +application_httpStatus_total{range="5xx"} 0 +... +``` +# JSON Format + +```shell +curl -H "Accept: application/json" -X GET http://localhost:8080/metrics +``` +```json +{ +... + "httpStatus;range=1xx": 0, + "httpStatus;range=2xx": 5, + "httpStatus;range=3xx": 0, + "httpStatus;range=4xx": 0, + "httpStatus;range=5xx": 0, +... +``` + +## Try health + +```shell +curl -s -X GET http://localhost:8080/health +``` +```listing +{"outcome":"UP",... + +``` diff --git a/examples/metrics/http-status-count-se/pom.xml b/examples/metrics/http-status-count-se/pom.xml new file mode 100644 index 00000000..c4278bc6 --- /dev/null +++ b/examples/metrics/http-status-count-se/pom.xml @@ -0,0 +1,94 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples + http-status-count-se + 1.0-SNAPSHOT + + Helidon Examples Metrics HTTP Status Counters + + + io.helidon.examples.se.httpstatuscount.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.metrics + helidon-metrics + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.media + helidon-media-jsonp + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/GreetService.java b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/GreetService.java new file mode 100644 index 00000000..1a4310fd --- /dev/null +++ b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/GreetService.java @@ -0,0 +1,155 @@ + +/* + * Copyright (c) 2022, 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.se.httpstatuscount; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + + + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +/** + * Greeting service. + */ +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + GreetService(Config config) { + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException) { + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } +} diff --git a/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/HttpStatusMetricService.java b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/HttpStatusMetricService.java new file mode 100644 index 00000000..f47b8ffa --- /dev/null +++ b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/HttpStatusMetricService.java @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2022, 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.se.httpstatuscount; + +import java.util.concurrent.atomic.AtomicInteger; + +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.Metadata; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.MetricType; +import org.eclipse.microprofile.metrics.MetricUnits; +import org.eclipse.microprofile.metrics.Tag; + +/** + * Helidon SE service to update a family of counters based on the HTTP status of each response. Add an instance of this service + * to the application's routing. + *

+ * The service uses one {@link org.eclipse.microprofile.metrics.Counter} for each HTTP status family (1xx, 2xx, etc.). + * All counters share the same name--{@value STATUS_COUNTER_NAME}--and each has the tag {@value STATUS_TAG_NAME} with + * value {@code 1xx}, {@code 2xx}, etc. + *

+ */ +public class HttpStatusMetricService implements Service { + + static final String STATUS_COUNTER_NAME = "httpStatus"; + + static final String STATUS_TAG_NAME = "range"; + + private static final AtomicInteger IN_PROGRESS = new AtomicInteger(); + + private final Counter[] responseCounters = new Counter[6]; + + static HttpStatusMetricService create() { + return new HttpStatusMetricService(); + } + + private HttpStatusMetricService() { + MetricRegistry appRegistry = RegistryFactory.getInstance().getRegistry(MetricRegistry.Type.APPLICATION); + Metadata metadata = Metadata.builder() + .withName(STATUS_COUNTER_NAME) + .withDisplayName("HTTP response values") + .withDescription("Counts the number of HTTP responses in each status category (1xx, 2xx, etc.)") + .withType(MetricType.COUNTER) + .withUnit(MetricUnits.NONE) + .build(); + // Declare the counters and keep references to them. + for (int i = 1; i < responseCounters.length; i++) { + responseCounters[i] = appRegistry.counter(metadata, new Tag(STATUS_TAG_NAME, i + "xx")); + } + } + + @Override + public void update(Routing.Rules rules) { + rules.any(this::updateRange); + } + + // for testing + static boolean isInProgress() { + return IN_PROGRESS.get() != 0; + } + + // Edited to adopt Ciaran's fix later in the thread. + private void updateRange(ServerRequest request, ServerResponse response) { + IN_PROGRESS.incrementAndGet(); + response.whenSent() + .thenAccept(this::logMetric); + request.next(); + } + + private void logMetric(ServerResponse response) { + int range = response.status().code() / 100; + if (range > 0 && range < responseCounters.length) { + responseCounters[range].inc(); + } + IN_PROGRESS.decrementAndGet(); + } +} diff --git a/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/Main.java b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/Main.java new file mode 100644 index 00000000..b736a708 --- /dev/null +++ b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/Main.java @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2022, 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.se.httpstatuscount; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + return startServer(createRouting(Config.create())); + } + + static Single startServer(Routing.Builder routingBuilder) { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(routingBuilder) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + static Routing.Builder createRouting(Config config) { + SimpleGreetService simpleGreetService = new SimpleGreetService(config); + GreetService greetService = new GreetService(config); + + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + Routing.Builder builder = Routing.builder() + .register(MetricsSupport.create()) // Metrics at "/metrics" + .register(health) // Health at "/health" + .register(HttpStatusMetricService.create()) // no endpoint, just metrics updates + .register("/simple-greet", simpleGreetService) + .register("/greet", greetService); + + + return builder; + } +} diff --git a/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/SimpleGreetService.java b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/SimpleGreetService.java new file mode 100644 index 00000000..85e9ffcf --- /dev/null +++ b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/SimpleGreetService.java @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2022, 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.se.httpstatuscount; + +import java.util.Collections; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.config.Config; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.MetricRegistry; + + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/simple-greet + * + * The message is returned as a JSON object + */ +public class SimpleGreetService implements Service { + + private static final Logger LOGGER = Logger.getLogger(SimpleGreetService.class.getName()); + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private final MetricRegistry registry = RegistryFactory.getInstance() + .getRegistry(MetricRegistry.Type.APPLICATION); + private final Counter accessCtr = registry.counter("accessctr"); + + private final String greeting; + + SimpleGreetService(Config config) { + greeting = config.get("app.greeting").asString().orElse("Ciao"); + } + + + /** + * A service registers itself by updating the routing rules. + * + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules.get("/", this::getDefaultMessageHandler); + rules.get("/greet-count", this::countAccess, this::getDefaultMessageHandler); + } + + /** + * Return a worldly greeting message. + * + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, ServerResponse response) { + String msg = String.format("%s %s!", greeting, "World"); + LOGGER.info("Greeting message is " + msg); + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + + private void countAccess(ServerRequest request, ServerResponse response) { + accessCtr.inc(); + request.next(); + } +} diff --git a/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/package-info.java b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/package-info.java new file mode 100644 index 00000000..9ee76148 --- /dev/null +++ b/examples/metrics/http-status-count-se/src/main/java/io/helidon/examples/se/httpstatuscount/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2022, 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. + */ +/** + * HTTP status counter example. + */ +package io.helidon.examples.se.httpstatuscount; diff --git a/examples/metrics/http-status-count-se/src/main/resources/application.yaml b/examples/metrics/http-status-count-se/src/main/resources/application.yaml new file mode 100644 index 00000000..df571a29 --- /dev/null +++ b/examples/metrics/http-status-count-se/src/main/resources/application.yaml @@ -0,0 +1,24 @@ +# +# Copyright (c) 2022, 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. +# + +server: + port: 8080 + host: 0.0.0.0 + +app: + greeting: "Hello" + + diff --git a/examples/metrics/http-status-count-se/src/main/resources/logging.properties b/examples/metrics/http-status-count-se/src/main/resources/logging.properties new file mode 100644 index 00000000..d31ec34b --- /dev/null +++ b/examples/metrics/http-status-count-se/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2022, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/MainTest.java b/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/MainTest.java new file mode 100644 index 00000000..6498277e --- /dev/null +++ b/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/MainTest.java @@ -0,0 +1,138 @@ +/* + * Copyright (c) 2022, 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.se.httpstatuscount; + +import java.util.concurrent.TimeUnit; +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.MethodOrderer; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestMethodOrder; + +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +@TestMethodOrder(MethodOrderer.MethodName.class) +public class MainTest { + + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + + private static WebServer webServer; + private static WebClient webClient; + + @BeforeAll + public static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() throws Exception { + if (webServer != null) { + webServer.shutdown() + .toCompletableFuture() + .get(10, TimeUnit.SECONDS); + } + } + + + @Test + public void testMicroprofileMetrics() { + String get = webClient.get() + .path("/simple-greet/greet-count") + .request(String.class) + .await(); + + assertThat(get, containsString("Hello World!")); + + String openMetricsOutput = webClient.get() + .path("/metrics") + .request(String.class) + .await(); + + assertThat("Metrics output", openMetricsOutput, containsString("application_accessctr_total")); + } + + @Test + public void testMetrics() throws Exception { + WebClientResponse response = webClient.get() + .path("/metrics") + .request() + .await(); + assertThat(response.status().code(), is(200)); + } + + @Test + public void testHealth() throws Exception { + WebClientResponse response = webClient.get() + .path("health") + .request() + .await(); + assertThat(response.status().code(), is(200)); + } + + @Test + public void testSimpleGreet() throws Exception { + JsonObject jsonObject = webClient.get() + .path("/simple-greet") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello World!")); + } + @Test + public void testGreetings() { + JsonObject jsonObject; + WebClientResponse response; + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello Joe!")); + + response = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + assertThat(response.status().code(), is(204)); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hola Joe!")); + } +} diff --git a/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/StatusService.java b/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/StatusService.java new file mode 100644 index 00000000..b84086a0 --- /dev/null +++ b/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/StatusService.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2022, 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.se.httpstatuscount; + +import io.helidon.common.http.Http; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Test-only service that allows the client to specify what HTTP status the service should return in its response. + * This allows the client to know which status family counter should be updated. + */ +public class StatusService implements Service { + + @Override + public void update(Routing.Rules rules) { + rules.get("/{status}", this::respondWithRequestedStatus); + } + + private void respondWithRequestedStatus(ServerRequest request, ServerResponse response) { + String statusText = request.path().param("status"); + int status; + String msg; + try { + status = Integer.parseInt(statusText); + msg = "Successful conversion"; + } catch (NumberFormatException ex) { + status = Http.Status.INTERNAL_SERVER_ERROR_500.code(); + msg = "Unsuccessful conversion"; + } + response.status(status) + .send(msg); + } +} diff --git a/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/StatusTest.java b/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/StatusTest.java new file mode 100644 index 00000000..bd8babd7 --- /dev/null +++ b/examples/metrics/http-status-count-se/src/test/java/io/helidon/examples/se/httpstatuscount/StatusTest.java @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2022, 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.se.httpstatuscount; + +import java.time.Duration; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.http.Http.ResponseStatus; +import io.helidon.common.http.Http.Status; +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.MetricID; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.Tag; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.isEmptyString; +import static org.junit.jupiter.api.Assertions.fail; + +public class StatusTest { + private static final Duration TIMEOUT = Duration.ofSeconds(10); + + private static WebServer webServer; + private static WebClient webClient; + + private final Counter[] STATUS_COUNTERS = new Counter[6]; + + @AfterAll + public static void stopServer() throws Exception { + if (webServer != null) { + webServer.shutdown() + .toCompletableFuture() + .get(10, TimeUnit.SECONDS); + } + } + + @BeforeAll + static void init() { + Routing.Builder routingBuilder = Main.createRouting(Config.create()); + routingBuilder.register("/status", new StatusService()); + + webServer = Main.startServer(routingBuilder).await(TIMEOUT); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @BeforeEach + void findStatusMetrics() { + MetricRegistry metricRegistry = RegistryFactory.getInstance().getRegistry(MetricRegistry.Type.APPLICATION); + for (int i = 1; i < STATUS_COUNTERS.length; i++) { + STATUS_COUNTERS[i] = metricRegistry.getCounters().get(new MetricID(HttpStatusMetricService.STATUS_COUNTER_NAME, + new Tag(HttpStatusMetricService.STATUS_TAG_NAME, i + "xx"))); + } + } + + @Test + void checkStatusMetrics() throws ExecutionException, InterruptedException { + checkAfterStatus(ResponseStatus.create(171)); + checkAfterStatus(Status.OK_200); + checkAfterStatus(Status.CREATED_201); + checkAfterStatus(Status.NO_CONTENT_204); + checkAfterStatus(Status.MOVED_PERMANENTLY_301); + checkAfterStatus(Status.UNAUTHORIZED_401); + checkAfterStatus(Status.NOT_FOUND_404); + } + + @Test + void checkStatusAfterGreet() throws ExecutionException, InterruptedException { + long[] before = new long[6]; + for (int i = 1; i < 6; i++) { + before[i] = STATUS_COUNTERS[i].getCount(); + } + WebClientResponse response = webClient.get() + .path("/greet") + .accept(MediaType.APPLICATION_JSON) + .request() + .get(); + assertThat("Status of /greet", response.status(), is(Status.OK_200)); + String entity = response.content().as(String.class).await(TIMEOUT); + assertThat(entity, not(isEmptyString())); + checkCounters(response.status(), before); + } + + void checkAfterStatus(ResponseStatus status) throws ExecutionException, InterruptedException { + long[] before = new long[6]; + for (int i = 1; i < 6; i++) { + before[i] = STATUS_COUNTERS[i].getCount(); + } + WebClientResponse response = webClient.get() + .path("/status/" + status.code()) + .accept(MediaType.APPLICATION_JSON) + .request() + .get(); + + assertThat("Response status", response.status().code(), is(status.code())); + String entity = response.content().as(String.class).await(TIMEOUT); + + checkCounters(status, before); + } + + private void checkCounters(ResponseStatus status, long[] before) throws InterruptedException { + // first make sure we do not have a request in progress + long now = System.currentTimeMillis(); + + while (HttpStatusMetricService.isInProgress()) { + Thread.sleep(50); + if (System.currentTimeMillis() - now > 5000) { + fail("Timed out while waiting for monitoring to finish"); + } + } + + int family = status.code() / 100; + for (int i = 1; i < 6; i++) { + long expectedDiff = i == family ? 1 : 0; + assertThat("Diff in counter " + family + "xx", STATUS_COUNTERS[i].getCount() - before[i], is(expectedDiff)); + } + } +} diff --git a/examples/metrics/http-status-count-se/src/test/resources/application.yaml b/examples/metrics/http-status-count-se/src/test/resources/application.yaml new file mode 100644 index 00000000..4a427521 --- /dev/null +++ b/examples/metrics/http-status-count-se/src/test/resources/application.yaml @@ -0,0 +1,26 @@ +# +# Copyright (c) 2022, 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. +# + +server: + port: 0 + host: 0.0.0.0 + +app: + greeting: "Hello" + +security: + enabled: false + diff --git a/examples/metrics/kpi/README.md b/examples/metrics/kpi/README.md new file mode 100644 index 00000000..3e070de8 --- /dev/null +++ b/examples/metrics/kpi/README.md @@ -0,0 +1,125 @@ +# Helidon Metrics Key Performance Indicators SE Example + +This project implements a simple Hello World REST service using Helidon SE and demonstrates +support in Helidon for extended key performance indicator (KPI) metrics. + +Your application can set up KPI metrics either programmatically or using configuration. +The `Main` class of this example shows both techniques, checking the system property `useConfig` to +determine +which to use. +You would typically write any given application to use only one of the approaches. + +## Build and run + +```shell +mvn package +``` +To use programmatic set-up: +```shell +java -jar target/helidon-examples-metrics-kpi.jar +``` +To use configuration: +```shell +java -DuseConfig=true -jar target/helidon-examples-metrics-kpi.jar +```` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} + +curl -X GET http://localhost:8080/greet +#{"message":"Hola World!"} +``` + +## Retrieve vendor metrics with key performance indicators + +For brevity, the example output below shows only some of the KPI metrics. + +Note that, even though the `curl` commands above access `/greet` endpoints five times, +the +`load` and (not shown here) +`count` and +`meter` are `6` in the Prometheus output example and `7` in the JSON output example. +Further, the `inFlight` +current value is `1`. + +This is +because Helidon tallies +all +requests, even those +to Helidon-provided services such as `/metrics` and `/health`, in the KPI metrics. +The request +to retrieve the metrics is the one that is in flight, and it contributes to the KPI metrics just +as requests to application endpoints do. + +Further, the request to `/metrics` is still in progress when Helidon prepares the +output by getting the values of the KPI metrics at that moment. +If _that_ request turns out to be long- running, Helidon would discover so only +_after_ preparing the metrics output and completing the request. +The `longRunning` `Meter` +values in _that_ +response +could +not reflect the fact that Helidon would subsequently conclude that _that_ request was +long-running. + +## Prometheus format +```shell +curl -s -X GET http://localhost:8080/metrics/vendor +``` +```text +... +# TYPE vendor_requests_inFlight_current concurrent gauge +# HELP vendor_requests_inFlight_current Measures the number of currently in-flight requests +vendor_requests_inFlight_current 1 +# TYPE vendor_requests_inFlight_min concurrent gauge +vendor_requests_inFlight_min 0 +# TYPE vendor_requests_inFlight_max concurrent gauge +vendor_requests_inFlight_max 1 +# TYPE vendor_requests_load_total counter +# HELP vendor_requests_load_total Measures the total number of in-flight requests and rates at which they occur +vendor_requests_load_total 6 +# TYPE vendor_requests_load_rate_per_second gauge +vendor_requests_load_rate_per_second 0.04932913209653636 +# TYPE vendor_requests_load_one_min_rate_per_second gauge +vendor_requests_load_one_min_rate_per_second 0.025499793037824785 +# TYPE vendor_requests_load_five_min_rate_per_second gauge +vendor_requests_load_five_min_rate_per_second 0.012963147773962286 +# TYPE vendor_requests_load_fifteen_min_rate_per_second gauge +vendor_requests_load_fifteen_min_rate_per_second 0.005104944851522425 +... +``` +## JSON output + + +```shell +curl -s -X GET -H "Accept: application/json" http://localhost:8080/metrics/vendor +``` +```json +{ + ... + "requests.inFlight": { + "current": 1, + "max": 1, + "min": 0 + }, + "requests.load": { + "count": 7, + "meanRate": 0.01530869471741443, + "oneMinRate": 0.00016123154886115814, + "fiveMinRate": 0.005344110443653005, + "fifteenMinRate": 0.004286243527303867 + }, + ... +} +``` diff --git a/examples/metrics/kpi/pom.xml b/examples/metrics/kpi/pom.xml new file mode 100644 index 00000000..eac05443 --- /dev/null +++ b/examples/metrics/kpi/pom.xml @@ -0,0 +1,111 @@ + + + + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + 4.0.0 + + io.helidon.examples.metrics + helidon-examples-metrics-kpi + 1.0.0-SNAPSHOT + Helidon Examples Metrics Key Performance Indicators + + io.helidon.examples.metrics.kpi.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.metrics + helidon-metrics-api + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + check-for-inflight-with-config-settings + + test + + + + true + + + + + + + + diff --git a/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/GreetService.java b/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/GreetService.java new file mode 100644 index 00000000..c045086e --- /dev/null +++ b/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/GreetService.java @@ -0,0 +1,196 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.kpi; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.Metadata; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.MetricType; +import org.eclipse.microprofile.metrics.MetricUnits; +import org.eclipse.microprofile.metrics.Timer; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + static final String TIMER_FOR_GETS = "timerForGets"; + static final String COUNTER_FOR_PERSONALIZED_GREETINGS = "counterForPersonalizedGreetings"; + + private final Timer timerForGets; + + private final Counter personalizedGreetingsCounter; + + private final Config config; + + GreetService(Config config) { + this.config = config; + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + MetricRegistry registry = RegistryFactory.getInstance().getRegistry(MetricRegistry.Type.APPLICATION); + Metadata metadata = Metadata.builder() + .withName(TIMER_FOR_GETS) + .withUnit(MetricUnits.NANOSECONDS) + .withType(MetricType.TIMER) + .build(); + timerForGets = registry.timer(metadata); + + metadata = Metadata.builder() + .withName(COUNTER_FOR_PERSONALIZED_GREETINGS) + .withUnit(MetricUnits.NONE) + .withType(MetricType.COUNTER) + .build(); + personalizedGreetingsCounter = registry.counter(metadata); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::timeGet, this::getDefaultMessageHandler) + .get("/{name}", this::countPersonalized, this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException){ + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } + + private void timeGet(ServerRequest request, ServerResponse response) { + timerForGets.time((Runnable) request::next); + } + + private void countPersonalized(ServerRequest request, ServerResponse response) { + personalizedGreetingsCounter.inc(); + request.next(); + } +} diff --git a/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/Main.java b/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/Main.java new file mode 100644 index 00000000..9dc470ff --- /dev/null +++ b/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/Main.java @@ -0,0 +1,138 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.kpi; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings; +import io.helidon.metrics.api.MetricsSettings; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The application main class. + */ +public final class Main { + + static final String USE_CONFIG_PROPERTY_NAME = "useConfig"; + + static final boolean USE_CONFIG = Boolean.getBoolean(USE_CONFIG_PROPERTY_NAME); + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder() + .routing(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + /* + * For purposes of illustration, the key performance indicator settings for the + * MetricsSupport instance are set up according to a system property so you can see, + * in one example, how to code each approach. Normally, you would choose one + * approach to use in an application. + */ + MetricsSupport metricsSupport = USE_CONFIG + ? metricsSupportWithConfig(config.get("metrics")) + : metricsSupportWithoutConfig(); + + GreetService greetService = new GreetService(config); + + return Routing.builder() + .register(metricsSupport) // Metrics at "/metrics" + .register("/greet", greetService) + .build(); + } + + /** + * Creates a {@link MetricsSupport} instance using a "metrics" configuration node. + * + * @param metricsConfig {@link Config} node with key "metrics" if present; an empty node otherwise + * @return {@code MetricsSupport} object with metrics (including KPI) set up using the config node + */ + private static MetricsSupport metricsSupportWithConfig(Config metricsConfig) { + return MetricsSupport.create(metricsConfig); + } + + /** + * Creates a {@link MetricsSupport} instance explicitly turning on extended KPI metrics. + * + * @return {@code MetricsSupport} object with extended KPI metrics enabled + */ + private static MetricsSupport metricsSupportWithoutConfig() { + + KeyPerformanceIndicatorMetricsSettings.Builder settingsBuilder = + KeyPerformanceIndicatorMetricsSettings.builder() + .extended(true) + .longRunningRequestThresholdMs(2000); + return MetricsSupport.builder() + .metricsSettings(MetricsSettings.builder() + .keyPerformanceIndicatorSettings(settingsBuilder)) + .build(); + } +} diff --git a/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/package-info.java b/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/package-info.java new file mode 100644 index 00000000..d9fd1cf7 --- /dev/null +++ b/examples/metrics/kpi/src/main/java/io/helidon/examples/metrics/kpi/package-info.java @@ -0,0 +1,24 @@ +/* + * 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. + */ + +/** + * Quickstart demo application for key performance metrics. + *

+ * Start with {@link io.helidon.examples.metrics.kpi.Main} class. + *

+ * @see io.helidon.examples.metrics.kpi.Main + */ +package io.helidon.examples.metrics.kpi; diff --git a/examples/metrics/kpi/src/main/resources/application.yaml b/examples/metrics/kpi/src/main/resources/application.yaml new file mode 100644 index 00000000..08d32211 --- /dev/null +++ b/examples/metrics/kpi/src/main/resources/application.yaml @@ -0,0 +1,28 @@ +# +# 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 + +metrics: + key-performance-indicators: + extended: true + long-running: + threshold-ms: 2000 # two seconds diff --git a/examples/metrics/kpi/src/main/resources/logging.properties b/examples/metrics/kpi/src/main/resources/logging.properties new file mode 100644 index 00000000..1395ed17 --- /dev/null +++ b/examples/metrics/kpi/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/metrics/kpi/src/test/java/io/helidon/examples/metrics/kpi/MainTest.java b/examples/metrics/kpi/src/test/java/io/helidon/examples/metrics/kpi/MainTest.java new file mode 100644 index 00000000..3506f3c4 --- /dev/null +++ b/examples/metrics/kpi/src/test/java/io/helidon/examples/metrics/kpi/MainTest.java @@ -0,0 +1,138 @@ +/* + * 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. + */ + +package io.helidon.examples.metrics.kpi; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.hamcrest.Matcher; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.Matchers.containsString; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.not; + +public class MainTest { + + private static final MetricRegistry.Type KPI_REGISTRY_TYPE = MetricRegistry.Type.VENDOR; + private static WebServer webServer; + private static WebClient webClient; + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + + static { + TEST_JSON_OBJECT = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + @BeforeAll + public static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + public void testHelloWorld() { + JsonObject jsonObject; + WebClientResponse response; + + jsonObject = webClient.get() + .path("/greet") + .request(JsonObject.class) + .await(); + assertThat("Returned generic message", jsonObject.getString("message"), is("Hello World!")); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat("Returned personalized message", jsonObject.getString("message"), is("Hello Joe!")); + + response = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + assertThat("Response status from setting greeting", response.status().code(), is(204)); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat("Response statuc after changing greeting", jsonObject.getString("message"), is("Hola Joe!")); + + response = webClient.get() + .path("/metrics") + .request() + .await(); + assertThat("Response code from metrics", response.status().code(), is(200)); + } + + @Test + public void testMetrics() { + WebClientResponse response; + + String get = webClient.get() + .path("/greet") + .request(String.class) + .await(); + + assertThat("Response from generic greeting", get, containsString("Hello World!")); + + get = webClient.get() + .path("/greet/Joe") + .request(String.class) + .await(); + + assertThat("Response body from personalized greeting", get, containsString("Hello Joe!")); + + String openMetricsOutput = webClient.get() + .path("/metrics/" + KPI_REGISTRY_TYPE.getName()) + .request(String.class) + .await(); + + assertThat("Returned metrics output", + openMetricsOutput, + containsString("# TYPE " + KPI_REGISTRY_TYPE.getName() + "_requests_inFlight_current")); + } +} diff --git a/examples/metrics/pom.xml b/examples/metrics/pom.xml new file mode 100644 index 00000000..9a4b974a --- /dev/null +++ b/examples/metrics/pom.xml @@ -0,0 +1,41 @@ + + + + + + helidon-examples-project + io.helidon.examples + 1.0.0-SNAPSHOT + + 4.0.0 + pom + + helidon-examples-metrics-project + Helidon Metrics Examples + + + exemplar + kpi + filtering + http-status-count-se + + + diff --git a/examples/microprofile/README.md b/examples/microprofile/README.md new file mode 100644 index 00000000..f678273b --- /dev/null +++ b/examples/microprofile/README.md @@ -0,0 +1,3 @@ +# Helidon MP Examples + +This directory contains Helidon MP examples. diff --git a/examples/microprofile/bean-validation/README.md b/examples/microprofile/bean-validation/README.md new file mode 100644 index 00000000..8a0c24e1 --- /dev/null +++ b/examples/microprofile/bean-validation/README.md @@ -0,0 +1,37 @@ +# Helidon MP Bean Validation Example + +This example implements a simple Hello World REST service using MicroProfile demonstrating Bean Validation. + +## Usage + +To be able to use bean validation add the following dependency: + +```xml + + io.helidon.microprofile.bean-validation + helidon-microprofile-bean-validation + +``` + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-bean-validation.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET -I http://localhost:8080/greet/null +``` +```text + +HTTP/1.1 400 Bad Request +Content-Type: application/json +transfer-encoding: chunked +connection: keep-alive +``` diff --git a/examples/microprofile/bean-validation/pom.xml b/examples/microprofile/bean-validation/pom.xml new file mode 100644 index 00000000..fec54d16 --- /dev/null +++ b/examples/microprofile/bean-validation/pom.xml @@ -0,0 +1,94 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-bean-validation + 1.0.0-SNAPSHOT + Helidon Bean Validation Example + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.microprofile.bean-validation + helidon-microprofile-bean-validation + + + org.jboss + jandex + runtime + true + + + jakarta.json + jakarta.json-api + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/bean-validation/src/main/java/io/helidon/examples/microprofile/bean/validation/ValidEmailResource.java b/examples/microprofile/bean-validation/src/main/java/io/helidon/examples/microprofile/bean/validation/ValidEmailResource.java new file mode 100644 index 00000000..8aa8a158 --- /dev/null +++ b/examples/microprofile/bean-validation/src/main/java/io/helidon/examples/microprofile/bean/validation/ValidEmailResource.java @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2022 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.bean.validation; + +import java.util.Collections; + +import javax.enterprise.context.ApplicationScoped; +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.validation.constraints.Email; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + + +/** + * A simple JAX-RS resource to validate email. + * Examples: + * + * Get valid response: + * curl -X GET http://localhost:8080/valid/e@mail.com + * + * Test failed response: + * curl -X GET http://localhost:8080/valid/email + */ +@Path("/valid") +@ApplicationScoped +public class ValidEmailResource { + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + /** + * Return a greeting message using the name that was provided. + * + * @param email the name to validate + * @return {@link JsonObject} + */ + @Path("/{email}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public JsonObject getMessage(@PathParam("email") @Email String email) { + return createResponse(email); + } + + + private JsonObject createResponse(String who) { + String msg = String.format("%s %s!", "Valid", who); + + return JSON.createObjectBuilder() + .add("message", msg) + .build(); + } +} diff --git a/examples/microprofile/bean-validation/src/main/java/io/helidon/examples/microprofile/bean/validation/package-info.java b/examples/microprofile/bean-validation/src/main/java/io/helidon/examples/microprofile/bean/validation/package-info.java new file mode 100644 index 00000000..655e1620 --- /dev/null +++ b/examples/microprofile/bean-validation/src/main/java/io/helidon/examples/microprofile/bean/validation/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2022 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. + */ + +/** + * Bean Validation example. + */ +package io.helidon.examples.microprofile.bean.validation; diff --git a/examples/microprofile/bean-validation/src/main/resources/META-INF/beans.xml b/examples/microprofile/bean-validation/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..b64f96fa --- /dev/null +++ b/examples/microprofile/bean-validation/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/bean-validation/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/bean-validation/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..125e4f0f --- /dev/null +++ b/examples/microprofile/bean-validation/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2022 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 diff --git a/examples/microprofile/bean-validation/src/main/resources/logging.properties b/examples/microprofile/bean-validation/src/main/resources/logging.properties new file mode 100644 index 00000000..930fbd49 --- /dev/null +++ b/examples/microprofile/bean-validation/src/main/resources/logging.properties @@ -0,0 +1,30 @@ +# +# Copyright (c) 2022 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.common.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 diff --git a/examples/microprofile/bean-validation/src/test/java/io/helidon/tests/integration/bean/validation/TestValidationEndpoint.java b/examples/microprofile/bean-validation/src/test/java/io/helidon/tests/integration/bean/validation/TestValidationEndpoint.java new file mode 100644 index 00000000..e1808e26 --- /dev/null +++ b/examples/microprofile/bean-validation/src/test/java/io/helidon/tests/integration/bean/validation/TestValidationEndpoint.java @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2022, 2023 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.tests.integration.bean.validation; + +import io.helidon.microprofile.tests.junit5.HelidonTest; +import org.junit.jupiter.api.Test; + +import javax.inject.Inject; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * When enabled, endpoints with bean validation should return response with BAD REQUEST status. + */ +@HelidonTest +public class TestValidationEndpoint { + + @Inject + private WebTarget webTarget; + + + /** + * This Endpoint should always fail with BAD REQUEST, as bean validation fails with Not Null. + */ + @Test + public void testValidation() { + + Response.StatusType statusInfo = webTarget + .path("/valid/email") + .request() + .get() + .getStatusInfo(); + + assertThat("Endpoint should return BAD REQUEST", statusInfo.getStatusCode(), is(Response.Status.BAD_REQUEST.getStatusCode())); + + } + + /** + * This test should always work, since no validation is performed. + */ + @Test + public void testNormalUsage(){ + + Response.StatusType statusInfo = webTarget + .path("/valid/e@mail.com") + .request() + .get() + .getStatusInfo(); + assertThat("Endpoint should return OK", statusInfo.getStatusCode(), is(Response.Status.OK.getStatusCode())); + + } +} diff --git a/examples/microprofile/cors/README.md b/examples/microprofile/cors/README.md new file mode 100644 index 00000000..410776ef --- /dev/null +++ b/examples/microprofile/cors/README.md @@ -0,0 +1,129 @@ +# Helidon MP CORS Example + +This example shows a simple greeting application, similar to the one from the +Helidon MP QuickStart, enhanced with CORS support. + +Near the end of the `resources/logging.properties` file, a commented line would turn on `FINE` +logging that would reveal how the Helidon CORS support makes it decisions. To see that logging, +uncomment that line and then package and run the application. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-cors.jar +``` + +## Using the app endpoints as with the "classic" greeting app + +These normal greeting app endpoints work just as in the original greeting app: + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} +``` + +## Using CORS + +### Sending "simple" CORS requests + +The following requests illustrate the CORS protocol with the example app. + +By setting `Origin` and `Host` headers that do not indicate the same system we trigger CORS processing in the + server: + +```shell +# Follow the CORS protocol for GET +curl -i -X GET -H "Origin: http://foo.com" -H "Host: here.com" http://localhost:8080/greet +``` +```text +HTTP/1.1 200 OK +Access-Control-Allow-Origin: * +Content-Type: application/json +Date: Thu, 30 Apr 2020 17:25:51 -0500 +Vary: Origin +connection: keep-alive +content-length: 27 + +{"greeting":"Hola World!"} +``` +Note the new headers `Access-Control-Allow-Origin` and `Vary` in the response. + +The same happens for a `GET` requesting a personalized greeting (by passing the name of the + person to be greeted): +```shell +curl -i -X GET -H "Origin: http://foo.com" -H "Host: here.com" http://localhost:8080/greet/Joe +#{"greeting":"Hola Joe!"} +``` +Take a look at `GreetResource` and in particular the methods named `optionsForXXX` near the end of the class. +There is one for each different subpath that the resource's endpoints handle: no subpath, `/{name}`, and `/greeting`. The +`@CrossOrigin` annotation on each defines the CORS behavior for the corresponding path. +The `optionsForUpdatingGreeting` gives specific origins and the HTTP method (`PUT`) constraints for sharing that +resource. The other two `optionsForRetrievingXXXGreeting` methods use default parameters for the `@CrossOrigin` +annotation: allowing all origins, all methods, etc. + +With this in mind, we can see why the two earlier `GET` `curl` requests work. + +These are what CORS calls "simple" requests; the CORS protocol for these adds headers to the request and response that +would be exchanged between the client and server even without CORS. + +### "Non-simple" CORS requests + +The CORS protocol requires the client to send a _pre-flight_ request before sending a request +that changes state on the server, such as `PUT` or `DELETE` and to check the returned status +and headers to make sure the server is willing to accept the actual request. CORS refers to such `PUT` and `DELETE` +requests as "non-simple" ones. + +This command sends a pre-flight `OPTIONS` request to see if the server will accept a subsequent `PUT` request from the +specified origin to change the greeting: +```shell +curl -i -X OPTIONS \ + -H "Access-Control-Request-Method: PUT" \ + -H "Origin: http://foo.com" \ + -H "Host: here.com" \ + http://localhost:8080/greet/greeting +``` +```text +HTTP/1.1 200 OK +Access-Control-Allow-Methods: PUT +Access-Control-Allow-Origin: http://foo.com +Date: Thu, 30 Apr 2020 17:30:59 -0500 +transfer-encoding: chunked +connection: keep-alive +``` +The successful status and the returned `Access-Control-Allow-xxx` headers indicate that the + server accepted the pre-flight request. That means it is OK for us to send `PUT` request to perform the actual change + of greeting. (See below for how the server rejects a pre-flight request.) +```shell +curl -i -X PUT \ + -H "Origin: http://foo.com" \ + -H "Host: here.com" \ + -H "Access-Control-Allow-Methods: PUT" \ + -H "Access-Control-Allow-Origin: http://foo.com" \ + -H "Content-Type: application/json" \ + -d "{ \"message\" : \"Cheers\" }" \ + http://localhost:8080/greet/greeting +``` +```text +HTTP/1.1 204 No Content +Access-Control-Allow-Origin: http://foo.com +Date: Thu, 30 Apr 2020 17:32:55 -0500 +Vary: Origin +connection: keep-alive +``` +And we run one more `GET` to observe the change in the greeting: +```shell +curl -i -X GET -H "Origin: http://foo.com" -H "Host: here.com" http://localhost:8080/greet/Joe +#{"greeting":"Cheers Joe!"} +``` +Note that the tests in the example `TestCORS` class follow these same steps. + + diff --git a/examples/microprofile/cors/pom.xml b/examples/microprofile/cors/pom.xml new file mode 100644 index 00000000..c7386f9f --- /dev/null +++ b/examples/microprofile/cors/pom.xml @@ -0,0 +1,103 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-cors + 1.0.0-SNAPSHOT + Helidon Microprofile Example CORS + + + Microprofile example showing CORS support + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile + helidon-microprofile-cors + + + org.glassfish.jersey.media + jersey-media-json-binding + runtime + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + io.helidon.media + helidon-media-jsonb + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetResource.java b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetResource.java new file mode 100644 index 00000000..d387a022 --- /dev/null +++ b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetResource.java @@ -0,0 +1,152 @@ +/* + * Copyright (c) 2020, 2023 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.microprofile.examples.cors; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.HttpMethod; +import javax.ws.rs.OPTIONS; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.cors.CrossOrigin; + +import org.eclipse.microprofile.openapi.annotations.enums.SchemaType; +import org.eclipse.microprofile.openapi.annotations.media.Content; +import org.eclipse.microprofile.openapi.annotations.media.Schema; +import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponses; + +/** + * A simple JAX-RS resource to greet you with CORS support. + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + + /** + * The greeting message provider. + */ + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a worldly greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link GreetingMessage} + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message JSON containing the new greeting + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + @RequestBody(name = "greeting", + required = true, + content = @Content(mediaType = "application/json", + schema = @Schema(type = SchemaType.OBJECT, requiredProperties = { "greeting" }))) + @APIResponses({ + @APIResponse(name = "normal", responseCode = "204", description = "Greeting updated"), + @APIResponse(name = "missing 'greeting'", responseCode = "400", + description = "JSON did not contain setting for 'greeting'")}) + public Response updateGreeting(GreetingMessage message) { + + if (message.getMessage() == null) { + GreetingMessage entity = new GreetingMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); + } + greetingProvider.setMessage(message.getMessage()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + + /** + * CORS set-up for updateGreeting. + */ + @OPTIONS + @Path("/greeting") + @CrossOrigin(value = {"http://foo.com", "http://there.com"}, + allowMethods = {HttpMethod.PUT}) + @APIResponses({ + @APIResponse(name = "normal", responseCode = "200", description = "Preflight request granted"), + @APIResponse(name = "bad preflight", responseCode = "403", + description = "Preflight request denied")}) + public void optionsForUpdatingGreeting() { + } + + /** + * CORS set-up for getDefaultMessage. + */ + @OPTIONS + @CrossOrigin() + public void optionsForRetrievingUnnamedGreeting() { + } + + /** + * CORS set-up for getMessage. + */ + @OPTIONS + @CrossOrigin() + @Path("/{name}") + public void optionsForRetrievingNamedGreeting() { + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new GreetingMessage(msg); + } +} diff --git a/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetingMessage.java b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetingMessage.java new file mode 100644 index 00000000..82934aee --- /dev/null +++ b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023 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.microprofile.examples.cors; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetingProvider.java b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetingProvider.java new file mode 100644 index 00000000..d0726ba4 --- /dev/null +++ b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/GreetingProvider.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2020 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.microprofile.examples.cors; + +import java.util.concurrent.atomic.AtomicReference; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +public class GreetingProvider { + private final AtomicReference message = new AtomicReference<>(); + + /** + * Create a new greeting provider, reading the message from configuration. + * + * @param message greeting to use + */ + @Inject + public GreetingProvider(@ConfigProperty(name = "app.greeting") String message) { + this.message.set(message); + } + + String getMessage() { + return message.get(); + } + + void setMessage(String message) { + this.message.set(message); + } +} diff --git a/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/package-info.java b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/package-info.java new file mode 100644 index 00000000..744088dc --- /dev/null +++ b/examples/microprofile/cors/src/main/java/io/helidon/microprofile/examples/cors/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 2023 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. + */ + +/** + * Helidon MicroProfile CORS example. + */ +package io.helidon.microprofile.examples.cors; diff --git a/examples/microprofile/cors/src/main/resources/META-INF/beans.xml b/examples/microprofile/cors/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..6ea8c3c7 --- /dev/null +++ b/examples/microprofile/cors/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/cors/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/cors/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..a2dfe23f --- /dev/null +++ b/examples/microprofile/cors/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2020 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. +# +app.greeting=Hello + +# Override configuration to use a random port for the unit tests +config_ordinal=1000 +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 diff --git a/examples/microprofile/cors/src/main/resources/logging.properties b/examples/microprofile/cors/src/main/resources/logging.properties new file mode 100644 index 00000000..38c3c808 --- /dev/null +++ b/examples/microprofile/cors/src/main/resources/logging.properties @@ -0,0 +1,30 @@ +# +# Copyright (c) 2020 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.common.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 + +# Component specific log levels +#io.helidon.webserver.cors.level=INFO diff --git a/examples/microprofile/cors/src/test/java/io/helidon/microprofile/examples/cors/TestCORS.java b/examples/microprofile/cors/src/test/java/io/helidon/microprofile/examples/cors/TestCORS.java new file mode 100644 index 00000000..7718bd34 --- /dev/null +++ b/examples/microprofile/cors/src/test/java/io/helidon/microprofile/examples/cors/TestCORS.java @@ -0,0 +1,231 @@ +/* + * Copyright (c) 2020, 2023 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.microprofile.examples.cors; + +import java.util.List; +import java.util.Optional; + +import io.helidon.common.http.Headers; +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.media.jsonb.JsonbSupport; +import io.helidon.microprofile.server.Server; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientRequestBuilder; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.cors.CrossOriginConfig; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.MethodOrderer; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestMethodOrder; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.contains; +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.empty; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.not; + +@TestMethodOrder(MethodOrderer.OrderAnnotation.class) +public class TestCORS { + private static final JsonbSupport JSONB_SUPPORT = JsonbSupport.create(); + + private static WebClient client; + private static Server server; + + @BeforeAll + static void init() { + Config serverConfig = Config.create().get("server"); + Server.Builder serverBuilder = Server.builder(); + serverConfig.ifExists(serverBuilder::config); + server = serverBuilder + .port(-1) // override the port for testing + .build() + .start(); + client = WebClient.builder() + .baseUri("http://localhost:" + server.port()) + .addMediaSupport(JSONB_SUPPORT) + .build(); + } + + @AfterAll + static void cleanup() { + if (server != null) { + server.stop(); + } + } + + @Order(1) // Make sure this runs before the greeting message changes so responses are deterministic. + @Test + public void testHelloWorld() { + + WebClientResponse r = getResponse("/greet"); + + assertThat("HTTP response1", r.status().code(), is(200)); + assertThat("default message", fromPayload(r), is("Hello World!")); + + r = getResponse("/greet/Joe"); + assertThat("HTTP response2", r.status().code(), is(200)); + assertThat("Hello Joe message", fromPayload(r), is("Hello Joe!")); + + r = putResponse("/greet/greeting", "Hola"); + assertThat("HTTP response3", r.status().code(), is(204)); + + r = getResponse("/greet/Jose"); + assertThat("HTTP response4", r.status().code(), is(200)); + assertThat("Hola Jose message", fromPayload(r), is("Hola Jose!")); + + r = getResponse("/health"); + assertThat("HTTP response health", r.status().code(), is(200)); + + r = getResponse("/metrics"); + assertThat("HTTP response metrics", r.status().code(), is(200)); + } + + @Order(10) // Run after the non-CORS tests (so the greeting is Hola) but before the CORS test that changes the greeting again. + @Test + void testAnonymousGreetWithCors() { + WebClientRequestBuilder builder = client.get(); + Headers headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + + WebClientResponse r = getResponse("/greet", builder); + assertThat("HTTP response", r.status().code(), is(200)); + String payload = fromPayload(r); + assertThat("HTTP response payload", payload, is("Hola World!")); + headers = r.headers(); + Optional allowOrigin = headers.value(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("Expected CORS header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN + " is present", + allowOrigin.isPresent(), is(true)); + assertThat("CORS header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN, allowOrigin.get(), is("*")); + } + + @Order(11) // Run after the non-CORS tests but before other CORS tests. + @Test + void testGreetingChangeWithCors() { + + // Send the pre-flight request and check the response. + + WebClientRequestBuilder builder = client.method("OPTIONS"); + Headers headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + headers.add("Access-Control-Request-Method", "PUT"); + + WebClientResponse r = builder.path("/greet/greeting") + .submit() + .await(); + + assertThat("pre-flight status", r.status().code(), is(200)); + Headers preflightResponseHeaders = r.headers(); + List allowMethods = preflightResponseHeaders.values(CrossOriginConfig.ACCESS_CONTROL_ALLOW_METHODS); + assertThat("pre-flight response check for " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_METHODS, + allowMethods, is(not(empty()))); + assertThat("Header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_METHODS, allowMethods, contains("PUT")); + List allowOrigins = preflightResponseHeaders.values(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("pre-flight response check for " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN, + allowOrigins, is(not(empty()))); + assertThat( "Header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN, allowOrigins, contains("http://foo.com")); + + // Send the follow-up request. + + builder = client.put(); + headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + headers.addAll(preflightResponseHeaders); + + r = putResponse("/greet/greeting", "Cheers", builder); + assertThat("HTTP response3", r.status().code(), is(204)); + headers = r.headers(); + allowOrigins = headers.values(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("Expected CORS header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN, + allowOrigins, is(not(empty()))); + assertThat( "Header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN, allowOrigins, contains("http://foo.com")); + } + + @Order(12) // Run after CORS test changes greeting to Cheers. + @Test + void testNamedGreetWithCors() { + WebClientRequestBuilder builder = client.get(); + Headers headers = builder.headers(); + headers.add("Origin", "http://foo.com"); + headers.add("Host", "here.com"); + + WebClientResponse r = getResponse("/greet/Maria", builder); + assertThat("HTTP response", r.status().code(), is(200)); + assertThat(fromPayload(r), containsString("Cheers Maria")); + headers = r.headers(); + Optional allowOrigin = headers.value(CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN); + assertThat("Expected CORS header " + CrossOriginConfig.ACCESS_CONTROL_ALLOW_ORIGIN + " presence check", + allowOrigin.isPresent(), is(true)); + assertThat(allowOrigin.get(), is("*")); + } + + @Order(100) // After all other tests so we can rely on deterministic greetings. + @Test + void testGreetingChangeWithCorsAndOtherOrigin() { + WebClientRequestBuilder builder = client.put(); + Headers headers = builder.headers(); + headers.add("Origin", "http://other.com"); + headers.add("Host", "here.com"); + + WebClientResponse r = putResponse("/greet/greeting", "Ahoy", builder); + // Result depends on whether we are using overrides or not. + boolean isOverriding = Config.create().get("cors").exists(); + assertThat("HTTP response3", r.status().code(), is(isOverriding ? 204 : 403)); + } + + + private static WebClientResponse getResponse(String path) { + return getResponse(path, client.get()); + } + + private static WebClientResponse getResponse(String path, WebClientRequestBuilder builder) { + return builder + .accept(MediaType.APPLICATION_JSON) + .path(path) + .submit() + .await(); + } + + private static String fromPayload(WebClientResponse response) { + GreetingMessage message = response + .content() + .as(GreetingMessage.class) + .await(); + return message.getMessage(); + } + + private static GreetingMessage toPayload(String message) { + return new GreetingMessage(message); + } + private static WebClientResponse putResponse(String path, String message) { + return putResponse(path, message, client.put()); + } + + private static WebClientResponse putResponse(String path, String message, WebClientRequestBuilder builder) { + return builder + .accept(MediaType.APPLICATION_JSON) + .path(path) + .submit(toPayload(message)) + .await(); + } +} diff --git a/examples/microprofile/cors/src/test/resources/logging.properties b/examples/microprofile/cors/src/test/resources/logging.properties new file mode 100644 index 00000000..c08c7458 --- /dev/null +++ b/examples/microprofile/cors/src/test/resources/logging.properties @@ -0,0 +1,39 @@ +# +# Copyright (c) 2020 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.common.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 + +# Component specific log levels +#io.helidon.webserver.cors.level=FINE + +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.microprofile.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO +#org.glassfish.jersey.level=INFO +#org.jboss.weld=INFO diff --git a/examples/microprofile/graphql/README.md b/examples/microprofile/graphql/README.md new file mode 100644 index 00000000..748cef31 --- /dev/null +++ b/examples/microprofile/graphql/README.md @@ -0,0 +1,266 @@ +# Microprofile GraphQL Example + +This example creates a simple Task API using Helidon's implementation of the Microprofile GraphQL API Specification. + +See [here](https://github.com/eclipse/microprofile-graphql) for more information on the +Microprofile GraphQL Specification as well as the [Helidon documentation](https://helidon.io/docs/v2/#/mp/introduction/01_introduction) +for an introduction to using GraphQL in Helidon MP. + +## Running the example + +1. Build + +```shell +mvn clean install +``` + +2. Run the example + +```shell +java -jar target/helidon-examples-microprofile-graphql.jar +``` + +## Issuing GraphQL requests via REST + +Access the `/graphql` endpoint via `http://127.0.0.1:7001/graphql`: + +1. Display the generated GraphQL Schema + + ```shell + curl http://127.0.0.1:7001/graphql/schema.graphql + ``` + + This will produce the following: + + ```graphql + type Mutation { + "Create a task with the given description" + createTask(description: String!): Task + "Remove all completed tasks and return the tasks left" + deleteCompletedTasks: [Task] + "Delete a task and return the deleted task details" + deleteTask(id: String!): Task + "Update a task" + updateTask(completed: Boolean, description: String, id: String!): Task + } + + type Query { + "Return a given task" + findTask(id: String!): Task + "Query tasks and optionally specified only completed" + tasks(completed: Boolean): [Task] + } + + type Task { + completed: Boolean! + createdAt: BigInteger! + description: String + id: String + } + + "Custom: Built-in java.math.BigInteger" + scalar BigInteger + ``` + +1. Create a Task + + ```shell + curl -X POST http://127.0.0.1:7001/graphql -d '{"query":"mutation createTask { createTask(description: \"Task Description 1\") { id description createdAt completed }}"}' + ``` + + Response is a newly created task: + + ```json + {"data":{"createTask":{"id":"0d4a8d","description":"Task Description 1","createdAt":1605501774877,"completed":false}} + ``` + +## Accessing Metrics + +In [TaskApi.java](src/main/java/io/helidon/examples/graphql/basics/TaskApi.java), the [Microprofile Metrics](https://github.com/eclipse/microprofile-metrics) +annotation`@SimplyTimed` has been added to the class which will apply simple timing metrics to all methods. After +exercising the APIs, access the metrics endpoint at http://127.0.0.1:7001/metrics to see all metrics. +In the case below we have also appended `/application` to the URL to just retrieve the application metrics. + +> Note: `jq` has been used to format the JSON output. This can be downloaded from https://stedolan.github.io/jq/download/ or you can +> format the output with an alternate utility. + +```shell +$ curl -H 'Accept: application/json' http://127.0.0.1:7001/metrics/application | jq +``` +```json +{ + "io.helidon.examples.graphql.basics.TaskApi.TaskApi": { + "count": 1, + "elapsedTime": 0.000440414 + }, + "io.helidon.examples.graphql.basics.TaskApi.createTask": { + "count": 1, + "elapsedTime": 0.000112074 + }, + "io.helidon.examples.graphql.basics.TaskApi.deleteCompletedTasks": { + "count": 0, + "elapsedTime": 0 + }, + "io.helidon.examples.graphql.basics.TaskApi.deleteTask": { + "count": 0, + "elapsedTime": 0 + }, + "io.helidon.examples.graphql.basics.TaskApi.findTask": { + "count": 0, + "elapsedTime": 0 + }, + "io.helidon.examples.graphql.basics.TaskApi.getTasks": { + "count": 0, + "elapsedTime": 0 + }, + "io.helidon.examples.graphql.basics.TaskApi.updateTask": { + "count": 0, + "elapsedTime": 0 + } +} +``` + +## Incorporating the GraphiQL UI + +The [GraphiQL UI](https://github.com/graphql/graphiql), which provides a UI to execute GraphQL commands, is not included by default in Helidon's Microprofile GraphQL +implementation. You can follow the guide below to incorporate the UI into this example: + +1. Add the following contents to the sample `examples/microprofile/graphql/src/main/resources/web/index.html` file, which has been included below from [here](https://github.com/graphql/graphiql/blob/main/packages/graphiql/README.md) +for convenience. + + ```html + + + Simple GraphiQL Example + + + +
+ + + + + + + + + ``` + + > Note: If you copy the original file, change the URL in the line `fetch('https://my/graphql', {` to `http://127.0.0.1:7001/graphql` + +1. Build and run the example using the instructions above. + +1. Access the GraphiQL UI via the following URL: http://127.0.0.1:7001/ui. + +2. Copy the following commands into the editor on the left. + + ```graphql + # Fragment to allow shorcut to display all fields for a task + fragment task on Task { + id + description + createdAt + completed + } + + # Create a task + mutation createTask { + createTask(description: "Task Description 1") { + ...task + } + } + + # Find all the tasks + query findAllTasks { + tasks { + ...task + } + } + + # Find a task + query findTask { + findTask(id: "251474") { + ...task + } + } + + # Find completed Tasks + query findCompletedTasks { + tasks(completed: true) { + ...task + } + } + + # Find outstanding Tasks + query findOutstandingTasks { + tasks(completed: false) { + ...task + } + } + + mutation updateTask { + updateTask(id: "251474" description:"New Description") { + ...task + } + } + + mutation completeTask { + updateTask(id: "251474" completed:true) { + ...task + } + } + + # Delete a task + mutation deleteTask { + deleteTask(id: "1f6ae5") { + ...task + } + } + + # Delete completed + mutation deleteCompleted { + deleteCompletedTasks { + ...task + } + } + ``` + +3. Run individual commands by clicking on the `Play` button and choosing the query or mutation to run. + +4. Sample requests + + 1. Execute `createTask` + 2. Change the description and execute `createTask` + 3. Execute `findTask` to show the exception when a task does not exist + 3. Change the id and execute `findTask` to show your newly created task + 5. Execute `findAllTasks` to show the 2 tasks + 6. Change the id and execute `updateTask` to update the existing task + 7. Change the id and execute `completeTask` + 8. Execute `findAllTasks` to show the task completed + 9. Execute `findCompletedTasks` to show only completed tasks + 10. Execute `deleteCompleted` to delete completed task + 11. Execute `findCompletedTasks` to show no completed tasks + + diff --git a/examples/microprofile/graphql/pom.xml b/examples/microprofile/graphql/pom.xml new file mode 100644 index 00000000..4a122229 --- /dev/null +++ b/examples/microprofile/graphql/pom.xml @@ -0,0 +1,69 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-graphql + 1.0.0-SNAPSHOT + Helidon Microprofile Examples GraphQL + + + Usage of GraphQL in Helidon MP + + + + + io.helidon.microprofile.graphql + helidon-microprofile-graphql-server + + + io.helidon.microprofile.bundles + helidon-microprofile + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/Task.java b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/Task.java new file mode 100644 index 00000000..1ed8d580 --- /dev/null +++ b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/Task.java @@ -0,0 +1,133 @@ +/* + * Copyright (c) 2020 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.graphql.basics; + +import java.util.UUID; + +import io.helidon.common.Reflected; + +import org.eclipse.microprofile.graphql.NonNull; + +/** + * A data class representing a single To Do List task. + */ +@Reflected +public class Task { + + /** + * The creation time. + */ + private long createdAt; + + /** + * The completion status. + */ + private boolean completed; + + /** + * The task ID. + */ + @NonNull + private String id; + + /** + * The task description. + */ + @NonNull + private String description; + + /** + * Deserialization constructor. + */ + public Task() { + } + + /** + * Construct Task instance. + * + * @param description task description + */ + public Task(String description) { + this.id = UUID.randomUUID().toString().substring(0, 6); + this.createdAt = System.currentTimeMillis(); + this.description = description; + this.completed = false; + } + + /** + * Get the creation time. + * + * @return the creation time + */ + public long getCreatedAt() { + return createdAt; + } + + /** + * Get the task ID. + * + * @return the task ID + */ + public String getId() { + return id; + } + + /** + * Get the task description. + * + * @return the task description + */ + public String getDescription() { + return description; + } + + /** + * Set the task description. + * + * @param description the task description + */ + public void setDescription(String description) { + this.description = description; + } + + /** + * Get the completion status. + * + * @return true if it is completed, false otherwise. + */ + public boolean isCompleted() { + return completed; + } + + /** + * Sets the completion status. + * + * @param completed the completion status + */ + public void setCompleted(boolean completed) { + this.completed = completed; + } + + @Override + public String toString() { + return "Task{" + + "id=" + id + + ", description=" + description + + ", completed=" + completed + + '}'; + } +} diff --git a/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/TaskApi.java b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/TaskApi.java new file mode 100644 index 00000000..bc0609c8 --- /dev/null +++ b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/TaskApi.java @@ -0,0 +1,150 @@ +/* + * Copyright (c) 2020, 2021 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.graphql.basics; + +import java.util.Collection; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + +import javax.enterprise.context.ApplicationScoped; + +import org.eclipse.microprofile.graphql.Description; +import org.eclipse.microprofile.graphql.GraphQLApi; +import org.eclipse.microprofile.graphql.Mutation; +import org.eclipse.microprofile.graphql.Name; +import org.eclipse.microprofile.graphql.NonNull; +import org.eclipse.microprofile.graphql.Query; +import org.eclipse.microprofile.metrics.annotation.SimplyTimed; + +/** + * A CDI Bean that exposes a GraphQL API to query and mutate {@link Task}s. + */ +@GraphQLApi +@ApplicationScoped +@SimplyTimed +public class TaskApi { + + private static final String MESSAGE = "Unable to find task with id "; + + private Map tasks = new ConcurrentHashMap<>(); + + /** + * Create a {@link Task}. + * + * @param description task description + * @return the created {@link Task} + */ + @Mutation + @Description("Create a task with the given description") + public Task createTask(@Name("description") @NonNull String description) { + if (description == null) { + throw new IllegalArgumentException("Description must be provided"); + } + Task task = new Task(description); + tasks.put(task.getId(), task); + return task; + } + + /** + * Query {@link Task}s. + * + * @param completed optionally specify completion status + * @return a {@link Collection} of {@link Task}s + */ + @Query + @Description("Query tasks and optionally specify only completed") + public Collection getTasks(@Name("completed") Boolean completed) { + return tasks.values().stream() + .filter(task -> completed == null || task.isCompleted() == completed) + .collect(Collectors.toList()); + } + + /** + * Return a {@link Task}. + * + * @param id task id + * @return the {@link Task} with the given id + * @throws TaskNotFoundException if the task was not found + */ + @Query + @Description("Return a given task") + public Task findTask(@Name("id") @NonNull String id) throws TaskNotFoundException { + return Optional.ofNullable(tasks.get(id)) + .orElseThrow(() -> new TaskNotFoundException(MESSAGE + id)); + } + + /** + * Delete a {@link Task}. + * + * @param id task to delete + * @return the deleted {@link Task} + * @throws TaskNotFoundException if the task was not found + */ + @Mutation + @Description("Delete a task and return the deleted task details") + public Task deleteTask(@Name("id") @NonNull String id) throws TaskNotFoundException { + return Optional.ofNullable(tasks.remove(id)) + .orElseThrow(() -> new TaskNotFoundException(MESSAGE + id)); + } + + /** + * Remove all completed {@link Task}s. + * + * @return the {@link Task}s left + */ + @Mutation + @Description("Remove all completed tasks and return the tasks left") + public Collection deleteCompletedTasks() { + tasks.values().removeIf(Task::isCompleted); + return tasks.values(); + } + + /** + * Update a {@link Task}. + * + * @param id task to update + * @param description optional description + * @param completed optional completed + * @return the updated {@link Task} + * @throws TaskNotFoundException if the task was not found + */ + @Mutation + @Description("Update a task") + public Task updateTask(@Name("id") @NonNull String id, + @Name("description") String description, + @Name("completed") Boolean completed) throws TaskNotFoundException { + + try { + return tasks.compute(id, (k, v) -> { + Objects.requireNonNull(v); + + if (description != null) { + v.setDescription(description); + } + if (completed != null) { + v.setCompleted(completed); + } + return v; + }); + } catch (Exception e) { + throw new TaskNotFoundException(MESSAGE + id); + } + } +} diff --git a/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/TaskNotFoundException.java b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/TaskNotFoundException.java new file mode 100644 index 00000000..12a4cbe5 --- /dev/null +++ b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/TaskNotFoundException.java @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2020 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.graphql.basics; + +/** + * An exception indicating that a {@link Task} was not found. + */ +public class TaskNotFoundException extends Exception { + /** + * Create the exception. + * @param message reason for the exception. + */ + public TaskNotFoundException(String message) { + super(message); + } +} diff --git a/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/package-info.java b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/package-info.java new file mode 100644 index 00000000..f9b68f8a --- /dev/null +++ b/examples/microprofile/graphql/src/main/java/io/helidon/examples/graphql/basics/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 2021 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. + */ + +/** + * A set of small usage examples. Start with {@link io.helidon.grpc.examples.basics.Main} class. + */ +package io.helidon.examples.graphql.basics; diff --git a/examples/microprofile/graphql/src/main/resources/META-INF/beans.xml b/examples/microprofile/graphql/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..e5a9e54a --- /dev/null +++ b/examples/microprofile/graphql/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/graphql/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/graphql/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..6c47520d --- /dev/null +++ b/examples/microprofile/graphql/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2020 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. +# + +server.static.classpath.context=/ui +server.static.classpath.location=/web +graphql.cors=Access-Control-Allow-Origin +mp.graphql.exceptionsWhiteList=java.lang.IllegalArgumentException diff --git a/examples/microprofile/graphql/src/main/resources/logging.properties b/examples/microprofile/graphql/src/main/resources/logging.properties new file mode 100644 index 00000000..d777fc77 --- /dev/null +++ b/examples/microprofile/graphql/src/main/resources/logging.properties @@ -0,0 +1,24 @@ +# +# Copyright (c) 2020 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler + +io.helidon.common.HelidonConsoleHandler.level=ALL +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 + +#All log level details +.level=WARNING +io.helidon.level=INFO diff --git a/examples/microprofile/graphql/src/main/resources/web/index.html b/examples/microprofile/graphql/src/main/resources/web/index.html new file mode 100644 index 00000000..e83b9cc7 --- /dev/null +++ b/examples/microprofile/graphql/src/main/resources/web/index.html @@ -0,0 +1,23 @@ + + + + + Sample + +

To enable GraphiQL UI please see the Microprofile GraphQL example README.md

+

+ \ No newline at end of file diff --git a/examples/microprofile/hello-world-explicit/README.md b/examples/microprofile/hello-world-explicit/README.md new file mode 100644 index 00000000..e93f7a68 --- /dev/null +++ b/examples/microprofile/hello-world-explicit/README.md @@ -0,0 +1,20 @@ +# Helidon MP Hello World Explicit Example + +This examples shows a simple application written using Helidon MP. +It is explicit because in this example you write the `main` class +and explicitly start the microprofile server. + +```shell +mvn package +java -jar target/helidon-examples-microprofile-hello-world-explicit.jar +``` + +Then try the endpoints: + +```shell +curl -X GET http://localhost:7001/helloworld +curl -X GET http://localhost:7001/helloworld/earth +``` + +By default the server will use a dynamic port, see the messages displayed +when the application starts. diff --git a/examples/microprofile/hello-world-explicit/pom.xml b/examples/microprofile/hello-world-explicit/pom.xml new file mode 100644 index 00000000..6127f125 --- /dev/null +++ b/examples/microprofile/hello-world-explicit/pom.xml @@ -0,0 +1,79 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + + io.helidon.examples.microprofile + helidon-examples-microprofile-hello-world-explicit + 1.0.0-SNAPSHOT + Helidon Microprofile Examples Explicit Hello World + + + Microprofile example with explicit bootstrapping (Server.create(Application.class).start()) + + + + io.helidon.microprofile.example.helloworld.explicit.Main + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/HelloWorldResource.java b/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/HelloWorldResource.java new file mode 100644 index 00000000..74154264 --- /dev/null +++ b/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/HelloWorldResource.java @@ -0,0 +1,98 @@ +/* + * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.example.helloworld.explicit; + +import java.net.URI; +import java.util.Collections; + +import javax.enterprise.context.RequestScoped; +import javax.enterprise.inject.spi.BeanManager; +import javax.inject.Inject; +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +import io.helidon.config.Config; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Example resource. + */ +@Path("helloworld") +@RequestScoped +public class HelloWorldResource { + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + private final Config config; + private final String applicationName; + private final URI applicationUri; + private BeanManager beanManager; + + /** + * Constructor injection of field values. + * + * @param config configuration instance + * @param appName name of application from config (app.name) + * @param appUri URI of application from config (app.uri) + * @param beanManager bean manager (injected automatically by CDI) + */ + @Inject + public HelloWorldResource(Config config, + @ConfigProperty(name = "app.name") String appName, + @ConfigProperty(name = "app.uri") URI appUri, + BeanManager beanManager) { + this.config = config; + this.applicationName = appName; + this.applicationUri = appUri; + this.beanManager = beanManager; + } + + /** + * Hello world GET method. + * + * @return string with application name + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public String message() { + return "Hello World from application " + applicationName; + } + + /** + * Hello World GET method returning JSON. + * + * @param name name to add to response + * @return JSON with name and configured fields of this class + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public JsonObject getHello(@PathParam("name") String name) { + return JSON.createObjectBuilder() + .add("name", name) + .add("appName", applicationName) + .add("appUri", String.valueOf(applicationUri)) + .add("config", config.get("my.property").asString().get()) + .add("beanManager", beanManager.toString()) + .build(); + } +} diff --git a/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/Main.java b/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/Main.java new file mode 100644 index 00000000..b0e580ba --- /dev/null +++ b/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/Main.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2018, 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.microprofile.example.helloworld.explicit; + +import io.helidon.microprofile.server.Server; + +/** + * Explicit example. + */ +public class Main { + private Main() { + } + + /** + * Starts server manually. + * + * @param args command line arguments (ignored) + */ + public static void main(String[] args) { + Server server = Server.builder() + .host("localhost") + // use a random free port + .port(7001) + .build(); + + server.start(); + + String endpoint = "http://" + server.host() + ":" + server.port(); + System.out.println("Started application on " + endpoint + "/helloworld"); + System.out.println("Metrics available on " + endpoint + "/metrics"); + System.out.println("Heatlh checks available on " + endpoint + "/health"); + + } +} diff --git a/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/package-info.java b/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/package-info.java new file mode 100644 index 00000000..3147b7ff --- /dev/null +++ b/examples/microprofile/hello-world-explicit/src/main/java/io/helidon/microprofile/example/helloworld/explicit/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved. + * + * 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. + */ + +/** + * Explicit example (configures server and resources). + */ +package io.helidon.microprofile.example.helloworld.explicit; diff --git a/examples/microprofile/hello-world-explicit/src/main/resources/META-INF/beans.xml b/examples/microprofile/hello-world-explicit/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..8a67108b --- /dev/null +++ b/examples/microprofile/hello-world-explicit/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/hello-world-explicit/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/hello-world-explicit/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..0a58d35b --- /dev/null +++ b/examples/microprofile/hello-world-explicit/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,23 @@ +# +# Copyright (c) 2020 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. +# + +app.name=Hello World Application +app.uri=https://www.example.com + +my.property=propertyValue + +# Enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=true diff --git a/examples/microprofile/hello-world-explicit/src/main/resources/logging.properties b/examples/microprofile/hello-world-explicit/src/main/resources/logging.properties new file mode 100644 index 00000000..0615cfef --- /dev/null +++ b/examples/microprofile/hello-world-explicit/src/main/resources/logging.properties @@ -0,0 +1,24 @@ +# +# Copyright (c) 2018, 2020 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler + +io.helidon.common.HelidonConsoleHandler.level=ALL +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 + +#All log level details +.level=WARNING +io.helidon.level=INFO diff --git a/examples/microprofile/hello-world-implicit/README.md b/examples/microprofile/hello-world-implicit/README.md new file mode 100644 index 00000000..e8d812a9 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/README.md @@ -0,0 +1,20 @@ +# Helidon MP Hello World Implicit Example + +This examples shows a simple application written using Helidon MP. +It is implicit because in this example you don't write the +`main` class, instead you rely on the Microprofile Server main class. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-hello-world-implicit.jar +``` + +Then try the endpoints: + +```shell +curl -X GET http://localhost:7001/helloworld +curl -X GET http://localhost:7001/helloworld/earth +curl -X GET http://localhost:7001/another +``` diff --git a/examples/microprofile/hello-world-implicit/pom.xml b/examples/microprofile/hello-world-implicit/pom.xml new file mode 100644 index 00000000..a2b2961d --- /dev/null +++ b/examples/microprofile/hello-world-implicit/pom.xml @@ -0,0 +1,89 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-hello-world-implicit + 1.0.0-SNAPSHOT + Helidon Microprofile Examples Implicit Hello World + + + Microprofile example with implicit bootstrapping (cdi.Main(new String[0]) + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/AnotherResource.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/AnotherResource.java new file mode 100644 index 00000000..cce3c586 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/AnotherResource.java @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2018,2020 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.microprofile.example.helloworld.implicit; + +import java.net.URI; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.inject.Provider; +import javax.ws.rs.GET; +import javax.ws.rs.Path; + +import org.eclipse.microprofile.config.Config; +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Resource showing all possible configuration injections. + */ +@Path("another") +@RequestScoped +public class AnotherResource { + @Inject + @ConfigProperty(name = "app.nonExistent", defaultValue = "145") + private int defaultValue; + + @Inject + @ConfigProperty(name = "app.nonExistent") + private Optional empty; + + @Inject + @ConfigProperty(name = "app.uri") + private Optional full; + + @Inject + @ConfigProperty(name = "app.someInt") + private Provider provider; + + @Inject + @ConfigProperty(name = "app.ints") + private List ints; + + @Inject + @ConfigProperty(name = "app.ints") + private Optional> optionalInts; + + @Inject + @ConfigProperty(name = "app.ints") + private Provider> providedInts; + + @Inject + @ConfigProperty(name = "app.ints") + private int[] intsArray; + + @Inject + @ConfigProperty(name = "app") + private Map detached; + + @Inject + private Config mpConfig; + + @Inject + private io.helidon.config.Config helidonConfig; + + /** + * Get method to validate that all injections worked. + * + * @return data from all fields of this class + */ + @GET + public String get() { + return toString(); + } + + @Override + public String toString() { + return "AnotherResource{" + + "defaultValue=" + defaultValue + + ", empty=" + empty + + ", full=" + full + + ", provider=" + provider + "(" + provider.get() + ")" + + ", ints=" + ints + + ", optionalInts=" + optionalInts + + ", providedInts=" + providedInts + "(" + providedInts.get() + ")" + + ", detached=" + detached + + ", microprofileConfig=" + mpConfig + + ", helidonConfig=" + helidonConfig + + ", intsArray=" + Arrays.toString(intsArray) + + '}'; + } +} diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/HelloWorldResource.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/HelloWorldResource.java new file mode 100644 index 00000000..696976d8 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/HelloWorldResource.java @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.example.helloworld.implicit; + +import java.net.URI; +import java.util.Collections; +import java.util.logging.Logger; + +import javax.enterprise.context.RequestScoped; +import javax.enterprise.inject.spi.BeanManager; +import javax.inject.Inject; +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +import io.helidon.config.Config; +import io.helidon.microprofile.example.helloworld.implicit.cdi.LoggerQualifier; +import io.helidon.microprofile.example.helloworld.implicit.cdi.RequestId; +import io.helidon.microprofile.example.helloworld.implicit.cdi.ResourceProducer; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Resource for hello world example. + */ +@Path("helloworld") +@RequestScoped +public class HelloWorldResource { + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private final Config config; + private final Logger logger; + private final int requestId; + private final String applicationName; + private final URI applicationUri; + private BeanManager beanManager; + + /** + * Using constructor injection for field values. + * + * @param config configuration instance + * @param logger logger (from {@link ResourceProducer} + * @param requestId requestId (from {@link ResourceProducer} + * @param appName name from configuration (app.name) + * @param appUri URI from configuration (app.uri) + * @param beanManager bean manager (injected automatically by CDI) + */ + @Inject + public HelloWorldResource(Config config, + @LoggerQualifier Logger logger, + @RequestId int requestId, + @ConfigProperty(name = "app.name") String appName, + @ConfigProperty(name = "app.uri") URI appUri, + BeanManager beanManager) { + this.config = config; + this.logger = logger; + this.requestId = requestId; + this.applicationName = appName; + this.applicationUri = appUri; + this.beanManager = beanManager; + } + + /** + * Get method for this resource, shows logger and request id. + * + * @return hello world + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public String message() { + return "Hello World: " + logger + ", request: " + requestId + ", appName: " + applicationName; + } + + /** + * Get method for this resource, returning JSON. + * + * @param name name to add to response + * @return JSON structure with injected fields + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public JsonObject getHello(@PathParam("name") String name) { + return JSON.createObjectBuilder() + .add("name", name) + .add("requestId", requestId) + .add("appName", applicationName) + .add("appUri", String.valueOf(applicationUri)) + .add("config", config.get("server.port").asInt().get()) + .add("beanManager", beanManager.toString()) + .add("logger", logger.getName()) + .build(); + } +} diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/LoggerQualifier.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/LoggerQualifier.java new file mode 100644 index 00000000..89f37b7a --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/LoggerQualifier.java @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2018, 2021 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.microprofile.example.helloworld.implicit.cdi; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import javax.inject.Qualifier; + +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +/** + * Use this qualifier to inject logger instances. + */ +@Qualifier +@Retention(RUNTIME) +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE}) +public @interface LoggerQualifier { +} diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/RequestId.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/RequestId.java new file mode 100644 index 00000000..9a5f6ec2 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/RequestId.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2018, 2021 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.microprofile.example.helloworld.implicit.cdi; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import javax.inject.Qualifier; + +/** + * Request id qualifier to inject increasing request id. + */ +@Qualifier +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE}) +public @interface RequestId { +} diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/RequestIdProducer.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/RequestIdProducer.java new file mode 100644 index 00000000..6b720fab --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/RequestIdProducer.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2018, 2021 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.microprofile.example.helloworld.implicit.cdi; + +import javax.enterprise.context.ApplicationScoped; + +/** + * Produce an ever increasing request id. + */ +@ApplicationScoped +public class RequestIdProducer { + +} diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/ResourceProducer.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/ResourceProducer.java new file mode 100644 index 00000000..c694c51e --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/ResourceProducer.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2018, 2021 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.microprofile.example.helloworld.implicit.cdi; + +import java.util.concurrent.atomic.AtomicInteger; + +import javax.enterprise.context.ApplicationScoped; +import javax.enterprise.inject.Produces; +import javax.enterprise.inject.spi.InjectionPoint; + +/** + * Producer for various resources required by this example. + */ +@ApplicationScoped +public class ResourceProducer { + private static final AtomicInteger COUNTER = new AtomicInteger(); + + /** + * Each injection will increase the COUNTER. + * + * @return increased COUNTER value + */ + @Produces + @RequestId + public int produceRequestId() { + return COUNTER.incrementAndGet(); + } + + /** + * Create/get a logger instance for the class that the logger is being injected into. + * + * @param injectionPoint injection point + * @return a logger instance + */ + @Produces + @LoggerQualifier + public java.util.logging.Logger produceLogger(final InjectionPoint injectionPoint) { + return java.util.logging.Logger.getLogger(injectionPoint.getMember().getDeclaringClass().getName()); + } +} diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/package-info.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/package-info.java new file mode 100644 index 00000000..3de41659 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/cdi/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 2021 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. + */ + +/** + * CDI classes for example. + */ +package io.helidon.microprofile.example.helloworld.implicit.cdi; diff --git a/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/package-info.java b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/package-info.java new file mode 100644 index 00000000..11dc177a --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/java/io/helidon/microprofile/example/helloworld/implicit/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved. + * + * 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. + */ + +/** + * Implicit HelloWorld example (starts server without configuration). + */ +package io.helidon.microprofile.example.helloworld.implicit; diff --git a/examples/microprofile/hello-world-implicit/src/main/resources/META-INF/beans.xml b/examples/microprofile/hello-world-implicit/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..83ee6b69 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/hello-world-implicit/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/hello-world-implicit/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..bbae60a1 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2020 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. +# + +app.name=Hello World Application +app.someInt=147 +app.uri=https://www.example.com +app.someInt=147 +app.ints=12,12,32,12,44 + +server.port=7001 + +# Enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=true diff --git a/examples/microprofile/hello-world-implicit/src/main/resources/logging.properties b/examples/microprofile/hello-world-implicit/src/main/resources/logging.properties new file mode 100644 index 00000000..7b0371c8 --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2018, 2021 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.config.level=FINEST diff --git a/examples/microprofile/hello-world-implicit/src/test/java/io/helidon/microprofile/example/helloworld/implicit/ImplicitHelloWorldTest.java b/examples/microprofile/hello-world-implicit/src/test/java/io/helidon/microprofile/example/helloworld/implicit/ImplicitHelloWorldTest.java new file mode 100644 index 00000000..69ba46ec --- /dev/null +++ b/examples/microprofile/hello-world-implicit/src/test/java/io/helidon/microprofile/example/helloworld/implicit/ImplicitHelloWorldTest.java @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2018, 2021 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.microprofile.example.helloworld.implicit; + +import javax.inject.Inject; +import javax.json.JsonObject; +import javax.ws.rs.client.WebTarget; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; +import static org.junit.jupiter.api.Assertions.assertAll; + +/** + * Unit test for {@link HelloWorldResource}. + */ +@HelidonTest +class ImplicitHelloWorldTest { + private final WebTarget target; + + @Inject + ImplicitHelloWorldTest(WebTarget target) { + this.target = target; + } + @Test + void testJsonResource() { + JsonObject jsonObject = target + .path("/helloworld/unit") + .request() + .get(JsonObject.class); + + assertAll("JSON fields must match expected injection values", + () -> assertThat("Name from request", jsonObject.getString("name"), is("unit")), + () -> assertThat("Request id from CDI provider", jsonObject.getInt("requestId"), is(1)), + () -> assertThat("App name from config", jsonObject.getString("appName"), is("Hello World Application")), + () -> assertThat("Logger name", jsonObject.getString("logger"), is(HelloWorldResource.class.getName())) + ); + + } +} diff --git a/examples/microprofile/http-status-count-mp/README.md b/examples/microprofile/http-status-count-mp/README.md new file mode 100644 index 00000000..a2f8acce --- /dev/null +++ b/examples/microprofile/http-status-count-mp/README.md @@ -0,0 +1,76 @@ +# http-status-count-mp + +This Helidon MP project illustrates a filter which updates a family of counters based on the HTTP status returned in each response. + +The addition of the single filter class `HttpStatusMetricFilter` is the only difference from the Helidon MP QuickStart project. + +## Incorporating status metrics into your own application +Use this example for inspiration in writing your own filter or just use the filter directly in your own application by copying and pasting the `HttpStatusMetricFilter` class into your application, adjusting the package declaration as needed. Helidon MP discovers and uses your filter automatically. + +## Build and run + +```shell +mvn package +java -jar target/http-status-count-mp.jar +``` + +## Exercise the application +```shell +curl -X GET http://localhost:8080/simple-greet +``` +```json +{"message":"Hello World!"} +``` + +```shell +curl -X GET http://localhost:8080/greet +``` +```json +{"message":"Hello World!"} +``` +```shell +curl -X GET http://localhost:8080/greet/Joe +``` +```json +{"message":"Hello Joe!"} +``` +```shell +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +``` +```json +{"message":"Hola Jose!"} +``` + +## Try metrics +```shell +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics/application +``` + +```listing +... +# TYPE application_httpStatus_total counter +# HELP application_httpStatus_total Counts the number of HTTP responses in each status category (1xx, 2xx, etc.) +application_httpStatus_total{range="1xx"} 0 +application_httpStatus_total{range="2xx"} 5 +application_httpStatus_total{range="3xx"} 0 +application_httpStatus_total{range="4xx"} 0 +application_httpStatus_total{range="5xx"} 0 +... +``` +# JSON Format + +```shell +curl -H "Accept: application/json" -X GET http://localhost:8080/metrics +``` +```json +{ +... + "httpStatus;range=1xx": 0, + "httpStatus;range=2xx": 5, + "httpStatus;range=3xx": 0, + "httpStatus;range=4xx": 0, + "httpStatus;range=5xx": 0, +... diff --git a/examples/microprofile/http-status-count-mp/app.yaml b/examples/microprofile/http-status-count-mp/app.yaml new file mode 100644 index 00000000..7f243250 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/app.yaml @@ -0,0 +1,32 @@ +# +# Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved. +# +# 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: http-status-count-mp + labels: + app: http-status-count-mp +spec: + type: NodePort + selector: + app: http-status-count-mp + ports: + - port: 8080 + targetPort: 8080 + name: http +--- + diff --git a/examples/microprofile/http-status-count-mp/pom.xml b/examples/microprofile/http-status-count-mp/pom.xml new file mode 100644 index 00000000..c65b941e --- /dev/null +++ b/examples/microprofile/http-status-count-mp/pom.xml @@ -0,0 +1,127 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples + http-status-count-mp + 1.0-SNAPSHOT + + Helidon Examples Metrics HTTP Status Counters + + + 2.6.8-SNAPSHOT + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + com.fasterxml.jackson.core + jackson-databind + + + io.helidon.media + helidon-media-jackson + + + org.eclipse.microprofile.metrics + microprofile-metrics-api + + + io.helidon.microprofile.metrics + helidon-microprofile-metrics + + + io.helidon.microprofile.health + helidon-microprofile-health + + + org.jboss + jandex + runtime + + + jakarta.activation + jakarta.activation-api + runtime + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + org.glassfish.jersey.media + jersey-media-json-binding + runtime + + + io.helidon.webclient + helidon-webclient + + + org.junit.jupiter + junit-jupiter-api + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/GreetResource.java b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/GreetResource.java new file mode 100644 index 00000000..998f9857 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/GreetResource.java @@ -0,0 +1,129 @@ +/* + * Copyright (c) 2022, 2023 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.mp.httpstatuscount; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import org.eclipse.microprofile.openapi.annotations.enums.SchemaType; +import org.eclipse.microprofile.openapi.annotations.media.Content; +import org.eclipse.microprofile.openapi.annotations.media.Schema; +import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponses; + +/** + * A simple JAX-RS resource to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object. + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + + /** + * The greeting message provider. + */ + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a worldly greeting message. + * + * @return {@link Message} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public Message getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link Message} + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public Message getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message the new greeting message + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + @RequestBody(name = "greeting", + required = true, + content = @Content(mediaType = "application/json", + schema = @Schema(type = SchemaType.OBJECT, requiredProperties = { "greeting" }))) + @APIResponses({ + @APIResponse(name = "normal", responseCode = "204", description = "Greeting updated"), + @APIResponse(name = "missing 'greeting'", responseCode = "400", + description = "JSON did not contain setting for 'greeting'")}) + public Response updateGreeting(Message message) { + + if (message.getGreeting() == null || message.getGreeting().isEmpty()) { + Message error = new Message(); + error.setMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(error).build(); + } + + greetingProvider.setMessage(message.getGreeting()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + + private Message createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new Message(msg); + } +} diff --git a/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/GreetingProvider.java b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/GreetingProvider.java new file mode 100644 index 00000000..b99bd81c --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/GreetingProvider.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2022, 2023 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.mp.httpstatuscount; + +import java.util.concurrent.atomic.AtomicReference; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +public class GreetingProvider { + private final AtomicReference message = new AtomicReference<>(); + + /** + * Create a new greeting provider, reading the message from configuration. + * + * @param message greeting to use + */ + @Inject + public GreetingProvider(@ConfigProperty(name = "app.greeting") String message) { + this.message.set(message); + } + + String getMessage() { + return message.get(); + } + + void setMessage(String message) { + this.message.set(message); + } +} diff --git a/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/HttpStatusMetricFilter.java b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/HttpStatusMetricFilter.java new file mode 100644 index 00000000..a03ff82b --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/HttpStatusMetricFilter.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2022, 2023 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.mp.httpstatuscount; + +import java.io.IOException; + +import javax.annotation.PostConstruct; +import javax.inject.Inject; +import javax.ws.rs.ConstrainedTo; +import javax.ws.rs.RuntimeType; +import javax.ws.rs.container.ContainerRequestContext; +import javax.ws.rs.container.ContainerResponseContext; +import javax.ws.rs.container.ContainerResponseFilter; +import javax.ws.rs.ext.Provider; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.Metadata; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.MetricType; +import org.eclipse.microprofile.metrics.MetricUnits; +import org.eclipse.microprofile.metrics.Tag; + +/** + * REST service filter to update a family of counters based on the HTTP status of each response. + *

+ * The filter uses one {@link org.eclipse.microprofile.metrics.Counter} for each HTTP status family (1xx, 2xx, etc.). + * All counters share the same name--{@value STATUS_COUNTER_NAME}--and each has the tag {@value STATUS_TAG_NAME} with + * value {@code 1xx}, {@code 2xx}, etc. + *

+ */ +@ConstrainedTo(RuntimeType.SERVER) +@Provider +public class HttpStatusMetricFilter implements ContainerResponseFilter { + + static final String STATUS_COUNTER_NAME = "httpStatus"; + static final String STATUS_TAG_NAME = "range"; + + @Inject + private MetricRegistry metricRegistry; + + private final Counter[] responseCounters = new Counter[6]; + + @PostConstruct + private void init() { + Metadata metadata = Metadata.builder() + .withName(STATUS_COUNTER_NAME) + .withDisplayName("HTTP response values") + .withDescription("Counts the number of HTTP responses in each status category (1xx, 2xx, etc.)") + .withType(MetricType.COUNTER) + .withUnit(MetricUnits.NONE) + .build(); + // Declare the counters and keep references to them. + for (int i = 1; i < responseCounters.length; i++) { + responseCounters[i] = metricRegistry.counter(metadata, new Tag(STATUS_TAG_NAME, i + "xx")); + } + } + + @Override + public void filter(ContainerRequestContext containerRequestContext, ContainerResponseContext containerResponseContext) + throws IOException { + updateCountForStatus(containerResponseContext.getStatus()); + } + + private void updateCountForStatus(int statusCode) { + int range = statusCode / 100; + if (range > 0 && range < responseCounters.length) { + responseCounters[range].inc(); + } + } +} diff --git a/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/Message.java b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/Message.java new file mode 100644 index 00000000..2546068d --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/Message.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2022, 2023 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.mp.httpstatuscount; + +/** + * Message sent as greetings to client. + */ +public class Message { + + private String message; + + private String greeting; + + /** + * Creates a new message instance. + */ + public Message() { + } + + /** + * Creates a new message instance with an initial greeting. + * @param message initial greeting message + */ + public Message(String message) { + this.message = message; + } + + /** + * Sets the greeting message. + * + * @param message message to set + */ + public void setMessage(String message) { + this.message = message; + } + + /** + * + * @return the greeting + */ + public String getMessage() { + return this.message; + } + + /** + * Sets the greeting. + * + * @param greeting new greeting + */ + public void setGreeting(String greeting) { + this.greeting = greeting; + } + + /** + * + * @return the greeting + */ + public String getGreeting() { + return this.greeting; + } +} diff --git a/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/SimpleGreetResource.java b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/SimpleGreetResource.java new file mode 100644 index 00000000..65828668 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/SimpleGreetResource.java @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2022, 2023 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.mp.httpstatuscount; + +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +import org.eclipse.microprofile.config.inject.ConfigProperty; +import org.eclipse.microprofile.metrics.MetricUnits; +import org.eclipse.microprofile.metrics.annotation.Counted; +import org.eclipse.microprofile.metrics.annotation.Timed; + +/** + * A simple JAX-RS resource to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/simple-greet + * + * The message is returned as a JSON object. + */ +@Path("/simple-greet") +public class SimpleGreetResource { + + private static final String PERSONALIZED_GETS_COUNTER_NAME = "personalizedGets"; + private static final String PERSONALIZED_GETS_COUNTER_DESCRIPTION = "Counts personalized GET operations"; + private static final String GETS_TIMER_NAME = "allGets"; + private static final String GETS_TIMER_DESCRIPTION = "Tracks all GET operations"; + private final String message; + + /** + * Creates a new instance using the configured default initial greeting. + * + * @param message configured initial greeting message + */ + @Inject + public SimpleGreetResource(@ConfigProperty(name = "app.greeting") String message) { + this.message = message; + } + + /** + * Return a worldly greeting message. + * + * @return {@link Message} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public Message getDefaultMessage() { + String msg = String.format("%s %s!", message, "World"); + Message message = new Message(); + message.setMessage(msg); + return message; + } + + /** + * Returns a personalized greeting. + * + * @param name name to use in personalizing the greeting + * @return the personalized greeting + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Counted(name = PERSONALIZED_GETS_COUNTER_NAME, + absolute = true, + description = PERSONALIZED_GETS_COUNTER_DESCRIPTION) + @Timed(name = GETS_TIMER_NAME, + description = GETS_TIMER_DESCRIPTION, + unit = MetricUnits.SECONDS, + absolute = true) + public String getMessage(@PathParam("name") String name) { + return String.format("Hello %s", name); + } + +} diff --git a/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/package-info.java b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/package-info.java new file mode 100644 index 00000000..5892581e --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/java/io/helidon/examples/mp/httpstatuscount/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2022, 2023 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. + */ +/** + * HTTP status counter example. + */ +package io.helidon.examples.mp.httpstatuscount; diff --git a/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/beans.xml b/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..5d94aab5 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,8 @@ + + + diff --git a/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..e3b22ac3 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,11 @@ +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +# Change the following to true to enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=false + +# Application properties. This is the default greeting +app.greeting=Hello + + diff --git a/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/native-image/reflect-config.json b/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/native-image/reflect-config.json new file mode 100644 index 00000000..fe51488c --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/resources/META-INF/native-image/reflect-config.json @@ -0,0 +1 @@ +[] diff --git a/examples/microprofile/http-status-count-mp/src/main/resources/application.yaml b/examples/microprofile/http-status-count-mp/src/main/resources/application.yaml new file mode 100644 index 00000000..c76b4864 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/resources/application.yaml @@ -0,0 +1,16 @@ +# +# Copyright (c) 2022 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. +# +server.port: 8080 \ No newline at end of file diff --git a/examples/microprofile/http-status-count-mp/src/main/resources/logging.properties b/examples/microprofile/http-status-count-mp/src/main/resources/logging.properties new file mode 100644 index 00000000..33743521 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/main/resources/logging.properties @@ -0,0 +1,36 @@ +# +# Copyright (c) 2022 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/MainTest.java b/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/MainTest.java new file mode 100644 index 00000000..6de8b584 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/MainTest.java @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2022, 2023 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.mp.httpstatuscount; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import javax.inject.Inject; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; +import javax.ws.rs.client.Entity; +import javax.ws.rs.core.MediaType; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.junit.jupiter.api.MethodOrderer; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestMethodOrder; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +@HelidonTest +@TestMethodOrder(MethodOrderer.MethodName.class) +public class MainTest { + + @Inject + private MetricRegistry registry; + + @Inject + private WebTarget target; + + + @Test + public void testMicroprofileMetrics() { + String message = target.path("simple-greet/Joe") + .request() + .get(String.class); + + assertThat(message, is("Hello Joe")); + Counter counter = registry.counter("personalizedGets"); + double before = counter.getCount(); + + message = target.path("simple-greet/Eric") + .request() + .get(String.class); + + assertThat(message, is("Hello Eric")); + double after = counter.getCount(); + assertThat("Difference in personalized greeting counter between successive calls", after - before, is(1d)); + } + + @Test + public void testMetrics() throws Exception { + Response response = target + .path("metrics") + .request() + .get(); + assertThat(response.getStatus(), is(200)); + } + + @Test + public void testHealth() throws Exception { + Response response = target + .path("health") + .request() + .get(); + assertThat(response.getStatus(), is(200)); + } + + @Test + public void testGreet() throws Exception { + Message message = target + .path("simple-greet") + .request() + .get(Message.class); + assertThat(message.getMessage(), is("Hello World!")); + } + + @Test + public void testGreetings() throws Exception { + Message jsonMessage = target + .path("greet/Joe") + .request() + .get(Message.class); + assertThat(jsonMessage.getMessage(), is("Hello Joe!")); + + try (Response r = target + .path("greet/greeting") + .request() + .put(Entity.entity("{\"greeting\" : \"Hola\"}", MediaType.APPLICATION_JSON))) { + assertThat(r.getStatus(), is(204)); + } + + jsonMessage = target + .path("greet/Jose") + .request() + .get(Message.class); + assertThat(jsonMessage.getMessage(), is("Hola Jose!")); + } + +} diff --git a/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/StatusResource.java b/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/StatusResource.java new file mode 100644 index 00000000..59f37193 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/StatusResource.java @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2022 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.mp.httpstatuscount; + +import io.helidon.common.http.Http; + +import javax.enterprise.context.RequestScoped; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +/** + * Test-only resource that allows the client to specify what HTTP status the service should return in its response. + * This allows the client to know which status family counter should be updated. + */ +@RequestScoped +@Path("/status") +public class StatusResource { + + @GET + @Produces(MediaType.TEXT_PLAIN) + @Path("/{status}") + public Response reportStatus(@PathParam("status") String statusText) { + int status; + String msg; + try { + status = Integer.parseInt(statusText); + msg = "Successful conversion"; + } catch (NumberFormatException ex) { + status = Http.Status.INTERNAL_SERVER_ERROR_500.code(); + msg = "Unsuccessful conversion"; + } + return Response.status(status).entity(msg).build(); + } +} diff --git a/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/StatusTest.java b/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/StatusTest.java new file mode 100644 index 00000000..9d41fbb7 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/test/java/io/helidon/examples/mp/httpstatuscount/StatusTest.java @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2022 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.mp.httpstatuscount; + +import javax.inject.Inject; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.common.http.Http; +import io.helidon.microprofile.tests.junit5.AddBean; +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.MetricID; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.Tag; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +@HelidonTest +@AddBean(StatusResource.class) +public class StatusTest { + + @Inject + private WebTarget webTarget; + + @Inject + private MetricRegistry metricRegistry; + + private final Counter[] STATUS_COUNTERS = new Counter[6]; + + @BeforeEach + void findStatusMetrics() { + for (int i = 1; i < STATUS_COUNTERS.length; i++) { + STATUS_COUNTERS[i] = metricRegistry.getCounters().get(new MetricID(HttpStatusMetricFilter.STATUS_COUNTER_NAME, + new Tag(HttpStatusMetricFilter.STATUS_TAG_NAME, i + "xx"))); + } + } + + @Test + void checkStatusMetrics() { + checkAfterStatus(171); + checkAfterStatus(200); + checkAfterStatus(201); + checkAfterStatus(204); + checkAfterStatus(301); + checkAfterStatus(401); + checkAfterStatus(404); + } + + @Test + void checkStatusAfterGreet() { + long[] before = new long[6]; + for (int i = 1; i < 6; i++) { + before[i] = STATUS_COUNTERS[i].getCount(); + } + Response response = webTarget.path("/greet") + .request(MediaType.APPLICATION_JSON) + .get(); + assertThat("Status of /greet", response.getStatus(), is(Http.Status.OK_200.code())); + checkCounters(response.getStatus(), before); + } + + void checkAfterStatus(int status) { + String path = "/status/" + status; + long[] before = new long[6]; + for (int i = 1; i < 6; i++) { + before[i] = STATUS_COUNTERS[i].getCount(); + } + Response response = webTarget.path(path) + .request(MediaType.TEXT_PLAIN_TYPE) + .get(); + assertThat("Response status", response.getStatus(), is(status)); + checkCounters(status, before); + } + + private void checkCounters(int status, long[] before) { + int family = status / 100; + for (int i = 1; i < 6; i++) { + long expectedDiff = i == family ? 1 : 0; + assertThat("Diff in counter " + family + "xx", STATUS_COUNTERS[i].getCount() - before[i], is(expectedDiff)); + } + } + +} diff --git a/examples/microprofile/http-status-count-mp/src/test/resources/application.yaml b/examples/microprofile/http-status-count-mp/src/test/resources/application.yaml new file mode 100644 index 00000000..d0f85e65 --- /dev/null +++ b/examples/microprofile/http-status-count-mp/src/test/resources/application.yaml @@ -0,0 +1,17 @@ +# +# Copyright (c) 2022 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. +# +security: + enabled: false \ No newline at end of file diff --git a/examples/microprofile/idcs/README.md b/examples/microprofile/idcs/README.md new file mode 100644 index 00000000..ff019567 --- /dev/null +++ b/examples/microprofile/idcs/README.md @@ -0,0 +1,56 @@ +# Helidon MP IDCS + +This example demonstrates integration with IDCS (Oracle identity service, integrated with Open ID Connect provider) where JAX-RS application resources are protected by IDCS. + +## Contents + +This project contains two samples, one (IdcsApplication.java) and a second (ReactiveService.java). It also contains a static resource. When configured the example exposes multiple HTTP endpoints. + +### IDCS Configuration + +[This documentation](https://docs.oracle.com/en/cloud/paas/identity-cloud/uaids/oracle-identity-cloud-service.html#GUID-BC4769EE-258A-4B53-AED5-6BA9888C8275) describes basics of IDCS as well as how you can get IDCS instance. + +1. [Log in to the IDCS console](https://docs.oracle.com/en/cloud/paas/identity-cloud/uaids/how-access-oracle-identity-cloud-service.html) and create a new application of type "confidential app" +2. Within **Resources** + 1. Create two resources called `first_scope` and `second_scope` + 2. Primary Audience = `http://localhost:7987/"` (ensure there is a trailing /) +3. Within **Client Configuration** + 1. Register a client + 2. Allowed Grant Types = Client Credentials,JWT Assertion, Refresh Token, Authorization Code + 3. Check "Allow non-HTTPS URLs" + 4. Set Redirect URL to `http://localhost:7987/oidc/redirect` + 5. Client Type = Confidential + 6. Add all Scopes defined in the resources section + 7. Set allowed operations to `Introspect` + 8. Set Post Logout Redirect URL to `http://localhost:7987/loggedout` + +Ensure you save and *activate* the application + +### Application Configuration + +Edit application.yaml based on your IDCS Configuration + +1. idcs-uri : Base URL of your idcs instance, usually something like https://idcs-.identity.oraclecloud.com +2. idcs-client-id : This is obtained from your IDCS application in the IDCS console +3. idcs-client-secret : This is obtained from your IDCS application in the IDCS console +4. frontend-uri : This is the base URL of your application when run, e.g. `http://localhost:7987` +5. proxy-host : Your proxy server if needed +6. scope-audience : This is the scope audience which MUST match the primary audience in the IDCS resource, recommendation is not to have a trailing slash (/) + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-security-idcs.jar +``` + +Try the endpoints: + +| Endpoint | Description | +|:------------------------|:---------------------------------------------------------------------------------------| +| `rest/login` | Login | +| `rest/scopes` | Full security with scopes and roles (see IdcsResource.java) | +| `rest/reactive` | Protected reactive service (see application.yaml - security.web-server) | +| `web/resource.html` | Protected static resource (see application.yaml - security.web-server) | + + diff --git a/examples/microprofile/idcs/pom.xml b/examples/microprofile/idcs/pom.xml new file mode 100644 index 00000000..d274f94c --- /dev/null +++ b/examples/microprofile/idcs/pom.xml @@ -0,0 +1,86 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-security-idcs + 1.0.0-SNAPSHOT + Helidon Microprofile Examples IDCS Security + + + Microprofile example with IDCS integration (through Open ID Connect) + + + + io.helidon.examples.microprofile.security.idcs.IdcsMain + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile + helidon-microprofile-oidc + + + io.helidon.security.providers + helidon-security-providers-idcs-mapper + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsApplication.java b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsApplication.java new file mode 100644 index 00000000..2c715158 --- /dev/null +++ b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsApplication.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2018, 2021 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.security.idcs; + +import java.util.Set; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.ApplicationPath; +import javax.ws.rs.core.Application; + +/** + * Example JAX-RS application with resources protected by IDCS. + */ +@ApplicationScoped +@ApplicationPath("/rest") +public class IdcsApplication extends Application { + @Override + public Set> getClasses() { + return Set.of(IdcsResource.class); + } +} diff --git a/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsMain.java b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsMain.java new file mode 100644 index 00000000..80b7a6a4 --- /dev/null +++ b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsMain.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2018, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.security.idcs; + +import io.helidon.microprofile.server.Server; + +/** + * IDCS example. + */ +public final class IdcsMain { + private IdcsMain() { + } + + /** + * Start the server and use the application picked up by CDI. + * + * @param args command line arguments, ignored + */ + public static void main(String[] args) { + Server.create().start(); + + System.out.println("Endpoints:"); + System.out.println("Login"); + System.out.println(" http://localhost:7987/rest/login"); + System.out.println("Full security with scopes and roles (see IdcsResource.java)"); + System.out.println(" http://localhost:7987/rest/scopes"); + System.out.println("A protected reactive service (see application.yaml - security.web-server)"); + System.out.println(" http://localhost:7987/reactive"); + System.out.println("A protected static resource (see application.yaml - security.web-server"); + System.out.println(" http://localhost:7987/web/resource.html"); + } +} diff --git a/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsResource.java b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsResource.java new file mode 100644 index 00000000..ea73cc84 --- /dev/null +++ b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/IdcsResource.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2018, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.security.idcs; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.Response; + +import io.helidon.security.SecurityContext; +import io.helidon.security.abac.role.RoleValidator; +import io.helidon.security.abac.scope.ScopeValidator; +import io.helidon.security.annotations.Authenticated; + +/** + * JAX-RS resource. + */ +@Path("/") +public class IdcsResource { + /** + * A protected resource (authentication required). + * + * @param context security context that will contain user's subject once login is completed + * @return user's subject as a string + */ + @GET + @Path("/login") + @Authenticated + public String login(@Context SecurityContext context) { + return context.user().toString(); + } + + /** + * A login flow example to use from a HTML frontend. A login button would call this method with a + * query parameter with redirect to the first page. + * + * @param context security context that will contain user's subject once login is completed + * @param redirectTo target URI (relative) to redirect to + * @return redirect response + */ + @GET + @Path("/login2") + @Authenticated + public Response login(@Context SecurityContext context, @QueryParam("target") String redirectTo) { + return Response + .status(Response.Status.TEMPORARY_REDIRECT) + .header("Location", redirectTo) + .build(); + } + + /** + * Authenticated and authorized endpoint that requires two scopes (these must be configure in your IDCS application). + * + * @param context security context + * @return current user's subject as a string, should now contain the scopes required + */ + @GET + @Path("/scopes") + @Authenticated + // Scopes defined in IDCS in my scope audience (see application.yaml) + @ScopeValidator.Scope("first_scope") + @ScopeValidator.Scope("second_scope") + // A group defined in my IDCS domain + @RoleValidator.Roles("my_admins") + public String scopes(@Context SecurityContext context) { + return context.user().toString(); + } +} diff --git a/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/ReactiveService.java b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/ReactiveService.java new file mode 100644 index 00000000..ad1f6101 --- /dev/null +++ b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/ReactiveService.java @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.security.idcs; + +import javax.enterprise.context.ApplicationScoped; + +import io.helidon.microprofile.server.RoutingPath; +import io.helidon.security.Principal; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Reactive service implementation. + */ +@ApplicationScoped +@RoutingPath("/reactive") +public class ReactiveService implements Service { + + @Override + public void update(Routing.Rules rules) { + rules.get(this::reactiveRoute); + } + + private void reactiveRoute(ServerRequest req, ServerResponse res) { + String username = req.context() + .get(SecurityContext.class) + .flatMap(SecurityContext::user) + .map(Subject::principal) + .map(Principal::getName) + .orElse("not authenticated"); + + res.send("Hello from reactive service, you are " + username); + } +} diff --git a/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/package-info.java b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/package-info.java new file mode 100644 index 00000000..7786a9f9 --- /dev/null +++ b/examples/microprofile/idcs/src/main/java/io/helidon/examples/microprofile/security/idcs/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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 of integration with IDCS (through Open ID Connect). + */ +package io.helidon.examples.microprofile.security.idcs; diff --git a/examples/microprofile/idcs/src/main/resources/META-INF/beans.xml b/examples/microprofile/idcs/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..83ee6b69 --- /dev/null +++ b/examples/microprofile/idcs/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/idcs/src/main/resources/WEB/resource.html b/examples/microprofile/idcs/src/main/resources/WEB/resource.html new file mode 100644 index 00000000..5a16aacb --- /dev/null +++ b/examples/microprofile/idcs/src/main/resources/WEB/resource.html @@ -0,0 +1,32 @@ + + + + + +Hello, this is a static resource loaded from classpath. +

+ The configuration (microprofile config, accessed from application.yaml): +


+        server.static.classpath.location=/WEB
+        server.static.classpath.context=/web
+
+

+ + + diff --git a/examples/microprofile/idcs/src/main/resources/application.yaml b/examples/microprofile/idcs/src/main/resources/application.yaml new file mode 100644 index 00000000..307a9647 --- /dev/null +++ b/examples/microprofile/idcs/src/main/resources/application.yaml @@ -0,0 +1,61 @@ +# +# Copyright (c) 2018, 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. +# + +# Security requires Helidon config + +server: + port: 7987 + # location on classpath (e.g. src/main/resources/WEB in maven) + static.classpath: + location: "/WEB" + # this is optional, defaults to "/" + context: "/web" +security: + config.require-encryption: false + properties: + # This is a nice way to be able to override this with local properties or env-vars + idcs-uri: "https://tenant-id.identity.oracle.com" + idcs-client-id: "client-id" + idcs-client-secret: "changeit" + # Used as a base for redirects back to us + frontend-uri: "http://localhost:7987" + proxy-host: "if you need proxy" + providers: + - abac: + # Adds ABAC Provider - it does not require any configuration + - oidc: + client-id: "${security.properties.idcs-client-id}" + client-secret: "${security.properties.idcs-client-secret}" + identity-uri: "${security.properties.idcs-uri}" + # A prefix used for custom scopes + scope-audience: "http://localhost:7987/test-application" + proxy-host: "${security.properties.proxy-host}" + frontend-uri: "${security.properties.frontend-uri}" + - idcs-role-mapper: + multitenant: false + oidc-config: + # we must repeat IDCS configuration, as in this case + # IDCS serves both as open ID connect authenticator and + # as a role mapper. Using minimal configuration here + client-id: "${security.properties.idcs-client-id}" + client-secret: "${security.properties.idcs-client-secret}" + identity-uri: "${security.properties.idcs-uri}" + web-server: + paths: + - path: "/web[/{*}]" + authenticate: true + - path: "/reactive[/{*}]" + authenticate: true diff --git a/examples/microprofile/idcs/src/main/resources/logging.properties b/examples/microprofile/idcs/src/main/resources/logging.properties new file mode 100644 index 00000000..51d8d54c --- /dev/null +++ b/examples/microprofile/idcs/src/main/resources/logging.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2018, 2021 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +AUDIT.level=FINEST +io.helidon.security.providers.oidc.level=FINEST +io.helidon.microprofile.config.level=FINEST diff --git a/examples/microprofile/lra/README.md b/examples/microprofile/lra/README.md new file mode 100644 index 00000000..5ee9f995 --- /dev/null +++ b/examples/microprofile/lra/README.md @@ -0,0 +1,50 @@ +# Helidon LRA Example + +## Build and run + +```shell +mvn package +java -jar ./target/helidon-examples-microprofile-lra.jar +``` + +### Coordinator +Narayana like coordinator is expected to be running on the port `8070`, url can be changed in application.yaml +```yaml +mp.lra.coordinator.url: http://localhost:8070/lra-coordinator +``` + +#### Build and run LRA coordinator +> :warning: **Experimental feature**: Helidon LRA coordinator is an experimental tool, running it in production is not advised + +```shell +docker build -t helidon/lra-coordinator https://github.com/oracle/helidon.git#:lra/coordinator/server +docker run --rm --name lra-coordinator --network="host" helidon/lra-coordinator +``` + +### Test LRA resource +Then call for completed transaction: +```shell +curl -X PUT -d 'lra rocks' http://localhost:7001/example/start-example +``` +And observe processing success in the output followed by complete called by LRA coordinator: +``` +Data lra rocks processed 🏭 +LRA id: f120a842-88da-429b-82d9-7274ee9ce8f6 completed 🎉 +``` + +For compensated transaction: +```shell +curl -X PUT -d BOOM http://localhost:7001/example/start-example +``` +Observe exception in the output followed by compensation called by LRA coordinator: +``` +java.lang.RuntimeException: BOOM 💥 + at io.helidon.microprofile.example.lra.LRAExampleResource.startExample(LRAExampleResource.java:56) +... +LRA id: 3629421b-b2a4-4fc4-a2f0-941cbf3fa8ad compensated 🚒 +``` + +Or compensated transaction timeout: +```shell +curl -X PUT -d TIMEOUT http://localhost:7001/example/start-example +``` \ No newline at end of file diff --git a/examples/microprofile/lra/pom.xml b/examples/microprofile/lra/pom.xml new file mode 100644 index 00000000..41b688b1 --- /dev/null +++ b/examples/microprofile/lra/pom.xml @@ -0,0 +1,86 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-lra + 1.0.0-SNAPSHOT + Microprofile LRA Example + + + Microprofile Long Running Actions Example + + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.microprofile.config + helidon-microprofile-config + + + io.helidon.microprofile.lra + helidon-microprofile-lra + + + io.helidon.lra + helidon-lra-coordinator-narayana-client + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/lra/src/main/java/io/helidon/microprofile/example/lra/LRAExampleResource.java b/examples/microprofile/lra/src/main/java/io/helidon/microprofile/example/lra/LRAExampleResource.java new file mode 100644 index 00000000..94d92b93 --- /dev/null +++ b/examples/microprofile/lra/src/main/java/io/helidon/microprofile/example/lra/LRAExampleResource.java @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2021 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.microprofile.example.lra; + +import java.net.URI; +import java.time.temporal.ChronoUnit; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.HeaderParam; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.core.Response; + +import org.eclipse.microprofile.lra.LRAResponse; +import org.eclipse.microprofile.lra.annotation.Compensate; +import org.eclipse.microprofile.lra.annotation.Complete; +import org.eclipse.microprofile.lra.annotation.ws.rs.LRA; + +import static org.eclipse.microprofile.lra.annotation.ws.rs.LRA.LRA_HTTP_CONTEXT_HEADER; + +/** + * Example resource with LRA. + */ +@Path("/example") +@ApplicationScoped +public class LRAExampleResource { + + private static final Logger LOGGER = Logger.getLogger(LRAExampleResource.class.getName()); + + /** + * Starts a new long-running action. + * + * @param lraId id of this action + * @param data entity + * @return empty response + * + * @throws InterruptedException this method is sleeping on thread, so it can throw interrupted exception + */ + @PUT + @LRA(value = LRA.Type.REQUIRES_NEW, timeLimit = 500, timeUnit = ChronoUnit.MILLIS) + @Path("start-example") + public Response startExample(@HeaderParam(LRA_HTTP_CONTEXT_HEADER) URI lraId, + String data) throws InterruptedException { + if (data.contains("BOOM")) { + throw new RuntimeException("BOOM 💥"); + } + + if (data.contains("TIMEOUT")) { + Thread.sleep(2000); + } + + LOGGER.info("Data " + data + " processed 🏭"); + return Response.ok().build(); + } + + /** + * Completes the long-running action. + * + * @param lraId id of this action + * @return completed response + */ + @PUT + @Complete + @Path("complete-example") + public Response completeExample(@HeaderParam(LRA_HTTP_CONTEXT_HEADER) URI lraId) { + LOGGER.log(Level.INFO, "LRA id: {0} completed 🎉", lraId); + return LRAResponse.completed(); + } + + /** + * Compensation for long-running action. + * + * @param lraId id of action to compensate + * @return compensated response + */ + @PUT + @Compensate + @Path("compensate-example") + public Response compensateExample(@HeaderParam(LRA_HTTP_CONTEXT_HEADER) URI lraId) { + LOGGER.log(Level.SEVERE, "LRA id: {0} compensated 🚒", lraId); + return LRAResponse.compensated(); + } + +} diff --git a/examples/microprofile/lra/src/main/java/io/helidon/microprofile/example/lra/package-info.java b/examples/microprofile/lra/src/main/java/io/helidon/microprofile/example/lra/package-info.java new file mode 100644 index 00000000..b9faa248 --- /dev/null +++ b/examples/microprofile/lra/src/main/java/io/helidon/microprofile/example/lra/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2021, 2023 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. + */ + +/** + * Helidon MicroProfile LRA Example. + */ +package io.helidon.microprofile.example.lra; + diff --git a/examples/microprofile/lra/src/main/resources/META-INF/beans.xml b/examples/microprofile/lra/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..d2546e3e --- /dev/null +++ b/examples/microprofile/lra/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/lra/src/main/resources/application.yaml b/examples/microprofile/lra/src/main/resources/application.yaml new file mode 100644 index 00000000..7fdbb8cc --- /dev/null +++ b/examples/microprofile/lra/src/main/resources/application.yaml @@ -0,0 +1,19 @@ +# +# Copyright (c) 2021 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. +# +server.port: 7001 + +mp.lra: + coordinator.url: http://localhost:8070/lra-coordinator diff --git a/examples/microprofile/lra/src/main/resources/logging.properties b/examples/microprofile/lra/src/main/resources/logging.properties new file mode 100644 index 00000000..dbdea1d1 --- /dev/null +++ b/examples/microprofile/lra/src/main/resources/logging.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2021 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO diff --git a/examples/microprofile/messaging-sse/README.md b/examples/microprofile/messaging-sse/README.md new file mode 100644 index 00000000..11f1719b --- /dev/null +++ b/examples/microprofile/messaging-sse/README.md @@ -0,0 +1,17 @@ +# Helidon Reactive Messaging Example + + Example showing + * [Microprofile Reactive Messaging](https://github.com/eclipse/microprofile-reactive-messaging) + with [Microprofile Reactive Stream Operators](https://github.com/eclipse/microprofile-reactive-streams-operators) + connected to [Server-Sent Events](https://eclipse-ee4j.github.io/jersey.github.io/documentation/latest/sse.html). + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-messaging-sse.jar +``` + +Then try in the browser: + +http://localhost:7001 \ No newline at end of file diff --git a/examples/microprofile/messaging-sse/pom.xml b/examples/microprofile/messaging-sse/pom.xml new file mode 100644 index 00000000..ea6eaf8e --- /dev/null +++ b/examples/microprofile/messaging-sse/pom.xml @@ -0,0 +1,105 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-messaging-sse + 1.0.0-SNAPSHOT + Microprofile Reactive Messaging with SSE + + + Microprofile Reactive Messaging with Server-Sent Events example + + + + + io.helidon.microprofile.messaging + helidon-microprofile-messaging + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.glassfish.jersey.media + jersey-media-sse + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-resources-plugin + + + snippet + + resources + + + + + src/main/java/io/helidon/microprofile/example/messaging/sse + + MsgProcessingBean.java + + + + ${project.build.directory}/classes/WEB + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/MessagingExampleResource.java b/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/MessagingExampleResource.java new file mode 100644 index 00000000..a9462095 --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/MessagingExampleResource.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2020 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.microprofile.example.messaging.sse; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.sse.Sse; +import javax.ws.rs.sse.SseEventSink; + +/** + * Example resource with SSE. + */ +@Path("example") +@RequestScoped +public class MessagingExampleResource { + private final MsgProcessingBean msgBean; + + /** + * Constructor injection of field values. + * + * @param msgBean Messaging example bean + */ + @Inject + public MessagingExampleResource(MsgProcessingBean msgBean) { + this.msgBean = msgBean; + } + + + /** + * Process send. + * @param msg message to process + */ + @Path("/send/{msg}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public void getSend(@PathParam("msg") String msg) { + msgBean.process(msg); + } + + /** + * Consume event. + * + * @param eventSink sink + * @param sse event + */ + @GET + @Path("sse") + @Produces(MediaType.SERVER_SENT_EVENTS) + public void listenToEvents(@Context SseEventSink eventSink, @Context Sse sse) { + msgBean.addSink(eventSink, sse); + } +} diff --git a/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/MsgProcessingBean.java b/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/MsgProcessingBean.java new file mode 100644 index 00000000..fb20d010 --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/MsgProcessingBean.java @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2020, 2023 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.microprofile.example.messaging.sse; + +import java.util.concurrent.SubmissionPublisher; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.sse.OutboundSseEvent; +import javax.ws.rs.sse.Sse; +import javax.ws.rs.sse.SseBroadcaster; +import javax.ws.rs.sse.SseEventSink; + +import org.eclipse.microprofile.reactive.messaging.Incoming; +import org.eclipse.microprofile.reactive.messaging.Outgoing; +import org.eclipse.microprofile.reactive.streams.operators.ProcessorBuilder; +import org.eclipse.microprofile.reactive.streams.operators.ReactiveStreams; +import org.glassfish.jersey.media.sse.OutboundEvent; +import org.reactivestreams.FlowAdapters; +import org.reactivestreams.Publisher; + +/** + * Bean for message processing. + */ +@ApplicationScoped +public class MsgProcessingBean { + private final SubmissionPublisher emitter = new SubmissionPublisher<>(); + private SseBroadcaster sseBroadcaster; + + /** + * Create a publisher for the emitter. + * + * @return A Publisher from the emitter + */ + @Outgoing("multiplyVariants") + public Publisher preparePublisher() { + // Create new publisher for emitting to by this::process + return ReactiveStreams + .fromPublisher(FlowAdapters.toPublisher(emitter)) + .buildRs(); + } + + /** + * Returns a builder for a processor that maps a string into three variants. + * + * @return ProcessorBuilder + */ + @Incoming("multiplyVariants") + @Outgoing("wrapSseEvent") + public ProcessorBuilder multiply() { + // Multiply to 3 variants of same message + return ReactiveStreams.builder() + .flatMap(o -> + ReactiveStreams.of( + // upper case variant + o.toUpperCase(), + // repeat twice variant + o.repeat(2), + // reverse chars 'tnairav' + new StringBuilder(o).reverse().toString()) + ); + } + + /** + * Maps a message to an sse event. + * + * @param msg to wrap + * @return an outbound SSE event + */ + @Incoming("wrapSseEvent") + @Outgoing("broadcast") + public OutboundSseEvent wrapSseEvent(String msg) { + // Map every message to sse event + return new OutboundEvent.Builder().data(msg).build(); + } + + /** + * Broadcasts an event. + * + * @param sseEvent Event to broadcast + */ + @Incoming("broadcast") + public void broadcast(OutboundSseEvent sseEvent) { + // Broadcast to all sse sinks + this.sseBroadcaster.broadcast(sseEvent); + } + + /** + * Consumes events. + * + * @param eventSink event sink + * @param sse event + */ + public void addSink(final SseEventSink eventSink, final Sse sse) { + if (this.sseBroadcaster == null) { + this.sseBroadcaster = sse.newBroadcaster(); + } + this.sseBroadcaster.register(eventSink); + } + + /** + * Emit a message. + * + * @param msg message to emit + */ + public void process(final String msg) { + emitter.submit(msg); + } +} diff --git a/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/package-info.java b/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/package-info.java new file mode 100644 index 00000000..8cee458f --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/java/io/helidon/microprofile/example/messaging/sse/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2020 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. + */ + +/** + * Helidon MicroProfile Messaging Example. + */ +package io.helidon.microprofile.example.messaging.sse; + diff --git a/examples/microprofile/messaging-sse/src/main/resources/META-INF/beans.xml b/examples/microprofile/messaging-sse/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..e5a9e54a --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/messaging-sse/src/main/resources/WEB/favicon.ico b/examples/microprofile/messaging-sse/src/main/resources/WEB/favicon.ico new file mode 100644 index 00000000..d91659fd Binary files /dev/null and b/examples/microprofile/messaging-sse/src/main/resources/WEB/favicon.ico differ diff --git a/examples/microprofile/messaging-sse/src/main/resources/WEB/img/arrow-1.png b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/arrow-1.png new file mode 100644 index 00000000..bbba0aef Binary files /dev/null and b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/arrow-1.png differ diff --git a/examples/microprofile/messaging-sse/src/main/resources/WEB/img/arrow-2.png b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/arrow-2.png new file mode 100644 index 00000000..0b1096b0 Binary files /dev/null and b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/arrow-2.png differ diff --git a/examples/microprofile/messaging-sse/src/main/resources/WEB/img/cloud.png b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/cloud.png new file mode 100644 index 00000000..3e04833c Binary files /dev/null and b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/cloud.png differ diff --git a/examples/microprofile/messaging-sse/src/main/resources/WEB/img/frank.png b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/frank.png new file mode 100644 index 00000000..51a13d8d Binary files /dev/null and b/examples/microprofile/messaging-sse/src/main/resources/WEB/img/frank.png differ diff --git a/examples/microprofile/messaging-sse/src/main/resources/WEB/index.html b/examples/microprofile/messaging-sse/src/main/resources/WEB/index.html new file mode 100644 index 00000000..7dd7ff93 --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/resources/WEB/index.html @@ -0,0 +1,120 @@ + + + + + + + Helidon Reactive Messaging + + + + + + + + +
+
+
+ +
+
Send
+
+
+
+
+
REST call /example/send/{msg}
+
+
+
SSE messages received
+
+
+
+
+ 
+            
+
+
+
+ + + + + \ No newline at end of file diff --git a/examples/microprofile/messaging-sse/src/main/resources/WEB/main.css b/examples/microprofile/messaging-sse/src/main/resources/WEB/main.css new file mode 100644 index 00000000..d4073f5e --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/resources/WEB/main.css @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2020, 2023 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. + */ + +#root { + background-color: #36ABF2; + font-family: Roboto,sans-serif; + color: #fff; + position: absolute; + overflow-x: hidden; + -ms-overflow-style: none; /* Internet Explorer 10+ */ + scrollbar-width: none; /* Firefox */ + top: 0; + left: 0; + width: 100%; + height: 100%; +} +#root::-webkit-scrollbar { + display: none; /* Safari and Chrome */ +} + +#helidon { + width: 509px; + height: 273px; + position: relative; + left: -509px; + z-index: 4; + background: url('img/frank.png'); +} + +#rest-tip { + position: relative; + top: -80px; + left: 160px; +} + +#rest-tip-arrow { + width: 205px; + height: 304px; + z-index: 4; + top: -20px; + background: url('img/arrow-1.png'); +} +#rest-tip-label { + position: absolute; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; + left: -60px; +} + +#sse-tip { + position: absolute; + overflow: hidden; + display: flex; + width: auto; + height: auto; + top: 5%; + right: 10%; + z-index: 0; +} + +#sse-tip-arrow { + position: relative; + top: -30px; + width: 296px; + height: 262px; + z-index: 4; + background: url('img/arrow-2.png'); +} +#sse-tip-label { + position: relative; + white-space: nowrap; + font-size: 18px; + font-weight: bold; + z-index: 4; +} + +#producer { + float: left; + position: relative; + width: 300px; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 99; +} + +#msgBox { + position: absolute; + width: 300px; + top: 25%; + right: 3%; + height: 100%; + margin: 50px; + padding: 10px; + z-index: 20; +} + +#input { + width: 210px; + height: 22px; + top: 58px; + left: 30px; + background-color: white; + border-radius: 10px; + border-style: solid; + border-color: white; + position: absolute; + z-index: 10; +} + +#inputCloud { + position: relative; + width: 310px; + height: 150px; + background: url('img/cloud.png'); +} + +#msg { + background-color: #D2EBFC; + color: #1A9BF4; + border-radius: 10px; + width: 300px; + height: 50px; + margin: 5px; + display: flex; + padding-left: 10px; + justify-content: center; + align-items: center; + z-index: 99; +} + +#submit { + font-weight: bold; + background-color: aqua; + color: #1A9BF4; + border-radius: 12px; + width: 100px; + height: 30px; + display: flex; + justify-content: center; + align-items: center; + margin: 5px; + cursor: pointer; +} + +#snippet { + position: absolute; + top: 15%; + left: 30%; + width: 40%; + z-index: 5; +} + +.hljs { + border-radius: 10px; + font-size: 12px; +} \ No newline at end of file diff --git a/examples/microprofile/messaging-sse/src/main/resources/application.yaml b/examples/microprofile/messaging-sse/src/main/resources/application.yaml new file mode 100644 index 00000000..c19b8a3f --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/resources/application.yaml @@ -0,0 +1,18 @@ +# +# Copyright (c) 2020 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. +# +server.port: 7001 +server.static.classpath.location: /WEB +server.static.classpath.welcome: index.html diff --git a/examples/microprofile/messaging-sse/src/main/resources/logging.properties b/examples/microprofile/messaging-sse/src/main/resources/logging.properties new file mode 100644 index 00000000..927be950 --- /dev/null +++ b/examples/microprofile/messaging-sse/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2020 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.config.level=FINEST diff --git a/examples/microprofile/multipart/README.md b/examples/microprofile/multipart/README.md new file mode 100644 index 00000000..58aea2ba --- /dev/null +++ b/examples/microprofile/multipart/README.md @@ -0,0 +1,22 @@ +# MicroProfile MultiPart Example + +This example demonstrates how to use the Jersey `MultiPartFeature` with Helidon. + +This project implements a simple file service web application that supports uploading + and downloading files. The unit test uses the JAXRS client API to test the endpoints. + +## Build + +```shell +mvn package +``` + +## Run + +First, start the server: + +```shell +java -jar target/helidon-examples-microprofile-multipart.jar +``` + +Then open in your browser. diff --git a/examples/microprofile/multipart/pom.xml b/examples/microprofile/multipart/pom.xml new file mode 100644 index 00000000..0964bb55 --- /dev/null +++ b/examples/microprofile/multipart/pom.xml @@ -0,0 +1,90 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-multipart + 1.0.0-SNAPSHOT + Helidon Microprofile Examples Multipart + + + Example of a form based file upload with Helidon MP. + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.glassfish.jersey.media + jersey-media-multipart + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/FileService.java b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/FileService.java new file mode 100644 index 00000000..e3d926b4 --- /dev/null +++ b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/FileService.java @@ -0,0 +1,105 @@ +/* + * Copyright (c) 2021 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.multipart; + +import java.io.IOException; +import java.net.URI; +import java.nio.file.Files; +import java.nio.file.StandardCopyOption; +import java.util.Map; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.json.Json; +import javax.json.JsonArrayBuilder; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import javax.ws.rs.core.StreamingOutput; + +import org.glassfish.jersey.media.multipart.BodyPart; +import org.glassfish.jersey.media.multipart.BodyPartEntity; +import org.glassfish.jersey.media.multipart.MultiPart; + +/** + * File service. + */ +@Path("/api") +@ApplicationScoped +public class FileService { + + private static final JsonBuilderFactory JSON_FACTORY = Json.createBuilderFactory(Map.of()); + + private final FileStorage storage; + + @Inject + FileService(FileStorage storage) { + this.storage = storage; + } + + /** + * Upload a file to the storage. + * @param multiPart multipart entity + * @return Response + * @throws IOException if an IO error occurs + */ + @POST + @Consumes(MediaType.MULTIPART_FORM_DATA) + public Response upload(MultiPart multiPart) throws IOException { + for (BodyPart part : multiPart.getBodyParts()) { + if ("file[]".equals(part.getContentDisposition().getParameters().get("name"))) { + Files.copy(part.getEntityAs(BodyPartEntity.class).getInputStream(), + storage.create(part.getContentDisposition().getFileName()), + StandardCopyOption.REPLACE_EXISTING); + } + } + return Response.seeOther(URI.create("ui")).build(); + } + + /** + * Download a file from the storage. + * @param fname file name of the file to download + * @return Response + */ + @GET + @Path("{fname}") + @Produces(MediaType.APPLICATION_OCTET_STREAM) + public Response download(@PathParam("fname") String fname) { + return Response.ok() + .header("Content-Disposition", "attachment; filename=\"" + fname + "\"") + .entity((StreamingOutput) output -> Files.copy(storage.lookup(fname), output)) + .build(); + } + + /** + * List the files in the storage. + * @return JsonObject + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public JsonObject list() { + JsonArrayBuilder arrayBuilder = JSON_FACTORY.createArrayBuilder(); + storage.listFiles().forEach(arrayBuilder::add); + return JSON_FACTORY.createObjectBuilder().add("files", arrayBuilder).build(); + } +} diff --git a/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/FileStorage.java b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/FileStorage.java new file mode 100644 index 00000000..3ee61f7a --- /dev/null +++ b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/FileStorage.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2021 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.multipart; + +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.BadRequestException; +import javax.ws.rs.NotFoundException; + +/** + * Simple bean to managed a directory based storage. + */ +@ApplicationScoped +public class FileStorage { + + private final Path storageDir; + + /** + * Create a new instance. + */ + public FileStorage() { + try { + storageDir = Files.createTempDirectory("fileupload"); + } catch (IOException ex) { + throw new UncheckedIOException(ex); + } + } + + /** + * Get the storage directory. + * @return directory + */ + public Path storageDir() { + return storageDir; + } + + /** + * Get the names of the files in the storage directory. + * @return Stream of file names + */ + public Stream listFiles() { + try { + return Files.walk(storageDir) + .filter(Files::isRegularFile) + .map(storageDir::relativize) + .map(java.nio.file.Path::toString); + } catch (IOException ex) { + throw new UncheckedIOException(ex); + } + } + + /** + * Create a new file in the storage. + * @param fname file name + * @return file + * @throws BadRequestException if the resolved file is not contained in the storage directory + */ + public Path create(String fname) { + Path file = storageDir.resolve(fname); + if (!file.getParent().equals(storageDir)) { + throw new BadRequestException("Invalid file name"); + } + return file; + } + + /** + * Lookup an existing file in the storage. + * @param fname file name + * @return file + * @throws NotFoundException If the resolved file does not exist + * @throws BadRequestException if the resolved file is not contained in the storage directory + */ + public Path lookup(String fname) { + Path file = storageDir.resolve(fname); + if (!file.getParent().equals(storageDir)) { + throw new BadRequestException("Invalid file name"); + } + if (!Files.exists(file)) { + throw new NotFoundException(); + } + if (!Files.isRegularFile(file)) { + throw new BadRequestException("Not a file"); + } + return file; + } +} diff --git a/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/MultiPartFeatureProvider.java b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/MultiPartFeatureProvider.java new file mode 100644 index 00000000..f6e614e9 --- /dev/null +++ b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/MultiPartFeatureProvider.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2021 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.multipart; + +import javax.ws.rs.core.Feature; +import javax.ws.rs.core.FeatureContext; +import javax.ws.rs.ext.Provider; + +import org.glassfish.jersey.media.multipart.MultiPartFeature; + +/** + * {@link MultiPartFeature} is not auto-discovered. This {@link Feature} is discovered with {@link @Provider} + * and registers {@link MultiPartFeature} manually. + */ +@Provider +public class MultiPartFeatureProvider implements Feature { + + @Override + public boolean configure(FeatureContext context) { + return new MultiPartFeature().configure(context); + } +} diff --git a/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/package-info.java b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/package-info.java new file mode 100644 index 00000000..944a5d9d --- /dev/null +++ b/examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2021 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. + */ + +/** + * Helidon Microprofile Examples Multipart. + */ +package io.helidon.examples.microprofile.multipart; diff --git a/examples/microprofile/multipart/src/main/resources/META-INF/beans.xml b/examples/microprofile/multipart/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..5c9746eb --- /dev/null +++ b/examples/microprofile/multipart/src/main/resources/META-INF/beans.xml @@ -0,0 +1,23 @@ + + + + + \ No newline at end of file diff --git a/examples/microprofile/multipart/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/multipart/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..08e39835 --- /dev/null +++ b/examples/microprofile/multipart/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,23 @@ +# +# Copyright (c) 2021 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 + +server.static.classpath.location=/WEB +server.static.classpath.welcome=index.html +server.static.classpath.context=/ui diff --git a/examples/microprofile/multipart/src/main/resources/WEB/index.html b/examples/microprofile/multipart/src/main/resources/WEB/index.html new file mode 100644 index 00000000..8a68d737 --- /dev/null +++ b/examples/microprofile/multipart/src/main/resources/WEB/index.html @@ -0,0 +1,59 @@ + + + + + + Helidon Microprofile Examples Multipart + + + + + +

Uploaded files

+
+ +

Upload

+
+ Select a file to upload: + + +
+ + + + \ No newline at end of file diff --git a/examples/microprofile/multipart/src/main/resources/logging.properties b/examples/microprofile/multipart/src/main/resources/logging.properties new file mode 100644 index 00000000..5a64db18 --- /dev/null +++ b/examples/microprofile/multipart/src/main/resources/logging.properties @@ -0,0 +1,37 @@ +# +# Copyright (c) 2021 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.microprofile.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO +#org.glassfish.jersey.level=INFO +#org.jboss.weld=INFO diff --git a/examples/microprofile/multipart/src/test/java/io/helidon/examples/microprofile/multipart/FileServiceTest.java b/examples/microprofile/multipart/src/test/java/io/helidon/examples/microprofile/multipart/FileServiceTest.java new file mode 100644 index 00000000..b69e17c1 --- /dev/null +++ b/examples/microprofile/multipart/src/test/java/io/helidon/examples/microprofile/multipart/FileServiceTest.java @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2021 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.multipart; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; + +import javax.json.JsonObject; +import javax.json.JsonString; +import javax.ws.rs.client.Entity; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.server.JaxRsCdiExtension; +import io.helidon.microprofile.server.ServerCdiExtension; +import io.helidon.microprofile.tests.junit5.AddBean; +import io.helidon.microprofile.tests.junit5.AddExtension; +import io.helidon.microprofile.tests.junit5.DisableDiscovery; +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.glassfish.jersey.client.ClientProperties; +import org.glassfish.jersey.ext.cdi1x.internal.CdiComponentProvider; +import org.glassfish.jersey.media.multipart.MultiPart; +import org.glassfish.jersey.media.multipart.MultiPartFeature; +import org.glassfish.jersey.media.multipart.file.FileDataBodyPart; +import org.junit.jupiter.api.MethodOrderer.OrderAnnotation; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestMethodOrder; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.hasItem; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.notNullValue; + +/** + * Tests {@link FileService}. + */ +@HelidonTest +@DisableDiscovery +@AddExtension(ServerCdiExtension.class) +@AddExtension(JaxRsCdiExtension.class) +@AddExtension(CdiComponentProvider.class) +@AddBean(FileService.class) +@AddBean(FileStorage.class) +@AddBean(MultiPartFeatureProvider.class) +@TestMethodOrder(OrderAnnotation.class) +public class FileServiceTest { + + @Test + @Order(1) + public void testUpload(WebTarget target) throws IOException { + Path tempDirectory = Files.createTempDirectory(null); + File file = Files.write(tempDirectory.resolve("foo.txt"), "bar\n".getBytes(StandardCharsets.UTF_8)).toFile(); + MultiPart multipart = new MultiPart() + .bodyPart(new FileDataBodyPart("file[]", file, MediaType.APPLICATION_OCTET_STREAM_TYPE)); + try (Response response = target + .property(ClientProperties.FOLLOW_REDIRECTS, Boolean.FALSE) + .register(MultiPartFeature.class) + .path("/api") + .request() + .post(Entity.entity(multipart, MediaType.MULTIPART_FORM_DATA_TYPE))) { + assertThat(response.getStatus(), is(303)); + } + } + + @Test + @Order(2) + public void testList(WebTarget target) { + try (Response response = target + .path("/api") + .request(MediaType.APPLICATION_JSON_TYPE) + .get()) { + assertThat(response.getStatus(), is(200)); + JsonObject json = response.readEntity(JsonObject.class); + assertThat(json, is(notNullValue())); + List files = json.getJsonArray("files").getValuesAs(v -> ((JsonString) v).getString()); + assertThat(files, hasItem("foo.txt")); + } + } + + @Test + @Order(3) + public void testDownload(WebTarget target) throws IOException { + try (Response response = target + .register(MultiPartFeature.class) + .path("/api/foo.txt") + .request(MediaType.APPLICATION_OCTET_STREAM_TYPE) + .get()) { + assertThat(response.getStatus(), is(200)); + assertThat(response.getHeaderString("Content-Disposition"), containsString("filename=\"foo.txt\"")); + InputStream inputStream = response.readEntity(InputStream.class); + assertThat(new String(inputStream.readAllBytes(), StandardCharsets.UTF_8), is("bar\n")); + } + } +} \ No newline at end of file diff --git a/examples/microprofile/multiport/README.md b/examples/microprofile/multiport/README.md new file mode 100644 index 00000000..4ec6b8ae --- /dev/null +++ b/examples/microprofile/multiport/README.md @@ -0,0 +1,39 @@ +# Helidon MicroProfile Multiple Port Example + +It is common when deploying a microservice to run your service on +multiple ports so that you can control the visibility of your +service's endpoints. For example you might want to use three ports: + +- 8080: public REST endpoints of application +- 8081: private REST endpoints of application +- 8082: admin endpoints for health, metrics, etc. + +This lets you expose only the public endpoints via your +ingress controller or load balancer. + +This example shows a Helidon JAX-RS application running on three ports +as described above. + +The ports are configured in `application.yaml` by using named sockets. + +Two Applications are defined, each associated with a different socket +using @RoutingName. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-multiport.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/hello + +curl -X GET http://localhost:8081/private/hello + +curl -X GET http://localhost:8082/health + +curl -X GET http://localhost:8082/metrics +``` diff --git a/examples/microprofile/multiport/pom.xml b/examples/microprofile/multiport/pom.xml new file mode 100644 index 00000000..c04b0fd3 --- /dev/null +++ b/examples/microprofile/multiport/pom.xml @@ -0,0 +1,94 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-multiport + 1.0.0-SNAPSHOT + Helidon Microprofile Examples Multiple Ports + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.config + helidon-config-yaml + + + io.helidon.microprofile.metrics + helidon-microprofile-metrics + + + io.helidon.microprofile.health + helidon-microprofile-health + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + org.junit.jupiter + junit-jupiter-params + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + diff --git a/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PrivateApplication.java b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PrivateApplication.java new file mode 100644 index 00000000..12e67150 --- /dev/null +++ b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PrivateApplication.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2021 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.multiport; + +import java.util.Set; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.core.Application; + +import io.helidon.microprofile.server.RoutingName; + +/** + * Application to expose private resource. + */ +@ApplicationScoped +@RoutingName("private") +public class PrivateApplication extends Application { + @Override + public Set> getClasses() { + return Set.of(PrivateResource.class); + } +} diff --git a/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PrivateResource.java b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PrivateResource.java new file mode 100644 index 00000000..5f4c4996 --- /dev/null +++ b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PrivateResource.java @@ -0,0 +1,39 @@ +/* + * Copyright (c) 2021 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.multiport; + +import javax.enterprise.context.RequestScoped; +import javax.ws.rs.GET; +import javax.ws.rs.Path; + +/** + * Simple resource. + */ +@RequestScoped +@Path("/private") +public class PrivateResource { + + /** + * Return a private worldly greeting message. + * + * @return {@link String} + */ + @Path("/hello") + @GET + public String helloWorld() { + return "Private Hello World!!"; + } +} diff --git a/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PublicApplication.java b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PublicApplication.java new file mode 100644 index 00000000..6da4ce8b --- /dev/null +++ b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PublicApplication.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2021 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.multiport; + +import java.util.Set; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.core.Application; + +/** + * Application to expose public resource. + */ +@ApplicationScoped +public class PublicApplication extends Application { + @Override + public Set> getClasses() { + return Set.of(PublicResource.class); + } +} diff --git a/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PublicResource.java b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PublicResource.java new file mode 100644 index 00000000..85c461f0 --- /dev/null +++ b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/PublicResource.java @@ -0,0 +1,39 @@ +/* + * Copyright (c) 2021 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.multiport; + +import javax.enterprise.context.RequestScoped; +import javax.ws.rs.GET; +import javax.ws.rs.Path; + +/** + * Simple resource. + */ +@RequestScoped +@Path("/") +public class PublicResource { + + /** + * Return a worldly greeting message. + * + * @return {@link String} + */ + @Path("/hello") + @GET + public String helloWorld() { + return "Public Hello World!!"; + } +} diff --git a/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/package-info.java b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/package-info.java new file mode 100644 index 00000000..f438f5b6 --- /dev/null +++ b/examples/microprofile/multiport/src/main/java/io/helidon/examples/microprofile/multiport/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2021 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. + */ +/** + * Application that exposes multiple ports. + */ +package io.helidon.examples.microprofile.multiport; diff --git a/examples/microprofile/multiport/src/main/resources/META-INF/beans.xml b/examples/microprofile/multiport/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..1f940258 --- /dev/null +++ b/examples/microprofile/multiport/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + + diff --git a/examples/microprofile/multiport/src/main/resources/application.yaml b/examples/microprofile/multiport/src/main/resources/application.yaml new file mode 100644 index 00000000..c8263080 --- /dev/null +++ b/examples/microprofile/multiport/src/main/resources/application.yaml @@ -0,0 +1,32 @@ +# +# Copyright (c) 2021 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. +# +server: + port: 8080 + host: "localhost" + sockets: + - name: "private" + port: 8081 + - name: "admin" + port: 8082 + # bind address is optional, if not defined, server host will be used) + bind-address: "localhost" + +# Metrics and health run on admin port +metrics: + routing: "admin" + +health: + routing: "admin" \ No newline at end of file diff --git a/examples/microprofile/multiport/src/test/java/io/helidon/examples/microprofile/multiport/MainTest.java b/examples/microprofile/multiport/src/test/java/io/helidon/examples/microprofile/multiport/MainTest.java new file mode 100644 index 00000000..cc62b3ac --- /dev/null +++ b/examples/microprofile/multiport/src/test/java/io/helidon/examples/microprofile/multiport/MainTest.java @@ -0,0 +1,161 @@ +/* + * Copyright (c) 2021 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.multiport; + +import javax.inject.Inject; +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; +import javax.ws.rs.core.Response.Status; + +import io.helidon.microprofile.server.ServerCdiExtension; +import io.helidon.microprofile.tests.junit5.AddConfig; +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.MethodSource; + +import java.util.List; +import java.util.stream.Stream; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Unit test for MP multiport example. + */ +@HelidonTest +@AddConfig(key = "server.sockets.0.port", value = "0") // Force ports to be dynamically allocated +@AddConfig(key = "server.sockets.1.port", value = "0") +class MainTest { + // Port names + private static final String ADMIN_PORT = "admin"; + private static final String PRIVATE_PORT = "private"; + private static final String PUBLIC_PORT = "default"; + + private static final String BASE_URL = "http://localhost:"; + + // Used for other (private, admin) ports + private static Client client; + + // Used for the default (public) port which HelidonTest will configure for us + @Inject + private WebTarget publicWebTarget; + + // Needed to get values of dynamically allocated admin and private ports + @Inject + private ServerCdiExtension serverCdiExtension; + + static Stream initParams() { + final String PUBLIC_PATH = "/hello"; + final String PRIVATE_PATH = "/private/hello"; + final String HEALTH_PATH = "/health"; + final String METRICS_PATH = "/metrics"; + + return List.of( + new Params(PUBLIC_PORT, PUBLIC_PATH, Status.OK), + new Params(PUBLIC_PORT, PRIVATE_PATH, Status.NOT_FOUND), + new Params(PUBLIC_PORT, HEALTH_PATH, Status.NOT_FOUND), + new Params(PUBLIC_PORT, METRICS_PATH, Status.NOT_FOUND), + + new Params(PRIVATE_PORT, PUBLIC_PATH, Status.NOT_FOUND), + new Params(PRIVATE_PORT, PRIVATE_PATH, Status.OK), + new Params(PRIVATE_PORT, HEALTH_PATH, Status.NOT_FOUND), + new Params(PRIVATE_PORT, METRICS_PATH, Status.NOT_FOUND), + + new Params(ADMIN_PORT, PUBLIC_PATH, Status.NOT_FOUND), + new Params(ADMIN_PORT, PRIVATE_PATH, Status.NOT_FOUND), + new Params(ADMIN_PORT, HEALTH_PATH, Status.OK), + new Params(ADMIN_PORT, METRICS_PATH, Status.OK) + ).stream(); + } + + @BeforeAll + static void initClass() { + client = ClientBuilder.newClient(); + } + + @AfterAll + static void destroyClass() { + client.close();; + } + + @MethodSource("initParams") + @ParameterizedTest + public void testPortAccess(Params params) { + WebTarget webTarget; + + if (params.portName.equals(PUBLIC_PORT)) { + webTarget = publicWebTarget; + } else { + webTarget = client.target(BASE_URL + serverCdiExtension.port(params.portName)); + } + + try (Response response = webTarget.path(params.path) + .request() + .get()) { + assertThat(webTarget.getUri() + " returned incorrect HTTP status", + response.getStatusInfo().toEnum(), is(params.httpStatus)); + } + } + + @Test + void testEndpoints() { + // Probe PUBLIC port + try (Response response = publicWebTarget.path("/hello") + .request() + .get()) { + assertThat("default port should be serving public resource", + response.getStatusInfo().toEnum(), is(Response.Status.OK)); + assertThat("default port should return public data", + response.readEntity(String.class), is("Public Hello World!!")); + } + + // Probe PRIVATE port + int privatePort = serverCdiExtension.port(PRIVATE_PORT); + WebTarget baseTarget = client.target(BASE_URL + privatePort); + try (Response response = baseTarget.path("/private/hello") + .request() + .get()) { + assertThat("port " + privatePort + " should be serving private resource", + response.getStatusInfo().toEnum(), is(Response.Status.OK)); + assertThat("port " + privatePort + " should return private data", + response.readEntity(String.class), is("Private Hello World!!")); + } + } + + private static class Params { + String portName; + String path; + Response.Status httpStatus; + + private Params(String portName, String path, Response.Status httpStatus) { + this.portName = portName; + this.path = path; + this.httpStatus = httpStatus; + } + + @Override + public String toString() { + return portName + ":" + path + " should return " + httpStatus; + } + } +} diff --git a/examples/microprofile/oidc/README.md b/examples/microprofile/oidc/README.md new file mode 100644 index 00000000..81ff0e7a --- /dev/null +++ b/examples/microprofile/oidc/README.md @@ -0,0 +1,27 @@ +# Security integration with OIDC + +This example demonstrates integration with OIDC (Open ID Connect) providers. + +## Contents + +MP example that integrates with an OIDC provider. + +To configure this example, you need to replace the following: +1. src/main/resources/application.yaml - set security.properties.oidc-* to your tenant and application configuration + +## Running the Example + +Run the "OidcMain" class for file configuration based example. + +## Local configuration + +The example is already set up to read +`${user.home}/helidon/conf/examples.yaml` to override defaults configured +in `application.yaml`. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-security-oidc-login.jar +``` diff --git a/examples/microprofile/oidc/pom.xml b/examples/microprofile/oidc/pom.xml new file mode 100644 index 00000000..f72735f2 --- /dev/null +++ b/examples/microprofile/oidc/pom.xml @@ -0,0 +1,81 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-security-oidc-login + 1.0.0-SNAPSHOT + Helidon Microprofile Examples OIDC Security + + + Microprofile example with (any) OIDC provider integration. + + + + io.helidon.examples.microprofile.security.oidc.OidcMain + + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile + helidon-microprofile-oidc + + + org.jboss + jandex + runtime + true + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/OidcMain.java b/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/OidcMain.java new file mode 100644 index 00000000..bef6c09a --- /dev/null +++ b/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/OidcMain.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2019, 2021 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.security.oidc; + +import io.helidon.config.Config; +import io.helidon.microprofile.server.Server; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * Main class for MP. + */ +public final class OidcMain { + private OidcMain() { + } + + /** + * Start the application. + * @param args ignored. + */ + public static void main(String[] args) { + Server server = Server.builder() + .config(buildConfig()) + .build() + .start(); + + System.out.println("http://localhost:" + server.port() + "/test"); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults that are built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } +} diff --git a/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/OidcResource.java b/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/OidcResource.java new file mode 100644 index 00000000..14990025 --- /dev/null +++ b/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/OidcResource.java @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2019, 2021 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.security.oidc; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.core.Context; + +import io.helidon.security.SecurityContext; +import io.helidon.security.annotations.Authenticated; + +/** + * A simple JAX-RS resource with a single GET method. + */ +@Path("/test") +public class OidcResource { + + /** + * Hello world using security context. + * @param securityContext context as established during login + * @return a string with current username + */ + @Authenticated + @GET + public String getIt(@Context SecurityContext securityContext) { + return "Hello " + securityContext.userName(); + } + +} diff --git a/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/package-info.java b/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/package-info.java new file mode 100644 index 00000000..598a0f5f --- /dev/null +++ b/examples/microprofile/oidc/src/main/java/io/helidon/examples/microprofile/security/oidc/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2019, 2021 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. + */ +/** + * An OIDC (Open ID Connect) example. + */ +package io.helidon.examples.microprofile.security.oidc; diff --git a/examples/microprofile/oidc/src/main/resources/META-INF/beans.xml b/examples/microprofile/oidc/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..982bf410 --- /dev/null +++ b/examples/microprofile/oidc/src/main/resources/META-INF/beans.xml @@ -0,0 +1,23 @@ + + + + + \ No newline at end of file diff --git a/examples/microprofile/oidc/src/main/resources/application.yaml b/examples/microprofile/oidc/src/main/resources/application.yaml new file mode 100644 index 00000000..2a9747a2 --- /dev/null +++ b/examples/microprofile/oidc/src/main/resources/application.yaml @@ -0,0 +1,52 @@ +# +# Copyright (c) 2019, 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. +# + +server: + port: 7987 +security: + config.require-encryption: false + properties: + # this should be defined by the identity server + oidc-identity-uri: "https://tenant.some-server.com/oauth2/default" + # when you create a new client in identity server configuration, you should get a client id and a client secret + oidc-client-id: "some client id" + oidc-client-secret: "changeit" + # issuer of the tokens - identity server specific (maybe even configurable) + oidc-issuer: "https://tenant.some-server.com/oauth2/default" + # audience of the tokens - identity server specific (usually configurable) + oidc-audience: "configured audience" + # The frontend URI defines the possible load balancer address + # The redirect URI used is ${frontend-uri}${redirect-uri} + # Webserver is by default listening on /oidc/redirect - this can be modified by `redirect-uri` option in oidc configuration + frontend-uri: "http://localhost:7987" + server-type: "@default" + providers: + - abac: + # Adds ABAC Provider - it does not require any configuration + - oidc: + # use a custom name, so it does not clash with other examples + cookie-name: "OIDC_EXAMPLE_COOKIE" + # support for "Authorization" header with bearer token + header-use: true + # the default redirect-uri, where the webserver listens on redirects from identity server + redirect-uri: "/oidc/redirect" + issuer: "${security.properties.oidc-issuer}" + audience: "${security.properties.oidc-audience}" + client-id: "${security.properties.oidc-client-id}" + client-secret: "${security.properties.oidc-client-secret}" + identity-uri: "${security.properties.oidc-identity-uri}" + frontend-uri: "${security.properties.frontend-uri}" + server-type: "${security.properties.server-type}" diff --git a/examples/microprofile/oidc/src/main/resources/logging.properties b/examples/microprofile/oidc/src/main/resources/logging.properties new file mode 100644 index 00000000..a0f8cb75 --- /dev/null +++ b/examples/microprofile/oidc/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# Copyright (c) 2019, 2020 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. +# + +handlers = java.util.logging.ConsoleHandler + +java.util.logging.ConsoleHandler.level = FINEST +java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter +java.util.logging.SimpleFormatter.format = [%1$tc] %4$s: %2$s - %5$s %6$s%n + +.level = INFO +io.helidon.config.level = WARNING +# io.helidon.security.providers.oidc.level = FINEST +AUDIT.level=FINEST +# to see detailed information about failed validations of tokens +io.helidon.security.providers.oidc.level=FINEST diff --git a/examples/microprofile/openapi-basic/README.md b/examples/microprofile/openapi-basic/README.md new file mode 100644 index 00000000..2404b139 --- /dev/null +++ b/examples/microprofile/openapi-basic/README.md @@ -0,0 +1,33 @@ +# Helidon MP Basic OpenAPI Example + +This example shows a simple greeting application, similar to the one from the +Helidon MP QuickStart, enhanced with OpenAPI support. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-openapi-basic.jar +``` + +Try the endpoints: + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} + +curl -X GET http://localhost:8080/openapi +#[lengthy OpenAPI document] +``` +The output describes not only then endpoints from `GreetResource` but +also one contributed by the `SimpleAPIModelReader`. + + diff --git a/examples/microprofile/openapi-basic/pom.xml b/examples/microprofile/openapi-basic/pom.xml new file mode 100644 index 00000000..95e2ca97 --- /dev/null +++ b/examples/microprofile/openapi-basic/pom.xml @@ -0,0 +1,93 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-openapi-basic + 1.0.0-SNAPSHOT + Helidon Microprofile Example Basic OpenAPI + + + Microprofile example showing basic OpenAPI support + + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.microprofile.openapi + helidon-microprofile-openapi + + + org.glassfish.jersey.media + jersey-media-json-binding + runtime + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetResource.java b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetResource.java new file mode 100644 index 00000000..f9c50ada --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetResource.java @@ -0,0 +1,148 @@ +/* + * Copyright (c) 2019, 2023 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.microprofile.examples.openapi.basic; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import org.eclipse.microprofile.openapi.annotations.Operation; +import org.eclipse.microprofile.openapi.annotations.media.Content; +import org.eclipse.microprofile.openapi.annotations.media.ExampleObject; +import org.eclipse.microprofile.openapi.annotations.media.Schema; +import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; + +/** + * A simple JAX-RS resource with OpenAPI annotations to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * Get OpenAPI document for the endpoints + * curl -X GET http://localhost:8080/openapi + * + * Note that the output will include not only the annotated endpoints from this + * class but also an endpoint added by the {@link io.helidon.microprofile.examples.openapi.basic.internal.SimpleAPIModelReader}. + * + * The message is returned as a JSON object. + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + + /** + * The greeting message provider. + */ + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a worldly greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Operation(summary = "Returns a generic greeting", + description = "Greets the user generically") + @APIResponse(description = "Simple JSON containing the greeting", + content = @Content(mediaType = "application/json", + schema = @Schema(implementation = GreetingMessage.class))) + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link GreetingMessage} + */ + @Path("/{name}") + @GET + @Operation(summary = "Returns a personalized greeting") + @APIResponse(description = "Simple JSON containing the greeting", + content = @Content(mediaType = "application/json", + schema = @Schema(implementation = GreetingMessage.class))) + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message JSON containing the new greeting + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Operation(summary = "Set the greeting prefix", + description = "Permits the client to set the prefix part of the greeting (\"Hello\")") + @RequestBody( + name = "greeting", + description = "Conveys the new greeting prefix to use in building greetings", + content = @Content( + mediaType = "application/json", + schema = @Schema(implementation = GreetingMessage.class), + examples = @ExampleObject( + name = "greeting", + summary = "Example greeting message to update", + value = "{\"message\": \"New greeting message\"}"))) + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + public Response updateGreeting(GreetingMessage message) { + + if (message.getMessage() == null) { + GreetingMessage entity = new GreetingMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); + } + greetingProvider.setMessage(message.getMessage()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new GreetingMessage(msg); + } + +} diff --git a/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetingMessage.java b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetingMessage.java new file mode 100644 index 00000000..6f8eee43 --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023 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.microprofile.examples.openapi.basic; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetingProvider.java b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetingProvider.java new file mode 100644 index 00000000..8c8fda7b --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/GreetingProvider.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2019, 2021 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.microprofile.examples.openapi.basic; + +import java.util.concurrent.atomic.AtomicReference; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +public class GreetingProvider { + private final AtomicReference message = new AtomicReference<>(); + + /** + * Create a new greeting provider, reading the message from configuration. + * + * @param message greeting to use + */ + @Inject + public GreetingProvider(@ConfigProperty(name = "app.greeting") String message) { + this.message.set(message); + } + + String getMessage() { + return message.get(); + } + + void setMessage(String message) { + this.message.set(message); + } +} diff --git a/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/SimpleAPIFilter.java b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/SimpleAPIFilter.java new file mode 100644 index 00000000..2d7c1eaf --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/SimpleAPIFilter.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2019, 2023 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.microprofile.examples.openapi.basic.internal; + +import java.util.Map; + +import org.eclipse.microprofile.openapi.OASFilter; +import org.eclipse.microprofile.openapi.models.Operation; +import org.eclipse.microprofile.openapi.models.PathItem; + +/** + * Example OpenAPI filter which hides a single endpoint from the OpenAPI document. + */ +public class SimpleAPIFilter implements OASFilter { + + @Override + public PathItem filterPathItem(PathItem pathItem) { + for (Map.Entry methodOp + : pathItem.getOperations().entrySet()) { + if (SimpleAPIModelReader.DOOMED_OPERATION_ID + .equals(methodOp.getValue().getOperationId())) { + return null; + } + } + return OASFilter.super.filterPathItem(pathItem); + } +} diff --git a/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/SimpleAPIModelReader.java b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/SimpleAPIModelReader.java new file mode 100644 index 00000000..e0bd6bc2 --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/SimpleAPIModelReader.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2019, 2023 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.microprofile.examples.openapi.basic.internal; + +import org.eclipse.microprofile.openapi.OASFactory; +import org.eclipse.microprofile.openapi.OASModelReader; +import org.eclipse.microprofile.openapi.models.OpenAPI; +import org.eclipse.microprofile.openapi.models.PathItem; +import org.eclipse.microprofile.openapi.models.Paths; + +/** + * Defines two paths using the OpenAPI model reader mechanism, one that should + * be suppressed by the filter class and one that should appear in the published + * OpenAPI document. + */ +public class SimpleAPIModelReader implements OASModelReader { + + /** + * Path for the example endpoint added by this model reader that should be visible. + */ + public static final String MODEL_READER_PATH = "/test/newpath"; + + /** + * Path for an endpoint that the filter should hide. + */ + public static final String DOOMED_PATH = "/test/doomed"; + + /** + * ID for an endpoint that the filter should hide. + */ + public static final String DOOMED_OPERATION_ID = "doomedPath"; + + /** + * Summary text for the endpoint. + */ + public static final String SUMMARY = "A sample test endpoint from ModelReader"; + + @Override + public OpenAPI buildModel() { + /* + * Add two path items, one of which we expect to be removed by + * the filter and a very simple one that will appear in the + * published OpenAPI document. + */ + PathItem newPathItem = OASFactory.createPathItem() + .GET(OASFactory.createOperation() + .operationId("newPath") + .summary(SUMMARY)); + PathItem doomedPathItem = OASFactory.createPathItem() + .GET(OASFactory.createOperation() + .operationId(DOOMED_OPERATION_ID) + .summary("This should become invisible")); + OpenAPI openAPI = OASFactory.createOpenAPI(); + Paths paths = OASFactory.createPaths() + .addPathItem(MODEL_READER_PATH, newPathItem) + .addPathItem(DOOMED_PATH, doomedPathItem); + openAPI.paths(paths); + + return openAPI; + } +} diff --git a/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/package-info.java b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/package-info.java new file mode 100644 index 00000000..b26f5559 --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/internal/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 2023 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. + */ + +/** + * Internal classes supporting Helidon MP OpenAPI. + */ +package io.helidon.microprofile.examples.openapi.basic.internal; diff --git a/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/package-info.java b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/package-info.java new file mode 100644 index 00000000..cf5f401b --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/java/io/helidon/microprofile/examples/openapi/basic/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 2021 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. + */ + +/** + * Helidon MicroProfile OpenAPI basic example. + */ +package io.helidon.microprofile.examples.openapi.basic; diff --git a/examples/microprofile/openapi-basic/src/main/resources/META-INF/beans.xml b/examples/microprofile/openapi-basic/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..9a480602 --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/openapi-basic/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/openapi-basic/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..edf0cc5b --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2019, 2021 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. +# + +# Application properties. This is the default greeting +app.greeting=Hello + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +mp.openapi.filter=io.helidon.microprofile.examples.openapi.basic.internal.SimpleAPIFilter +mp.openapi.model.reader=io.helidon.microprofile.examples.openapi.basic.internal.SimpleAPIModelReader diff --git a/examples/microprofile/openapi-basic/src/main/resources/logging.properties b/examples/microprofile/openapi-basic/src/main/resources/logging.properties new file mode 100644 index 00000000..4029baf3 --- /dev/null +++ b/examples/microprofile/openapi-basic/src/main/resources/logging.properties @@ -0,0 +1,37 @@ +# +# Copyright (c) 2019, 2021 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.microprofile.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO +#org.glassfish.jersey.level=INFO +#org.jboss.weld=INFO diff --git a/examples/microprofile/openapi-basic/src/test/java/io/helidon/microprofile/examples/openapi/basic/MainTest.java b/examples/microprofile/openapi-basic/src/test/java/io/helidon/microprofile/examples/openapi/basic/MainTest.java new file mode 100644 index 00000000..714b29b8 --- /dev/null +++ b/examples/microprofile/openapi-basic/src/test/java/io/helidon/microprofile/examples/openapi/basic/MainTest.java @@ -0,0 +1,134 @@ +/* + * Copyright (c) 2019, 2023 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.microprofile.examples.openapi.basic; + +import javax.enterprise.inject.se.SeContainer; +import javax.enterprise.inject.spi.CDI; +import javax.json.Json; +import javax.json.JsonObject; +import javax.json.JsonPointer; +import javax.json.JsonString; +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.Entity; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.examples.openapi.basic.internal.SimpleAPIModelReader; +import io.helidon.microprofile.server.Server; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +class MainTest { + private static Server server; + + @BeforeAll + public static void startTheServer() throws Exception { + server = startServer(); + } + + @Test + void testHelloWorld() { + + Client client = ClientBuilder.newClient(); + + GreetingMessage message = client + .target(getConnectionString("/greet")) + .request() + .get(GreetingMessage.class); + assertThat("default message", message.getMessage(), + is("Hello World!")); + + message = client + .target(getConnectionString("/greet/Joe")) + .request() + .get(GreetingMessage.class); + assertThat("hello Joe message", message.getMessage(), + is("Hello Joe!")); + + try (Response r = client + .target(getConnectionString("/greet/greeting")) + .request() + .put(Entity.entity("{\"message\" : \"Hola\"}", MediaType.APPLICATION_JSON))) { + assertThat("PUT status code", r.getStatus(), is(204)); + } + + message = client + .target(getConnectionString("/greet/Jose")) + .request() + .get(GreetingMessage.class); + assertThat("hola Jose message", message.getMessage(), + is("Hola Jose!")); + + client.close(); + } + + @Test + public void testOpenAPI() { + + Client client = ClientBuilder.newClient(); + + JsonObject jsonObject = client + .target(getConnectionString("/openapi")) + .request(MediaType.APPLICATION_JSON) + .get(JsonObject.class); + JsonObject paths = jsonObject.get("paths").asJsonObject(); + + JsonPointer jp = Json.createPointer("/" + escape(SimpleAPIModelReader.MODEL_READER_PATH) + "/get/summary"); + JsonString js = JsonString.class.cast(jp.getValue(paths)); + assertThat("/test/newpath GET summary did not match", js.getString(), is(SimpleAPIModelReader.SUMMARY)); + + jp = Json.createPointer("/" + escape(SimpleAPIModelReader.DOOMED_PATH)); + assertThat("/test/doomed should not appear but does", jp.containsValue(paths), is(false)); + + jp = Json.createPointer("/" + escape("/greet") + "/get/summary"); + js = JsonString.class.cast(jp.getValue(paths)); + assertThat("/greet GET summary did not match", js.getString(), is("Returns a generic greeting")); + + client.close(); + } + + @AfterAll + static void destroyClass() { + CDI current = CDI.current(); + ((SeContainer) current).close(); + } + + private String getConnectionString(String path) { + return "http://localhost:" + server.port() + path; + } + + /** + * Start the server. + * @return the created {@link Server} instance + */ + static Server startServer() { + // Server will automatically pick up configuration from + // microprofile-config.properties + // and Application classes annotated as @ApplicationScoped + return Server.create().start(); + } + + private String escape(String path) { + return path.replace("/", "~1"); + } +} diff --git a/examples/microprofile/openapi-basic/src/test/resources/META-INF/microprofile-config.properties b/examples/microprofile/openapi-basic/src/test/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..242323a4 --- /dev/null +++ b/examples/microprofile/openapi-basic/src/test/resources/META-INF/microprofile-config.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2019, 2021 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. +# + + +# Override configuration in main source branch, so we do not use 8080 port for tests +config_ordinal=1000 +# Microprofile server properties +server.port=-1 +server.host=0.0.0.0 diff --git a/examples/microprofile/pom.xml b/examples/microprofile/pom.xml new file mode 100644 index 00000000..917caaef --- /dev/null +++ b/examples/microprofile/pom.xml @@ -0,0 +1,53 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + pom + io.helidon.examples.microprofile + helidon-examples-microprofile-project + Helidon Microprofile Examples + + + graphql + hello-world-implicit + hello-world-explicit + static-content + security + idcs + multipart + oidc + openapi-basic + websocket + messaging-sse + cors + tls + multiport + bean-validation + http-status-count-mp + lra + + diff --git a/examples/microprofile/security/README.md b/examples/microprofile/security/README.md new file mode 100644 index 00000000..7636f44b --- /dev/null +++ b/examples/microprofile/security/README.md @@ -0,0 +1,28 @@ + +# Helidon MP Multiple Applications with Security + +Example MicroProfile application. This has two JAX-RS applications +sharing a common resource accessed through different context roots. + +The resource has multiple endpoints, protected with different +levels of security. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-mp1_1-security.jar +``` + +## Endpoints + +Open either of the following in a browser. Once the page loads +click on the links to try and load endpoints restricted to +admin roles or user roles. See the example's `application.yaml` +for the list of user, passwords and roles. + +|Endpoint |Description | +|:-----------|:----------------| +|`static/helloworld`|Public page with no security| +|`other/helloworld`|Same page from second application| + diff --git a/examples/microprofile/security/pom.xml b/examples/microprofile/security/pom.xml new file mode 100644 index 00000000..45260d7c --- /dev/null +++ b/examples/microprofile/security/pom.xml @@ -0,0 +1,88 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-mp1_1-security + 1.0.0-SNAPSHOT + Helidon Microprofile Examples MP 1.1 Security + + + Microprofile 1.1 example with security + + + + io.helidon.microprofile.example.security.Main + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/HelloWorldResource.java b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/HelloWorldResource.java new file mode 100644 index 00000000..6bbe3394 --- /dev/null +++ b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/HelloWorldResource.java @@ -0,0 +1,105 @@ +/* + * Copyright (c) 2018, 2020 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.microprofile.example.security; + +import javax.annotation.security.RolesAllowed; +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; + +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.annotations.Authenticated; +import io.helidon.security.annotations.Authorized; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * A dynamic resource that shows a link to the static resource. + */ +@Path("/helloworld") +@RequestScoped +public class HelloWorldResource { + @Inject + private Security security; + @Inject + private SecurityContext securityContext; + + @Inject + @ConfigProperty(name = "server.static.classpath.context") + private String context; + + /** + * Public page (does not require authentication). + * If there is pre-emptive basic auth, it will run within a user context. + * + * @return web page with links to other resources + */ + @GET + @Produces(MediaType.TEXT_HTML) + @Authenticated(optional = true) + public String getPublic() { + return "Hello World. This is a public page with no security " + + "Allowed for admin only
" + + "Allowed for user only
" + + "" + context + "/resource.html allowed for a logged in user
" + + "you are logged in as: " + securityContext.user() + + ""; + } + + /** + * Page restricted to users in "admin" role. + * + * @param securityContext Helidon security context + * @return web page with links to other resources + */ + @GET + @Path("/admin") + @Produces(MediaType.TEXT_HTML) + @Authenticated + @Authorized + @RolesAllowed("admin") + public String getAdmin(@Context SecurityContext securityContext) { + return "Hello World. You may want to check " + + "" + context + "/resource.html
" + + "you are logged in as: " + securityContext.user() + + ""; + } + + /** + * Page restricted to users in "user" role. + * + * @param securityContext Helidon security context + * @return web page with links to other resources + */ + @GET + @Path("/user") + @Produces(MediaType.TEXT_HTML) + @Authenticated + @Authorized + @RolesAllowed("user") + public String getUser(@Context SecurityContext securityContext) { + return "Hello World. You may want to check " + + "" + context + "/resource.html
" + + "you are logged in as: " + securityContext.user() + + ""; + } +} diff --git a/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/Main.java b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/Main.java new file mode 100644 index 00000000..d8208964 --- /dev/null +++ b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/Main.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2018, 2020 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.microprofile.example.security; + +import java.util.concurrent.TimeUnit; + +import io.helidon.microprofile.server.Server; + +/** + * Main class to start the application. + * See resources/META-INF/microprofile-config.properties. + */ +public final class Main { + private Main() { + } + + /** + * Run this example. + * + * @param args command line arguments (ignored) + */ + public static void main(String[] args) { + long now = System.nanoTime(); + + Server server = Server.create(StaticContentApp.class, OtherApp.class) + .start(); + + now = System.nanoTime() - now; + System.out.println("Start server: " + TimeUnit.MILLISECONDS.convert(now, TimeUnit.NANOSECONDS)); + System.out.println("Endpoint available at http://localhost:" + server.port() + "/static/helloworld"); + System.out.println("Alternative endpoint (second application) available at http://localhost:" + server + .port() + "/other/helloworld"); + } +} diff --git a/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/OtherApp.java b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/OtherApp.java new file mode 100644 index 00000000..80716ce5 --- /dev/null +++ b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/OtherApp.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2018, 2020 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.microprofile.example.security; + +import java.util.Set; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.ApplicationPath; +import javax.ws.rs.core.Application; + +/** + * An example of two applications in a single MP Server. + * This is the "other" application - serving the same resource on a different context. + */ +@ApplicationScoped +@ApplicationPath("/other") +public class OtherApp extends Application { + @Override + public Set> getClasses() { + return Set.of( + HelloWorldResource.class + ); + } +} diff --git a/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/StaticContentApp.java b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/StaticContentApp.java new file mode 100644 index 00000000..aad3215b --- /dev/null +++ b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/StaticContentApp.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2018, 2020 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.microprofile.example.security; + +import java.util.Set; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.ApplicationPath; +import javax.ws.rs.core.Application; + +/** + * Example JAX-RS application with static content. + */ +@ApplicationScoped +@ApplicationPath("/static") +public class StaticContentApp extends Application { + @Override + public Set> getClasses() { + return Set.of( + HelloWorldResource.class + ); + } +} diff --git a/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/package-info.java b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/package-info.java new file mode 100644 index 00000000..52da3d94 --- /dev/null +++ b/examples/microprofile/security/src/main/java/io/helidon/microprofile/example/security/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 2020 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. + */ + +/** + * Static content example. + */ +package io.helidon.microprofile.example.security; diff --git a/examples/microprofile/security/src/main/resources/META-INF/beans.xml b/examples/microprofile/security/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..55a0f38e --- /dev/null +++ b/examples/microprofile/security/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/security/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/security/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..40ae4bec --- /dev/null +++ b/examples/microprofile/security/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2018, 2020 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. +# + +# web server configuration +# Use a random free port +server.port=0 + +# location on classpath (e.g. src/main/resources/WEB in maven) +server.static.classpath.location=/WEB +# this is optional, defaults to "/" +server.static.classpath.context=/static-cp +# server.static.path.location=/content +# server.static.path.context=/static-file diff --git a/examples/microprofile/security/src/main/resources/WEB/resource.html b/examples/microprofile/security/src/main/resources/WEB/resource.html new file mode 100644 index 00000000..70f019da --- /dev/null +++ b/examples/microprofile/security/src/main/resources/WEB/resource.html @@ -0,0 +1,32 @@ + + + + + +Hello, this is a static resource loaded from classpath. +

+ The configuration (microprofile config): +


+        server.static.classpath.location=/WEB
+        server.static.classpath.context=/static-cp
+
+

+ + + diff --git a/examples/microprofile/security/src/main/resources/application.yaml b/examples/microprofile/security/src/main/resources/application.yaml new file mode 100644 index 00000000..2ea4cce6 --- /dev/null +++ b/examples/microprofile/security/src/main/resources/application.yaml @@ -0,0 +1,40 @@ +# +# Copyright (c) 2018, 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. +# + +# As security uses a tree structure with object arrays, it is easier to define in yaml or JSON +# META-INF/microprofile-config.properties is still used for basic server configuration + + +# security for jersey is based on annotations +# security for webserver is configured here (static content) +security: + providers: + - abac: + - http-basic-auth: + realm: "helidon" + users: + - login: "jack" + password: "changeit" + roles: ["user", "admin"] + - login: "jill" + password: "changeit" + roles: ["user"] + - login: "john" + password: "changeit" + web-server: + paths: + - path: "/static-cp[/{*}]" + authenticate: true diff --git a/examples/microprofile/security/src/main/resources/logging.properties b/examples/microprofile/security/src/main/resources/logging.properties new file mode 100644 index 00000000..73bb7b5f --- /dev/null +++ b/examples/microprofile/security/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2018, 2020 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.config.level=FINEST diff --git a/examples/microprofile/static-content/README.md b/examples/microprofile/static-content/README.md new file mode 100644 index 00000000..083ac410 --- /dev/null +++ b/examples/microprofile/static-content/README.md @@ -0,0 +1,20 @@ +# Helidon MP with Static Content + +This example has a simple Hello World rest enpoint, plus +static content that is loaded from the application's classpath. +The configuration for the static content is in the +`microprofile-config.properties` file. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-mp1_1-static-content.jar +``` + +## Endpoints + +|Endpoint |Description | +|:-----------|:----------------| +|`helloworld`|Rest enpoint providing a link to the static content| +|`resource.html`|The static content| diff --git a/examples/microprofile/static-content/pom.xml b/examples/microprofile/static-content/pom.xml new file mode 100644 index 00000000..15b318d9 --- /dev/null +++ b/examples/microprofile/static-content/pom.xml @@ -0,0 +1,123 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-mp1_1-static-content + 1.0.0-SNAPSHOT + Helidon Microprofile Examples MP 1.1 Static Content + + + Microprofile 1.1 example with static content + + + + io.helidon.microprofile.example.staticc.Main + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + **/*$* + io/helidon/microprofile/example/staticc/StaticContentTest.java + + + + + org.apache.maven.plugins + maven-failsafe-plugin + + + Run integration tests + integration-test + + integration-test + + + + io/helidon/microprofile/example/staticc/StaticContentTest.java + + + + + Verify integration tests + verify + + verify + + + + + + + diff --git a/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/HelloWorldResource.java b/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/HelloWorldResource.java new file mode 100644 index 00000000..26a25960 --- /dev/null +++ b/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/HelloWorldResource.java @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2018, 2020 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.microprofile.example.staticc; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * A dynamic resource that shows a link to the static resource. + */ +@Path("/helloworld") +@RequestScoped +public class HelloWorldResource { + @Inject + @ConfigProperty(name = "server.static.classpath.context", defaultValue = "") + private String context; + + @GET + @Produces(MediaType.TEXT_HTML) + public String getIt() { + return "Hello World. You may want to check " + + "" + context + "/resource.html" + + ""; + } +} diff --git a/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/Main.java b/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/Main.java new file mode 100644 index 00000000..cacb5c04 --- /dev/null +++ b/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/Main.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2018, 2020 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.microprofile.example.staticc; + +import java.util.concurrent.TimeUnit; + +import io.helidon.microprofile.server.Server; + +/** + * Main class to start the application. + * See resources/META-INF/microprofile-config.properties. + */ +public class Main { + private static int port; + + private Main() { + } + + /** + * Run this example. + * + * @param args command line arguments (ignored) + */ + public static void main(String[] args) { + long now = System.nanoTime(); + + // everything is configured through application.yaml + Server server = Server.create(); + + now = System.nanoTime() - now; + System.out.println("Create server: " + TimeUnit.MILLISECONDS.convert(now, TimeUnit.NANOSECONDS)); + now = System.nanoTime(); + + server.start(); + + port = server.port(); + + now = System.nanoTime() - now; + System.out.println("Start server: " + TimeUnit.MILLISECONDS.convert(now, TimeUnit.NANOSECONDS)); + System.out.println("Endpoint available at http://localhost:" + port + "/helloworld"); + } + + public static int getPort() { + return port; + } +} diff --git a/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/package-info.java b/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/package-info.java new file mode 100644 index 00000000..7889402e --- /dev/null +++ b/examples/microprofile/static-content/src/main/java/io/helidon/microprofile/example/staticc/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 2020 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. + */ + +/** + * Static content example. + */ +package io.helidon.microprofile.example.staticc; diff --git a/examples/microprofile/static-content/src/main/java/module-info.java.txt b/examples/microprofile/static-content/src/main/java/module-info.java.txt new file mode 100644 index 00000000..8ca46fa5 --- /dev/null +++ b/examples/microprofile/static-content/src/main/java/module-info.java.txt @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2018, 2021 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 1.1. static content example. + */ + // TODO disabled for now, as automatic modules don't work with e-api of jboss (number is not allowed): + /* + java.lang.module.FindException: Unable to derive module descriptor for /Users/tomas/.m2/repository/org/jboss/spec/javax/el/jboss-el-api_3.0_spec/1.0.7.Final/jboss-el-api_3.0_spec-1.0.7.Final.jar + Caused by: java.lang.IllegalArgumentException: jboss.el.api.3.0.spec: Invalid module name: '3' is not a Java identifier + */ +module io.helidon.microprofile.example.staticc { + requires cdi.api; + requires javax.inject; + requires java.ws.rs; + requires microprofile.config.api; + requires io.helidon.microprofile.server; +} diff --git a/examples/microprofile/static-content/src/main/resources/META-INF/beans.xml b/examples/microprofile/static-content/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..55a0f38e --- /dev/null +++ b/examples/microprofile/static-content/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/static-content/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/static-content/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..ef43eb4c --- /dev/null +++ b/examples/microprofile/static-content/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,27 @@ +# +# Copyright (c) 2018, 2020 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. +# + +# web server configuration +# Use a random free port +server.port=0 + +# location on classpath (e.g. src/main/resources/WEB in maven) +server.static.classpath.location=/WEB +server.static.classpath.welcome=resource.html +# this is optional, defaults to "/" +# server.static.classpath.context=/static-cp +# server.static.path=/content +# server.static.path.context=/static-file diff --git a/examples/microprofile/static-content/src/main/resources/WEB/resource.html b/examples/microprofile/static-content/src/main/resources/WEB/resource.html new file mode 100644 index 00000000..90cce542 --- /dev/null +++ b/examples/microprofile/static-content/src/main/resources/WEB/resource.html @@ -0,0 +1,33 @@ + + + + + +Hello, this is a static resource loaded from classpath. +

+ The configuration (microprofile config): +


+        server.static.classpath.location=/WEB
+
+ +

+ Dynamic page (a hello world) can be found here: /helloworld + + + diff --git a/examples/microprofile/static-content/src/main/resources/logging.properties b/examples/microprofile/static-content/src/main/resources/logging.properties new file mode 100644 index 00000000..7ea32155 --- /dev/null +++ b/examples/microprofile/static-content/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2018, 2020 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. +# + +#All attributes details +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tY.%1$tm.%1$td %1$tH:%1$tM:%1$tS.%1$tL] %4$s %3$s : %5$s%6$s%n +#All log level details +.level=INFO +# Microprofile config +# io.helidon.microprofile.config.level = FINEST +# Microprofile server startup +io.helidon.microprofile.startup.level=FINEST +org.glassfish.jersey.internal.Errors.level=SEVERE diff --git a/examples/microprofile/static-content/src/test/java/io/helidon/microprofile/example/staticc/StaticContentTest.java b/examples/microprofile/static-content/src/test/java/io/helidon/microprofile/example/staticc/StaticContentTest.java new file mode 100644 index 00000000..f544488e --- /dev/null +++ b/examples/microprofile/static-content/src/test/java/io/helidon/microprofile/example/staticc/StaticContentTest.java @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2018, 2021 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.microprofile.example.staticc; + +import java.io.IOException; + +import javax.enterprise.inject.se.SeContainer; +import javax.enterprise.inject.spi.CDI; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.common.http.Http; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.is; +import static org.junit.jupiter.api.Assertions.assertAll; + +/** + * Unit test for {@link HelloWorldResource}. + */ +class StaticContentTest { + @BeforeAll + static void initClass() throws IOException { + Main.main(new String[0]); + } + + @AfterAll + static void destroyClass() { + CDI current = CDI.current(); + ((SeContainer) current).close(); + } + + @Test + void testDynamicResource() { + String response = ClientBuilder.newClient() + .target("http://localhost:" + Main.getPort() + "/helloworld") + .request() + .get(String.class); + + assertAll("Response must be HTML and contain a ref to static resource", + () -> assertThat(response, containsString("/resource.html")), + () -> assertThat(response, containsString("Hello World")) + ); + } + + @Test + void testWelcomePage() { + try (Response response = ClientBuilder.newClient() + .target("http://localhost:" + Main.getPort()) + .request() + .accept(MediaType.TEXT_HTML_TYPE) + .get()) { + assertThat("Status should be 200", response.getStatus(), is(Http.Status.OK_200.code())); + + String str = response.readEntity(String.class); + + assertAll( + () -> assertThat(response.getMediaType(), is(MediaType.TEXT_HTML_TYPE)), + () -> assertThat(str, containsString("server.static.classpath.location=/WEB")) + ); + } + } + + @Test + void testStaticResource() { + try (Response response = ClientBuilder.newClient() + .target("http://localhost:" + Main.getPort() + "/resource.html") + .request() + .accept(MediaType.TEXT_HTML_TYPE) + .get()) { + assertThat("Status should be 200", response.getStatus(), is(Http.Status.OK_200.code())); + + String str = response.readEntity(String.class); + + assertAll( + () -> assertThat(response.getMediaType(), is(MediaType.TEXT_HTML_TYPE)), + () -> assertThat(str, containsString("server.static.classpath.location=/WEB")) + ); + } + } +} diff --git a/examples/microprofile/static-content/src/test/resources/logging.properties b/examples/microprofile/static-content/src/test/resources/logging.properties new file mode 100644 index 00000000..b5af390c --- /dev/null +++ b/examples/microprofile/static-content/src/test/resources/logging.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2018, 2023 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +.level=INFO +org.jboss.weld.level=INFO diff --git a/examples/microprofile/tls/README.md b/examples/microprofile/tls/README.md new file mode 100644 index 00000000..31bceaac --- /dev/null +++ b/examples/microprofile/tls/README.md @@ -0,0 +1,16 @@ +# Helidon MP TLS Example + +This examples shows how to configure server TLS using Helidon MP. + +Note: This example uses self-signed server certificate! + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-tls.jar +``` +## Exercise the application +```shell +curl -k -X GET https://localhost:8080 +``` diff --git a/examples/microprofile/tls/pom.xml b/examples/microprofile/tls/pom.xml new file mode 100644 index 00000000..86007b6d --- /dev/null +++ b/examples/microprofile/tls/pom.xml @@ -0,0 +1,84 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + + io.helidon.examples.microprofile + helidon-examples-microprofile-tls + 1.0.0-SNAPSHOT + Helidon Microprofile Examples TLS + + + Microprofile example that configures TLS + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + diff --git a/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/GreetResource.java b/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/GreetResource.java new file mode 100644 index 00000000..f2d63433 --- /dev/null +++ b/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/GreetResource.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2020, 2023 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.microprofile.example.tls; + +import javax.enterprise.context.RequestScoped; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +/** + * A simple JAX-RS resource to greet you. Examples: + * + * Get default greeting message: + * curl -X GET https://localhost:8080 + * + * The message is returned as a plain text. + */ +@Path("/") +@RequestScoped +public class GreetResource { + + /** + * Return a greeting message. + * + * @return {@link String} + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public String getDefaultMessage() { + return "Hello user!"; + } + +} diff --git a/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/Main.java b/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/Main.java new file mode 100644 index 00000000..ab9ad747 --- /dev/null +++ b/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/Main.java @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2020 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.microprofile.example.tls; + +import io.helidon.microprofile.server.Server; + +/** + * Starts the server. + */ +public class Main { + + private Main() { + } + + /** + * Main method. + * + * @param args args + */ + public static void main(String[] args) { + startServer(); + } + + static Server startServer() { + return Server.create().start(); + } + +} diff --git a/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/package-info.java b/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/package-info.java new file mode 100644 index 00000000..c2d67894 --- /dev/null +++ b/examples/microprofile/tls/src/main/java/io/helidon/microprofile/example/tls/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020 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. + */ + +/** + * Quickstart MicroProfile example. + */ +package io.helidon.microprofile.example.tls; diff --git a/examples/microprofile/tls/src/main/resources/META-INF/beans.xml b/examples/microprofile/tls/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..5de4daa3 --- /dev/null +++ b/examples/microprofile/tls/src/main/resources/META-INF/beans.xml @@ -0,0 +1,24 @@ + + + + + diff --git a/examples/microprofile/tls/src/main/resources/META-INF/microprofile-config.properties b/examples/microprofile/tls/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..2c3978a7 --- /dev/null +++ b/examples/microprofile/tls/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,28 @@ +# +# Copyright (c) 2020, 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 + +#Truststore setup +server.tls.trust.keystore.resource.resource-path=server.p12 +server.tls.trust.keystore.passphrase=changeit +server.tls.trust.keystore.trust-store=true + +#Keystore with private key and server certificate +server.tls.private-key.keystore.resource.resource-path=server.p12 +server.tls.private-key.keystore.passphrase=changeit diff --git a/examples/microprofile/tls/src/main/resources/logging.properties b/examples/microprofile/tls/src/main/resources/logging.properties new file mode 100644 index 00000000..a71c681a --- /dev/null +++ b/examples/microprofile/tls/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# Copyright (c) 2020 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.common.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 + diff --git a/examples/microprofile/tls/src/main/resources/server.p12 b/examples/microprofile/tls/src/main/resources/server.p12 new file mode 100644 index 00000000..d2599833 Binary files /dev/null and b/examples/microprofile/tls/src/main/resources/server.p12 differ diff --git a/examples/microprofile/tls/src/test/java/io/helidon/microprofile/example/tls/TlsTest.java b/examples/microprofile/tls/src/test/java/io/helidon/microprofile/example/tls/TlsTest.java new file mode 100644 index 00000000..a37b479c --- /dev/null +++ b/examples/microprofile/tls/src/test/java/io/helidon/microprofile/example/tls/TlsTest.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2020, 2021 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.microprofile.example.tls; + +import java.net.URI; +import java.security.cert.CertificateException; +import java.security.cert.X509Certificate; + +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.server.Server; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Test of the example. + */ +public class TlsTest { + + private static Client client; + static { + + try { + SSLContext sslcontext = SSLContext.getInstance("TLS"); + sslcontext.init(null, new TrustManager[]{new X509TrustManager() { + public void checkClientTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {} + public void checkServerTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {} + public X509Certificate[] getAcceptedIssuers() { return new X509Certificate[0]; } + }}, new java.security.SecureRandom()); + + client = ClientBuilder.newBuilder() + .sslContext(sslcontext) + .build(); + } catch (Exception e) { + e.printStackTrace(); + } + } + private static Server server; + + @BeforeAll + static void initClass() { + server = Main.startServer(); + server.start(); + } + + @AfterAll + static void destroyClass() { + server.stop(); + } + + @Test + public void testTls() { + URI restUri = URI.create("https://localhost:" + server.port() + "/"); + try (Response res = client.target(restUri).request().get()) { + assertThat(res.getStatus(), is(200)); + assertThat(res.readEntity(String.class), is("Hello user!")); + } + } + +} diff --git a/examples/microprofile/tls/src/test/resources/META-INF/microprofile-config.properties b/examples/microprofile/tls/src/test/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..32b20fab --- /dev/null +++ b/examples/microprofile/tls/src/test/resources/META-INF/microprofile-config.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2020 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=0 + +config_ordinal=500 diff --git a/examples/microprofile/websocket/README.md b/examples/microprofile/websocket/README.md new file mode 100644 index 00000000..61223b9a --- /dev/null +++ b/examples/microprofile/websocket/README.md @@ -0,0 +1,15 @@ +# Helidon MP WebSocket Example + +This examples shows a simple application written using Helidon MP +that combines REST resources and WebSocket endpoints. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-microprofile-websocket.jar +``` + +```shell +http://localhost:7001/web/index.html +``` diff --git a/examples/microprofile/websocket/pom.xml b/examples/microprofile/websocket/pom.xml new file mode 100644 index 00000000..42fcf7a9 --- /dev/null +++ b/examples/microprofile/websocket/pom.xml @@ -0,0 +1,103 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.microprofile + helidon-examples-microprofile-websocket + 1.0.0-SNAPSHOT + Helidon Microprofile Examples WebSocket + + + Microprofile example that uses websockets + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.microprofile.websocket + helidon-microprofile-websocket + + + org.jboss + jandex + runtime + true + + + org.glassfish.tyrus + tyrus-client + test + + + org.glassfish.tyrus + tyrus-container-grizzly-client + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageBoardEndpoint.java b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageBoardEndpoint.java new file mode 100644 index 00000000..cfd3407f --- /dev/null +++ b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageBoardEndpoint.java @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.example.websocket; + +import java.io.IOException; +import java.util.logging.Logger; + +import javax.inject.Inject; +import javax.websocket.Encoder; +import javax.websocket.EndpointConfig; +import javax.websocket.OnClose; +import javax.websocket.OnError; +import javax.websocket.OnMessage; +import javax.websocket.OnOpen; +import javax.websocket.Session; +import javax.websocket.server.ServerEndpoint; + +/** + * Class MessageBoardEndpoint. + */ +@ServerEndpoint( + value = "/websocket", + encoders = { MessageBoardEndpoint.UppercaseEncoder.class } +) +public class MessageBoardEndpoint { + private static final Logger LOGGER = Logger.getLogger(MessageBoardEndpoint.class.getName()); + + @Inject + private MessageQueue messageQueue; + + /** + * OnOpen call. + * + * @param session The websocket session. + * @throws IOException If error occurs. + */ + @OnOpen + public void onOpen(Session session) throws IOException { + LOGGER.info("OnOpen called"); + } + + /** + * OnMessage call. + * + * @param session The websocket session. + * @param message The message received. + * @throws Exception If error occurs. + */ + @OnMessage + public void onMessage(Session session, String message) throws Exception { + LOGGER.info("OnMessage called '" + message + "'"); + + // Send all messages in the queue + if (message.equals("SEND")) { + while (!messageQueue.isEmpty()) { + session.getBasicRemote().sendObject(messageQueue.pop()); + } + } + } + + /** + * OnError call. + * + * @param t The throwable. + */ + @OnError + public void onError(Throwable t) { + LOGGER.info("OnError called"); + } + + /** + * OnError call. + * + * @param session The websocket session. + */ + @OnClose + public void onClose(Session session) { + LOGGER.info("OnClose called"); + } + + /** + * Uppercase encoder. + */ + public static class UppercaseEncoder implements Encoder.Text { + + @Override + public String encode(String s) { + LOGGER.info("UppercaseEncoder encode called"); + return s.toUpperCase(); + } + + @Override + public void init(EndpointConfig config) { + } + + @Override + public void destroy() { + } + } +} diff --git a/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageQueue.java b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageQueue.java new file mode 100644 index 00000000..dedd8270 --- /dev/null +++ b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageQueue.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.example.websocket; + +import java.util.Queue; +import java.util.concurrent.ConcurrentLinkedQueue; + +import javax.enterprise.context.ApplicationScoped; + +/** + * Class MessageQueue. + */ +@ApplicationScoped +public class MessageQueue { + + private Queue queue = new ConcurrentLinkedQueue<>(); + + /** + * Push string on stack. + * + * @param s String to push. + */ + public void push(String s) { + queue.add(s); + } + + /** + * Pop string from stack. + * + * @return The string or {@code null}. + */ + public String pop() { + return queue.poll(); + } + + /** + * Check if stack is empty. + * + * @return Outcome of test. + */ + public boolean isEmpty() { + return queue.isEmpty(); + } + + /** + * Peek at stack without changing it. + * + * @return String peeked or {@code null}. + */ + public String peek() { + return queue.peek(); + } +} diff --git a/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageQueueResource.java b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageQueueResource.java new file mode 100644 index 00000000..eaa32f2f --- /dev/null +++ b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/MessageQueueResource.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.example.websocket; + +import java.util.logging.Logger; + +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.POST; +import javax.ws.rs.Path; + +/** + * Class MessageQueueResource. + */ +@Path("rest") +public class MessageQueueResource { + + private static final Logger LOGGER = Logger.getLogger(MessageQueueResource.class.getName()); + + @Inject + private MessageQueue messageQueue; + + /** + * Resource to push string into queue. + * + * @param s The string. + */ + @POST + @Consumes("text/plain") + public void push(String s) { + LOGGER.info("push called '" + s + "'"); + messageQueue.push(s); + } +} diff --git a/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/package-info.java b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/package-info.java new file mode 100644 index 00000000..0da0f7e2 --- /dev/null +++ b/examples/microprofile/websocket/src/main/java/io/helidon/microprofile/example/websocket/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved. + * + * 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. + */ + +/** + * Helidon WebSocket example. + */ +package io.helidon.microprofile.example.websocket; diff --git a/examples/microprofile/websocket/src/main/resources/META-INF/beans.xml b/examples/microprofile/websocket/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..c5405c06 --- /dev/null +++ b/examples/microprofile/websocket/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/microprofile/websocket/src/main/resources/WEB/index.html b/examples/microprofile/websocket/src/main/resources/WEB/index.html new file mode 100644 index 00000000..1dacd34c --- /dev/null +++ b/examples/microprofile/websocket/src/main/resources/WEB/index.html @@ -0,0 +1,81 @@ + + + + + + + + + + + +

+
+

+

+ +

+

+ +

+

+

History

+
+
+ + \ No newline at end of file diff --git a/examples/microprofile/websocket/src/main/resources/application.yaml b/examples/microprofile/websocket/src/main/resources/application.yaml new file mode 100644 index 00000000..b0a388c6 --- /dev/null +++ b/examples/microprofile/websocket/src/main/resources/application.yaml @@ -0,0 +1,22 @@ +# +# Copyright (c) 2020, 2021 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. +# + +server: + port: 7001 + # location on classpath (e.g. src/main/resources/WEB in maven) + static.classpath: + location: "/WEB" + context: "/web" \ No newline at end of file diff --git a/examples/microprofile/websocket/src/main/resources/logging.properties b/examples/microprofile/websocket/src/main/resources/logging.properties new file mode 100644 index 00000000..24de00b0 --- /dev/null +++ b/examples/microprofile/websocket/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2020, 2021 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.server.level=INFO diff --git a/examples/microprofile/websocket/src/test/java/io/helidon/microprofile/example/websocket/MessageBoardTest.java b/examples/microprofile/websocket/src/test/java/io/helidon/microprofile/example/websocket/MessageBoardTest.java new file mode 100644 index 00000000..6b674c7c --- /dev/null +++ b/examples/microprofile/websocket/src/test/java/io/helidon/microprofile/example/websocket/MessageBoardTest.java @@ -0,0 +1,124 @@ +/* + * Copyright (c) 2020, 2021 Oracle and/or its affiliates. All rights reserved. + * + * 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.microprofile.example.websocket; + +import java.io.IOException; +import java.net.URI; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.logging.Logger; + +import javax.inject.Inject; +import javax.websocket.ClientEndpointConfig; +import javax.websocket.CloseReason; +import javax.websocket.DeploymentException; +import javax.websocket.Endpoint; +import javax.websocket.EndpointConfig; +import javax.websocket.MessageHandler; +import javax.websocket.Session; +import javax.ws.rs.client.Entity; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.server.ServerCdiExtension; +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.glassfish.tyrus.client.ClientManager; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * Class MessageBoardTest. + */ +@HelidonTest +class MessageBoardTest { + private static final Logger LOGGER = Logger.getLogger(MessageBoardTest.class.getName()); + private static final String[] MESSAGES = { "Whisky", "Tango", "Foxtrot" }; + + private final WebTarget webTarget; + private final ServerCdiExtension server; + private final ClientManager websocketClient = ClientManager.createClient(); + + @Inject + MessageBoardTest(WebTarget webTarget, ServerCdiExtension server) { + this.webTarget = webTarget; + this.server = server; + } + + @Test + public void testBoard() throws IOException, DeploymentException, InterruptedException { + // Post messages using REST resource + for (String message : MESSAGES) { + try (Response res = webTarget.path("/rest").request().post(Entity.text(message))) { + assertThat(res.getStatus(), is(204)); + LOGGER.info("Posting message '" + message + "'"); + } + } + + // Now connect to message board using WS and them back + URI websocketUri = URI.create("ws://localhost:" + server.port() + "/websocket"); + CountDownLatch messageLatch = new CountDownLatch(MESSAGES.length); + ClientEndpointConfig config = ClientEndpointConfig.Builder.create().build(); + + websocketClient.connectToServer(new Endpoint() { + @Override + public void onOpen(Session session, EndpointConfig EndpointConfig) { + try { + // Set message handler to receive messages + session.addMessageHandler(new MessageHandler.Whole() { + @Override + public void onMessage(String message) { + LOGGER.info("Client OnMessage called '" + message + "'"); + messageLatch.countDown(); + if (messageLatch.getCount() == 0) { + try { + session.close(); + } catch (IOException e) { + fail("Unexpected exception " + e); + } + } + } + }); + + // Send an initial message to start receiving + session.getBasicRemote().sendText("SEND"); + } catch (IOException e) { + fail("Unexpected exception " + e); + } + } + + @Override + public void onClose(Session session, CloseReason closeReason) { + LOGGER.info("Client OnClose called '" + closeReason + "'"); + } + + @Override + public void onError(Session session, Throwable thr) { + LOGGER.info("Client OnError called '" + thr + "'"); + + } + }, config, websocketUri); + + // Wait until all messages are received + assertThat("Message latch should have counted down to 0", + messageLatch.await(1000, TimeUnit.SECONDS), + is(true)); + } +} diff --git a/examples/openapi-tools/README.md b/examples/openapi-tools/README.md new file mode 100644 index 00000000..c043e0cc --- /dev/null +++ b/examples/openapi-tools/README.md @@ -0,0 +1,3 @@ +# OpenApi Tools Examples + +This directory contains OpenApi Tools examples for Helidon SE/MP clients and servers. diff --git a/examples/openapi-tools/pom.xml b/examples/openapi-tools/pom.xml new file mode 100644 index 00000000..e2569874 --- /dev/null +++ b/examples/openapi-tools/pom.xml @@ -0,0 +1,38 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + pom + io.helidon.examples.openapi.tools + helidon-examples-openapi-tools-project + Helidon OpenApi Tools Examples + + + quickstart-mp + quickstart-se + + diff --git a/examples/openapi-tools/quickstart-mp/README.md b/examples/openapi-tools/quickstart-mp/README.md new file mode 100644 index 00000000..570f4429 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/README.md @@ -0,0 +1,296 @@ +# Helidon OpenAPI Generator example for Helidon MP server and client + +The goal of this example is to show how a user can easily create a Helidon MP server or client from an OpenAPI document using OpenAPI Generator. + +Here we will show the steps that a user has to do to create Helidon MP server and client using OpenAPI Generator and what has to be done to make the generated server and client fully functional. + +For generation of our projects we will use `openapi-generator-cli.jar` that can be downloaded from the maven repository (instructions and other options can be found [here](https://openapi-generator.tech/docs/installation)) and OpenAPI document `quickstart.yaml` that can be found next to this `README.md`. + +## Build, prepare and run the Helidon MP server + +To generate Helidon MP server at first we create `mp-server` folder and then inside it we run the following command where `path-to-generator` is the directory where you downloaded the generator CLI JAR file and `path-to-openapi-doc` is the folder where `quickstart.yaml` is located: +```shell +java -jar path-to-generator/openapi-generator-cli.jar \ + generate \ + -g java-helidon-server \ + --library mp \ + -p helidonVersion=2.5.6 \ + -i path-to-openapi-doc/quickstart.yaml +``` + +When this command finishes its work in the folder `mp-server` we will find the generated project where the most interesting parts are located inside `api` and `model` packages. +The package `api` contains interfaces that represent endpoints for our server and implementations with stubs for them. +These implementations we need to change to implement our business logic. +The package `model` contains classes that represent transport objects that will be used by our endpoints to receive requests and send responses. + +Let's change a little class `MessageServiceImpl` for our example : +1) Add annotation `@ApplicationScoped` to this class. +2) Add field that will contain default message for our endpoints : +```java + private final AtomicReference defaultMessage = new AtomicReference<>(); +``` +3) Add default constructor to the class : +```java + public MessageServiceImpl() { + Message message = new Message(); + message.setMessage("World"); + message.setGreeting("Hello"); + defaultMessage.set(message); + } +``` +4) Replace implementation of the method `public Message getDefaultMessage()` by this: +```java + return defaultMessage.get(); +``` +5) Replace implementation of the method `public Message getMessage(@PathParam("name") String name)` by this: +```java + Message result = new Message(); + return result.message(name).greeting(defaultMessage.get().getGreeting()); +``` +6) Replace implementation of the method `public Response updateGreeting(@Valid @NotNull Message message)` by this: +```java + defaultMessage.set(message); + Response.status(Response.Status.NO_CONTENT).build(); +``` + +To run the application : + +With JDK11+ +```shell +mvn package +java -jar target/openapi-java-server.jar +``` + +To check that server works as expected run the following `curl` commands : + +``` +curl -X GET http://localhost:8080/greet +{"message":"World","greeting":"Hello"} + +curl -X GET http://localhost:8080/greet/Joe +{"message":"Joe","greeting":"Hello"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola", "message":"Lisa"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet +{"message":"Lisa","greeting":"Hola"} +``` + +## Build, prepare and run the Helidon MP client + +The second part of this example is generating MicroProfile Rest Client that will communicate with the server that we have just created. + +To generate Helidon MP client at first we create `mp-client` folder and then inside it we run the following command where `path-to-generator` is the directory where you downloaded the generator CLI JAR file and `path-to-openapi-doc` is the folder where `quickstart.yaml` is located: +```shell +java -jar path-to-generator/openapi-generator-cli.jar \ + generate \ + -g java-helidon-client \ + --library mp \ + -p helidonVersion=2.5.6 \ + -i path-to-openapi-doc/quickstart.yaml +``` + +When this command finishes its work in the folder `mp-client` we will find the generated project. +As with server project there is the most interesting part are located inside `api` and `model` packages. +The package `api` contains interfaces that represent endpoints to our server. +The package `model` contains classes that represent transport objects that will be used to communicate with the server. + +You can use the generated MP client artifact in either of two ways: + + - as a library - One or more other client projects can depend on the client artifact and use its generated classes. + - as a client program itself - Add some code to the generated project to make it a client program and not just a library. + +This example illustrates the second approach. We create a second server (at port 8081) which accepts greeting requests and, acting as a client, forwards them to the first service and returns the responses from the first service as its own. + +To make our client application fully functional let's add some classes, dependencies and files to the project. + +1) Let's add a class `MessageService` that will use `MessageApi` interface to interact with the server : +```java +package org.openapitools.client.api; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; + +import org.eclipse.microprofile.rest.client.inject.RestClient; +import org.openapitools.client.model.Message; + +@Path("/greet") +@ApplicationScoped +public class MessageService { + + @Inject + @RestClient + private MessageApi messageApi; + + + @GET + @Produces({"application/json"}) + public Message getDefaultMessage() throws ApiException { + return messageApi.getDefaultMessage(); + } + + @GET + @Path("/{name}") + @Produces({"application/json"}) + public Message getMessage(@PathParam("name") String name) throws ApiException { + return messageApi.getMessage(name); + } + + @PUT + @Path("/greeting") + @Consumes({"application/json"}) + public void updateGreeting(Message message) throws ApiException { + messageApi.updateGreeting(message); + } +} +``` + +2) Create the directory `src/main/resources/META-INF`. +3) Add file `beans.xml` inside the folder `META-INF` : +```xml + + + + +``` +4) Add file `microprofile-config.properties` inside the folder `META-INF` : +```properties +# Microprofile server properties +server.port=8081 +server.host=0.0.0.0 +``` +5) Add dependency in `pom.xml` : +```xml + + io.helidon.microprofile.bundles + helidon-microprofile-core + +``` +6) In the file `MessageApi` replace the line: +```java +@RegisterRestClient +``` +to +```java +@RegisterRestClient(baseUri="http://localhost:8080") +``` + +To run the application : + +With JDK11+ +```shell +mvn package +java -jar target/openapi-java-client.jar +``` + +To check that the client works as expected and process all the requests using our server run the following `curl` commands : + +``` +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hi", "message":"Mike"}' http://localhost:8081/greet/greeting + +curl -X GET http://localhost:8081/greet +{"message":"Mike","greeting":"Hi"} + +curl -X GET http://localhost:8081/greet/Joe +{"message":"Joe","greeting":"Hi"} +``` + +## Update applications + +To keep the server and the client up to date according to the OpenApi document, we can use the maven plugin `openapi-generator-maven-plugin`. + +Add these lines to the `pom.xml` of our server : +```xml + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/META-INF/openapi.yml + java-helidon-server + mp + ${project.basedir} + + false + + + + + + + + + +``` + +For the client application : +1) Copy OpenApi document `path-to-openapi-doc/quickstart.yaml` to the folder `META-INF` and rename it to `openapi.yaml`. +2) Add these lines to the `pom.xml` of our client : +```xml + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/META-INF/openapi.yml + java-helidon-client + mp + ${project.basedir} + + false + + + + + + + + + +``` + +Also add the following to the `` in the `pom.xml` file: +```xml +6.2.1 +``` + +The version `6.2.1` was the first version where Helidon generators were added, so if more modern versions of this plugin are exist you can choose one of them. + +To run the generator during your build, invoke the profile: `mvn clean package -P openapi`. + +It should also be added that the `fullProject` option was used in the plugin configuration. +If it set to true, it will generate all files; if set to false, it will only generate API files. +If unspecified, the behavior depends on whether a project exists or not: if it does not, same as true; if it does, same as false. +So keep in mind that regenerating will overwrite your customized `MessageService` or `Message` files and you will need to add the customization again after regenerating. +Note that test files are never overwritten. diff --git a/examples/openapi-tools/quickstart-mp/mp-client/README.md b/examples/openapi-tools/quickstart-mp/mp-client/README.md new file mode 100644 index 00000000..0c53668b --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/README.md @@ -0,0 +1,16 @@ +# OpenAPI Helidon Quickstart + +MP client example + + +## Overview +mp-server shall be running on port 8080 before running the client + +```shell +mvn package +java -jar target/openapi-mp-client.jar +``` + +```shell +curl http://localhost:8081/greet +``` \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-mp/mp-client/docs/Message.md b/examples/openapi-tools/quickstart-mp/mp-client/docs/Message.md new file mode 100644 index 00000000..df42a18c --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/docs/Message.md @@ -0,0 +1,15 @@ + + +# Message + +An message for the user + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**message** | **String** | | [optional] | +|**greeting** | **String** | | [optional] | + + + diff --git a/examples/openapi-tools/quickstart-mp/mp-client/docs/MessageApi.md b/examples/openapi-tools/quickstart-mp/mp-client/docs/MessageApi.md new file mode 100644 index 00000000..c35f4f40 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/docs/MessageApi.md @@ -0,0 +1,108 @@ +# MessageApi + +All URIs are relative to *http://localhost:8080* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getDefaultMessage**](MessageApi.md#getDefaultMessage) | **GET** /greet | Return a worldly greeting message. | +| [**getMessage**](MessageApi.md#getMessage) | **GET** /greet/{name} | Return a greeting message using the name that was provided. | +| [**updateGreeting**](MessageApi.md#updateGreeting) | **PUT** /greet/greeting | Set the greeting to use in future messages. | + + + +## getDefaultMessage + +> Message getDefaultMessage() + +Return a worldly greeting message. + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Message**](Message.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | - | + + +## getMessage + +> Message getMessage(name) + +Return a greeting message using the name that was provided. + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| the name to greet | | + +### Return type + +[**Message**](Message.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | - | + + +## updateGreeting + +> void updateGreeting(message) + +Set the greeting to use in future messages. + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **message** | [**Message**](Message.md)| Message for the user | | + +### Return type + +[**void**](Void.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | - | +| **400** | No greeting provided | - | + diff --git a/examples/openapi-tools/quickstart-mp/mp-client/pom.xml b/examples/openapi-tools/quickstart-mp/mp-client/pom.xml new file mode 100644 index 00000000..c85cfc23 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/pom.xml @@ -0,0 +1,135 @@ + + + + 4.0.0 + org.openapitools + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + openapi-mp-client + 1.0.0 + openapi-java-client + https://github.com/openapitools/openapi-generator + OpenAPI Java + jar + + + 6.2.1 + + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.microprofile.rest-client + helidon-microprofile-rest-client + + + io.helidon.microprofile.config + helidon-microprofile-config + + + org.glassfish.jersey.ext.cdi + jersey-cdi1x + + + jakarta.enterprise + jakarta.enterprise.cdi-api + + + jakarta.json + jakarta.json-api + + + org.glassfish.jersey.media + jersey-media-json-jackson + + + org.openapitools + jackson-databind-nullable + 0.2.2 + + + org.junit.jupiter + junit-jupiter-api + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/META-INF/openapi.yml + java-helidon-client + mp + ${project.basedir} + + false + + + + + + + + + + diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/JavaTimeFormatter.java b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/JavaTimeFormatter.java new file mode 100644 index 00000000..f9884f32 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/JavaTimeFormatter.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client; + +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; + +/** + * Class that add parsing/formatting support for Java 8+ {@code OffsetDateTime} class. + * It's generated for java clients when {@code AbstractJavaCodegen#dateLibrary} specified as {@code java8}. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaHelidonClientCodegen", date = "2022-12-19T17:39:09.021857615+01:00[Europe/Prague]") +public class JavaTimeFormatter { + + private DateTimeFormatter offsetDateTimeFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME; + + /** + * Get the date format used to parse/format {@code OffsetDateTime} parameters. + * @return DateTimeFormatter + */ + public DateTimeFormatter getOffsetDateTimeFormatter() { + return offsetDateTimeFormatter; + } + + /** + * Set the date format used to parse/format {@code OffsetDateTime} parameters. + * @param offsetDateTimeFormatter {@code DateTimeFormatter} + */ + public void setOffsetDateTimeFormatter(DateTimeFormatter offsetDateTimeFormatter) { + this.offsetDateTimeFormatter = offsetDateTimeFormatter; + } + + /** + * Parse the given string into {@code OffsetDateTime} object. + * @param str String + * @return {@code OffsetDateTime} + */ + public OffsetDateTime parseOffsetDateTime(String str) { + try { + return OffsetDateTime.parse(str, offsetDateTimeFormatter); + } catch (DateTimeParseException e) { + throw new RuntimeException(e); + } + } + /** + * Format the given {@code OffsetDateTime} object into string. + * @param offsetDateTime {@code OffsetDateTime} + * @return {@code OffsetDateTime} in string format + */ + public String formatOffsetDateTime(OffsetDateTime offsetDateTime) { + return offsetDateTimeFormatter.format(offsetDateTime); + } +} diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/RFC3339DateFormat.java b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/RFC3339DateFormat.java new file mode 100644 index 00000000..d863106f --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/RFC3339DateFormat.java @@ -0,0 +1,73 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client; + +import com.fasterxml.jackson.databind.util.StdDateFormat; + +import java.text.DateFormat; +import java.text.FieldPosition; +import java.text.ParsePosition; +import java.util.Date; +import java.text.DecimalFormat; +import java.util.GregorianCalendar; +import java.util.TimeZone; + +public class RFC3339DateFormat extends DateFormat { + private static final long serialVersionUID = 1L; + private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC"); + + private final StdDateFormat fmt = new StdDateFormat() + .withTimeZone(TIMEZONE_Z) + .withColonInTimeZone(true); + + public RFC3339DateFormat() { + this.calendar = new GregorianCalendar(); + this.numberFormat = new DecimalFormat(); + } + + @Override + public Date parse(String source) { + return parse(source, new ParsePosition(0)); + } + + @Override + public Date parse(String source, ParsePosition pos) { + return fmt.parse(source, pos); + } + + @Override + public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) { + return fmt.format(date, toAppendTo, fieldPosition); + } + + @Override + public Object clone() { + return super.clone(); + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/ApiException.java b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/ApiException.java new file mode 100644 index 00000000..749b1d29 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/ApiException.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.api; + +import javax.ws.rs.core.Response; + +public class ApiException extends Exception { + private static final long serialVersionUID = 1L; + + private final Response response; + + public ApiException(Response response) { + super("Api response has status code " + response.getStatus()); + this.response = response; + } + + public Response getResponse() { + return this.response; + } +} diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/ApiExceptionMapper.java b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/ApiExceptionMapper.java new file mode 100644 index 00000000..99b10ede --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/ApiExceptionMapper.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.api; + +import javax.ws.rs.core.MultivaluedMap; +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.Provider; + +import org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper; + +@Provider +public class ApiExceptionMapper implements ResponseExceptionMapper { + + @Override + public boolean handles(int status, MultivaluedMap headers) { + return status >= 400; + } + + @Override + public ApiException toThrowable(Response response) { + return new ApiException(response); + } +} diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/MessageApi.java b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/MessageApi.java new file mode 100644 index 00000000..4b6d9650 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/MessageApi.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.api; + +import java.io.InputStream; +import java.io.OutputStream; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.ws.rs.*; +import javax.ws.rs.core.Response; +import javax.ws.rs.core.MediaType; + +import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; +import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; + +import org.openapitools.client.model.Message; + +/** + * OpenAPI Helidon Quickstart + * + *

This is a sample for Helidon Quickstart project. + */ +@RegisterRestClient(baseUri="http://localhost:8080") +@RegisterProvider(ApiExceptionMapper.class) +@Path("/greet") +public interface MessageApi { + + /** + * Return a worldly greeting message. + */ + @GET + + @Produces({ "application/json" }) + Message getDefaultMessage() throws ApiException, ProcessingException; + + /** + * Return a greeting message using the name that was provided. + */ + @GET + @Path("/{name}") + @Produces({ "application/json" }) + Message getMessage(@PathParam("name") String name) throws ApiException, ProcessingException; + + /** + * Set the greeting to use in future messages. + */ + @PUT + @Path("/greeting") + @Consumes({ "application/json" }) + void updateGreeting(Message message) throws ApiException, ProcessingException; +} diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/MessageService.java b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/MessageService.java new file mode 100644 index 00000000..12236a7c --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/api/MessageService.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.client.api; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; + +import org.eclipse.microprofile.rest.client.inject.RestClient; +import org.openapitools.client.model.Message; + +@Path("/greet") +@ApplicationScoped +public class MessageService { + + @Inject + @RestClient + private MessageApi messageApi; + + + @GET + @Produces({"application/json"}) + public Message getDefaultMessage() throws ApiException { + return messageApi.getDefaultMessage(); + } + + @GET + @Path("/{name}") + @Produces({"application/json"}) + public Message getMessage(@PathParam("name") String name) throws ApiException { + return messageApi.getMessage(name); + } + + @PUT + @Path("/greeting") + @Consumes({"application/json"}) + public void updateGreeting(Message message) throws ApiException { + messageApi.updateGreeting(message); + } +} diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/model/Message.java b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/model/Message.java new file mode 100644 index 00000000..d5d51939 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/java/org/openapitools/client/model/Message.java @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; + + + +/** + * An message for the user + **/ + +public class Message { + + private String message; + + private String greeting; + + /** + * Get message + * @return message + **/ + public String getMessage() { + return message; + } + + /** + * Set message + **/ + public void setMessage(String message) { + this.message = message; + } + + public Message message(String message) { + this.message = message; + return this; + } + + /** + * Get greeting + * @return greeting + **/ + public String getGreeting() { + return greeting; + } + + /** + * Set greeting + **/ + public void setGreeting(String greeting) { + this.greeting = greeting; + } + + public Message greeting(String greeting) { + this.greeting = greeting; + return this; + } + + + /** + * Create a string representation of this pojo. + **/ + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Message {\n"); + + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" greeting: ").append(toIndentedString(greeting)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/beans.xml b/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..1c09dd0c --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/microprofile-config.properties b/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..e70fd1ec --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2022 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=8081 +server.host=0.0.0.0 diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/openapi.yaml b/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/openapi.yaml new file mode 100644 index 00000000..f4c8af62 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/main/resources/META-INF/openapi.yaml @@ -0,0 +1,112 @@ +# +# Copyright (c) 2022, 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. +# + +# +# Copyright (c) 2022, 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. +# + +openapi: 3.0.0 +servers: + - url: 'http://localhost:8080' +info: + description: >- + This is a sample for Helidon Quickstart project. + version: 1.0.0 + title: OpenAPI Helidon Quickstart + license: + name: Apache-2.0 + url: 'https://www.apache.org/licenses/LICENSE-2.0.html' +tags: + - name: message +paths: + /greet: + get: + tags: + - message + summary: Return a worldly greeting message. + operationId: getDefaultMessage + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + /greet/greeting: + put: + tags: + - message + summary: Set the greeting to use in future messages. + operationId: updateGreeting + responses: + '200': + description: successful operation + '400': + description: No greeting provided + requestBody: + $ref: '#/components/requestBodies/Message' + '/greet/{name}': + get: + tags: + - message + summary: Return a greeting message using the name that was provided. + operationId: getMessage + parameters: + - name: name + in: path + description: the name to greet + required: true + schema: + type: string + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Message' +components: + requestBodies: + Message: + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: Message for the user + required: true + schemas: + Message: + description: An message for the user + type: object + properties: + message: + type: string + format: int64 + greeting: + type: string + format: int64 diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/test/java/org/openapitools/client/api/MessageApiTest.java b/examples/openapi-tools/quickstart-mp/mp-client/src/test/java/org/openapitools/client/api/MessageApiTest.java new file mode 100644 index 00000000..16c02e40 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/test/java/org/openapitools/client/api/MessageApiTest.java @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.api; + +import org.openapitools.client.model.Message; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import org.eclipse.microprofile.rest.client.RestClientBuilder; + +import java.net.URL; +import java.net.MalformedURLException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * OpenAPI Helidon Quickstart Test + * + * API tests for MessageApi + */ +public class MessageApiTest { + + private static MessageApi client; + private static final String baseUrl = "http://localhost:8080"; + + @BeforeAll + public static void setup() throws MalformedURLException { + client = RestClientBuilder.newBuilder() + .baseUrl(new URL(baseUrl)) + .register(ApiException.class) + .build(MessageApi.class); + } + + + /** + * Return a worldly greeting message. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getDefaultMessageTest() throws Exception { + //Message response = client.getDefaultMessage(); + //assertNotNull(response); + } + + /** + * Return a greeting message using the name that was provided. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMessageTest() throws Exception { + //Message response = client.getMessage(name); + //assertNotNull(response); + } + + /** + * Set the greeting to use in future messages. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateGreetingTest() throws Exception { + //void response = client.updateGreeting(message); + //assertNotNull(response); + } + +} diff --git a/examples/openapi-tools/quickstart-mp/mp-client/src/test/java/org/openapitools/client/model/MessageTest.java b/examples/openapi-tools/quickstart-mp/mp-client/src/test/java/org/openapitools/client/model/MessageTest.java new file mode 100644 index 00000000..0989251b --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-client/src/test/java/org/openapitools/client/model/MessageTest.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2022, 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. + */ + + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.model; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; + +import org.junit.jupiter.api.Test; + + +/** + * Model tests for Message + */ +public class MessageTest { + private final Message model = new Message(); + + /** + * Model tests for Message + */ + @Test + public void testMessage() { + // TODO: test Message + } + + /** + * Test the property 'message' + */ + @Test + public void messageTest() { + // TODO: test message + } + + /** + * Test the property 'greeting' + */ + @Test + public void greetingTest() { + // TODO: test greeting + } + +} diff --git a/examples/openapi-tools/quickstart-mp/mp-server/README.md b/examples/openapi-tools/quickstart-mp/mp-server/README.md new file mode 100644 index 00000000..9f44f5e4 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/README.md @@ -0,0 +1,35 @@ +# Helidon Server with OpenAPI + +## Build and run + +```shell +mvn package +java -jar target/openapi-mp-server.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet/ +curl -X GET http://localhost:8080/greet/{name} +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + +``` + +## Try health and metrics + +```shell +curl -s -X GET http://localhost:8080/health +#{"outcome":"UP",... +. . . + +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics +# TYPE base:gc_g1_young_generation_count gauge +#. . . + +# JSON Format +curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics +#{"base":... +#. . . +``` \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-mp/mp-server/pom.xml b/examples/openapi-tools/quickstart-mp/mp-server/pom.xml new file mode 100644 index 00000000..4eac98d2 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/pom.xml @@ -0,0 +1,134 @@ + + + + + + 4.0.0 + org.openapitools + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + openapi-mp-server + openapi-java-server + This is a sample for Helidon Quickstart project. + 1.0.0 + jar + + + 0.2.3 + 6.2.1 + + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.microprofile.cdi + helidon-microprofile-cdi + + + jakarta.enterprise + jakarta.enterprise.cdi-api + + + jakarta.ws.rs + jakarta.ws.rs-api + + + org.openapitools + jackson-databind-nullable + ${version.jackson.databind.nullable} + + + org.glassfish.jersey.media + jersey-media-json-jackson + + + org.junit.jupiter + junit-jupiter-api + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/META-INF/openapi.yml + java-helidon-server + mp + ${project.basedir} + + false + + + + + + + + + + diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/JavaTimeFormatter.java b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/JavaTimeFormatter.java new file mode 100644 index 00000000..193adcac --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/JavaTimeFormatter.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server; + +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; + +/** + * Class that add parsing/formatting support for Java 8+ {@code OffsetDateTime} class. + * It's generated for java clients when {@code AbstractJavaCodegen#dateLibrary} specified as {@code java8}. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaHelidonServerCodegen", date = "2022-12-19T17:22:28.508111889+01:00[Europe/Prague]") +public class JavaTimeFormatter { + + private DateTimeFormatter offsetDateTimeFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME; + + /** + * Get the date format used to parse/format {@code OffsetDateTime} parameters. + * @return DateTimeFormatter + */ + public DateTimeFormatter getOffsetDateTimeFormatter() { + return offsetDateTimeFormatter; + } + + /** + * Set the date format used to parse/format {@code OffsetDateTime} parameters. + * @param offsetDateTimeFormatter {@code DateTimeFormatter} + */ + public void setOffsetDateTimeFormatter(DateTimeFormatter offsetDateTimeFormatter) { + this.offsetDateTimeFormatter = offsetDateTimeFormatter; + } + + /** + * Parse the given string into {@code OffsetDateTime} object. + * @param str String + * @return {@code OffsetDateTime} + */ + public OffsetDateTime parseOffsetDateTime(String str) { + try { + return OffsetDateTime.parse(str, offsetDateTimeFormatter); + } catch (DateTimeParseException e) { + throw new RuntimeException(e); + } + } + /** + * Format the given {@code OffsetDateTime} object into string. + * @param offsetDateTime {@code OffsetDateTime} + * @return {@code OffsetDateTime} in string format + */ + public String formatOffsetDateTime(OffsetDateTime offsetDateTime) { + return offsetDateTimeFormatter.format(offsetDateTime); + } +} diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/RFC3339DateFormat.java b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/RFC3339DateFormat.java new file mode 100644 index 00000000..af55f54c --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/RFC3339DateFormat.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server; + +import com.fasterxml.jackson.databind.util.StdDateFormat; + +import java.text.DateFormat; +import java.text.FieldPosition; +import java.text.ParsePosition; +import java.util.Date; +import java.util.GregorianCalendar; +import java.util.TimeZone; + +public class RFC3339DateFormat extends DateFormat { + private static final long serialVersionUID = 1L; + private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC"); + + private final StdDateFormat fmt = new StdDateFormat() + .withTimeZone(TIMEZONE_Z) + .withColonInTimeZone(true); + + public RFC3339DateFormat() { + this.calendar = new GregorianCalendar(); + } + + @Override + public Date parse(String source, ParsePosition pos) { + return fmt.parse(source, pos); + } + + @Override + public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) { + return fmt.format(date, toAppendTo, fieldPosition); + } + + @Override + public Object clone() { + return this; + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/RestApplication.java b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/RestApplication.java new file mode 100644 index 00000000..7c0d4984 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/RestApplication.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.ApplicationPath; +import javax.ws.rs.core.Application; + +@ApplicationScoped +@ApplicationPath("") +public class RestApplication extends Application { + +} diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/api/MessageService.java b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/api/MessageService.java new file mode 100644 index 00000000..bb87fcdd --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/api/MessageService.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server.api; + +import org.openapitools.server.model.Message; + +import javax.ws.rs.*; + +import java.io.InputStream; +import java.util.Map; +import java.util.List; +import javax.validation.constraints.*; +import javax.validation.Valid; + +@Path("/greet") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaHelidonServerCodegen", date = "2022-12-19T17:22:28.508111889+01:00[Europe/Prague]") +public interface MessageService { + + @GET + @Produces({ "application/json" }) + Message getDefaultMessage(); + + @GET + @Path("/{name}") + @Produces({ "application/json" }) + Message getMessage(@PathParam("name") String name); + + @PUT + @Path("/greeting") + @Consumes({ "application/json" }) + void updateGreeting(@Valid @NotNull Message message); +} diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/api/MessageServiceImpl.java b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/api/MessageServiceImpl.java new file mode 100644 index 00000000..d3a0a9f7 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/api/MessageServiceImpl.java @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server.api; + +import org.openapitools.server.model.Message; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.*; + + +import java.io.InputStream; +import java.util.Map; +import java.util.List; +import java.util.concurrent.atomic.AtomicReference; + +import javax.validation.constraints.*; +import javax.validation.Valid; +import javax.ws.rs.core.Response; + +@ApplicationScoped +@Path("/greet") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaHelidonServerCodegen", date = "2022-12-19T17:22:28.508111889+01:00[Europe/Prague]") +public class MessageServiceImpl implements MessageService { + + private final AtomicReference defaultMessage = new AtomicReference<>(); + + public MessageServiceImpl() { + Message message = new Message(); + message.setMessage("World"); + message.setGreeting("Hello"); + defaultMessage.set(message); + } + + @GET + @Produces({ "application/json" }) + public Message getDefaultMessage() { + return defaultMessage.get(); + } + + @GET + @Path("/{name}") + @Produces({ "application/json" }) + public Message getMessage(@PathParam("name") String name) { + Message result = new Message(); + return result.message(name).greeting(defaultMessage.get().getGreeting()); + } + + @PUT + @Path("/greeting") + @Consumes({ "application/json" }) + public void updateGreeting(@Valid @NotNull Message message) { + defaultMessage.set(message); + Response.status(Response.Status.NO_CONTENT).build(); + } +} diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/model/Message.java b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/model/Message.java new file mode 100644 index 00000000..ac6234c6 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/model/Message.java @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server.model; + +import javax.validation.constraints.*; +import javax.validation.Valid; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * An message for the user + **/ + +public class Message { + + private String message; + + private String greeting; + + /** + * Get message + * @return message + **/ + public String getMessage() { + return message; + } + + /** + * Set message + **/ + public void setMessage(String message) { + this.message = message; + } + + public Message message(String message) { + this.message = message; + return this; + } + + /** + * Get greeting + * @return greeting + **/ + public String getGreeting() { + return greeting; + } + + /** + * Set greeting + **/ + public void setGreeting(String greeting) { + this.greeting = greeting; + } + + public Message greeting(String greeting) { + this.greeting = greeting; + return this; + } + + + /** + * Create a string representation of this pojo. + **/ + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Message {\n"); + + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" greeting: ").append(toIndentedString(greeting)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/package-info.java b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/package-info.java new file mode 100644 index 00000000..e9166bc9 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/java/org/openapitools/server/package-info.java @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server; \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/beans.xml b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..1c09dd0c --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/beans.xml @@ -0,0 +1,25 @@ + + + + diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/microprofile-config.properties b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..3bed5e93 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,27 @@ +# +# Copyright (c) 2022 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 + +# Application properties. This is the default greeting +app.greeting=Hello + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +# Enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=true diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/openapi.yml b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/openapi.yml new file mode 100644 index 00000000..6036c9eb --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/META-INF/openapi.yml @@ -0,0 +1,104 @@ +# +# Copyright (c) 2022, 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. +# + +openapi: 3.0.0 +info: + description: This is a sample for Helidon Quickstart project. + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + title: OpenAPI Helidon Quickstart + version: 1.0.0 +servers: +- url: http://localhost:8080 +tags: +- name: message +paths: + /greet: + get: + operationId: getDefaultMessage + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: successful operation + summary: Return a worldly greeting message. + tags: + - message + x-accepts: application/json + /greet/greeting: + put: + operationId: updateGreeting + requestBody: + $ref: '#/components/requestBodies/Message' + responses: + "200": + description: successful operation + "400": + description: No greeting provided + summary: Set the greeting to use in future messages. + tags: + - message + x-content-type: application/json + x-accepts: application/json + /greet/{name}: + get: + operationId: getMessage + parameters: + - description: the name to greet + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: successful operation + summary: Return a greeting message using the name that was provided. + tags: + - message + x-accepts: application/json +components: + requestBodies: + Message: + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: Message for the user + required: true + schemas: + Message: + description: An message for the user + example: + greeting: greeting + message: message + properties: + message: + format: int64 + type: string + greeting: + format: int64 + type: string + type: object diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/logging.properties b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/logging.properties new file mode 100644 index 00000000..d31ec34b --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2022, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/openapi-tools/quickstart-mp/mp-server/src/test/java/org/openapitools/server/model/MessageTest.java b/examples/openapi-tools/quickstart-mp/mp-server/src/test/java/org/openapitools/server/model/MessageTest.java new file mode 100644 index 00000000..ecfb5364 --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/mp-server/src/test/java/org/openapitools/server/model/MessageTest.java @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server.model; + +import org.junit.jupiter.api.Test; + + +/** + * Model tests for Message + */ +public class MessageTest { + private final Message model = new Message(); + + /** + * Model tests for Message + */ + @Test + public void testMessage() { + // TODO: test Message + } + + /** + * Test the property 'message' + */ + @Test + public void messageTest() { + // TODO: test message + } + + /** + * Test the property 'greeting' + */ + @Test + public void greetingTest() { + // TODO: test greeting + } + +} diff --git a/examples/openapi-tools/quickstart-mp/pom.xml b/examples/openapi-tools/quickstart-mp/pom.xml new file mode 100644 index 00000000..49e65b2d --- /dev/null +++ b/examples/openapi-tools/quickstart-mp/pom.xml @@ -0,0 +1,42 @@ + + + + + 4.0.0 + + io.helidon.examples.openapi.tools + helidon-examples-openapi-tools-project + 1.0.0-SNAPSHOT + + pom + helidon-examples-openapi-tools-quickstart-mp + 1.0.0-SNAPSHOT + Helidon OpenApi Tools Example for Quickstart MP + + + Example of usage OpenApi Tools for Helidon Quickstart MP server and client + + + + mp-server + mp-client + + diff --git a/examples/openapi-tools/quickstart-se/README.md b/examples/openapi-tools/quickstart-se/README.md new file mode 100644 index 00000000..a7b7611d --- /dev/null +++ b/examples/openapi-tools/quickstart-se/README.md @@ -0,0 +1,400 @@ +# Helidon OpenAPI Generator example for Helidon SE server and client + +The goal of this example is to show how a user can easily create a Helidon SE server or client from an OpenAPI document using OpenAPI Generator. + +Here we will show the steps that a user has to do to create Helidon SE server and client using OpenAPI Generator and what has to be done to make the generated server and client fully functional. + +For generation of our projects we will use `openapi-generator-cli.jar` that can be downloaded from the maven repository (instructions and other options can be found [here](https://openapi-generator.tech/docs/installation)) and OpenAPI document `quickstart.yaml` that can be found next to this `README.md`. + +## Build, prepare and run the Helidon SE server + +To generate Helidon SE server at first we create `se-server` folder and then inside it we run the following command where `path-to-generator` is the directory where you downloaded the generator CLI JAR file and `path-to-openapi-doc` is the folder where `quickstart.yaml` is located: +```shell +java -jar path-to-generator/openapi-generator-cli.jar \ + generate \ + -g java-helidon-server \ + --library se \ + -p helidonVersion=2.5.6 \ + -i path-to-openapi-doc/quickstart.yaml +``` + +When this command finishes its work in the folder `se-server` we will find the generated project where the most interesting parts are located inside `api` and `model` packages. +The package `api` contains interfaces that represent endpoints for our server and implementations with stubs for them. +These implementations we need to change to implement our business logic. +The package `model` contains classes that represent transport objects that will be used by our endpoints to receive requests and send responses. + +Let's change a little class `MessageServiceImpl` for our example : +1) Add field that will contain default message for our endpoints : +```java + private final AtomicReference defaultMessage = new AtomicReference<>(); +``` +2) Add default constructor to the class : +```java + public MessageServiceImpl() { + Message message = new Message(); + message.setMessage("World"); + message.setGreeting("Hello"); + defaultMessage.set(message); + } +``` +3) Replace implementation of the method `public void getDefaultMessage(ServerRequest request, ServerResponse response)` by this: +```java + response.send(defaultMessage.get()); +``` +4) Replace implementation of the method `public void getMessage(ServerRequest request, ServerResponse response)` by this: +```java + String name = request.path().param("name"); + Message result = new Message(); + result.setMessage(name); + result.setGreeting(defaultMessage.get().getGreeting()); + response.send(result); +``` +5) Replace implementation of the method `public void updateGreeting(ServerRequest request, ServerResponse response, Message message)` by this: +```java + if (message.getGreeting() == null) { + Message jsonError = new Message(); + jsonError.setMessage("No greeting provided"); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonError); + return; + } + defaultMessage.set(message); + response.status(Http.Status.NO_CONTENT_204).send(); +``` + +To run the application : + +With JDK11+ +```shell +mvn package +java -jar target/openapi-java-server.jar +``` + +To check that server works as expected run the following `curl` commands : + +``` +curl -X GET http://localhost:8080/greet +{"message":"World","greeting":"Hello"} + +curl -X GET http://localhost:8080/greet/Joe +{"message":"Joe","greeting":"Hello"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola", "message":"Lisa"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet +{"message":"Lisa","greeting":"Hola"} +``` + +## Build, prepare and run the Helidon SE client + +The second part of this example is generating Helidon Webclient that will communicate with the server that we have just created. + +To generate Helidon SE Webclient at first we create `se-client` folder and then inside it we run the following command where `path-to-generator` is the directory where you downloaded the generator CLI JAR file and `path-to-openapi-doc` is the folder where `quickstart.yaml` is located: +```shell +java -jar path-to-generator/openapi-generator-cli.jar \ + generate \ + -g java-helidon-client \ + --library se \ + -p helidonVersion=2.5.6 \ + -i path-to-openapi-doc/quickstart.yaml +``` + +When this command finishes its work in the folder `se-client` we will find the generated project. +As with the server project the most interesting parts are located inside `api` and `model` packages and `ApiClient` class. +The package `api` contains interfaces that represent endpoints to our server and implementations for them. +The package `model` contains classes that represent transport objects that will be used to communicate with the server. +`ApiClient` class represents configuration and utility class for `WebClient` that is used to connect to our server. + +You can use the generated SE client artifact in either of two ways: + + - as a library - One or more other client projects can depend on the client artifact and use its generated classes. + - as a client program itself - Add some code to the generated project to make it a client program and not just a library. + +This example illustrates the second approach. We create a second server (at port 8081) which accepts greeting requests and, acting as a client, forwards them to the first service and returns the responses from the first service as its own. + +To make our client application fully functional let's add some classes, dependencies and files to the project. + +1) Add to the `pom.xml` : +```xml + + org.openapitools.client.Main + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + +``` + +2) Let's add a class `MessageService` to the `api` package that will use `MessageApi` and `ApiClient` to interact with the server : +```java +package org.openapitools.client.api; + +import io.helidon.common.http.Http; +import io.helidon.webserver.Handler; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; +import org.openapitools.client.ApiClient; +import org.openapitools.client.model.Message; + +public class MessageService implements Service { + + private final MessageApi api; + + public MessageService() { + ApiClient apiClient = ApiClient.builder().build(); + api = MessageApiImpl.create(apiClient); + } + + /** + * A service registers itself by updating the routing rules. + * + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules.get("/greet", this::getDefaultMessage); + rules.get("/greet/{name}", this::getMessage); + rules.put("/greet/greeting", Handler.create(Message.class, this::updateGreeting)); + } + + /** + * GET /greet : Return a worldly greeting message.. + * + * @param request the server request + * @param response the server response + */ + public void getDefaultMessage(ServerRequest request, ServerResponse response) { + api.getDefaultMessage() + .webClientResponse() + .flatMapSingle(serverResponse -> serverResponse.content().as(Message.class)) + .thenAccept(response::send); + } + + /** + * GET /greet/{name} : Return a greeting message using the name that was provided.. + * + * @param request the server request + * @param response the server response + */ + public void getMessage(ServerRequest request, ServerResponse response) { + String name = request.path().param("name"); + api.getMessage(name) + .webClientResponse() + .flatMapSingle(serverResponse -> serverResponse.content().as(Message.class)) + .thenAccept(response::send); + } + + /** + * PUT /greet/greeting : Set the greeting to use in future messages.. + * + * @param request the server request + * @param response the server response + * @param message Message for the user + */ + public void updateGreeting(ServerRequest request, ServerResponse response, Message message) { + api.updateGreeting(message) + .webClientResponse() + .thenAccept(content -> response.status(Http.Status.NO_CONTENT_204).send()); + } +} +``` + +3) Add class `Main` that will be the main class for our client : +```java +package org.openapitools.client; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.jackson.JacksonSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.openapitools.client.api.MessageService; + +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JacksonSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:8081"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + return Routing.builder() + .register("/", new MessageService()) + .build(); + } +} +``` + +4) Create the directory `src/main/resources/`. Create `application.yaml` in that directory with the following content: +```yaml +server: + port: 8081 + host: localhost +``` + +To run the application : + +With JDK11+ +```shell +mvn package +java -jar target/openapi-java-client.jar +``` + +To check that client works as expected and process all the request using our server run the following `curl` commands : + +``` +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola", "message":"Lisa"}' http://localhost:8081/greet/greeting + +curl -X GET http://localhost:8081/greet +{"message":"Lisa","greeting":"Hola"} + +curl -X GET http://localhost:8081/greet/Joe +{"message":"Joe","greeting":"Hola"} +``` + +## Update applications + +To keep the server and the client up to date according to the OpenApi document, we can use the maven plugin. + +Add these lines to the `pom.xml` of our server : +```xml + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/META-INF/openapi.yml + java-helidon-server + se + ${project.basedir} + + false + + + + + + + + + +``` + +For the client application : +1) Copy the OpenApi document `path-to-openapi-doc/quickstart.yaml` to the folder `resources` and rename it to `openapi.yaml`. +2) Add these lines to the `pom.xml` of our client : +```xml + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/openapi.yml + java-helidon-client + se + ${project.basedir} + + false + + + + + + + + + +``` + +Also add the following to the `` in the `pom.xml` file: +```xml +6.2.1 +``` + +The version `6.2.1` was the first version where Helidon generators were added, so if more modern versions of this plugin are exist you can choose one of them. + +To run the generator during your build, invoke the profile: `mvn clean package -P openapi`. + +It should also be added that the `fullProject` option was used in the plugin configuration. +If it set to true, it will generate all files; if set to false, it will only generate API files. +If unspecified, the behavior depends on whether a project exists or not: if it does not, same as true; if it does, same as false. +So keep in mind that regenerating will overwrite your customized `MessageService` or `Message` files and you will need to add the customization again after regenerating. +Note that test files are never overwritten. diff --git a/examples/openapi-tools/quickstart-se/pom.xml b/examples/openapi-tools/quickstart-se/pom.xml new file mode 100644 index 00000000..5b35b1c0 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/pom.xml @@ -0,0 +1,42 @@ + + + + + 4.0.0 + + io.helidon.examples.openapi.tools + helidon-examples-openapi-tools-project + 1.0.0-SNAPSHOT + + pom + helidon-examples-openapi-tools-quickstart-se + 1.0.0-SNAPSHOT + Helidon OpenApi Tools Example for Quickstart SE + + + Example of usage OpenApi Tools for Helidon Quickstart SE server and client + + + + se-server + se-client + + diff --git a/examples/openapi-tools/quickstart-se/se-client/README.md b/examples/openapi-tools/quickstart-se/se-client/README.md new file mode 100644 index 00000000..debd008c --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/README.md @@ -0,0 +1,32 @@ +# OpenAPI Helidon Quickstart + +This is a sample for Helidon Quickstart project. + + +## Overview +This project was generated using the Helidon OpenAPI Generator. + +The generated classes use the programming model from the Helidon WebClient implementation, primarily the `WebClient` interface and its +`WebClient.Builder` class. Refer to the Helidon WebClient documentation for complete information about them. + +## Using the Generated Classes and Interfaces +The generated `ApiClient` class wraps a `WebClient` instance. Similarly, the `ApiClient.Builder` class wraps the `WebClient.Builder` class. + +The generated `xxxApi` interfaces and `xxxApiImpl` classes make it very simple for your code to send requests (with input parameters) to the remote service which the OpenAPI document describes and to process the response (with output values) from the remote service. + +To use the generated API, your code performs the following steps. + +1. Create an instance of the `ApiClient` using its `Builder`. +2. Create an instance of a `xxxApi` it wants to access, typically by invoking `xxxApiImpl.create(ApiClient)` and passing the `ApiClient` instance just created. +3. Invoke any of the `public` methods on the `xxxApi` instance, passing the input parameters and saving the returned `Single` object. +4. Invoke methods on the returned `Single` to process the response and any output from it. + +Browse the methods and JavaDoc on the generated classes for more information. +```shell +mvn package +java -jar target/openapi-se-client.jar +``` + +```shell +curl http://localhost:8081/greet +``` \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-client/docs/Message.md b/examples/openapi-tools/quickstart-se/se-client/docs/Message.md new file mode 100644 index 00000000..df42a18c --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/docs/Message.md @@ -0,0 +1,15 @@ + + +# Message + +An message for the user + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**message** | **String** | | [optional] | +|**greeting** | **String** | | [optional] | + + + diff --git a/examples/openapi-tools/quickstart-se/se-client/docs/MessageApi.md b/examples/openapi-tools/quickstart-se/se-client/docs/MessageApi.md new file mode 100644 index 00000000..094434a3 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/docs/MessageApi.md @@ -0,0 +1,199 @@ +# MessageApi + +All URIs are relative to *http://localhost:8080* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**getDefaultMessage**](MessageApi.md#getDefaultMessage) | **GET** /greet | Return a worldly greeting message. | +| [**getMessage**](MessageApi.md#getMessage) | **GET** /greet/{name} | Return a greeting message using the name that was provided. | +| [**updateGreeting**](MessageApi.md#updateGreeting) | **PUT** /greet/greeting | Set the greeting to use in future messages. | + + + +## getDefaultMessage + +> Message getDefaultMessage() + +Return a worldly greeting message. + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MessageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:8080"); + + MessageApi apiInstance = new MessageApi(defaultClient); + try { + Message result = apiInstance.getDefaultMessage(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MessageApi#getDefaultMessage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Message**](Message.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | - | + + +## getMessage + +> Message getMessage(name) + +Return a greeting message using the name that was provided. + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MessageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:8080"); + + MessageApi apiInstance = new MessageApi(defaultClient); + String name = "name_example"; // String | the name to greet + try { + Message result = apiInstance.getMessage(name); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MessageApi#getMessage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **name** | **String**| the name to greet | | + +### Return type + +[**Message**](Message.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | - | + + +## updateGreeting + +> updateGreeting(message) + +Set the greeting to use in future messages. + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.MessageApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:8080"); + + MessageApi apiInstance = new MessageApi(defaultClient); + Message message = new Message(); // Message | Message for the user + try { + apiInstance.updateGreeting(message); + } catch (ApiException e) { + System.err.println("Exception when calling MessageApi#updateGreeting"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **message** | [**Message**](Message.md)| Message for the user | | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | - | +| **400** | No greeting provided | - | + diff --git a/examples/openapi-tools/quickstart-se/se-client/pom.xml b/examples/openapi-tools/quickstart-se/se-client/pom.xml new file mode 100644 index 00000000..89088a4f --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/pom.xml @@ -0,0 +1,131 @@ + + + + 4.0.0 + org.openapitools + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + openapi-se-client + openapi-java-client + This is a sample for Helidon Quickstart project. + 1.0.0 + jar + + + org.openapitools.client.Main + 6.2.1 + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.webclient + helidon-webclient + + + io.helidon.config + helidon-config + + + jakarta.json + jakarta.json-api + + + io.helidon.media + helidon-media-jackson + + + org.glassfish.jersey.media + jersey-media-json-jackson + + + org.openapitools + jackson-databind-nullable + 0.2.2 + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/openapi.yml + java-helidon-client + se + ${project.basedir} + + false + + + + + + + + + + diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiClient.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiClient.java new file mode 100644 index 00000000..7be501ba --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiClient.java @@ -0,0 +1,257 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.openapitools.jackson.nullable.JsonNullableModule; + +import io.helidon.config.Config; +import io.helidon.media.jackson.JacksonSupport; +import io.helidon.webclient.WebClient; + +import java.net.URI; +import java.net.URLEncoder; +import java.time.Duration; +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.StringJoiner; +import java.util.function.Consumer; +import java.util.stream.Collectors; + +import static java.nio.charset.StandardCharsets.UTF_8; + +/** + * Configuration and utility class for API clients. + *

+ * Use the {@link ApiClient.Builder} class to prepare and ultimately create the {@code ApiClient} instance. + *

+ */ +public class ApiClient { + + private final WebClient webClient; + + /** + * @return a {@code Builder} for an {@code ApiClient} + */ + public static ApiClient.Builder builder() { + return new Builder(); + } + + /** + * URL encode a string in the UTF-8 encoding. + * + * @param s String to encode. + * @return URL-encoded representation of the input string. + */ + public static String urlEncode(String s) { + return URLEncoder.encode(s, UTF_8); + } + + /** + * Convert a URL query name/value parameter to a list of encoded {@link Pair} + * objects. + * + *

The value can be null, in which case an empty list is returned.

+ * + * @param name The query name parameter. + * @param value The query value, which may not be a collection but may be + * null. + * @return A singleton list of the {@link Pair} objects representing the input + * parameters, which is encoded for use in a URL. If the value is null, an + * empty list is returned. + */ + public static List parameterToPairs(String name, Object value) { + if (name == null || name.isEmpty() || value == null) { + return Collections.emptyList(); + } + return Collections.singletonList(new Pair(urlEncode(name), urlEncode(valueToString(value)))); + } + + /** + * Convert a URL query name/collection parameter to a list of encoded + * {@link Pair} objects. + * + * @param collectionFormat The swagger collectionFormat string (csv, tsv, etc). + * @param name The query name parameter. + * @param values A collection of values for the given query name, which may be + * null. + * @return A list of {@link Pair} objects representing the input parameters, + * which is encoded for use in a URL. If the values collection is null, an + * empty list is returned. + */ + public static List parameterToPairs( + String collectionFormat, String name, Collection values) { + if (name == null || name.isEmpty() || values == null || values.isEmpty()) { + return Collections.emptyList(); + } + + // get the collection format (default: csv) + String format = collectionFormat == null || collectionFormat.isEmpty() ? "csv" : collectionFormat; + + // create the params based on the collection format + if ("multi".equals(format)) { + return values.stream() + .map(value -> new Pair(urlEncode(name), urlEncode(valueToString(value)))) + .collect(Collectors.toList()); + } + + String delimiter; + switch(format) { + case "csv": + delimiter = urlEncode(","); + break; + case "ssv": + delimiter = urlEncode(" "); + break; + case "tsv": + delimiter = urlEncode("\t"); + break; + case "pipes": + delimiter = urlEncode("|"); + break; + default: + throw new IllegalArgumentException("Illegal collection format: " + collectionFormat); + } + + StringJoiner joiner = new StringJoiner(delimiter); + for (Object value : values) { + joiner.add(urlEncode(valueToString(value))); + } + + return Collections.singletonList(new Pair(urlEncode(name), joiner.toString())); + } + + private ApiClient(Builder builder) { + webClient = builder.webClientBuilder().build(); + } + + /** + * Get the {@link WebClient} prepared by the builder of this {@code ApiClient}. + * + * @return the WebClient + */ + public WebClient webClient() { + return webClient; + } + + private static String valueToString(Object value) { + if (value == null) { + return ""; + } + if (value instanceof OffsetDateTime) { + return ((OffsetDateTime) value).format(DateTimeFormatter.ISO_OFFSET_DATE_TIME); + } + return value.toString(); + } + + /** + * Builder for creating a new {@code ApiClient} instance. + * + *

+ * The builder accepts a {@link WebClient.Builder} via the {@code webClientBuilder} method but will provide a default one + * using available configuration (the {@code client} node) and the base URI set in the OpenAPI document. + *

+ */ + public static class Builder { + + private WebClient.Builder webClientBuilder; + private Config clientConfig; + private ObjectMapper objectMapper; + + public ApiClient build() { + return new ApiClient(this); + } + + /** + * Sets the {@code WebClient.Builder} which the {@code ApiClient.Builder} uses. Any previous setting is discarded. + * + * @param webClientBuilder the {@code WebClient.Builder} to be used going forward + * @return the updated builder + */ + public Builder webClientBuilder(WebClient.Builder webClientBuilder) { + this.webClientBuilder = webClientBuilder; + return this; + } + + /** + * Sets the client {@code Config} which the {@code ApiClient.Builder} uses in preparing a default {@code WebClient.Builder}. + * The builder ignores this setting if you provide your own {@code WebClient.Builder} by invoking the + * {@code webClientBuilder} method. + * + * @param clientConfig the {@code Config} node containing client settings + * @return the updated builder + */ + public Builder clientConfig(Config clientConfig) { + this.clientConfig = clientConfig; + return this; + } + + /** + * @return the previously-stored web client builder or, if none, a default one using the provided or defaulted + * client configuration + */ + public WebClient.Builder webClientBuilder() { + if (webClientBuilder == null) { + webClientBuilder = defaultWebClientBuilder(); + } + return webClientBuilder; + } + + /** + * Stores the Jackson {@code ObjectMapper} the builder uses in preparing the {@code WebClient}. + * + * @param objectMapper the Jackson object mapper to use in all API invocations via the built {@code ApiClient} + * @return the updated builder + */ + public Builder objectMapper(ObjectMapper objectMapper) { + this.objectMapper = objectMapper; + return this; + } + + private WebClient.Builder defaultWebClientBuilder() { + WebClient.Builder defaultWebClientBuilder = WebClient.builder() + .baseUri("http://localhost:8080") + .config(clientConfig()); + defaultWebClientBuilder.addMediaSupport(objectMapper == null + ? JacksonSupport.create() + : JacksonSupport.create(objectMapper)); + return defaultWebClientBuilder; + } + + private Config clientConfig() { + if (clientConfig == null) { + clientConfig = Config.create().get("client"); + } + return clientConfig; + } + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiResponse.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiResponse.java new file mode 100644 index 00000000..b07b5587 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiResponse.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client; + +import java.util.concurrent.ExecutionException; + +import io.helidon.common.GenericType; +import io.helidon.common.reactive.Single; +import io.helidon.webclient.WebClientResponse; + +/** + * Generic-typed response. + * + * Return type for generated API methods. + * + * @param type of the return value from the generated API method + */ +public interface ApiResponse { + + static ApiResponse create(GenericType responseType, Single webClientResponse) { + return new ApiResponseBase<>(responseType, webClientResponse); + } + + /** + * @returns reactive access to the {@link WebClientResponse} describing the response from the server + */ + Single webClientResponse(); + + /** + * @return reactive access to the value returned in the response from the server + */ + Single result() throws ExecutionException, InterruptedException; +} diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiResponseBase.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiResponseBase.java new file mode 100644 index 00000000..faa53831 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/ApiResponseBase.java @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client; + +import java.util.concurrent.ExecutionException; + +import io.helidon.common.GenericType; +import io.helidon.common.reactive.Single; +import io.helidon.webclient.WebClientResponse; + +/** + * Implementation of a generic-typed response. + * + * @param type of the return value from the generated API method + */ +class ApiResponseBase implements ApiResponse { + + private final Single webClientResponse; + private final GenericType responseType; + + protected ApiResponseBase(GenericType responseType, Single webClientResponse) { + this.webClientResponse = webClientResponse; + this.responseType = responseType; + } + + @Override + public Single webClientResponse() { + return webClientResponse; + } + + @Override + public Single result() throws ExecutionException, InterruptedException { + return webClientResponse.get().content().as(responseType); + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/Main.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/Main.java new file mode 100644 index 00000000..f302dd06 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/Main.java @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.client; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.jackson.JacksonSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import org.openapitools.client.api.MessageService; + +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JacksonSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:8081"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + return Routing.builder() + .register("/", new MessageService()) + .build(); + } +} diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/Pair.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/Pair.java new file mode 100644 index 00000000..6ebda031 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/Pair.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client; + +public class Pair { + private String name = ""; + private String value = ""; + + public Pair (String name, String value) { + setName(name); + setValue(value); + } + + private void setName(String name) { + if (!isValidString(name)) { + return; + } + + this.name = name; + } + + private void setValue(String value) { + if (!isValidString(value)) { + return; + } + + this.value = value; + } + + public String getName() { + return this.name; + } + + public String getValue() { + return this.value; + } + + private boolean isValidString(String arg) { + if (arg == null) { + return false; + } + + return true; + } +} diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/RFC3339DateFormat.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/RFC3339DateFormat.java new file mode 100644 index 00000000..d863106f --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/RFC3339DateFormat.java @@ -0,0 +1,73 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client; + +import com.fasterxml.jackson.databind.util.StdDateFormat; + +import java.text.DateFormat; +import java.text.FieldPosition; +import java.text.ParsePosition; +import java.util.Date; +import java.text.DecimalFormat; +import java.util.GregorianCalendar; +import java.util.TimeZone; + +public class RFC3339DateFormat extends DateFormat { + private static final long serialVersionUID = 1L; + private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC"); + + private final StdDateFormat fmt = new StdDateFormat() + .withTimeZone(TIMEZONE_Z) + .withColonInTimeZone(true); + + public RFC3339DateFormat() { + this.calendar = new GregorianCalendar(); + this.numberFormat = new DecimalFormat(); + } + + @Override + public Date parse(String source) { + return parse(source, new ParsePosition(0)); + } + + @Override + public Date parse(String source, ParsePosition pos) { + return fmt.parse(source, pos); + } + + @Override + public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) { + return fmt.format(date, toAppendTo, fieldPosition); + } + + @Override + public Object clone() { + return super.clone(); + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageApi.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageApi.java new file mode 100644 index 00000000..1a7329dd --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageApi.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.api; + +import org.openapitools.client.ApiResponse; +import java.util.List; +import java.util.Map; +import org.openapitools.client.model.Message; + +/** + * OpenAPI Helidon Quickstart + * + *

This is a sample for Helidon Quickstart project. + */ +public interface MessageApi { + + /** + * Return a worldly greeting message. + * @return {@code ApiResponse} + */ + ApiResponse getDefaultMessage(); + + /** + * Return a greeting message using the name that was provided. + * @param name the name to greet (required) + * @return {@code ApiResponse} + */ + ApiResponse getMessage(String name); + + /** + * Set the greeting to use in future messages. + * @param message Message for the user (required) + * @return {@code ApiResponse} + */ + ApiResponse updateGreeting(Message message); + +} diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageApiImpl.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageApiImpl.java new file mode 100644 index 00000000..80959c4d --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageApiImpl.java @@ -0,0 +1,188 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.api; + +import java.util.Objects; +import org.openapitools.client.ApiResponse; + +import com.fasterxml.jackson.databind.ObjectMapper; + +import io.helidon.common.GenericType; +import io.helidon.common.http.MediaType; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.common.MediaSupport; + +import io.helidon.media.jackson.JacksonSupport; +import io.helidon.webclient.WebClientRequestBuilder; +import io.helidon.webclient.WebClientResponse; + +import org.openapitools.client.ApiClient; + +import java.util.List; +import java.util.Map; +import org.openapitools.client.model.Message; + +/** + * OpenAPI Helidon Quickstart + * + *

This is a sample for Helidon Quickstart project. + */ +public class MessageApiImpl implements MessageApi { + + private final ApiClient apiClient; + + protected static final GenericType RESPONSE_TYPE_getDefaultMessage = ResponseType.create(Message.class); + protected static final GenericType RESPONSE_TYPE_getMessage = ResponseType.create(Message.class); + protected static final GenericType RESPONSE_TYPE_updateGreeting = ResponseType.create(Void.class); + + /** + * Creates a new instance of MessageApiImpl initialized with the specified {@link ApiClient}. + * + */ + public static MessageApiImpl create(ApiClient apiClient) { + return new MessageApiImpl(apiClient); + } + + protected MessageApiImpl(ApiClient apiClient) { + this.apiClient = apiClient; + } + + @Override + public ApiResponse getDefaultMessage() { + WebClientRequestBuilder webClientRequestBuilder = getDefaultMessageRequestBuilder(); + return getDefaultMessageSubmit(webClientRequestBuilder); + } + + /** + * Creates a {@code WebClientRequestBuilder} for the getDefaultMessage operation. + * Optional customization point for subclasses. + * + * @return WebClientRequestBuilder for getDefaultMessage + */ + protected WebClientRequestBuilder getDefaultMessageRequestBuilder() { + WebClientRequestBuilder webClientRequestBuilder = apiClient.webClient() + .method("GET"); + + webClientRequestBuilder.path("/greet"); + webClientRequestBuilder.accept(MediaType.APPLICATION_JSON); + + return webClientRequestBuilder; + } + + /** + * Initiates the request for the getDefaultMessage operation. + * Optional customization point for subclasses. + * + * @param webClientRequestBuilder the request builder to use for submitting the request + * @return {@code ApiResponse} for the submitted request + */ + protected ApiResponse getDefaultMessageSubmit(WebClientRequestBuilder webClientRequestBuilder) { + Single webClientResponse = webClientRequestBuilder.submit(); + return ApiResponse.create(RESPONSE_TYPE_getDefaultMessage, webClientResponse); + } + + @Override + public ApiResponse getMessage(String name) { + Objects.requireNonNull(name, "Required parameter 'name' not specified"); + WebClientRequestBuilder webClientRequestBuilder = getMessageRequestBuilder(name); + return getMessageSubmit(webClientRequestBuilder, name); + } + + /** + * Creates a {@code WebClientRequestBuilder} for the getMessage operation. + * Optional customization point for subclasses. + * + * @param name the name to greet (required) + * @return WebClientRequestBuilder for getMessage + */ + protected WebClientRequestBuilder getMessageRequestBuilder(String name) { + WebClientRequestBuilder webClientRequestBuilder = apiClient.webClient() + .method("GET"); + + String path = "/greet/{name}" + .replace("{name}", ApiClient.urlEncode(name)); + webClientRequestBuilder.path(path); + webClientRequestBuilder.accept(MediaType.APPLICATION_JSON); + + return webClientRequestBuilder; + } + + /** + * Initiates the request for the getMessage operation. + * Optional customization point for subclasses. + * + * @param webClientRequestBuilder the request builder to use for submitting the request + * @param name the name to greet (required) + * @return {@code ApiResponse} for the submitted request + */ + protected ApiResponse getMessageSubmit(WebClientRequestBuilder webClientRequestBuilder, String name) { + Single webClientResponse = webClientRequestBuilder.submit(); + return ApiResponse.create(RESPONSE_TYPE_getMessage, webClientResponse); + } + + @Override + public ApiResponse updateGreeting(Message message) { + Objects.requireNonNull(message, "Required parameter 'message' not specified"); + WebClientRequestBuilder webClientRequestBuilder = updateGreetingRequestBuilder(message); + return updateGreetingSubmit(webClientRequestBuilder, message); + } + + /** + * Creates a {@code WebClientRequestBuilder} for the updateGreeting operation. + * Optional customization point for subclasses. + * + * @param message Message for the user (required) + * @return WebClientRequestBuilder for updateGreeting + */ + protected WebClientRequestBuilder updateGreetingRequestBuilder(Message message) { + WebClientRequestBuilder webClientRequestBuilder = apiClient.webClient() + .method("PUT"); + + webClientRequestBuilder.path("/greet/greeting"); + webClientRequestBuilder.contentType(MediaType.APPLICATION_JSON); + webClientRequestBuilder.accept(MediaType.APPLICATION_JSON); + + return webClientRequestBuilder; + } + + /** + * Initiates the request for the updateGreeting operation. + * Optional customization point for subclasses. + * + * @param webClientRequestBuilder the request builder to use for submitting the request + * @param message Message for the user (required) + * @return {@code ApiResponse} for the submitted request + */ + protected ApiResponse updateGreetingSubmit(WebClientRequestBuilder webClientRequestBuilder, Message message) { + Single webClientResponse = webClientRequestBuilder.submit(message); + return ApiResponse.create(RESPONSE_TYPE_updateGreeting, webClientResponse); + } + +} diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageService.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageService.java new file mode 100644 index 00000000..5e9c35a4 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/MessageService.java @@ -0,0 +1,88 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.client.api; + +import io.helidon.common.http.Http; +import io.helidon.webserver.Handler; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; +import org.openapitools.client.ApiClient; +import org.openapitools.client.model.Message; + +public class MessageService implements Service { + + private final MessageApi api; + + public MessageService() { + ApiClient apiClient = ApiClient.builder().build(); + api = MessageApiImpl.create(apiClient); + } + + /** + * A service registers itself by updating the routing rules. + * + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules.get("/greet", this::getDefaultMessage); + rules.get("/greet/{name}", this::getMessage); + rules.put("/greet/greeting", Handler.create(Message.class, this::updateGreeting)); + } + + /** + * GET /greet : Return a worldly greeting message.. + * + * @param request the server request + * @param response the server response + */ + public void getDefaultMessage(ServerRequest request, ServerResponse response) { + api.getDefaultMessage() + .webClientResponse() + .flatMapSingle(serverResponse -> serverResponse.content().as(Message.class)) + .thenAccept(response::send); + } + + /** + * GET /greet/{name} : Return a greeting message using the name that was provided.. + * + * @param request the server request + * @param response the server response + */ + public void getMessage(ServerRequest request, ServerResponse response) { + String name = request.path().param("name"); + api.getMessage(name) + .webClientResponse() + .flatMapSingle(serverResponse -> serverResponse.content().as(Message.class)) + .thenAccept(response::send); + } + + /** + * PUT /greet/greeting : Set the greeting to use in future messages.. + * + * @param request the server request + * @param response the server response + * @param message Message for the user + */ + public void updateGreeting(ServerRequest request, ServerResponse response, Message message) { + api.updateGreeting(message) + .webClientResponse() + .thenAccept(content -> response.status(Http.Status.NO_CONTENT_204).send()); + } +} diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/ResponseType.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/ResponseType.java new file mode 100644 index 00000000..7733df79 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/api/ResponseType.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.api; + +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; + +import io.helidon.common.GenericType; + +class ResponseType { + + static GenericType create(Type rawType, Type... typeParams) { + return typeParams.length == 0 + ? GenericType.create(rawType) + : GenericType.create(new ParameterizedType() { + + @Override + public Type[] getActualTypeArguments() { + return typeParams; + } + + @Override + public Type getRawType() { + return rawType; + } + + @Override + public Type getOwnerType() { + return null; + } + }); + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/model/Message.java b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/model/Message.java new file mode 100644 index 00000000..d5d51939 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/java/org/openapitools/client/model/Message.java @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; + + + +/** + * An message for the user + **/ + +public class Message { + + private String message; + + private String greeting; + + /** + * Get message + * @return message + **/ + public String getMessage() { + return message; + } + + /** + * Set message + **/ + public void setMessage(String message) { + this.message = message; + } + + public Message message(String message) { + this.message = message; + return this; + } + + /** + * Get greeting + * @return greeting + **/ + public String getGreeting() { + return greeting; + } + + /** + * Set greeting + **/ + public void setGreeting(String greeting) { + this.greeting = greeting; + } + + public Message greeting(String greeting) { + this.greeting = greeting; + return this; + } + + + /** + * Create a string representation of this pojo. + **/ + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Message {\n"); + + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" greeting: ").append(toIndentedString(greeting)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/resources/application.yaml b/examples/openapi-tools/quickstart-se/se-client/src/main/resources/application.yaml new file mode 100644 index 00000000..05893dd2 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/resources/application.yaml @@ -0,0 +1,18 @@ +# +# Copyright (c) 2022, 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. +# +server: + port: 8081 + host: localhost \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-client/src/main/resources/openapi.yaml b/examples/openapi-tools/quickstart-se/se-client/src/main/resources/openapi.yaml new file mode 100644 index 00000000..75bdc18f --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/main/resources/openapi.yaml @@ -0,0 +1,96 @@ +# +# Copyright (c) 2022, 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. +# + +openapi: 3.0.0 +servers: + - url: 'http://localhost:8080' +info: + description: >- + This is a sample for Helidon Quickstart project. + version: 1.0.0 + title: OpenAPI Helidon Quickstart + license: + name: Apache-2.0 + url: 'https://www.apache.org/licenses/LICENSE-2.0.html' +tags: + - name: message +paths: + /greet: + get: + tags: + - message + summary: Return a worldly greeting message. + operationId: getDefaultMessage + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + /greet/greeting: + put: + tags: + - message + summary: Set the greeting to use in future messages. + operationId: updateGreeting + responses: + '200': + description: successful operation + '400': + description: No greeting provided + requestBody: + $ref: '#/components/requestBodies/Message' + '/greet/{name}': + get: + tags: + - message + summary: Return a greeting message using the name that was provided. + operationId: getMessage + parameters: + - name: name + in: path + description: the name to greet + required: true + schema: + type: string + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Message' +components: + requestBodies: + Message: + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: Message for the user + required: true + schemas: + Message: + description: An message for the user + type: object + properties: + message: + type: string + format: int64 + greeting: + type: string + format: int64 diff --git a/examples/openapi-tools/quickstart-se/se-client/src/test/java/org/openapitools/client/api/MessageApiTest.java b/examples/openapi-tools/quickstart-se/se-client/src/test/java/org/openapitools/client/api/MessageApiTest.java new file mode 100644 index 00000000..202154a9 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/test/java/org/openapitools/client/api/MessageApiTest.java @@ -0,0 +1,121 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.api; + +import java.util.List; +import java.util.Map; +import org.openapitools.client.model.Message; + +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiResponse; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import io.helidon.common.reactive.Single; +import io.helidon.webclient.WebClientResponse; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +/** + * + * OpenAPI Helidon Quickstart Test + * + * + * API tests for MessageApi + */ +public class MessageApiTest { + + private static ApiClient apiClient; + private static MessageApi api; + private static final String baseUrl = "http://localhost:8080"; + + @BeforeAll + public static void setup() { + apiClient = ApiClient.builder().build(); + api = MessageApiImpl.create(apiClient); + } + + /** + * Return a worldly greeting message. + */ + @Test + public void getDefaultMessageTest() { + + // TODO - uncomment the following two lines to invoke the service with valid parameters. + //ApiResponse response = api.getDefaultMessage(); + //response.webClientResponse().await(); + // TODO - check for appropriate return status + // assertThat("Return status", response.get().status().code(), is(expectedStatus)); + + // TODO: test validations + } + + /** + * Return a greeting message using the name that was provided. + */ + @Test + public void getMessageTest() { + // TODO - assign values to the input arguments. + String name = null; + + // TODO - uncomment the following two lines to invoke the service with valid parameters. + //ApiResponse response = api.getMessage(name); + //response.webClientResponse().await(); + // TODO - check for appropriate return status + // assertThat("Return status", response.get().status().code(), is(expectedStatus)); + + // TODO: test validations + } + + /** + * Set the greeting to use in future messages. + */ + @Test + public void updateGreetingTest() { + // TODO - assign values to the input arguments. + Message message = null; + + // TODO - uncomment the following two lines to invoke the service with valid parameters. + //ApiResponse response = api.updateGreeting(message); + //response.webClientResponse().await(); + // TODO - check for appropriate return status + // assertThat("Return status", response.get().status().code(), is(expectedStatus)); + + // TODO: test validations + } + +} diff --git a/examples/openapi-tools/quickstart-se/se-client/src/test/java/org/openapitools/client/model/MessageTest.java b/examples/openapi-tools/quickstart-se/se-client/src/test/java/org/openapitools/client/model/MessageTest.java new file mode 100644 index 00000000..ca2b98bd --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-client/src/test/java/org/openapitools/client/model/MessageTest.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2022, 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. + */ + +/** + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.openapitools.client.model; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; + +import org.junit.jupiter.api.Test; + + +/** + * Model tests for Message + */ +public class MessageTest { + private final Message model = new Message(); + + /** + * Model tests for Message + */ + @Test + public void testMessage() { + // TODO: test Message + } + + /** + * Test the property 'message' + */ + @Test + public void messageTest() { + // TODO: test message + } + + /** + * Test the property 'greeting' + */ + @Test + public void greetingTest() { + // TODO: test greeting + } + +} diff --git a/examples/openapi-tools/quickstart-se/se-server/README.md b/examples/openapi-tools/quickstart-se/se-server/README.md new file mode 100644 index 00000000..c7de400e --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/README.md @@ -0,0 +1,35 @@ +# Helidon SE Server with OpenAPI + +## Build and run + +```shell +mvn package +java -jar target/openapi-se-server.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +curl -X GET http://localhost:8080/greet/{name} +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + +``` + +## Try health and metrics + +```shell +curl -s -X GET http://localhost:8080/health +#{"outcome":"UP",... +#. . . + +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics +# TYPE base:gc_g1_young_generation_count gauge +#. . . + +# JSON Format +curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics +#{"base":... +#. . . +``` \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-server/pom.xml b/examples/openapi-tools/quickstart-se/se-server/pom.xml new file mode 100644 index 00000000..50d0d3d2 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/pom.xml @@ -0,0 +1,152 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + org.openapitools + openapi-se-server + 1.0.0-SNAPSHOT + openapi-java-server + This is a sample for Helidon Quickstart project. + + + org.openapitools.server.Main + 0.2.3 + 6.2.1 + + + + + jakarta.validation + jakarta.validation-api + + + io.helidon.webserver + helidon-webserver + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.media + helidon-media-multipart + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics + + + io.helidon.openapi + helidon-openapi + + + org.openapitools + jackson-databind-nullable + ${version.jackson.databind.nullable} + + + io.helidon.media + helidon-media-jackson + + + org.junit.jupiter + junit-jupiter-api + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + io.helidon.build-tools + helidon-maven-plugin + + + third-party-license-report + + + + + + + + + openapi + + + + org.openapitools + openapi-generator-maven-plugin + ${version.openapi.generator.maven.plugin} + + + + generate + + + ${project.basedir}/src/main/resources/META-INF/openapi.yml + java-helidon-server + se + ${project.basedir} + + false + + + + + + + + + + diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/Main.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/Main.java new file mode 100644 index 00000000..ed798d5b --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/Main.java @@ -0,0 +1,107 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server; + +import org.openapitools.server.api.MessageServiceImpl; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.media.jackson.JacksonSupport; +import org.openapitools.server.api.JsonProvider; +import io.helidon.metrics.MetricsSupport; +import io.helidon.openapi.OpenAPISupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** +* The application main class. +*/ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .addMediaSupport(JacksonSupport.create(JsonProvider.objectMapper())) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:8080"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + return Routing.builder() + .register(OpenAPISupport.create(config.get(OpenAPISupport.Builder.CONFIG_KEY))) + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register("/", new MessageServiceImpl()) + .build(); + } +} diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/RFC3339DateFormat.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/RFC3339DateFormat.java new file mode 100644 index 00000000..af55f54c --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/RFC3339DateFormat.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server; + +import com.fasterxml.jackson.databind.util.StdDateFormat; + +import java.text.DateFormat; +import java.text.FieldPosition; +import java.text.ParsePosition; +import java.util.Date; +import java.util.GregorianCalendar; +import java.util.TimeZone; + +public class RFC3339DateFormat extends DateFormat { + private static final long serialVersionUID = 1L; + private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC"); + + private final StdDateFormat fmt = new StdDateFormat() + .withTimeZone(TIMEZONE_Z) + .withColonInTimeZone(true); + + public RFC3339DateFormat() { + this.calendar = new GregorianCalendar(); + } + + @Override + public Date parse(String source, ParsePosition pos) { + return fmt.parse(source, pos); + } + + @Override + public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) { + return fmt.format(date, toAppendTo, fieldPosition); + } + + @Override + public Object clone() { + return this; + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/JsonProvider.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/JsonProvider.java new file mode 100644 index 00000000..137f8073 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/JsonProvider.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server.api; + +import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.PropertyAccessor; +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; + +public class JsonProvider { + + public static ObjectMapper objectMapper() { + ObjectMapper mapper = new ObjectMapper(); + mapper.registerModule(new JavaTimeModule()); + mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); + mapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY); + mapper.configure(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE, false); + return mapper; + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/MessageService.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/MessageService.java new file mode 100644 index 00000000..03a3ee6f --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/MessageService.java @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server.api; + +import io.helidon.webserver.Handler; +import org.openapitools.server.model.Message; +import com.fasterxml.jackson.databind.ObjectMapper; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +public interface MessageService extends Service { + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + default void update(Routing.Rules rules) { + rules.get("/greet", this::getDefaultMessage); + rules.get("/greet/{name}", this::getMessage); + rules.put("/greet/greeting", Handler.create(Message.class, this::updateGreeting)); + } + + + /** + * GET /greet : Return a worldly greeting message.. + * @param request the server request + * @param response the server response + */ + void getDefaultMessage(ServerRequest request, ServerResponse response); + + /** + * GET /greet/{name} : Return a greeting message using the name that was provided.. + * @param request the server request + * @param response the server response + */ + void getMessage(ServerRequest request, ServerResponse response); + + /** + * PUT /greet/greeting : Set the greeting to use in future messages.. + * @param request the server request + * @param response the server response + * @param message Message for the user + */ + void updateGreeting(ServerRequest request, ServerResponse response, Message message); + +} diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/MessageServiceImpl.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/MessageServiceImpl.java new file mode 100644 index 00000000..8ea48eec --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/MessageServiceImpl.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server.api; + +import io.helidon.common.http.Http; +import io.helidon.webserver.Handler; +import org.openapitools.server.model.Message; +import com.fasterxml.jackson.databind.ObjectMapper; + +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Logger; + +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; + +public class MessageServiceImpl implements MessageService { + + private static final int HTTP_CODE_NOT_IMPLEMENTED = 501; + private static final Logger LOGGER = Logger.getLogger(MessageService.class.getName()); + private static final ObjectMapper MAPPER = JsonProvider.objectMapper(); + + private final AtomicReference defaultMessage = new AtomicReference<>(); + + public MessageServiceImpl() { + Message message = new Message(); + message.setMessage("World"); + message.setGreeting("Hello"); + defaultMessage.set(message); + } + + public void getDefaultMessage(ServerRequest request, ServerResponse response) { + response.send(defaultMessage.get()); + } + + public void getMessage(ServerRequest request, ServerResponse response) { + String name = request.path().param("name"); + Message result = new Message(); + result.setMessage(name); + result.setGreeting(defaultMessage.get().getGreeting()); + response.send(result); + } + + public void updateGreeting(ServerRequest request, ServerResponse response, Message message) { + if (message.getGreeting() == null) { + Message jsonError = new Message(); + jsonError.setMessage("No greeting provided"); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonError); + return; + } + defaultMessage.set(message); + response.status(Http.Status.NO_CONTENT_204).send(); + } + +} diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/ValidatorUtils.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/ValidatorUtils.java new file mode 100644 index 00000000..ee93b37a --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/api/ValidatorUtils.java @@ -0,0 +1,128 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server.api; + +import java.lang.reflect.Array; +import java.math.BigDecimal; +import java.util.Collection; +import java.util.Map; +import java.util.Objects; + +import javax.validation.ValidationException; + +/** +* Validation utility methods. +*/ +public final class ValidatorUtils { + + public static boolean validateMin(Integer value, Integer min) { + checkNonNull(value); + if (value < min) { + throw new ValidationException(String.format("%s is less than %s", value, min)); + } + return true; + } + + public static boolean validateMax(Integer value, Integer max) { + checkNonNull(value); + if (value > max) { + throw new ValidationException(String.format("%s is more than %s", value, max)); + } + return true; + } + + public static boolean validateSize(Object value, Integer min, Integer max) { + checkNonNull(value); + Integer size = -1; + if (value instanceof Map) { + size = ((Map) value).size(); + } + if (value instanceof CharSequence) { + size = ((CharSequence) value).length(); + } + if (value instanceof Collection) { + size = ((Collection) value).size(); + } + if (value.getClass().isArray()) { + size = Array.getLength(value); + } + if (size == -1) { + throw new ValidationException("Value has incorrect type"); + } + if (min != null) { + validateMin(size, min); + } + if (max != null) { + validateMax(size, max); + } + return true; + } + + public static boolean validatePattern(String value, String pattern) { + checkNonNull(value, pattern); + if (value.matches(pattern)) { + return true; + } + throw new ValidationException(String.format("'%s' does not match the pattern '%s'", value, pattern)); + } + + public static boolean validateMin(BigDecimal value, String stringMinValue, boolean inclusive) { + checkNonNull(value); + BigDecimal minValue = new BigDecimal(stringMinValue); + int result = value.compareTo(minValue); + if (inclusive) { + if (result >= 0) { + return true; + } + } else { + if (result > 0) { + return true; + } + } + throw new ValidationException( + String.format("%s is not valid value. Min value '%s'. Inclusive - %s.", value, stringMinValue, inclusive) + ); + } + + public static boolean validateMax(BigDecimal value, String stringMaxValue, boolean inclusive) { + checkNonNull(value); + BigDecimal maxValue = new BigDecimal(stringMaxValue); + int result = value.compareTo(maxValue); + if (inclusive) { + if (result <= 0) { + return true; + } + } else { + if (result < 0) { + return true; + } + } + throw new ValidationException( + String.format("%s is not valid value. Max value '%s'. Inclusive - %s.", value, stringMaxValue, inclusive) + ); + } + + public static void checkNonNull(Object... args) { + try { + for (Object o : args) { + Objects.requireNonNull(o); + } + } catch (Exception e) { + throw new ValidationException(e); + } + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/model/Message.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/model/Message.java new file mode 100644 index 00000000..c8ce86e0 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/model/Message.java @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server.model; + + + +/** + * An message for the user + */ +public class Message { + + private String message; + private String greeting; + + /** + * Default constructor. + */ + public Message() { + // JSON-B / Jackson + } + + /** + * Create Message. + * + * @param message message + * @param greeting greeting + */ + public Message( + String message, + String greeting + ) { + this.message = message; + this.greeting = greeting; + } + + + + /** + * Get message + * @return message + */ + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + /** + * Get greeting + * @return greeting + */ + public String getGreeting() { + return greeting; + } + + public void setGreeting(String greeting) { + this.greeting = greeting; + } + + /** + * Create a string representation of this pojo. + **/ + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Message {\n"); + + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" greeting: ").append(toIndentedString(greeting)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/package-info.java b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/package-info.java new file mode 100644 index 00000000..e9166bc9 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/java/org/openapitools/server/package-info.java @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server; \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/resources/META-INF/openapi.yml b/examples/openapi-tools/quickstart-se/se-server/src/main/resources/META-INF/openapi.yml new file mode 100644 index 00000000..2f31fd46 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/resources/META-INF/openapi.yml @@ -0,0 +1,103 @@ +# +# Copyright (c) 2022, 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. +# +openapi: 3.0.0 +info: + description: This is a sample for Helidon Quickstart project. + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + title: OpenAPI Helidon Quickstart + version: 1.0.0 +servers: +- url: http://localhost:8080 +tags: +- name: message +paths: + /greet: + get: + operationId: getDefaultMessage + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: successful operation + summary: Return a worldly greeting message. + tags: + - message + x-accepts: application/json + /greet/greeting: + put: + operationId: updateGreeting + requestBody: + $ref: '#/components/requestBodies/Message' + responses: + "200": + description: successful operation + "400": + description: No greeting provided + summary: Set the greeting to use in future messages. + tags: + - message + x-content-type: application/json + x-accepts: application/json + /greet/{name}: + get: + operationId: getMessage + parameters: + - description: the name to greet + explode: false + in: path + name: name + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: successful operation + summary: Return a greeting message using the name that was provided. + tags: + - message + x-accepts: application/json +components: + requestBodies: + Message: + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: Message for the user + required: true + schemas: + Message: + description: An message for the user + example: + greeting: greeting + message: message + properties: + message: + format: int64 + type: string + greeting: + format: int64 + type: string + type: object diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/resources/application.yaml b/examples/openapi-tools/quickstart-se/se-server/src/main/resources/application.yaml new file mode 100644 index 00000000..c954b645 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/resources/application.yaml @@ -0,0 +1,18 @@ +# +# Copyright (c) 2022, 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. +# +server: + port: 8080 + host: localhost diff --git a/examples/openapi-tools/quickstart-se/se-server/src/main/resources/logging.properties b/examples/openapi-tools/quickstart-se/se-server/src/main/resources/logging.properties new file mode 100644 index 00000000..d31ec34b --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2022, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/openapi-tools/quickstart-se/se-server/src/test/java/org/openapitools/server/MainTest.java b/examples/openapi-tools/quickstart-se/se-server/src/test/java/org/openapitools/server/MainTest.java new file mode 100644 index 00000000..64f92dd1 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/test/java/org/openapitools/server/MainTest.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2022, 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 org.openapitools.server; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + +@Disabled +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + + @BeforeAll + public static void startTheServer() throws Exception { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() throws Exception { + if (webServer != null) { + webServer.shutdown() + .toCompletableFuture() + .get(10, TimeUnit.SECONDS); + } + } + + @Test + public void test() throws Exception { + } +} \ No newline at end of file diff --git a/examples/openapi-tools/quickstart-se/se-server/src/test/java/org/openapitools/server/model/MessageTest.java b/examples/openapi-tools/quickstart-se/se-server/src/test/java/org/openapitools/server/model/MessageTest.java new file mode 100644 index 00000000..ecfb5364 --- /dev/null +++ b/examples/openapi-tools/quickstart-se/se-server/src/test/java/org/openapitools/server/model/MessageTest.java @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2022, 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. + */ + +/* + * OpenAPI Helidon Quickstart + * This is a sample for Helidon Quickstart project. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.server.model; + +import org.junit.jupiter.api.Test; + + +/** + * Model tests for Message + */ +public class MessageTest { + private final Message model = new Message(); + + /** + * Model tests for Message + */ + @Test + public void testMessage() { + // TODO: test Message + } + + /** + * Test the property 'message' + */ + @Test + public void messageTest() { + // TODO: test message + } + + /** + * Test the property 'greeting' + */ + @Test + public void greetingTest() { + // TODO: test greeting + } + +} diff --git a/examples/openapi-tools/quickstart.yaml b/examples/openapi-tools/quickstart.yaml new file mode 100644 index 00000000..75bdc18f --- /dev/null +++ b/examples/openapi-tools/quickstart.yaml @@ -0,0 +1,96 @@ +# +# Copyright (c) 2022, 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. +# + +openapi: 3.0.0 +servers: + - url: 'http://localhost:8080' +info: + description: >- + This is a sample for Helidon Quickstart project. + version: 1.0.0 + title: OpenAPI Helidon Quickstart + license: + name: Apache-2.0 + url: 'https://www.apache.org/licenses/LICENSE-2.0.html' +tags: + - name: message +paths: + /greet: + get: + tags: + - message + summary: Return a worldly greeting message. + operationId: getDefaultMessage + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + /greet/greeting: + put: + tags: + - message + summary: Set the greeting to use in future messages. + operationId: updateGreeting + responses: + '200': + description: successful operation + '400': + description: No greeting provided + requestBody: + $ref: '#/components/requestBodies/Message' + '/greet/{name}': + get: + tags: + - message + summary: Return a greeting message using the name that was provided. + operationId: getMessage + parameters: + - name: name + in: path + description: the name to greet + required: true + schema: + type: string + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Message' +components: + requestBodies: + Message: + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + description: Message for the user + required: true + schemas: + Message: + description: An message for the user + type: object + properties: + message: + type: string + format: int64 + greeting: + type: string + format: int64 diff --git a/examples/openapi/README.md b/examples/openapi/README.md new file mode 100644 index 00000000..12682caa --- /dev/null +++ b/examples/openapi/README.md @@ -0,0 +1,36 @@ + +# Helidon SE OpenAPI Example + +This example shows a simple greeting application, similar to the one from the +Helidon SE QuickStart, enhanced with OpenAPI support. + +Most of the OpenAPI document in this example comes from a static file packaged +with the application. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-openapi.jar +``` + +Try the endpoints: + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} + +curl -X GET http://localhost:8080/openapi +#[lengthy OpenAPI document] +``` + +The output describes not only then endpoints in `GreetService` as described in +the static file but also an endpoint contributed by the `SimpleAPIModelReader`. diff --git a/examples/openapi/pom.xml b/examples/openapi/pom.xml new file mode 100644 index 00000000..3fae0f48 --- /dev/null +++ b/examples/openapi/pom.xml @@ -0,0 +1,101 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples + helidon-examples-openapi + 1.0.0-SNAPSHOT + Helidon Examples OpenAPI + + + Basic illustration of OpenAPI support in Helidon SE + + + + io.helidon.examples.openapi.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.openapi + helidon-openapi + + + io.helidon.metrics + helidon-metrics + runtime + + + io.helidon.webclient + helidon-webclient + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/openapi/src/main/java/io/helidon/examples/openapi/GreetService.java b/examples/openapi/src/main/java/io/helidon/examples/openapi/GreetService.java new file mode 100644 index 00000000..14365b54 --- /dev/null +++ b/examples/openapi/src/main/java/io/helidon/examples/openapi/GreetService.java @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2019, 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.openapi; + +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.json.JsonReaderFactory; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private String greeting; + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + + private static final JsonReaderFactory JSON_RF = Json.createReaderFactory(Collections.emptyMap()); + + GreetService(Config config) { + this.greeting = config.get("app.greeting").asString().orElse("Ciao"); + } + + /** + * A service registers itself by updating the routine rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + GreetingMessage msg = new GreetingMessage(String.format("%s %s!", greeting, name)); + response.send(msg.forRest()); + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey(GreetingMessage.JSON_LABEL)) { + JsonObject jsonErrorObject = JSON_BF.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting = GreetingMessage.fromRest(jo).getMessage(); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class).thenAccept(jo -> updateGreetingFromJson(jo, response)); + } + +} diff --git a/examples/openapi/src/main/java/io/helidon/examples/openapi/GreetingMessage.java b/examples/openapi/src/main/java/io/helidon/examples/openapi/GreetingMessage.java new file mode 100644 index 00000000..6cf718dd --- /dev/null +++ b/examples/openapi/src/main/java/io/helidon/examples/openapi/GreetingMessage.java @@ -0,0 +1,87 @@ +/* + * Copyright (c) 2019, 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.openapi; + +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.json.JsonObjectBuilder; + +/** + * POJO for the greeting message exchanged between the server and the client. + */ +public class GreetingMessage { + + /** + * Label for tagging a {@code GreetingMessage} instance in JSON. + */ + public static final String JSON_LABEL = "greeting"; + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + + private String message; + + /** + * Create a new greeting with the specified message content. + * + * @param message the message to store in the greeting + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Returns the message value. + * + * @return the message + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message value to be set + */ + public void setMessage(String message) { + this.message = message; + } + + /** + * Converts a JSON object (typically read from the request payload) + * into a {@code GreetingMessage}. + * + * @param jsonObject the {@link JsonObject} to convert. + * @return {@code GreetingMessage} set according to the provided object + */ + public static GreetingMessage fromRest(JsonObject jsonObject) { + return new GreetingMessage(jsonObject.getString(JSON_LABEL)); + } + + /** + * Prepares a {@link JsonObject} corresponding to this instance. + * + * @return {@code JsonObject} representing this {@code GreetingMessage} instance + */ + public JsonObject forRest() { + JsonObjectBuilder builder = JSON_BF.createObjectBuilder(); + return builder.add(JSON_LABEL, message) + .build(); + } +} diff --git a/examples/openapi/src/main/java/io/helidon/examples/openapi/Main.java b/examples/openapi/src/main/java/io/helidon/examples/openapi/Main.java new file mode 100644 index 00000000..ed725998 --- /dev/null +++ b/examples/openapi/src/main/java/io/helidon/examples/openapi/Main.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2019, 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.openapi; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.openapi.OpenAPISupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Simple Hello World rest application. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + // Get webserver config from the "server" section of application.yaml and register JSON support + Single server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build() + .start(); + + server.thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + return server; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + GreetService greetService = new GreetService(config); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + return Routing.builder() + .register(OpenAPISupport.create(config.get(OpenAPISupport.Builder.CONFIG_KEY))) + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register("/greet", greetService) + .build(); + } + +} diff --git a/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/SimpleAPIFilter.java b/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/SimpleAPIFilter.java new file mode 100644 index 00000000..89c1939c --- /dev/null +++ b/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/SimpleAPIFilter.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2019, 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.openapi.internal; + +import java.util.Map; + +import org.eclipse.microprofile.openapi.OASFilter; +import org.eclipse.microprofile.openapi.models.Operation; +import org.eclipse.microprofile.openapi.models.PathItem; + +/** + * Example OpenAPI filter which hides a single endpoint from the OpenAPI document. + */ +public class SimpleAPIFilter implements OASFilter { + + @Override + public PathItem filterPathItem(PathItem pathItem) { + for (Map.Entry methodOp + : pathItem.getOperations().entrySet()) { + if (SimpleAPIModelReader.DOOMED_OPERATION_ID + .equals(methodOp.getValue().getOperationId())) { + return null; + } + } + return OASFilter.super.filterPathItem(pathItem); + } +} diff --git a/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/SimpleAPIModelReader.java b/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/SimpleAPIModelReader.java new file mode 100644 index 00000000..352f4918 --- /dev/null +++ b/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/SimpleAPIModelReader.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2019, 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.openapi.internal; + +import org.eclipse.microprofile.openapi.OASFactory; +import org.eclipse.microprofile.openapi.OASModelReader; +import org.eclipse.microprofile.openapi.models.OpenAPI; +import org.eclipse.microprofile.openapi.models.PathItem; +import org.eclipse.microprofile.openapi.models.Paths; + +/** + * Defines two paths using the OpenAPI model reader mechanism, one that should + * be suppressed by the filter class and one that should appear in the published + * OpenAPI document. + */ +public class SimpleAPIModelReader implements OASModelReader { + + /** + * Path for the example endpoint added by this model reader that should be visible. + */ + public static final String MODEL_READER_PATH = "/test/newpath"; + + /** + * Path for an endpoint that the filter should hide. + */ + public static final String DOOMED_PATH = "/test/doomed"; + + /** + * ID for an endpoint that the filter should hide. + */ + public static final String DOOMED_OPERATION_ID = "doomedPath"; + + /** + * Summary text for the endpoint. + */ + public static final String SUMMARY = "A sample test endpoint from ModelReader"; + + @Override + public OpenAPI buildModel() { + /* + * Add two path items, one of which we expect to be removed by + * the filter and a very simple one that will appear in the + * published OpenAPI document. + */ + PathItem newPathItem = OASFactory.createPathItem() + .GET(OASFactory.createOperation() + .operationId("newPath") + .summary(SUMMARY)); + PathItem doomedPathItem = OASFactory.createPathItem() + .GET(OASFactory.createOperation() + .operationId(DOOMED_OPERATION_ID) + .summary("This should become invisible")); + OpenAPI openAPI = OASFactory.createOpenAPI(); + Paths paths = OASFactory.createPaths() + .addPathItem(MODEL_READER_PATH, newPathItem) + .addPathItem(DOOMED_PATH, doomedPathItem); + openAPI.paths(paths); + + return openAPI; + } +} diff --git a/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/package-info.java b/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/package-info.java new file mode 100644 index 00000000..a8f05c8d --- /dev/null +++ b/examples/openapi/src/main/java/io/helidon/examples/openapi/internal/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Internal classes supporting the Helidon OpenAPI example. + */ +package io.helidon.examples.openapi.internal; diff --git a/examples/openapi/src/main/java/io/helidon/examples/openapi/package-info.java b/examples/openapi/src/main/java/io/helidon/examples/openapi/package-info.java new file mode 100644 index 00000000..fd83d08b --- /dev/null +++ b/examples/openapi/src/main/java/io/helidon/examples/openapi/package-info.java @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2019, 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 application showing support for OpenAPI in Helidon SE + *

+ * Start with {@link io.helidon.examples.openapi.Main} class. + * + * @see io.helidon.examples.openapi.Main + */ +package io.helidon.examples.openapi; diff --git a/examples/openapi/src/main/resources/META-INF/openapi.yml b/examples/openapi/src/main/resources/META-INF/openapi.yml new file mode 100644 index 00000000..fa4911b5 --- /dev/null +++ b/examples/openapi/src/main/resources/META-INF/openapi.yml @@ -0,0 +1,83 @@ +# +# Copyright (c) 2019, 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. +# +--- +openapi: 3.0.0 +info: + title: Helidon SE Quickstart Example + description: A very simple application to reply with friendly greetings + version: 1.0.0 + +servers: + - url: http://localhost:8080 + description: Local test server + +paths: + /greet: + get: + summary: Returns a generic greeting + description: Greets the user generically + responses: + default: + description: Simple JSON containing the greeting + content: + application/json: + schema: + $ref: '#/components/schemas/GreetingMessage' + /greet/greeting: + put: + summary: Set the greeting prefix + description: Permits the client to set the prefix part of the greeting ("Hello") + requestBody: + description: Conveys the new greeting prefix to use in building greetings + content: + application/json: + schema: + $ref: '#/components/schemas/GreetingUpdateMessage' + examples: + greeting: + summary: Example greeting message to update + value: {"greeting": "New greeting message"} + responses: + "200": + description: OK + content: + application/json: {} + /greet/{name}: + get: + summary: Returns a personalized greeting + parameters: + - name: name + in: path + required: true + schema: + type: string + responses: + default: + description: Simple JSON containing the greeting + content: + application/json: + schema: + $ref: '#/components/schemas/GreetingMessage' +components: + schemas: + GreetingMessage: + properties: + message: + type: string + GreetingUpdateMessage: + properties: + greeting: + type: string diff --git a/examples/openapi/src/main/resources/application.yaml b/examples/openapi/src/main/resources/application.yaml new file mode 100644 index 00000000..f1f35cc4 --- /dev/null +++ b/examples/openapi/src/main/resources/application.yaml @@ -0,0 +1,29 @@ +# +# Copyright (c) 2019, 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 + +openapi: + filter: io.helidon.examples.openapi.internal.SimpleAPIFilter + model: + reader: io.helidon.examples.openapi.internal.SimpleAPIModelReader +# The following would change the endpoint path for retrieving the OpenAPI document +# web-context: /myopenapi diff --git a/examples/openapi/src/main/resources/logging.properties b/examples/openapi/src/main/resources/logging.properties new file mode 100644 index 00000000..8491bdce --- /dev/null +++ b/examples/openapi/src/main/resources/logging.properties @@ -0,0 +1,35 @@ +# +# Copyright (c) 2018, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO +io.helidon.openapi.OpenAPISupport.level=FINER diff --git a/examples/openapi/src/test/java/io/helidon/examples/openapi/MainTest.java b/examples/openapi/src/test/java/io/helidon/examples/openapi/MainTest.java new file mode 100644 index 00000000..5bcbc196 --- /dev/null +++ b/examples/openapi/src/test/java/io/helidon/examples/openapi/MainTest.java @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2018, 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.openapi; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.json.JsonPointer; +import javax.json.JsonString; + +import io.helidon.common.http.MediaType; +import io.helidon.examples.openapi.internal.SimpleAPIModelReader; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + + private static final JsonBuilderFactory JSON_BF = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + + static { + TEST_JSON_OBJECT = JSON_BF.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + @BeforeAll + public static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + public void testHelloWorld() { + webClient.get() + .path("/greet") + .request(JsonObject.class) + .thenAccept(jsonObject -> assertThat(jsonObject.getString("greeting"), is("Hello World!"))) + .await(); + + webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .thenAccept(jsonObject -> assertThat(jsonObject.getString("greeting"), is("Hello Joe!"))) + .await(); + + webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .thenAccept(response -> assertThat(response.status().code(), is(204))) + .thenCompose(nothing -> webClient.get() + .path("/greet/Joe") + .request(JsonObject.class)) + .thenAccept(jsonObject -> assertThat(jsonObject.getString("greeting"), is("Hola Joe!"))) + .await(); + + webClient.get() + .path("/health") + .request() + .thenAccept(response -> { + assertThat(response.status().code(), is(200)); + response.close(); + }) + .await(); + + webClient.get() + .path("/metrics") + .request() + .thenAccept(response -> { + assertThat(response.status().code(), is(200)); + response.close(); + }) + .await(); + } + + @Test + public void testOpenAPI() { + /* + * If you change the OpenAPI endpoint path in application.yaml, then + * change the following path also. + */ + JsonObject jsonObject = webClient.get() + .accept(MediaType.APPLICATION_JSON) + .path("/openapi") + .request(JsonObject.class) + .await(); + JsonObject paths = jsonObject.getJsonObject("paths"); + + JsonPointer jp = Json.createPointer("/" + escape("/greet/greeting") + "/put/summary"); + JsonString js = (JsonString) jp.getValue(paths); + assertThat("/greet/greeting.put.summary not as expected", js.getString(), is("Set the greeting prefix")); + + jp = Json.createPointer("/" + escape(SimpleAPIModelReader.MODEL_READER_PATH) + + "/get/summary"); + js = (JsonString) jp.getValue(paths); + assertThat("summary added by model reader does not match", js.getString(), + is(SimpleAPIModelReader.SUMMARY)); + + jp = Json.createPointer("/" + escape(SimpleAPIModelReader.DOOMED_PATH)); + assertThat("/test/doomed should not appear but does", jp.containsValue(paths), is(false)); + } + + private static String escape(String path) { + return path.replace("/", "~1"); + } + +} diff --git a/examples/pom.xml b/examples/pom.xml index 3150a03b..fa89b284 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -1,7 +1,7 @@ + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples + helidon-quickstart-mp + 1.0.0-SNAPSHOT + Helidon Quickstart MP Example + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/quickstarts/helidon-quickstart-mp/settings.gradle b/examples/quickstarts/helidon-quickstart-mp/settings.gradle new file mode 100644 index 00000000..82acd1f1 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/settings.gradle @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2018, 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. + */ + +rootProject.name = 'helidon-quickstart-mp' diff --git a/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetResource.java b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetResource.java new file mode 100644 index 00000000..7d29a083 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetResource.java @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2018, 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.quickstart.mp; + +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import org.eclipse.microprofile.openapi.annotations.enums.SchemaType; +import org.eclipse.microprofile.openapi.annotations.media.Content; +import org.eclipse.microprofile.openapi.annotations.media.Schema; +import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponses; + +/** + * A simple JAX-RS resource to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object. + */ +@Path("/greet") +public class GreetResource { + + /** + * The greeting message provider. + */ + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a worldly greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link GreetingMessage} + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message JSON containing the new greeting + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + @RequestBody(name = "greeting", + required = true, + content = @Content(mediaType = "application/json", + schema = @Schema(type = SchemaType.OBJECT, requiredProperties = { "greeting" }))) + @APIResponses({ + @APIResponse(name = "normal", responseCode = "204", description = "Greeting updated"), + @APIResponse(name = "missing 'greeting'", responseCode = "400", + description = "JSON did not contain setting for 'greeting'")}) + public Response updateGreeting(GreetingMessage message) { + + if (message.getMessage() == null) { + GreetingMessage entity = new GreetingMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); + } + greetingProvider.setMessage(message.getMessage()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new GreetingMessage(msg); + } +} diff --git a/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingMessage.java b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingMessage.java new file mode 100644 index 00000000..4bfaf92a --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023, 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.quickstart.mp; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingProvider.java b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingProvider.java new file mode 100644 index 00000000..241a0b55 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingProvider.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2018, 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.quickstart.mp; + +import java.util.concurrent.atomic.AtomicReference; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +public class GreetingProvider { + private final AtomicReference message = new AtomicReference<>(); + + /** + * Create a new greeting provider, reading the message from configuration. + * + * @param message greeting to use + */ + @Inject + public GreetingProvider(@ConfigProperty(name = "app.greeting") String message) { + this.message.set(message); + } + + String getMessage() { + return message.get(); + } + + void setMessage(String message) { + this.message.set(message); + } +} diff --git a/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/package-info.java b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/package-info.java new file mode 100644 index 00000000..7949c2c1 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/package-info.java @@ -0,0 +1,26 @@ +/* + * Copyright (c) 2018, 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. + */ + +/** + * Quickstart MicroProfile example. + */ +@OpenAPIDefinition(info = @Info(title = "Helidon MP QuickStart Example", + version = "1.0.0", + description = "A very simple application to reply with friendly greetings") +) +package io.helidon.examples.quickstart.mp; +import org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition; +import org.eclipse.microprofile.openapi.annotations.info.Info; diff --git a/examples/quickstarts/helidon-quickstart-mp/src/main/resources/META-INF/beans.xml b/examples/quickstarts/helidon-quickstart-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..965a8a02 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/quickstarts/helidon-quickstart-mp/src/main/resources/META-INF/microprofile-config.properties b/examples/quickstarts/helidon-quickstart-mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..0828e0e8 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2018, 2020 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. +# + +# Application properties. This is the default greeting +app.greeting=Hello + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +# Enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=true diff --git a/examples/quickstarts/helidon-quickstart-mp/src/main/resources/logging.properties b/examples/quickstarts/helidon-quickstart-mp/src/main/resources/logging.properties new file mode 100644 index 00000000..5a28a898 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/main/resources/logging.properties @@ -0,0 +1,40 @@ +# +# Copyright (c) 2018, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.microprofile.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO +#org.glassfish.jersey.level=INFO +#org.jboss.weld=INFO diff --git a/examples/quickstarts/helidon-quickstart-mp/src/test/java/io/helidon/examples/quickstart/mp/MainTest.java b/examples/quickstarts/helidon-quickstart-mp/src/test/java/io/helidon/examples/quickstart/mp/MainTest.java new file mode 100644 index 00000000..e48ec9bf --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/test/java/io/helidon/examples/quickstart/mp/MainTest.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2018, 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.quickstart.mp; + +import javax.inject.Inject; +import javax.ws.rs.client.Entity; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +@HelidonTest +class MainTest { + private final WebTarget target; + + @Inject + MainTest(WebTarget target) { + this.target = target; + } + + @Test + void testHelloWorld() { + + GreetingMessage message = target.path("/greet") + .request() + .get(GreetingMessage.class); + assertThat("default message", message.getMessage(), + is("Hello World!")); + + message = target.path("/greet/Joe") + .request() + .get(GreetingMessage.class); + assertThat("hello Joe message", message.getMessage(), + is("Hello Joe!")); + + try (Response r = target.path("/greet/greeting") + .request() + .put(Entity.entity("{\"message\" : \"Hola\"}", MediaType.APPLICATION_JSON))) { + assertThat("PUT status code", r.getStatus(), is(204)); + } + + message = target.path("/greet/Jose") + .request() + .get(GreetingMessage.class); + assertThat("hola Jose message", message.getMessage(), + is("Hola Jose!")); + + try (Response r = target.path("/metrics") + .request() + .get()) { + assertThat("GET metrics status code", r.getStatus(), is(200)); + } + + try (Response r = target.path("/health") + .request() + .get()) { + assertThat("GET health status code", r.getStatus(), is(200)); + } + } +} diff --git a/examples/quickstarts/helidon-quickstart-mp/src/test/resources/META-INF/microprofile-config.properties b/examples/quickstarts/helidon-quickstart-mp/src/test/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..0d037f28 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-mp/src/test/resources/META-INF/microprofile-config.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved. +# +# 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. +# + + +# Override configuration to use a random port for the unit tests +config_ordinal=1000 +# Microprofile server properties +server.port=-1 +server.host=0.0.0.0 diff --git a/examples/quickstarts/helidon-quickstart-se/.dockerignore b/examples/quickstarts/helidon-quickstart-se/.dockerignore new file mode 100644 index 00000000..c8b241f2 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/.dockerignore @@ -0,0 +1 @@ +target/* \ No newline at end of file diff --git a/examples/quickstarts/helidon-quickstart-se/.gitignore b/examples/quickstarts/helidon-quickstart-se/.gitignore new file mode 100644 index 00000000..241e8042 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/.gitignore @@ -0,0 +1,16 @@ +hs_err_pid* +target/ +.DS_Store +.idea/ +*.iws +*.ipr +*.iml +atlassian-ide-plugin.xml +nbactions.xml +nb-configuration.xml +.settings +.settings/ +.project +.classpath +*.swp +*~ \ No newline at end of file diff --git a/examples/quickstarts/helidon-quickstart-se/Dockerfile b/examples/quickstarts/helidon-quickstart-se/Dockerfile new file mode 100644 index 00000000..ed8be3b4 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/Dockerfile @@ -0,0 +1,45 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-quickstart-se.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-quickstart-se.jar"] + +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-quickstart-se/Dockerfile.jlink b/examples/quickstarts/helidon-quickstart-se/Dockerfile.jlink new file mode 100644 index 00000000..98773c0f --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/Dockerfile.jlink @@ -0,0 +1,40 @@ +# +# Copyright (c) 2020, 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. +# + +# 1st stage, build the app +FROM maven:3.6.3-jdk-11-slim as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build to create the custom Java Runtime Image +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pjlink-image -DskipTests +RUN echo "done!" + +# 2nd stage, build the final image with the JRI built in the 1st stage + +FROM debian:stretch-slim +WORKDIR /helidon +COPY --from=build /helidon/target/helidon-quickstart-se-jri ./ +ENTRYPOINT ["/bin/bash", "/helidon/bin/start"] +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-quickstart-se/Dockerfile.native b/examples/quickstarts/helidon-quickstart-se/Dockerfile.native new file mode 100644 index 00000000..9b25aa42 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/Dockerfile.native @@ -0,0 +1,44 @@ +# +# Copyright (c) 2019, 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. +# + +# 1st stage, build the app +FROM helidon/jdk11-graalvm-maven:21.3.0 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Pnative-image -Dnative.image.skip -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pnative-image -Dnative.image.buildStatic -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM scratch +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-quickstart-se . + +ENTRYPOINT ["./helidon-quickstart-se"] + +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-quickstart-se/README.md b/examples/quickstarts/helidon-quickstart-se/README.md new file mode 100644 index 00000000..6bfaeba6 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/README.md @@ -0,0 +1,164 @@ +# Helidon Quickstart SE Example + +This project implements a simple Hello World REST service using Helidon SE. + +## Build and run + +```shell +mvn package +java -jar target/helidon-quickstart-se.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} +``` + +## Try health and metrics + +```shell +curl -s -X GET http://localhost:8080/health +#{"outcome":"UP",... +. . . + +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics +# TYPE base:gc_g1_young_generation_count gauge +#. . . + +# JSON Format +curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics +#{"base":... +#. . . + +``` + +## Build the Docker Image + +```shell +docker build -t helidon-quickstart-se . +``` + +## Start the application with Docker + +```shell +docker run --rm -p 8080:8080 helidon-quickstart-se:latest +``` + +Exercise the application as described above + +## Deploy the application to Kubernetes + +```shell +kubectl cluster-info # Verify which cluster +kubectl get pods # Verify connectivity to cluster +kubectl create -f app.yaml # Deply application +kubectl get service helidon-quickstart-se # Get service info +``` + +## Build a native image with GraalVM + +GraalVM allows you to compile your programs ahead-of-time into a native + executable. See https://www.graalvm.org/docs/reference-manual/aot-compilation/ + for more information. + +You can build a native executable in 2 different ways: +* With a local installation of GraalVM +* Using Docker + +### Local build + +Download Graal VM at https://www.graalvm.org/downloads. We recommend +version `20.1.0` or later. + +```shell +# Setup the environment +export GRAALVM_HOME=/path +# build the native executable +mvn package -Pnative-image +``` + +You can also put the Graal VM `bin` directory in your PATH, or pass + `-DgraalVMHome=/path` to the Maven command. + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-native-image + for more information. + +Start the application: + +```shell +./target/helidon-quickstart-se +``` + +### Multi-stage Docker build + +Build the "native" Docker Image + +```shell +docker build -t helidon-quickstart-se-native -f Dockerfile.native . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-quickstart-se-native:latest +``` + +## Build a Java Runtime Image using jlink + +You can build a custom Java Runtime Image (JRI) containing the application jars and the JDK modules +on which they depend. This image also: + +* Enables Class Data Sharing by default to reduce startup time. +* Contains a customized `start` script to simplify CDS usage and support debug and test modes. + +You can build a custom JRI in two different ways: +* Local +* Using Docker + + +### Local build + +```shell +# build the JRI +mvn package -Pjlink-image +``` + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-jlink-image + for more information. + +Start the application: + +```shell +./target/helidon-quickstart-se-jri/bin/start +``` + +### Multi-stage Docker build + +Build the JRI as a Docker Image + +```shell +docker build -t helidon-quickstart-se-jri -f Dockerfile.jlink . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-quickstart-se-jri:latest +``` + +See the start script help: + +```shell +docker run --rm helidon-quickstart-se-jri:latest --help +``` diff --git a/examples/quickstarts/helidon-quickstart-se/app.yaml b/examples/quickstarts/helidon-quickstart-se/app.yaml new file mode 100644 index 00000000..8a314633 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/app.yaml @@ -0,0 +1,57 @@ +# +# Copyright (c) 2018, 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: helidon-quickstart-se + labels: + app: helidon-quickstart-se +spec: + type: NodePort + selector: + app: helidon-quickstart-se + ports: + - port: 8080 + targetPort: 8080 + name: http +--- + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-quickstart-se + labels: + app: helidon-quickstart-se + version: v1 +spec: + replicas: 1 + selector: + matchLabels: + app: helidon-quickstart-se + version: v1 + template: + metadata: + labels: + app: helidon-quickstart-se + version: v1 + spec: + containers: + - name: helidon-quickstart-se + image: helidon-quickstart-se + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 diff --git a/examples/quickstarts/helidon-quickstart-se/build.gradle b/examples/quickstarts/helidon-quickstart-se/build.gradle new file mode 100644 index 00000000..dbb75bc1 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/build.gradle @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2018, 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. + */ + +plugins { + id 'java' + id 'application' +} + +group = 'io.helidon.examples' +version = '1.0-SNAPSHOT' + +description = """helidon-quickstart-se""" + +sourceCompatibility = 11 +targetCompatibility = 11 +tasks.withType(JavaCompile) { + options.encoding = 'UTF-8' +} + +ext { + helidonversion = '2.6.8-SNAPSHOT' + mainClass='io.helidon.examples.quickstart.se.Main' +} + +test { + useJUnitPlatform() +} + +repositories { + mavenCentral() + mavenLocal() +} + +dependencies { + // import Helidon BOM + implementation enforcedPlatform("io.helidon:helidon-dependencies:${project.helidonversion}") + implementation 'io.helidon.webserver:helidon-webserver' + implementation 'io.helidon.media:helidon-media-jsonp' + implementation 'io.helidon.config:helidon-config-yaml' + implementation 'io.helidon.health:helidon-health' + implementation 'io.helidon.health:helidon-health-checks' + implementation 'io.helidon.metrics:helidon-metrics' + + testImplementation 'org.junit.jupiter:junit-jupiter-api' + testImplementation 'io.helidon.webclient:helidon-webclient' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine' +} + +// define a custom task to copy all dependencies in the runtime classpath +// into build/libs/libs +// uses built-in Copy +task copyLibs(type: Copy) { + from configurations.runtimeClasspath + into 'build/libs/libs' +} + +// add it as a dependency of built-in task 'assemble' +copyLibs.dependsOn jar +assemble.dependsOn copyLibs + +// default jar configuration +// set the main classpath +// add each jar under build/libs/libs into the classpath +jar { + archiveFileName = "${project.name}.jar" + manifest { + attributes ('Main-Class': "${project.mainClass}", + 'Class-Path': configurations.runtimeClasspath.files.collect { "libs/$it.name" }.join(' ') + ) + } +} + +application { + mainClass = "${project.mainClass}" +} + diff --git a/examples/quickstarts/helidon-quickstart-se/pom.xml b/examples/quickstarts/helidon-quickstart-se/pom.xml new file mode 100644 index 00000000..fe0908ef --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/pom.xml @@ -0,0 +1,99 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples + helidon-quickstart-se + 1.0.0-SNAPSHOT + Helidon Quickstart SE Example + + + io.helidon.examples.quickstart.se.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/quickstarts/helidon-quickstart-se/settings.gradle b/examples/quickstarts/helidon-quickstart-se/settings.gradle new file mode 100644 index 00000000..ef7a8abd --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/settings.gradle @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2018, 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. + */ + +rootProject.name = 'helidon-quickstart-se' diff --git a/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/GreetService.java b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/GreetService.java new file mode 100644 index 00000000..d7aa3631 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/GreetService.java @@ -0,0 +1,156 @@ +/* + * Copyright (c) 2018, 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.quickstart.se; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + GreetService(Config config) { + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException){ + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } + +} diff --git a/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java new file mode 100644 index 00000000..50c0d85a --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2018, 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.quickstart.se; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + GreetService greetService = new GreetService(config); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + return Routing.builder() + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register("/greet", greetService) + .build(); + } +} diff --git a/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/package-info.java b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/package-info.java new file mode 100644 index 00000000..d282464f --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/package-info.java @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * Quickstart demo application + *

+ * Start with {@link io.helidon.examples.quickstart.se.Main} class. + * + * @see io.helidon.examples.quickstart.se.Main + */ +package io.helidon.examples.quickstart.se; diff --git a/examples/quickstarts/helidon-quickstart-se/src/main/resources/application.yaml b/examples/quickstarts/helidon-quickstart-se/src/main/resources/application.yaml new file mode 100644 index 00000000..97ed299b --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/src/main/resources/application.yaml @@ -0,0 +1,26 @@ +# +# Copyright (c) 2018, 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 +# experimental: +# http2: +# enable: true +# max-content-length: 16384 \ No newline at end of file diff --git a/examples/quickstarts/helidon-quickstart-se/src/main/resources/logging.properties b/examples/quickstarts/helidon-quickstart-se/src/main/resources/logging.properties new file mode 100644 index 00000000..5993ad58 --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2018, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/quickstarts/helidon-quickstart-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java b/examples/quickstarts/helidon-quickstart-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java new file mode 100644 index 00000000..d630286c --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2018, 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.quickstart.se; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + + static { + TEST_JSON_OBJECT = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + @BeforeAll + static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + void testHelloWorld() { + JsonObject jsonObject; + WebClientResponse response; + + jsonObject = webClient.get() + .path("/greet") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello World!")); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello Joe!")); + + response = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + assertThat(response.status().code(), is(204)); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hola Joe!")); + + response = webClient.get() + .path("/health") + .request() + .await(); + assertThat(response.status().code(), is(200)); + + response = webClient.get() + .path("/metrics") + .request() + .await(); + assertThat(response.status().code(), is(200)); + } + +} diff --git a/examples/quickstarts/helidon-quickstart-se/src/test/resources/config-profile.yaml b/examples/quickstarts/helidon-quickstart-se/src/test/resources/config-profile.yaml new file mode 100644 index 00000000..6290f00d --- /dev/null +++ b/examples/quickstarts/helidon-quickstart-se/src/test/resources/config-profile.yaml @@ -0,0 +1,23 @@ +# +# Copyright (c) 2022 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. +# + +sources: + - type: "inlined" + properties: + server.port: 0 + - type: "classpath" + properties: + resource: "application.yaml" diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/.dockerignore b/examples/quickstarts/helidon-standalone-quickstart-mp/.dockerignore new file mode 100644 index 00000000..c8b241f2 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/.dockerignore @@ -0,0 +1 @@ +target/* \ No newline at end of file diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/.gitignore b/examples/quickstarts/helidon-standalone-quickstart-mp/.gitignore new file mode 100644 index 00000000..594f3abf --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/.gitignore @@ -0,0 +1,16 @@ +hs_err_pid* +target/ +.DS_Store +.idea/ +*.iws +*.ipr +*.iml +atlassian-ide-plugin.xml +nbactions.xml +nb-configuration.xml +.settings +.settings/ +.project +.classpath +*.swp +*~ diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile b/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile new file mode 100644 index 00000000..432e31b8 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile @@ -0,0 +1,44 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-standalone-quickstart-mp.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-standalone-quickstart-mp.jar"] + +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile.jlink b/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile.jlink new file mode 100644 index 00000000..e343f99e --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile.jlink @@ -0,0 +1,40 @@ +# +# Copyright (c) 2020, 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. +# + +# 1st stage, build the app +FROM maven:3.6.3-jdk-11-slim as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build to create the custom Java Runtime Image +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pjlink-image -DskipTests +RUN echo "done!" + +# 2nd stage, build the final image with the JRI built in the 1st stage + +FROM debian:stretch-slim +WORKDIR /helidon +COPY --from=build /helidon/target/helidon-quickstart-mp-jri ./ +ENTRYPOINT ["/bin/bash", "/helidon/bin/start"] +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile.native b/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile.native new file mode 100644 index 00000000..37a465d6 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/Dockerfile.native @@ -0,0 +1,44 @@ +# +# Copyright (c) 2020, 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. +# + +# 1st stage, build the app +FROM helidon/jdk11-graalvm-maven:21.3.0 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Pnative-image -Dnative.image.skip -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pnative-image -Dnative.image.buildStatic -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM scratch +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-standalone-quickstart-mp . + +ENTRYPOINT ["./helidon-standalone-quickstart-mp"] + +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/README.md b/examples/quickstarts/helidon-standalone-quickstart-mp/README.md new file mode 100644 index 00000000..1b13e7d3 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/README.md @@ -0,0 +1,165 @@ +# Helidon Standalone Quickstart MP Example + +This example implements a simple Hello World REST service using MicroProfile + with a standalone Maven pom. + +## Build and run + +```shell +mvn package +java -jar target/helidon-standalone-quickstart-mp.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} +``` + +## Try health and metrics + +```shell +curl -s -X GET http://localhost:8080/health +#{"outcome":"UP",... +#. . . + +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics +# TYPE base:gc_g1_young_generation_count gauge +#. . . + +# JSON Format +curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics +#{"base":... +#. . . + +``` + +## Build the Docker Image + +``` +docker build -t helidon-standalone-quickstart-mp . +``` + +## Start the application with Docker + +``` +docker run --rm -p 8080:8080 helidon-standalone-quickstart-mp:latest +``` + +Exercise the application as described above + +## Deploy the application to Kubernetes + +``` +kubectl cluster-info # Verify which cluster +kubectl get pods # Verify connectivity to cluster +kubectl create -f app.yaml # Deploy application +kubectl get service helidon-standalone-quickstart-mp # Verify deployed service +``` + +## Build a native image with GraalVM + +GraalVM allows you to compile your programs ahead-of-time into a native + executable. See https://www.graalvm.org/docs/reference-manual/aot-compilation/ + for more information. + +You can build a native executable in 2 different ways: +* With a local installation of GraalVM +* Using Docker + +### Local build + +Download Graal VM at https://www.graalvm.org/downloads. We recommend +version `20.1.0` or later. + +``` +# Setup the environment +export GRAALVM_HOME=/path +# build the native executable +mvn package -Pnative-image +``` + +You can also put the Graal VM `bin` directory in your PATH, or pass + `-DgraalVMHome=/path` to the Maven command. + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-native-image + for more information. + +Start the application: + +``` +./target/helidon-quickstart-mp +``` + +### Multi-stage Docker build + +Build the "native" Docker Image + +``` +docker build -t helidon-quickstart-mp-native -f Dockerfile.native . +``` + +Start the application: + +``` +docker run --rm -p 8080:8080 helidon-quickstart-mp-native:latest +``` + +## Build a Java Runtime Image using jlink + +You can build a custom Java Runtime Image (JRI) containing the application jars and the JDK modules +on which they depend. This image also: + +* Enables Class Data Sharing by default to reduce startup time. +* Contains a customized `start` script to simplify CDS usage and support debug and test modes. + +You can build a custom JRI in two different ways: +* Local +* Using Docker + + +### Local build + +``` +# build the JRI +mvn package -Pjlink-image +``` + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-jlink-image + for more information. + +Start the application: + +``` +./target/helidon-quickstart-se-jri/bin/start +``` + +### Multi-stage Docker build + +Build the JRI as a Docker Image + +``` +docker build -t helidon-quickstart-mp-jri -f Dockerfile.jlink . +``` + +Start the application: + +``` +docker run --rm -p 8080:8080 helidon-quickstart-mp-jri:latest +``` + +See the start script help: + +``` +docker run --rm helidon-quickstart-mp-jri:latest --help +``` diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/app.yaml b/examples/quickstarts/helidon-standalone-quickstart-mp/app.yaml new file mode 100644 index 00000000..9475ca4f --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/app.yaml @@ -0,0 +1,57 @@ +# +# Copyright (c) 2018, 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: helidon-quickstart-mp + labels: + app: helidon-quickstart-mp +spec: + type: NodePort + selector: + app: helidon-quickstart-mp + ports: + - port: 8080 + targetPort: 8080 + name: http +--- + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-quickstart-mp + labels: + app: helidon-quickstart-mp + version: v1 +spec: + replicas: 1 + selector: + matchLabels: + app: helidon-quickstart-mp + version: v1 + template: + metadata: + labels: + app: helidon-quickstart-mp + version: v1 + spec: + containers: + - name: helidon-quickstart-mp + image: helidon-quickstart-mp + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/pom.xml b/examples/quickstarts/helidon-standalone-quickstart-mp/pom.xml new file mode 100644 index 00000000..332d0d46 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/pom.xml @@ -0,0 +1,256 @@ + + + + 4.0.0 + io.helidon.examples.quickstarts + helidon-standalone-quickstart-mp + 1.0.0-SNAPSHOT + Helidon Standalone Quickstart MP Example + + + 2.6.8-SNAPSHOT + io.helidon.microprofile.cdi.Main + + 11 + ${maven.compiler.source} + true + UTF-8 + UTF-8 + + + 3.8.1 + 3.6.0 + 2.7.5.1 + 1.6.0 + 3.0.0-M5 + 2.3.7 + 2.3.7 + 1.0.6 + 3.0.2 + 1.5.0.Final + 0.5.1 + 2.7 + 3.0.0-M5 + + + + + + io.helidon + helidon-dependencies + ${helidon.version} + pom + import + + + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + + + ${project.artifactId} + + + + org.apache.maven.plugins + maven-compiler-plugin + ${version.plugin.compiler} + + + org.apache.maven.plugins + maven-surefire-plugin + ${version.plugin.surefire} + + false + + ${project.build.outputDirectory}/logging.properties + + + + + org.apache.maven.plugins + maven-failsafe-plugin + ${version.plugin.failsafe} + + false + true + + + + org.apache.maven.plugins + maven-dependency-plugin + ${version.plugin.dependency} + + + org.apache.maven.plugins + maven-resources-plugin + ${version.plugin.resources} + + + org.apache.maven.plugins + maven-jar-plugin + ${version.plugin.jar} + + + + true + libs + ${mainClass} + false + + + + + + org.jboss.jandex + jandex-maven-plugin + ${version.plugin.jandex} + + + org.codehaus.mojo + exec-maven-plugin + ${version.plugin.exec} + + ${mainClass} + + + + io.helidon.build-tools + helidon-maven-plugin + ${version.plugin.helidon} + + + io.helidon.build-tools + helidon-cli-maven-plugin + ${version.plugin.helidon-cli} + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + prepare-package + + copy-dependencies + + + ${project.build.directory}/libs + false + false + true + true + runtime + + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + jandex + + process-classes + + + + + + + + + native-image + + + + io.helidon.build-tools + helidon-maven-plugin + + + native-image + + native-image + + + + + + + + + io.helidon.integrations.graal + helidon-mp-graal-native-image-extension + + + + + jlink-image + + + + io.helidon.build-tools + helidon-maven-plugin + + + + jlink-image + + + + + + + + + diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetResource.java b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetResource.java new file mode 100644 index 00000000..613af9cd --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetResource.java @@ -0,0 +1,128 @@ +/* + * Copyright (c) 2018, 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.quickstart.mp; + +import javax.enterprise.context.RequestScoped; +import javax.inject.Inject; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import org.eclipse.microprofile.openapi.annotations.enums.SchemaType; +import org.eclipse.microprofile.openapi.annotations.media.Content; +import org.eclipse.microprofile.openapi.annotations.media.Schema; +import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; +import org.eclipse.microprofile.openapi.annotations.responses.APIResponses; + +/** + * A simple JAX-RS resource to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object. + */ +@Path("/greet") +@RequestScoped +public class GreetResource { + + /** + * The greeting message provider. + */ + private final GreetingProvider greetingProvider; + + /** + * Using constructor injection to get a configuration property. + * By default this gets the value from META-INF/microprofile-config + * + * @param greetingConfig the configured greeting message + */ + @Inject + public GreetResource(GreetingProvider greetingConfig) { + this.greetingProvider = greetingConfig; + } + + /** + * Return a worldly greeting message. + * + * @return {@link GreetingMessage} + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getDefaultMessage() { + return createResponse("World"); + } + + /** + * Return a greeting message using the name that was provided. + * + * @param name the name to greet + * @return {@link GreetingMessage} + */ + @Path("/{name}") + @GET + @Produces(MediaType.APPLICATION_JSON) + public GreetingMessage getMessage(@PathParam("name") String name) { + return createResponse(name); + } + + /** + * Set the greeting to use in future messages. + * + * @param message JSON containing the new greeting + * @return {@link Response} + */ + @Path("/greeting") + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + @RequestBody(name = "greeting", + required = true, + content = @Content(mediaType = "application/json", + schema = @Schema(type = SchemaType.OBJECT, requiredProperties = { "greeting" }))) + @APIResponses({ + @APIResponse(name = "normal", responseCode = "204", description = "Greeting updated"), + @APIResponse(name = "missing 'greeting'", responseCode = "400", + description = "JSON did not contain setting for 'greeting'")}) + public Response updateGreeting(GreetingMessage message) { + + if (message.getMessage() == null) { + GreetingMessage entity = new GreetingMessage("No greeting provided"); + return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); + } + greetingProvider.setMessage(message.getMessage()); + return Response.status(Response.Status.NO_CONTENT).build(); + } + + private GreetingMessage createResponse(String who) { + String msg = String.format("%s %s!", greetingProvider.getMessage(), who); + + return new GreetingMessage(msg); + } +} diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingMessage.java b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingMessage.java new file mode 100644 index 00000000..4bfaf92a --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingMessage.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2023, 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.quickstart.mp; + +/** + * POJO defining the greeting message content. + */ +@SuppressWarnings("unused") +public class GreetingMessage { + private String message; + + /** + * Create a new GreetingMessage instance. + */ + public GreetingMessage() { + } + + /** + * Create a new GreetingMessage instance. + * + * @param message message + */ + public GreetingMessage(String message) { + this.message = message; + } + + /** + * Gets the message value. + * + * @return message value + */ + public String getMessage() { + return message; + } + + /** + * Sets the message value. + * + * @param message message value to set + */ + public void setMessage(String message) { + this.message = message; + } +} diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingProvider.java b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingProvider.java new file mode 100644 index 00000000..a9d110a2 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/GreetingProvider.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2019, 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.quickstart.mp; + +import java.util.concurrent.atomic.AtomicReference; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +/** + * Provider for greeting message. + */ +@ApplicationScoped +public class GreetingProvider { + private final AtomicReference message = new AtomicReference<>(); + + /** + * Create a new greeting provider, reading the message from configuration. + * + * @param message greeting to use + */ + @Inject + public GreetingProvider(@ConfigProperty(name = "app.greeting") String message) { + this.message.set(message); + } + + String getMessage() { + return message.get(); + } + + void setMessage(String message) { + this.message.set(message); + } +} diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/package-info.java b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/package-info.java new file mode 100644 index 00000000..71c5673b --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/java/io/helidon/examples/quickstart/mp/package-info.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Quickstart MicroProfile example. + */ +@OpenAPIDefinition(info = @Info(title = "Helidon MP QuickStart Example", + version = "1.0.0", + description = "A very simple application to reply with friendly greetings") +) +package io.helidon.examples.quickstart.mp; +import org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition; +import org.eclipse.microprofile.openapi.annotations.info.Info; + diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/META-INF/beans.xml b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..801c3923 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/META-INF/microprofile-config.properties b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/META-INF/microprofile-config.properties new file mode 100644 index 00000000..c2246f26 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/META-INF/microprofile-config.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2019, 2020 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. +# + +# Application properties. This is the default greeting +app.greeting=Hello + +# Microprofile server properties +server.port=8080 +server.host=0.0.0.0 + +# Enable the optional MicroProfile Metrics REST.request metrics +metrics.rest-request.enabled=true diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/logging.properties b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/logging.properties new file mode 100644 index 00000000..445ae560 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/main/resources/logging.properties @@ -0,0 +1,41 @@ +# +# Copyright (c) 2018, 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.common.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 + +# +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.microprofile.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO +#org.glassfish.jersey.level=INFO +#org.jboss.weld=INFO diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/src/test/java/io/helidon/examples/quickstart/mp/MainTest.java b/examples/quickstarts/helidon-standalone-quickstart-mp/src/test/java/io/helidon/examples/quickstart/mp/MainTest.java new file mode 100644 index 00000000..e48ec9bf --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-mp/src/test/java/io/helidon/examples/quickstart/mp/MainTest.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2018, 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.quickstart.mp; + +import javax.inject.Inject; +import javax.ws.rs.client.Entity; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +@HelidonTest +class MainTest { + private final WebTarget target; + + @Inject + MainTest(WebTarget target) { + this.target = target; + } + + @Test + void testHelloWorld() { + + GreetingMessage message = target.path("/greet") + .request() + .get(GreetingMessage.class); + assertThat("default message", message.getMessage(), + is("Hello World!")); + + message = target.path("/greet/Joe") + .request() + .get(GreetingMessage.class); + assertThat("hello Joe message", message.getMessage(), + is("Hello Joe!")); + + try (Response r = target.path("/greet/greeting") + .request() + .put(Entity.entity("{\"message\" : \"Hola\"}", MediaType.APPLICATION_JSON))) { + assertThat("PUT status code", r.getStatus(), is(204)); + } + + message = target.path("/greet/Jose") + .request() + .get(GreetingMessage.class); + assertThat("hola Jose message", message.getMessage(), + is("Hola Jose!")); + + try (Response r = target.path("/metrics") + .request() + .get()) { + assertThat("GET metrics status code", r.getStatus(), is(200)); + } + + try (Response r = target.path("/health") + .request() + .get()) { + assertThat("GET health status code", r.getStatus(), is(200)); + } + } +} diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/.dockerignore b/examples/quickstarts/helidon-standalone-quickstart-se/.dockerignore new file mode 100644 index 00000000..c8b241f2 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/.dockerignore @@ -0,0 +1 @@ +target/* \ No newline at end of file diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/.gitignore b/examples/quickstarts/helidon-standalone-quickstart-se/.gitignore new file mode 100644 index 00000000..241e8042 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/.gitignore @@ -0,0 +1,16 @@ +hs_err_pid* +target/ +.DS_Store +.idea/ +*.iws +*.ipr +*.iml +atlassian-ide-plugin.xml +nbactions.xml +nb-configuration.xml +.settings +.settings/ +.project +.classpath +*.swp +*~ \ No newline at end of file diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile b/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile new file mode 100644 index 00000000..74f5119e --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile @@ -0,0 +1,45 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-standalone-quickstart-se.jar ./ +COPY --from=build /helidon/target/libs ./libs + +CMD ["java", "-jar", "helidon-standalone-quickstart-se.jar"] + +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile.jlink b/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile.jlink new file mode 100644 index 00000000..98773c0f --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile.jlink @@ -0,0 +1,40 @@ +# +# Copyright (c) 2020, 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. +# + +# 1st stage, build the app +FROM maven:3.6.3-jdk-11-slim as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build to create the custom Java Runtime Image +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pjlink-image -DskipTests +RUN echo "done!" + +# 2nd stage, build the final image with the JRI built in the 1st stage + +FROM debian:stretch-slim +WORKDIR /helidon +COPY --from=build /helidon/target/helidon-quickstart-se-jri ./ +ENTRYPOINT ["/bin/bash", "/helidon/bin/start"] +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile.native b/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile.native new file mode 100644 index 00000000..a2c35dcf --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/Dockerfile.native @@ -0,0 +1,44 @@ +# +# Copyright (c) 2019, 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. +# + +# 1st stage, build the app +FROM helidon/jdk11-graalvm-maven:21.3.0 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Pnative-image -Dnative.image.skip -Dmaven.test.skip -Declipselink.weave.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Pnative-image -Dnative.image.buildStatic -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM scratch +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-standalone-quickstart-se . + +ENTRYPOINT ["./helidon-standalone-quickstart-se"] + +EXPOSE 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/README.md b/examples/quickstarts/helidon-standalone-quickstart-se/README.md new file mode 100644 index 00000000..edfed64e --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/README.md @@ -0,0 +1,165 @@ +# Helidon Standalone Quickstart SE Example + +This project implements a simple Hello World REST service using Helidon SE with + a standalone Maven pom. + +## Build and run + +```shell +mvn package +java -jar target/helidon-standalone-quickstart-se.jar +``` + +## Exercise the application + +```shell +curl -X GET http://localhost:8080/greet +#{"message":"Hello World!"} + +curl -X GET http://localhost:8080/greet/Joe +#{"message":"Hello Joe!"} + +curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting + +curl -X GET http://localhost:8080/greet/Jose +#{"message":"Hola Jose!"} +``` + +## Try health and metrics + +```shell +curl -s -X GET http://localhost:8080/health +#{"outcome":"UP",... +#. . . + +# Prometheus Format +curl -s -X GET http://localhost:8080/metrics +# TYPE base:gc_g1_young_generation_count gauge +#. . . + +# JSON Format +curl -H 'Accept: application/json' -X GET http://localhost:8080/metrics +#{"base":... +#. . . + +``` + +## Build the Docker Image + +```shell +docker build -t helidon-standalone-quickstart-se . +``` + +## Start the application with Docker + +```shell +docker run --rm -p 8080:8080 helidon-standalone-quickstart-se:latest +``` + +Exercise the application as described above + +## Deploy the application to Kubernetes + +```shell +kubectl cluster-info # Verify which cluster +kubectl get pods # Verify connectivity to cluster +kubectl create -f app.yaml # Deply application +kubectl get service helidon-standalone-quickstart-se # Get service info +``` + +## Build a native image with GraalVM + +GraalVM allows you to compile your programs ahead-of-time into a native + executable. See https://www.graalvm.org/docs/reference-manual/aot-compilation/ + for more information. + +You can build a native executable in 2 different ways: +* With a local installation of GraalVM +* Using Docker + +### Local build + +Download Graal VM at https://www.graalvm.org/downloads. We recommend +version `20.1.0` or later. + +```shell +# Setup the environment +export GRAALVM_HOME=/path +# build the native executable +mvn package -Pnative-image +``` + +You can also put the Graal VM `bin` directory in your PATH, or pass + `-DgraalVMHome=/path` to the Maven command. + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin + for more information. + +Start the application: + +```shell +./target/helidon-standalone-quickstart-se +``` + +### Multi-stage Docker build + +Build the "native" Docker Image + +```shell +docker build -t helidon-standalone-quickstart-se-native -f Dockerfile.native . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-standalone-quickstart-se-native:latest +``` + +## Build a Java Runtime Image using jlink + +You can build a custom Java Runtime Image (JRI) containing the application jars and the JDK modules +on which they depend. This image also: + +* Enables Class Data Sharing by default to reduce startup time. +* Contains a customized `start` script to simplify CDS usage and support debug and test modes. + +You can build a custom JRI in two different ways: +* Local +* Using Docker + + +### Local build + +```shell +# build the JRI +mvn package -Pjlink-image +``` + +See https://github.com/oracle/helidon-build-tools/tree/master/helidon-maven-plugin#goal-jlink-image + for more information. + +Start the application: + +```shell +./target/helidon-quickstart-se-jri/bin/start +``` + +### Multi-stage Docker build + +Build the JRI as a Docker Image + +```shell +docker build -t helidon-quickstart-se-jri -f Dockerfile.jlink . +``` + +Start the application: + +```shell +docker run --rm -p 8080:8080 helidon-quickstart-se-jri:latest +``` + +See the start script help: + +```shell +docker run --rm helidon-quickstart-se-jri:latest --help +``` diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/app.yaml b/examples/quickstarts/helidon-standalone-quickstart-se/app.yaml new file mode 100644 index 00000000..de62a277 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/app.yaml @@ -0,0 +1,57 @@ +# +# Copyright (c) 2018, 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. +# + +kind: Service +apiVersion: v1 +metadata: + name: helidon-quickstart-se + labels: + app: helidon-quickstart-se +spec: + type: NodePort + selector: + app: helidon-quickstart-se + ports: + - port: 8080 + targetPort: 8080 + name: http +--- + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-quickstart-se + labels: + app: helidon-quickstart-se + version: v1 +spec: + replicas: 1 + selector: + matchLabels: + app: helidon-quickstart-se + version: v1 + template: + metadata: + labels: + app: helidon-quickstart-se + version: v1 + spec: + containers: + - name: helidon-quickstart-se + image: helidon-quickstart-se + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/pom.xml b/examples/quickstarts/helidon-standalone-quickstart-se/pom.xml new file mode 100644 index 00000000..ee107012 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/pom.xml @@ -0,0 +1,250 @@ + + + + 4.0.0 + io.helidon.examples.quickstarts + helidon-standalone-quickstart-se + 1.0.0-SNAPSHOT + Helidon Standalone Quickstart SE Example + + + 2.6.8-SNAPSHOT + io.helidon.examples.quickstart.se.Main + + 11 + ${maven.compiler.source} + true + UTF-8 + UTF-8 + + + 3.8.1 + 3.6.0 + 1.6.0 + 3.0.0-M5 + 2.3.7 + 2.3.7 + 3.0.2 + 1.5.0.Final + 0.5.1 + 2.7 + 3.0.0-M5 + + + + + + io.helidon + helidon-dependencies + ${helidon.version} + pom + import + + + + + + + io.helidon.bundles + helidon-bundles-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + + + ${project.artifactId} + + + + org.apache.maven.plugins + maven-compiler-plugin + ${version.plugin.compiler} + + + org.apache.maven.plugins + maven-surefire-plugin + ${version.plugin.surefire} + + false + + ${project.build.outputDirectory}/logging.properties + + + + + org.apache.maven.plugins + maven-failsafe-plugin + ${version.plugin.failsafe} + + false + true + + + + org.apache.maven.plugins + maven-dependency-plugin + ${version.plugin.dependency} + + + org.apache.maven.plugins + maven-resources-plugin + ${version.plugin.resources} + + + org.apache.maven.plugins + maven-jar-plugin + ${version.plugin.jar} + + + + true + libs + ${mainClass} + false + + + + + + org.codehaus.mojo + exec-maven-plugin + ${version.plugin.exec} + + ${mainClass} + + + + io.helidon.build-tools + helidon-maven-plugin + ${version.plugin.helidon} + + + io.helidon.build-tools + helidon-cli-maven-plugin + ${version.plugin.helidon-cli} + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + prepare-package + + copy-dependencies + + + ${project.build.directory}/libs + false + false + true + true + runtime + + + + + + + + + + native-image + + + + io.helidon.build-tools + helidon-maven-plugin + + + + native-image + + + + + + + + + io.helidon.integrations.graal + helidon-graal-native-image-extension + + + + + jlink-image + + + + io.helidon.build-tools + helidon-maven-plugin + + + + jlink-image + + + + + + + + + diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/GreetService.java b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/GreetService.java new file mode 100644 index 00000000..d7aa3631 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/GreetService.java @@ -0,0 +1,156 @@ +/* + * Copyright (c) 2018, 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.quickstart.se; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + GreetService(Config config) { + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException){ + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } + +} diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java new file mode 100644 index 00000000..50c0d85a --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2018, 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.quickstart.se; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + startServer(); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer() { + + // load logging configuration + LogConfig.configureRuntime(); + + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + return webserver; + } + + /** + * Creates new {@link Routing}. + * + * @return routing configured with JSON support, a health check, and a service + * @param config configuration of this server + */ + private static Routing createRouting(Config config) { + + MetricsSupport metrics = MetricsSupport.create(); + GreetService greetService = new GreetService(config); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + return Routing.builder() + .register(health) // Health at "/health" + .register(metrics) // Metrics at "/metrics" + .register("/greet", greetService) + .build(); + } +} diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/package-info.java b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/package-info.java new file mode 100644 index 00000000..01961ba0 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/package-info.java @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * Quickstart demo application + *

+ * Start with {@link io.helidon.examples.quickstart.se.Main} class. + * + * @see io.helidon.examples.quickstart.se.Main + */ +package io.helidon.examples.quickstart.se; diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/META-INF/native-image/helidon-example-reflection-config.json b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/META-INF/native-image/helidon-example-reflection-config.json new file mode 100644 index 00000000..fe51488c --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/META-INF/native-image/helidon-example-reflection-config.json @@ -0,0 +1 @@ +[] diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/META-INF/native-image/native-image.properties b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/META-INF/native-image/native-image.properties new file mode 100644 index 00000000..cfcdd398 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/META-INF/native-image/native-image.properties @@ -0,0 +1,17 @@ +# +# Copyright (c) 2019, 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. +# + +Args=-H:ReflectionConfigurationResources=${.}/helidon-example-reflection-config.json diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/application.yaml b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/application.yaml new file mode 100644 index 00000000..98642dda --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/application.yaml @@ -0,0 +1,26 @@ +# +# Copyright (c) 2019, 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. +# + +app: + greeting: "Hello" + +server: + port: 8080 + host: 0.0.0.0 +# experimental: +# http2: +# enable: true +# max-content-length: 16384 \ No newline at end of file diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/logging.properties b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/logging.properties new file mode 100644 index 00000000..5993ad58 --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# Copyright (c) 2018, 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java b/examples/quickstarts/helidon-standalone-quickstart-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java new file mode 100644 index 00000000..d630286c --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/test/java/io/helidon/examples/quickstart/se/MainTest.java @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2018, 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.quickstart.se; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + + static { + TEST_JSON_OBJECT = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + @BeforeAll + static void startTheServer() { + webServer = Main.startServer().await(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + static void stopServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + void testHelloWorld() { + JsonObject jsonObject; + WebClientResponse response; + + jsonObject = webClient.get() + .path("/greet") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello World!")); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello Joe!")); + + response = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + assertThat(response.status().code(), is(204)); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hola Joe!")); + + response = webClient.get() + .path("/health") + .request() + .await(); + assertThat(response.status().code(), is(200)); + + response = webClient.get() + .path("/metrics") + .request() + .await(); + assertThat(response.status().code(), is(200)); + } + +} diff --git a/examples/quickstarts/helidon-standalone-quickstart-se/src/test/resources/config-profile.yaml b/examples/quickstarts/helidon-standalone-quickstart-se/src/test/resources/config-profile.yaml new file mode 100644 index 00000000..6290f00d --- /dev/null +++ b/examples/quickstarts/helidon-standalone-quickstart-se/src/test/resources/config-profile.yaml @@ -0,0 +1,23 @@ +# +# Copyright (c) 2022 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. +# + +sources: + - type: "inlined" + properties: + server.port: 0 + - type: "classpath" + properties: + resource: "application.yaml" diff --git a/examples/quickstarts/pom.xml b/examples/quickstarts/pom.xml new file mode 100644 index 00000000..c25af539 --- /dev/null +++ b/examples/quickstarts/pom.xml @@ -0,0 +1,39 @@ + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.quickstarts + examples-quickstarts-project + Helidon Quickstart Examples + pom + + + helidon-quickstart-se + helidon-quickstart-mp + helidon-standalone-quickstart-mp + helidon-standalone-quickstart-se + + diff --git a/examples/security/README.md b/examples/security/README.md new file mode 100644 index 00000000..e6b14226 --- /dev/null +++ b/examples/security/README.md @@ -0,0 +1,4 @@ + +# Helidon SE Security Examples + + diff --git a/examples/security/attribute-based-access-control/README.md b/examples/security/attribute-based-access-control/README.md new file mode 100644 index 00000000..e1bf22b8 --- /dev/null +++ b/examples/security/attribute-based-access-control/README.md @@ -0,0 +1,10 @@ +# Helidon Security ABAC Example + +JAX-RS (Jersey) example for attribute based access control. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-abac.jar +``` diff --git a/examples/security/attribute-based-access-control/pom.xml b/examples/security/attribute-based-access-control/pom.xml new file mode 100644 index 00000000..1962b266 --- /dev/null +++ b/examples/security/attribute-based-access-control/pom.xml @@ -0,0 +1,91 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-abac + 1.0.0-SNAPSHOT + Helidon Security Examples ABAC + + + Example of attribute based access control. + + + + io.helidon.security.examples.abac.AbacJerseyMain + + + + + io.helidon.microprofile.bundles + helidon-microprofile + + + io.helidon.security.abac + helidon-security-abac-policy-el + + + org.glassfish + jakarta.el + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacApplication.java b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacApplication.java new file mode 100644 index 00000000..c6d5e43e --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacApplication.java @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2019, 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.security.examples.abac; + +import java.util.Set; + +import javax.enterprise.context.ApplicationScoped; +import javax.ws.rs.ApplicationPath; +import javax.ws.rs.core.Application; + +/** + * Application class of this MP application. + */ +@ApplicationScoped +@ApplicationPath("/rest") +public class AbacApplication extends Application { + @Override + public Set> getClasses() { + return Set.of(AbacResource.class, AbacExplicitResource.class); + } +} diff --git a/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacExplicitResource.java b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacExplicitResource.java new file mode 100644 index 00000000..4d0feb16 --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacExplicitResource.java @@ -0,0 +1,139 @@ +/* + * Copyright (c) 2019, 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.security.examples.abac; + +import java.time.DayOfWeek; + +import javax.json.JsonString; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.security.AuthorizationResponse; +import io.helidon.security.SecurityContext; +import io.helidon.security.SubjectType; +import io.helidon.security.abac.policy.PolicyValidator; +import io.helidon.security.abac.scope.ScopeValidator; +import io.helidon.security.abac.time.TimeValidator; +import io.helidon.security.annotations.Authenticated; +import io.helidon.security.annotations.Authorized; + +/** + * Explicit authorization resource - authorization must be called by programmer. + */ +@Path("/explicit") +@TimeValidator.TimeOfDay(from = "08:15:00", to = "12:00:00") +@TimeValidator.TimeOfDay(from = "12:30:00", to = "17:30:00") +@TimeValidator.DaysOfWeek({DayOfWeek.MONDAY, DayOfWeek.TUESDAY, DayOfWeek.WEDNESDAY, DayOfWeek.THURSDAY, DayOfWeek.FRIDAY}) +@ScopeValidator.Scope("calendar_read") +@ScopeValidator.Scope("calendar_edit") +@PolicyValidator.PolicyStatement("${env.time.year >= 2017 && object.owner == subject.principal.id}") +@Authenticated +public class AbacExplicitResource { + /** + * A resource method to demonstrate explicit authorization. + * + * @param context security context (injected) + * @return "fine, sir" string; or a description of authorization failure + */ + @GET + @Authorized(explicit = true) + @AtnProvider.Authentication(value = "user", + roles = {"user_role"}, + scopes = {"calendar_read", "calendar_edit"}) + @AtnProvider.Authentication(value = "service", + type = SubjectType.SERVICE, + roles = {"service_role"}, + scopes = {"calendar_read", "calendar_edit"}) + public Response process(@Context SecurityContext context) { + SomeResource res = new SomeResource("user"); + AuthorizationResponse atzResponse = context.authorize(res); + + if (atzResponse.isPermitted()) { + //do the update + return Response.ok().entity("fine, sir").build(); + } else { + return Response.status(Response.Status.FORBIDDEN) + .entity(atzResponse.description().orElse("Access not granted")) + .build(); + } + } + + /** + * A resource method to demonstrate explicit authorization - this should fail, as we do not call authorization. + * + * @param context security context (injected) + * @param object a JSON string + * @return "fine, sir" string; or a description of authorization failure + */ + @POST + @Path("/deny") + @Authorized(explicit = true) + @AtnProvider.Authentication(value = "user", + roles = {"user_role"}, + scopes = {"calendar_read", "calendar_edit"}) + @AtnProvider.Authentication(value = "service", + type = SubjectType.SERVICE, + roles = {"service_role"}, + scopes = {"calendar_read", "calendar_edit"}) + @Consumes(MediaType.APPLICATION_JSON) + public Response fail(@Context SecurityContext context, JsonString object) { + return Response.ok("This should not work").build(); + } + + /** + * Example resource. + */ + public static class SomeResource { + private String id; + private String owner; + private String message; + + private SomeResource(String owner) { + this.id = "id"; + this.owner = owner; + this.message = "Unit test"; + } + + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getOwner() { + return owner; + } + + public void setOwner(String owner) { + this.owner = owner; + } + + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + } +} diff --git a/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacJerseyMain.java b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacJerseyMain.java new file mode 100644 index 00000000..b80d7bb2 --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacJerseyMain.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2018, 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.security.examples.abac; + +import io.helidon.config.Config; +import io.helidon.microprofile.server.Server; + +/** + * Jersey example for Attribute based access control. + */ +public final class AbacJerseyMain { + private static Server server; + + private AbacJerseyMain() { + } + + /** + * Main method of example. No arguments required, no configuration required. + * + * @param args empty is OK + * @throws Throwable if server fails to start + */ + public static void main(String[] args) throws Throwable { + server = startIt(); + } + + static Server startIt() { + Config config = Config.create(); + + Server server = Server.builder() + .config(config) + .port(8080) + .build() + .start(); + + System.out.printf("Started server on localhost:%d%n", server.port()); + System.out.println(); + System.out.println("***********************"); + System.out.println("** Endpoints: **"); + System.out.println("***********************"); + System.out.println("Using declarative authorization (ABAC):"); + System.out.printf(" http://localhost:%1$d/rest/attributes%n", server.port()); + System.out.println("Using explicit authorization (ABAC):"); + System.out.printf(" http://localhost:%1$d/rest/explicit%n", server.port()); + + return server; + } +} diff --git a/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacResource.java b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacResource.java new file mode 100644 index 00000000..66ee0bfe --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AbacResource.java @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2019, 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.security.examples.abac; + +import java.time.DayOfWeek; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; + +import io.helidon.security.SubjectType; +import io.helidon.security.abac.policy.PolicyValidator; +import io.helidon.security.abac.role.RoleValidator; +import io.helidon.security.abac.scope.ScopeValidator; +import io.helidon.security.abac.time.TimeValidator; +import io.helidon.security.annotations.Authenticated; + +/** + * Annotation only resource. + */ +@Path("/attributes") +@TimeValidator.TimeOfDay(from = "08:15:00", to = "12:00:00") +@TimeValidator.TimeOfDay(from = "12:30:00", to = "17:30:00") +@TimeValidator.DaysOfWeek({DayOfWeek.TUESDAY, DayOfWeek.WEDNESDAY, DayOfWeek.THURSDAY, DayOfWeek.FRIDAY}) +@ScopeValidator.Scope("calendar_read") +@ScopeValidator.Scope("calendar_edit") +@RoleValidator.Roles("user_role") +@RoleValidator.Roles(value = "service_role", subjectType = SubjectType.SERVICE) +@PolicyValidator.PolicyStatement("${env.time.year >= 2017}") +@Authenticated +public class AbacResource { + /** + * A resource method to demonstrate if access was successful or not. + * + * @return "hello" + */ + @GET + @AtnProvider.Authentication(value = "user", + roles = {"user_role"}, + scopes = {"calendar_read", "calendar_edit"}) + @AtnProvider.Authentication(value = "service", + type = SubjectType.SERVICE, + roles = {"service_role"}, + scopes = {"calendar_read", "calendar_edit"}) + public String process() { + return "hello"; + } + + /** + * A resource method to demonstrate if access was successful or not. + * + * @return "hello" + */ + @GET + @Path("/deny") + @PolicyValidator.PolicyStatement("${env.time.year < 2017}") + @AtnProvider.Authentication(value = "user", scopes = {"calendar_read"}) + @AtnProvider.Authentication(value = "service", + type = SubjectType.SERVICE, + roles = {"service_role"}, + scopes = {"calendar_read", "calendar_edit"}) + public String deny() { + return "hello"; + } +} diff --git a/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AtnProvider.java b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AtnProvider.java new file mode 100644 index 00000000..238aa2b2 --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/AtnProvider.java @@ -0,0 +1,151 @@ +/* + * Copyright (c) 2018, 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.security.examples.abac; + +import java.lang.annotation.Annotation; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Inherited; +import java.lang.annotation.Repeatable; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.util.Arrays; +import java.util.Collection; +import java.util.LinkedList; +import java.util.List; +import java.util.ListIterator; +import java.util.Set; + +import io.helidon.security.AuthenticationResponse; +import io.helidon.security.EndpointConfig; +import io.helidon.security.Grant; +import io.helidon.security.Principal; +import io.helidon.security.ProviderRequest; +import io.helidon.security.Role; +import io.helidon.security.SecurityLevel; +import io.helidon.security.Subject; +import io.helidon.security.SubjectType; +import io.helidon.security.spi.AuthenticationProvider; +import io.helidon.security.spi.SynchronousProvider; + +/** + * Example authentication provider that reads annotation to create a subject. + */ +public class AtnProvider extends SynchronousProvider implements AuthenticationProvider { + @Override + protected AuthenticationResponse syncAuthenticate(ProviderRequest providerRequest) { + List securityLevels = providerRequest.endpointConfig().securityLevels(); + ListIterator listIterator = securityLevels.listIterator(securityLevels.size()); + Subject user = null; + Subject service = null; + while (listIterator.hasPrevious()) { + SecurityLevel securityLevel = listIterator.previous(); + List authenticationAnnots = securityLevel + .filterAnnotations(Authentications.class, EndpointConfig.AnnotationScope.METHOD); + + List authentications = new LinkedList<>(); + authenticationAnnots.forEach(atn -> authentications.addAll(Arrays.asList(atn.value()))); + + + if (!authentications.isEmpty()) { + for (Authentication authentication : authentications) { + if (authentication.type() == SubjectType.USER) { + user = buildSubject(authentication); + } else { + service = buildSubject(authentication); + } + } + break; + } + } + return AuthenticationResponse.success(user, service); + } + + private Subject buildSubject(Authentication authentication) { + Subject.Builder subjectBuilder = Subject.builder(); + + subjectBuilder.principal(Principal.create(authentication.value())); + for (String role : authentication.roles()) { + subjectBuilder.addGrant(Role.create(role)); + } + for (String scope : authentication.scopes()) { + subjectBuilder.addGrant(Grant.builder() + .name(scope) + .type("scope") + .build()); + } + + return subjectBuilder.build(); + } + + @Override + public Collection> supportedAnnotations() { + return Set.of(Authentication.class); + } + + /** + * Authentication annotation. + */ + @Retention(RetentionPolicy.RUNTIME) + @Target({ElementType.METHOD}) + @Documented + @Inherited + @Repeatable(Authentications.class) + public @interface Authentication { + /** + * Name of the principal. + * + * @return principal name + */ + String value(); + + /** + * Type of the subject, defaults to user. + * + * @return type + */ + SubjectType type() default SubjectType.USER; + + /** + * Granted roles. + * @return array of roles + */ + String[] roles() default ""; + + /** + * Granted scopes. + * @return array of scopes + */ + String[] scopes() default ""; + } + + /** + * Repeatable annotation for {@link Authentication}. + */ + @Retention(RetentionPolicy.RUNTIME) + @Target({ElementType.METHOD}) + @Documented + @Inherited + public @interface Authentications { + /** + * Repeating annotation. + * @return annotations + */ + Authentication[] value(); + } +} diff --git a/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/package-info.java b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/package-info.java new file mode 100644 index 00000000..edcfdc41 --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/java/io/helidon/security/examples/abac/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 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 of Attribute based access control (ABAC). + */ +package io.helidon.security.examples.abac; diff --git a/examples/security/attribute-based-access-control/src/main/resources/META-INF/beans.xml b/examples/security/attribute-based-access-control/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..cf2d796b --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/resources/META-INF/beans.xml @@ -0,0 +1,24 @@ + + + + + diff --git a/examples/security/attribute-based-access-control/src/main/resources/application.yaml b/examples/security/attribute-based-access-control/src/main/resources/application.yaml new file mode 100644 index 00000000..93967275 --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/resources/application.yaml @@ -0,0 +1,88 @@ +# +# Copyright (c) 2017, 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. +# + +# +# It is possible to provide default config values, here. +# + +server: + port: 8380 + +security: + providers: + - abac: + # prepares environment + # executes attribute validations + # validates that attributes were processed + # grants/denies access to resource + # + #### + # Combinations: + # # Will fail if any attribute is not validated and if any has failed validation + # fail-on-unvalidated: true + # fail-if-none-validated: true + # + # # Will fail if there is one or more attributes present and NONE of them is validated or if any has failed validation + # # Will NOT fail if there is at least one validated attribute and any number of not validated attributes (and NONE failed) + # fail-on-unvalidated: false + # fail-if-none-validated: true + # + # # Will fail if there is any attribute that failed validation + # # Will NOT fail if there are no failed validation or if there are NONE validated + # fail-on-unvalidated: false + # fail-if-none-validated: false + #### + # fail if an attribute was not validated (e.g. we do not know, whether it is valid or not) + # defaults to true + fail-on-unvalidated: true + # fail if none of the attributes were validated + # defaults to true + fail-if-none-validated: true +# policy-validator: +# validators: +# - class: "io.helidon.security.abac.policy.DefaultPolicyValidator" +# my-custom-policy-engine: +# some-key: "some value" +# another-key: "another value" + - atn: + class: "io.helidon.security.examples.abac.AtnProvider" + web-server: + paths: + - path: "/query" + audit: true + - path: "/noRoles" + methods: ["get"] + authenticate: true + - path: "/user[/{*}]" + methods: ["get"] + # implies authentication and authorization + abac: + scopes: ["calendar_read", "calendar_edit"] + time: + time-of-day: + - from: "08:15:00" + to: "12:00:00" + - from: "12:30" + to: "17:30" + days-of-week: ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY"] + policy: + #statement: "hasScopes('calendar_read','calendar_edit') AND timeOfDayBetween('8:15', '17:30')" + #ref: "service/policy_id" + statement: "object.owner == subject.principal.id" + resource: "com.oracle.ResourceProvider" + + + diff --git a/examples/security/attribute-based-access-control/src/main/resources/logging.properties b/examples/security/attribute-based-access-control/src/main/resources/logging.properties new file mode 100644 index 00000000..2d0291f2 --- /dev/null +++ b/examples/security/attribute-based-access-control/src/main/resources/logging.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2018, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +.level=INFO +AUDIT.level=FINEST diff --git a/examples/security/basic-auth-with-static-content/README.md b/examples/security/basic-auth-with-static-content/README.md new file mode 100644 index 00000000..fcc3952c --- /dev/null +++ b/examples/security/basic-auth-with-static-content/README.md @@ -0,0 +1,33 @@ +# Web Server Integration and Basic Authentication + +This example demonstrates integration of Web Server +based application with Security component and Basic authentication (from HttpAuthProvider), including +protection of a static resource. + +## Contents + +There are two examples with exactly the same behavior: +1. BasicExampleMain - shows how to programmatically secure application +2. BasicExampleConfigMain - shows how to secure application with configuration + 1. see src/main/resources/application.yaml for configuration + +## Build and run + +```shell +mvn package +java -jar target//helidon-examples-security-webserver-basic-uath.jar +``` + +Try the application: + +The application starts on a random port, the following assumes it is `56551` + +```shell +export PORT=37667 +curl http://localhost:56551/public +curl -u "jill:changeit" http://localhost:${PORT}/noRoles +curl -u "john:changeit" http://localhost:${PORT}/user +curl -u "jack:changeit" http://localhost:${PORT}/admin +curl -v -u "john:changeit" http://localhost:${PORT}/deny +curl -u "jack:changeit" http://localhost:${PORT}/noAuthn +``` diff --git a/examples/security/basic-auth-with-static-content/pom.xml b/examples/security/basic-auth-with-static-content/pom.xml new file mode 100644 index 00000000..49b3b630 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/pom.xml @@ -0,0 +1,109 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-webserver-basic-uath + 1.0.0-SNAPSHOT + Helidon Security Examples HTTP Basic Authentication with Static Content + + + This example demonstrates Integration of RX Web Server based application with Security component, HTTP Basic + Authentication, and static content support + + + + io.helidon.security.examples.webserver.basic.BasicExampleConfigMain + + + + + io.helidon.security.integration + helidon-security-integration-webserver + + + io.helidon.config + helidon-config-encryption + + + io.helidon.security.providers + helidon-security-providers-http-auth + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + io.helidon.webclient + helidon-webclient + test + + + io.helidon.webclient + helidon-webclient-security + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-core + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleBuilderMain.java b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleBuilderMain.java new file mode 100644 index 00000000..7aead3fe --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleBuilderMain.java @@ -0,0 +1,143 @@ +/* + * Copyright (c) 2020, 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.security.examples.webserver.basic; + +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.LogConfig; +import io.helidon.common.http.MediaType; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.security.providers.httpauth.SecureUserStore; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +/** + * Example using {@link io.helidon.common.Builder} approach instead of configuration based approach. + */ +public final class BasicExampleBuilderMain { + // simple approach to user storage - for real world, use data store... + private static final Map USERS = new HashMap<>(); + + static { + USERS.put("jack", new MyUser("jack", "password".toCharArray(), Set.of("user", "admin"))); + USERS.put("jill", new MyUser("jill", "password".toCharArray(), Set.of("user"))); + USERS.put("john", new MyUser("john", "password".toCharArray(), Set.of())); + } + + private BasicExampleBuilderMain() { + } + + /** + * Entry point, starts the server. + * + * @param args not used + */ + public static void main(String[] args) { + BasicExampleUtil.startAndPrintEndpoints(BasicExampleBuilderMain::startServer); + } + + static WebServer startServer() { + LogConfig.initClass(); + + Routing routing = Routing.builder() + // must be configured first, to protect endpoints + .register(buildWebSecurity().securityDefaults(WebSecurity.authenticate())) + .any("/static[/{*}]", WebSecurity.rolesAllowed("user")) + .register("/static", StaticContentSupport.create("/WEB")) + .get("/noRoles", WebSecurity.enforce()) + .get("/user[/{*}]", WebSecurity.rolesAllowed("user")) + .get("/admin", WebSecurity.rolesAllowed("admin")) + // audit is not enabled for GET methods by default + .get("/deny", WebSecurity.rolesAllowed("deny").audit()) + // roles allowed imply authn and authz + .any("/noAuthn", WebSecurity.rolesAllowed("admin") + .authenticationOptional() + .audit()) + .get("/{*}", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Hello, you are: \n" + securityContext + .map(ctx -> ctx.user().orElse(SecurityContext.ANONYMOUS).toString()) + .orElse("Security context is null")); + }) + .build(); + + return WebServer.builder() + .routing(routing) + // uncomment to use an explicit port + //.port(8080) + .build() + .start() + .await(10, TimeUnit.SECONDS); + + } + + private static WebSecurity buildWebSecurity() { + Security security = Security.builder() + .addAuthenticationProvider( + HttpBasicAuthProvider.builder() + .realm("helidon") + .userStore(buildUserStore()), + "http-basic-auth") + .build(); + return WebSecurity.create(security); + } + + private static SecureUserStore buildUserStore() { + return login -> Optional.ofNullable(USERS.get(login)); + } + + private static class MyUser implements SecureUserStore.User { + private final String login; + private final char[] password; + private final Set roles; + + private MyUser(String login, char[] password, Set roles) { + this.login = login; + this.password = password; + this.roles = roles; + } + + private char[] password() { + return password; + } + + @Override + public boolean isPasswordValid(char[] password) { + return Arrays.equals(password(), password); + } + + @Override + public Set roles() { + return roles; + } + + @Override + public String login() { + return login; + } + } +} diff --git a/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleConfigMain.java b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleConfigMain.java new file mode 100644 index 00000000..e0d85499 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleConfigMain.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2020, 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.security.examples.webserver.basic; + +import java.util.Optional; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.LogConfig; +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.security.SecurityContext; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +/** + * Example using configuration based approach. + */ +public final class BasicExampleConfigMain { + private BasicExampleConfigMain() { + } + + /** + * Entry point, starts the server. + * @param args not used + */ + public static void main(String[] args) { + BasicExampleUtil.startAndPrintEndpoints(BasicExampleConfigMain::startServer); + } + + static WebServer startServer() { + LogConfig.initClass(); + + Config config = Config.create(); + + Routing routing = Routing.builder() + // must be configured first, to protect endpoints + .register(WebSecurity.create(config.get("security"))) + .register("/static", StaticContentSupport.create("/WEB")) + .get("/{*}", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Hello, you are: \n" + securityContext + .map(ctx -> ctx.user().orElse(SecurityContext.ANONYMOUS).toString()) + .orElse("Security context is null")); + }) + .build(); + + return WebServer.builder() + .config(config.get("server")) + .routing(routing) + .build() + .start() + .await(10, TimeUnit.SECONDS); + + } +} diff --git a/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleUtil.java b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleUtil.java new file mode 100644 index 00000000..66603828 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/BasicExampleUtil.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2020, 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.security.examples.webserver.basic; + +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; + +import io.helidon.webserver.WebServer; + +final class BasicExampleUtil { + private BasicExampleUtil() { + } + + static void startAndPrintEndpoints(Supplier startMethod) { + long t = System.nanoTime(); + + WebServer webServer = startMethod.get(); + + long time = System.nanoTime() - t; + System.out.printf("Server started in %d ms ms%n", TimeUnit.MILLISECONDS.convert(time, TimeUnit.NANOSECONDS)); + System.out.printf("Started server on localhost:%d%n", webServer.port()); + System.out.println(); + System.out.println("Users:"); + System.out.println("Jack/password in roles: user, admin"); + System.out.println("Jill/password in roles: user"); + System.out.println("John/password in no roles"); + System.out.println(); + System.out.println("***********************"); + System.out.println("** Endpoints: **"); + System.out.println("***********************"); + System.out.println("No authentication:"); + System.out.printf(" http://localhost:%1$d/public%n", webServer.port()); + System.out.println("No roles required, authenticated:"); + System.out.printf(" http://localhost:%1$d/noRoles%n", webServer.port()); + System.out.println("User role required:"); + System.out.printf(" http://localhost:%1$d/user%n", webServer.port()); + System.out.println("Admin role required:"); + System.out.printf(" http://localhost:%1$d/admin%n", webServer.port()); + System.out.println("Always forbidden (uses role nobody is in), audited:"); + System.out.printf(" http://localhost:%1$d/deny%n", webServer.port()); + System.out.println( + "Admin role required, authenticated, authentication optional, audited (always forbidden - challenge is not " + + "returned as authentication is optional):"); + System.out.printf(" http://localhost:%1$d/noAuthn%n", webServer.port()); + System.out.println("Static content, requires user role:"); + System.out.printf(" http://localhost:%1$d/static/index.html%n", webServer.port()); + System.out.println(); + } +} diff --git a/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/package-info.java b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/package-info.java new file mode 100644 index 00000000..2daa6b75 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/main/java/io/helidon/security/examples/webserver/basic/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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 of basic authentication used with static content. + */ +package io.helidon.security.examples.webserver.basic; diff --git a/examples/security/basic-auth-with-static-content/src/main/resources/WEB/index.html b/examples/security/basic-auth-with-static-content/src/main/resources/WEB/index.html new file mode 100644 index 00000000..fe9a6928 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/main/resources/WEB/index.html @@ -0,0 +1,43 @@ + + + + + +Hello, this is a static resource loaded from classpath. +

+The following endpoints are available on this server: +

+ +The following users are configured: +
    +
  • jack/password in user and admin roles
    • +
  • jill/password in user roles
    • +
  • john/password that has no roles
    • +
+ + + diff --git a/examples/security/basic-auth-with-static-content/src/main/resources/application.yaml b/examples/security/basic-auth-with-static-content/src/main/resources/application.yaml new file mode 100644 index 00000000..a4394886 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/main/resources/application.yaml @@ -0,0 +1,60 @@ +# +# Copyright (c) 2020, 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. +# + +# To configure an explicit port: +# server.port: 8080 + +security: + config: + # Configuration of secured config (encryption of passwords in property files) + # Set to true for production - if set to true, clear text passwords will cause failure + require-encryption: false + providers: + - http-basic-auth: + realm: "helidon" + users: + - login: "jack" + password: "${CLEAR=password}" + roles: [ "user", "admin" ] + - login: "jill" + password: "${CLEAR=password}" + roles: [ "user" ] + - login: "john" + password: "${CLEAR=password}" + roles: [ ] + web-server: + # Configuration of integration with web server + defaults: + authenticate: true + paths: + - path: "/noRoles" + methods: [ "get" ] + - path: "/user[/{*}]" + methods: [ "get" ] + roles-allowed: [ "user" ] + - path: "/admin" + methods: [ "get" ] + roles-allowed: [ "admin" ] + - path: "/deny" + methods: [ "get" ] + roles-allowed: [ "deny" ] + audit: true + - path: "/noAuthn" + roles-allowed: [ "admin" ] + authentication-optional: true + audit: true + - path: "/static[/{*}]" + roles-allowed: "user" diff --git a/examples/security/basic-auth-with-static-content/src/main/resources/logging.properties b/examples/security/basic-auth-with-static-content/src/main/resources/logging.properties new file mode 100644 index 00000000..5e5636fc --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/main/resources/logging.properties @@ -0,0 +1,21 @@ +# +# Copyright (c) 2018, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +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 +#All log level details +.level=INFO +AUDIT.level=FINEST diff --git a/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleBuilderTest.java b/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleBuilderTest.java new file mode 100644 index 00000000..a560c263 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleBuilderTest.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2020, 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.security.examples.webserver.basic; + +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link io.helidon.security.examples.webserver.basic.BasicExampleBuilderMain}. + */ +public class BasicExampleBuilderTest extends BasicExampleTest { + + private static WebServer server; + + @BeforeAll + public static void startServer() { + // start the test + server = BasicExampleBuilderMain.startServer(); + } + + @AfterAll + public static void stopServer() { + stopServer(server); + } + + @Override + String getServerBase() { + return "http://localhost:" + server.port(); + } +} diff --git a/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleConfigTest.java b/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleConfigTest.java new file mode 100644 index 00000000..b88075f5 --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleConfigTest.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2020, 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.security.examples.webserver.basic; + +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link io.helidon.security.examples.webserver.basic.BasicExampleConfigMain}. + */ +public class BasicExampleConfigTest extends BasicExampleTest { + + private static WebServer server; + + @BeforeAll + public static void startServer() { + // start the test + server = BasicExampleConfigMain.startServer(); + } + + @AfterAll + public static void stopServer() { + stopServer(server); + } + + @Override + String getServerBase() { + return "http://localhost:" + server.port(); + } +} diff --git a/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleTest.java b/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleTest.java new file mode 100644 index 00000000..51c23ada --- /dev/null +++ b/examples/security/basic-auth-with-static-content/src/test/java/io/helidon/security/examples/webserver/basic/BasicExampleTest.java @@ -0,0 +1,186 @@ +/* + * Copyright (c) 2020, 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.security.examples.webserver.basic; + +import java.util.Set; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.http.Http; +import io.helidon.security.Security; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webclient.security.WebClientSecurity; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Abstract class with tests for this example (used by programmatic and config based tests). + */ +public abstract class BasicExampleTest { + private static WebClient client; + + @BeforeAll + public static void classInit() { + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.builder() + .build()) + .build(); + + WebClientSecurity securityService = WebClientSecurity.create(security); + + client = WebClient.builder() + .addService(securityService) + .build(); + } + + static void stopServer(WebServer server) { + long t = System.nanoTime(); + server.shutdown().await(5, TimeUnit.SECONDS); + + long time = System.nanoTime() - t; + System.out.println("Server shutdown in " + TimeUnit.NANOSECONDS.toMillis(time) + " ms"); + } + + abstract String getServerBase(); + + //now for the tests + @Test + public void testPublic() { + //Must be accessible without authentication + WebClientResponse response = client.get() + .uri(getServerBase() + "/public") + .request() + .await(10, TimeUnit.SECONDS); + + assertThat(response.status(), is(Http.Status.OK_200)); + String entity = response.content().as(String.class).await(10, TimeUnit.SECONDS); + assertThat(entity, containsString("")); + } + + @Test + public void testNoRoles() { + String url = getServerBase() + "/noRoles"; + + testNotAuthorized(url); + + //Must be accessible with authentication - to everybody + testProtected(url, "jack", "password", Set.of("admin", "user"), Set.of()); + testProtected(url, "jill", "password", Set.of("user"), Set.of("admin")); + testProtected(url, "john", "password", Set.of(), Set.of("admin", "user")); + } + + @Test + public void testUserRole() { + String url = getServerBase() + "/user"; + + testNotAuthorized(url); + + //Jack and Jill allowed (user role) + testProtected(url, "jack", "password", Set.of("admin", "user"), Set.of()); + testProtected(url, "jill", "password", Set.of("user"), Set.of("admin")); + testProtectedDenied(url, "john", "password"); + } + + @Test + public void testAdminRole() { + String url = getServerBase() + "/admin"; + + testNotAuthorized(url); + + //Only jack is allowed - admin role... + testProtected(url, "jack", "password", Set.of("admin", "user"), Set.of()); + testProtectedDenied(url, "jill", "password"); + testProtectedDenied(url, "john", "password"); + } + + @Test + public void testDenyRole() { + String url = getServerBase() + "/deny"; + + testNotAuthorized(url); + + // nobody has the correct role + testProtectedDenied(url, "jack", "password"); + testProtectedDenied(url, "jill", "password"); + testProtectedDenied(url, "john", "password"); + } + + @Test + public void getNoAuthn() { + String url = getServerBase() + "/noAuthn"; + //Must NOT be accessible without authentication + WebClientResponse response = client.get().uri(url).request().await(5, TimeUnit.SECONDS); + + // authentication is optional, so we are not challenged, only forbidden, as the role can never be there... + assertThat(response.status(), is(Http.Status.FORBIDDEN_403)); + } + + private void testNotAuthorized(String uri) { + //Must NOT be accessible without authentication + WebClientResponse response = client.get().uri(uri).request().await(5, TimeUnit.SECONDS); + + assertThat(response.status(), is(Http.Status.UNAUTHORIZED_401)); + String header = response.headers().first("WWW-Authenticate").get(); + assertThat(header.toLowerCase(), containsString("basic")); + assertThat(header, containsString("helidon")); + } + + private WebClientResponse callProtected(String uri, String username, String password) { + // here we call the endpoint + return client.get() + .uri(uri) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, username) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, password) + .request() + .await(5, TimeUnit.SECONDS); + } + + private void testProtectedDenied(String uri, + String username, + String password) { + + WebClientResponse response = callProtected(uri, username, password); + assertThat(response.status(), is(Http.Status.FORBIDDEN_403)); + } + + private void testProtected(String uri, + String username, + String password, + Set expectedRoles, + Set invalidRoles) { + + WebClientResponse response = callProtected(uri, username, password); + + String entity = response.content().as(String.class).await(5, TimeUnit.SECONDS); + + assertThat(response.status(), is(Http.Status.OK_200)); + + // check login + assertThat(entity, containsString("id='" + username + "'")); + // check roles + expectedRoles.forEach(role -> assertThat(entity, containsString(":" + role))); + invalidRoles.forEach(role -> assertThat(entity, not(containsString(":" + role)))); + } +} diff --git a/examples/security/google-login/README.md b/examples/security/google-login/README.md new file mode 100644 index 00000000..da9dbd1b --- /dev/null +++ b/examples/security/google-login/README.md @@ -0,0 +1,25 @@ +# Integration with Google login button + +This example demonstrates Integration with Google login button on a web page. + +## Contents + +There are two examples with exactly the same behavior +1. builder - shows how to programmatically secure application +2. config - shows how to secure application with configuration + 1. see src/main/resources/application.conf + +There is a static web page in src/main/resources/WEB with a page to login to Google. + +This example requires a Google client id to run. +Update the following files with your client id (it should support http://localhost:8080/index.html): +1. src/main/resources/application.yaml - set security.properties.google-client-id or override it in a file in ~/helidon/examples.yaml +2. src/main/resources/WEB/index.html - update the meta tag in header with name "google-signin-client_id" +3. src/main/java/io/helidon/security/examples/google/GoogleBuilderMain.java - update the client id in builder of provider + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-google-login.jar +``` diff --git a/examples/security/google-login/pom.xml b/examples/security/google-login/pom.xml new file mode 100644 index 00000000..16e7cec9 --- /dev/null +++ b/examples/security/google-login/pom.xml @@ -0,0 +1,103 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-google-login + 1.0.0-SNAPSHOT + Helidon Security Examples Google Login + + + Example of Google login button integration with Security. + + + + io.helidon.security.examples.google.GoogleConfigMain + + + + + io.helidon.security.integration + helidon-security-integration-webserver + + + io.helidon.security.providers + helidon-security-providers-google-login + + + io.helidon.config + helidon-config-encryption + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.bundles + helidon-bundles-config + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-core + test + + + io.helidon.webclient + helidon-webclient + test + + + io.helidon.config + helidon-config-testing + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleBuilderMain.java b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleBuilderMain.java new file mode 100644 index 00000000..3a207331 --- /dev/null +++ b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleBuilderMain.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2018, 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.security.examples.google; + +import java.util.Optional; + +import io.helidon.common.http.MediaType; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.google.login.GoogleTokenProvider; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +/** + * Google login button example main class using builders. + */ +public final class GoogleBuilderMain { + private static volatile WebServer theServer; + + private GoogleBuilderMain() { + } + + public static WebServer getTheServer() { + return theServer; + } + + /** + * Start the example. + * + * @param args ignored + */ + public static void main(String[] args) { + start(GoogleUtil.PORT); + } + + static int start(int port) { + Security security = Security.builder() + .addProvider(GoogleTokenProvider.builder() + .clientId("your-client-id.apps.googleusercontent.com")) + .build(); + WebSecurity ws = WebSecurity.create(security); + + Routing.Builder routing = Routing.builder() + .register(ws) + .get("/rest/profile", + WebSecurity.authenticate(), + (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Response from builder based service, you are: \n" + securityContext + .flatMap(SecurityContext::user) + .map(Subject::toString) + .orElse("Security context is null")); + req.next(); + }) + .register(StaticContentSupport.create("/WEB")); + + theServer = GoogleUtil.startIt(port, routing); + + return theServer.port(); + } +} diff --git a/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleConfigMain.java b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleConfigMain.java new file mode 100644 index 00000000..e09f52c9 --- /dev/null +++ b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleConfigMain.java @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2018, 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.security.examples.google; + +import java.util.Optional; + +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * Google login button example main class using configuration. + */ +public final class GoogleConfigMain { + private static volatile WebServer theServer; + + private GoogleConfigMain() { + } + + public static WebServer getTheServer() { + return theServer; + } + + /** + * Start the example. + * + * @param args ignored + */ + public static void main(String[] args) { + start(GoogleUtil.PORT); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } + + static int start(int port) { + Config config = buildConfig(); + + Routing.Builder routing = Routing.builder() + // helper method to load both security and web server security from configuration + .register(WebSecurity.create(config.get("security"))) + // web server does not (yet) have possibility to configure routes in config files, so explicit... + .get("/rest/profile", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Response from config based service, you are: \n" + securityContext + .flatMap(SecurityContext::user) + .map(Subject::toString) + .orElse("Security context is null")); + }) + .register(StaticContentSupport.create("/WEB")); + + theServer = GoogleUtil.startIt(port, routing); + + return theServer.port(); + } +} diff --git a/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleUtil.java b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleUtil.java new file mode 100644 index 00000000..3c59865f --- /dev/null +++ b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/GoogleUtil.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2018, 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.security.examples.google; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.Builder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Google login example utilities. + */ +public final class GoogleUtil { + // do not change this constant, unless you modify configuration + // of Google application redirect URI + static final int PORT = 8080; + private static final int START_TIMEOUT_SECONDS = 10; + + private GoogleUtil() { + } + + static WebServer startIt(int port, Builder routing) { + WebServer server = WebServer.builder(routing) + .port(port) + .build(); + + long t = System.nanoTime(); + + CountDownLatch cdl = new CountDownLatch(1); + + server.start().thenAccept(webServer -> { + long time = System.nanoTime() - t; + + System.out.printf("Server started in %d ms ms%n", TimeUnit.MILLISECONDS.convert(time, TimeUnit.NANOSECONDS)); + System.out.printf("Started server on localhost:%d%n", webServer.port()); + System.out.printf("You can access this example at http://localhost:%d/index.html%n", webServer.port()); + System.out.println(); + System.out.println(); + System.out.println("Check application.yaml in case you are behind a proxy to configure it"); + cdl.countDown(); + }); + + try { + cdl.await(START_TIMEOUT_SECONDS, TimeUnit.SECONDS); + } catch (InterruptedException e) { + throw new RuntimeException("Failed to start server within defined timeout: " + START_TIMEOUT_SECONDS + " seconds"); + } + + return server; + } +} diff --git a/examples/security/google-login/src/main/java/io/helidon/security/examples/google/package-info.java b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/package-info.java new file mode 100644 index 00000000..193b0c54 --- /dev/null +++ b/examples/security/google-login/src/main/java/io/helidon/security/examples/google/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 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 of integration of Google Login button with security. + */ +package io.helidon.security.examples.google; diff --git a/examples/security/google-login/src/main/resources/WEB/index.html b/examples/security/google-login/src/main/resources/WEB/index.html new file mode 100755 index 00000000..11075666 --- /dev/null +++ b/examples/security/google-login/src/main/resources/WEB/index.html @@ -0,0 +1,86 @@ + + + + + + Google Login Provider + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +

Login to Google.

+
+
+
+ +
+ +
+
+
+
+ + + diff --git a/examples/security/google-login/src/main/resources/WEB/static/js/google-app.js b/examples/security/google-login/src/main/resources/WEB/static/js/google-app.js new file mode 100755 index 00000000..53bb91e9 --- /dev/null +++ b/examples/security/google-login/src/main/resources/WEB/static/js/google-app.js @@ -0,0 +1,47 @@ +/* + * Copyright (c) 2017, 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. + */ + +(function () { + // new module with no dependencies + var app = angular.module('g', []); + + app.controller('GoogleController', ['$http', function ($http) { + this.callBackend = function () { + var accessToken = document.getElementById('gat_input').value; + + if (accessToken === "") { + console.log("No access token, not calling backend"); + alert("Please login before calling backend service"); + return; + } + console.log("Submit attempt to server: " + accessToken); + + $http({ + method: 'GET', + url: '/rest/profile', + headers: { + 'Authorization': "Bearer " + accessToken + } + }).success(function (data, status, headers, config) { + console.log('Successfully sent data to backend, received' + data); + alert(data); + }).error(function (data, status, headers, config) { + console.log('Failed to send data to backend. Status: ' + status); + alert(status + ", auth header: " + headers('WWW-Authenticate') + ", error: " + data); + }); + } + }]); +})(); diff --git a/examples/security/google-login/src/main/resources/application.yaml b/examples/security/google-login/src/main/resources/application.yaml new file mode 100644 index 00000000..4f9e6034 --- /dev/null +++ b/examples/security/google-login/src/main/resources/application.yaml @@ -0,0 +1,50 @@ +# +# Copyright (c) 2016, 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. +# + +security: + config.require-encryption: false + properties: + # This example loads overriding properties from ~/helidon/examples.yaml + # You may configure correct values in that file to leave this content intact + google-client-id: "your-app-id.apps.googleusercontent.com" + proxy-host: "" + providers: + - google-login: + # Create your own application in Google developer console + # Also update the client id configured in header of index.html + # Detailed how-to for login button (including links how to create an application): + # https://developers.google.com/identity/sign-in/web/sign-in + client-id: "${security.properties.google-client-id}" + # Defaults for Helidon + # realm: "helidon" + # Configure proxy host if needed + proxy-host: "${security.properties.proxy-host}" + # proxy-port: 80 + + # This is the default for GoogleTokenProvider + #token: + # header: "Authorization" + # or do not specify - then the whole header is considered to be the token value + # prefix: "bearer " + # optional alternative - looking for first matching group + # regexp: "bearer (.*)" + #} + web-server: + paths: + - path: "/rest/profile" + methods: ["get"] + authenticate: true + diff --git a/examples/security/google-login/src/main/resources/logging.properties b/examples/security/google-login/src/main/resources/logging.properties new file mode 100644 index 00000000..2d0291f2 --- /dev/null +++ b/examples/security/google-login/src/main/resources/logging.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2018, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +.level=INFO +AUDIT.level=FINEST diff --git a/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleBuilderMainTest.java b/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleBuilderMainTest.java new file mode 100644 index 00000000..f1bc5943 --- /dev/null +++ b/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleBuilderMainTest.java @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2018, 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.security.examples.google; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link GoogleBuilderMain}. + */ +public class GoogleBuilderMainTest extends GoogleMainTest { + static int port; + + @BeforeAll + public static void initClass() throws InterruptedException { + port = GoogleBuilderMain.start(0); + } + + @AfterAll + public static void destroyClass() throws InterruptedException { + stopServer(GoogleBuilderMain.getTheServer()); + } + + @Override + int port() { + return port; + } +} diff --git a/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleConfigMainTest.java b/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleConfigMainTest.java new file mode 100644 index 00000000..8b47c111 --- /dev/null +++ b/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleConfigMainTest.java @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2018, 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.security.examples.google; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link GoogleConfigMain}. + */ +public class GoogleConfigMainTest extends GoogleMainTest { + static int port; + + @BeforeAll + public static void initClass() throws InterruptedException { + port = GoogleConfigMain.start(0); + } + + @AfterAll + public static void destroyClass() throws InterruptedException { + stopServer(GoogleConfigMain.getTheServer()); + } + + @Override + int port() { + return port; + } +} diff --git a/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleMainTest.java b/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleMainTest.java new file mode 100644 index 00000000..6dd47f6d --- /dev/null +++ b/examples/security/google-login/src/test/java/io/helidon/security/examples/google/GoogleMainTest.java @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2018, 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.security.examples.google; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.http.Http; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static io.helidon.config.testing.OptionalMatcher.value; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Google login common unit tests. + */ +public abstract class GoogleMainTest { + private static WebClient client; + + @BeforeAll + public static void classInit() { + client = WebClient.create(); + } + + static void stopServer(WebServer server) throws InterruptedException { + CountDownLatch cdl = new CountDownLatch(1); + long t = System.nanoTime(); + if (null == server) { + return; + } + server.shutdown().thenAccept(webServer -> { + long time = System.nanoTime() - t; + System.out.println("Server shutdown in " + TimeUnit.NANOSECONDS.toMillis(time) + " ms"); + cdl.countDown(); + }); + + if (!cdl.await(5, TimeUnit.SECONDS)) { + throw new IllegalStateException("Failed to shutdown server within 5 seconds"); + } + } + + @Test + public void testEndpoint() { + client.get() + .uri("http://localhost:" + port() + "/rest/profile") + .request() + .thenAccept(it -> { + assertThat(it.status(), is(Http.Status.UNAUTHORIZED_401)); + assertThat(it.headers().first(Http.Header.WWW_AUTHENTICATE), + value(is("Bearer realm=\"helidon\",scope=\"openid profile email\""))); + }) + .await(); + } + + abstract int port(); +} diff --git a/examples/security/idcs-login/README.md b/examples/security/idcs-login/README.md new file mode 100644 index 00000000..5076dea8 --- /dev/null +++ b/examples/security/idcs-login/README.md @@ -0,0 +1,76 @@ +# Security integration with IDCS + +This example demonstrates integration with IDCS (Oracle identity service, integrated with Open ID Connect provider). + +## Contents + +This project contains two samples, one (IdcsMain.java) which is configured via the application.yaml file and a second example (IdcsBuilderMain.java) which is configured in code. + +When configured the example exposes two HTTP endpoints `/jersey`, a rest endpoint protected by an IDCS application (with two scopes) and a second endpoint (/rest/profile) which is not protected. + +### IDCS Configuration + +Edit application.yaml for IdcsMain.java or OidcConfig variable definition for IdcsBuilderMain.java sample + +1. Log in to the IDCS console and create a new application of type "confidential app" +2. Within **Resources** + 1. Create two resources called `first_scope` and `second_scope` + 2. Primary Audience = `http://localhost:7987/"` (ensure there is a trailing /) +3. Within **Client Configuration** + 1. Register a client + 2. Allowed Grant Types = Client Credentials,JWT Assertion, Refresh Token, Authorization Code + 3. Check "Allow non-HTTPS URLs" + 4. Set Redirect URL to `http://localhost:7987/oidc/redirect` + 5. Client Type = Confidential + 6. Add all Scopes defined in the resources section + 7. Set allowed operations to `Introspect` + 8. Set Post Logout Redirect URL to `http://localhost:7987/loggedout` + +Ensure you save and *activate* the application + +### Code Configuration + +Edit application.yaml for IdcsMain.java or OidcConfig variable definition for IdcsBuilderMain.java sample + + 1. idcs-uri : Base URL of your idcs instance, usually something like https://idcs-.identity.oraclecloud.com + 2. idcs-client-id : This is obtained from your IDCS application in the IDCS console + 3. idcs-client-secret : This is obtained from your IDCS application in the IDCS console + 4. frontend-uri : This is the base URL of your application when run, e.g. `http://localhost:7987` + 5. proxy-host : Your proxy server if needed + 6. scope-audience : This is the scope audience which MUST match the primary audience in the IDCS resource, recommendation is not to have a trailing slash (/) + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-oidc.jar +``` + +Try the endpoints: + +3. Open http://localhost:7987/rest/profile in your browser. This should present + you with a response highlighting your logged in role (null) correctly as you are not logged in +4. Open `http://localhost:7987/oidc/logout` in your browser. This will log you out from your IDCS and Helidon sessions + +## Calling Sample from Postman + +Now that everything is setup it is possible to call the sample from tools like postman + +1. Create new REST call for your service , e.g. `http://localhost:7987/jersey` +2. Set authentication to oauth 2.0 +3. Press the "Get New Access Token" button + 1. Grant Type should be "Password Credentials" + 2. IDCS Access token URI should be `https://.identity.oraclecloud.com/oauth2/v1/token` + 3. ClientID and Client Secret should be obtained from IDCS and is the same that is configured in the app + 4. Scopes should be a "space" delimited list of scopes prefixed by audience , e.g. `http://localhost:7987/first_scope http://localhost:7987/second_scope` + 5. Client Authentication "Send as Basic Auth Header" +4. Request Token (If you get an error check the postman developer console) +5. Once you have a token ensure you press the "Use token" button +6. Execute your rest call + +## Troubleshooting + +#### Upon redirect to IDCS login page you receive a message indicating the scope isn't found + +- Check that *both* scope names in JerseyResource (first_scope and second_scope) exist in your IDCS application +- Check that the `primary audience` config value in IDCS contains a trailing / and the `front-end-url` in the config file does not diff --git a/examples/security/idcs-login/pom.xml b/examples/security/idcs-login/pom.xml new file mode 100644 index 00000000..051c0f6e --- /dev/null +++ b/examples/security/idcs-login/pom.xml @@ -0,0 +1,134 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-oidc + 1.0.0-SNAPSHOT + Helidon Security Examples IDCS Login + + + Example of login with IDCS using the OIDC provider, storing the identity in a cookie + + + + io.helidon.security.examples.idcs.IdcsMain + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.media + helidon-media-jsonp + + + + io.helidon.security.providers + helidon-security-providers-oidc + + + + io.helidon.security.providers + helidon-security-providers-idcs-mapper + + + + io.helidon.security.providers + helidon-security-providers-abac + + + + io.helidon.security.abac + helidon-security-abac-scope + + + + io.helidon.security.abac + helidon-security-abac-role + + + + io.helidon.security.integration + helidon-security-integration-webserver + + + + io.helidon.config + helidon-config-encryption + + + io.helidon.config + helidon-config-yaml + + + org.jboss + jandex + runtime + true + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-core + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsBuilderMain.java b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsBuilderMain.java new file mode 100644 index 00000000..85c8c32b --- /dev/null +++ b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsBuilderMain.java @@ -0,0 +1,109 @@ +/* + * Copyright (c) 2018, 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.security.examples.idcs; + +import java.io.IOException; +import java.net.URI; +import java.util.Optional; + +import io.helidon.common.LogConfig; +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProvider; +import io.helidon.security.providers.oidc.OidcProvider; +import io.helidon.security.providers.oidc.OidcSupport; +import io.helidon.security.providers.oidc.common.OidcConfig; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * IDCS Login example main class using configuration . + */ +public final class IdcsBuilderMain { + private static volatile WebServer theServer; + + private IdcsBuilderMain() { + } + + public static WebServer getTheServer() { + return theServer; + } + + /** + * Start the example. + * + * @param args ignored + * @throws IOException if logging configuration fails + */ + public static void main(String[] args) throws IOException { + // load logging configuration + LogConfig.configureRuntime(); + + Config config = buildConfig(); + + OidcConfig oidcConfig = OidcConfig.builder() + .clientId("clientId.of.your.application") + .clientSecret("clientSecret.of.your.application") + .identityUri(URI.create( + "https://idcs-tenant-id.identity.oracle.com")) + //.proxyHost("proxy.proxy.com") + .frontendUri("http://your.host:your.port") + // tell us it is IDCS, so we can modify the behavior + .serverType("idcs") + .build(); + + Security security = Security.builder() + .addProvider(OidcProvider.create(oidcConfig)) + .addProvider(IdcsRoleMapperProvider.builder() + .config(config) + .oidcConfig(oidcConfig)) + .build(); + + Routing.Builder routing = Routing.builder() + .register(WebSecurity.create(security, config.get("security"))) + // IDCS requires a web resource for redirects + .register(OidcSupport.create(config)) + // web server does not (yet) have possibility to configure routes in config files, so explicit... + .get("/rest/profile", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Response from builder based service, you are: \n" + securityContext + .flatMap(SecurityContext::user) + .map(Subject::toString) + .orElse("Security context is null")); + }); + + theServer = IdcsUtil.startIt(routing); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } +} diff --git a/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsMain.java b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsMain.java new file mode 100644 index 00000000..37bb25cc --- /dev/null +++ b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsMain.java @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2018, 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.security.examples.idcs; + +import java.util.Optional; + +import io.helidon.common.LogConfig; +import io.helidon.common.context.Contexts; +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.oidc.OidcSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * IDCS Login example main class using configuration . + */ +public final class IdcsMain { + private static volatile WebServer theServer; + + private IdcsMain() { + } + + public static WebServer getTheServer() { + return theServer; + } + + /** + * Start the example. + * + * @param args ignored + */ + public static void main(String[] args) { + // load logging configuration + LogConfig.configureRuntime(); + + Config config = buildConfig(); + + Security security = Security.create(config.get("security")); + // this is needed for proper encryption/decryption of cookies + Contexts.globalContext().register(security); + + Routing.Builder routing = Routing.builder() + .register(WebSecurity.create(security, config.get("security"))) + // IDCS requires a web resource for redirects + .register(OidcSupport.create(config)) + // web server does not (yet) have possibility to configure routes in config files, so explicit... + .get("/rest/profile", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Response from config based service, you are: \n" + securityContext + .flatMap(SecurityContext::user) + .map(Subject::toString) + .orElse("Security context is null")); + }) + .get("/loggedout", (req, res) -> res.send("You have been logged out")); + + theServer = WebServer.create(routing, config.get("server")); + + IdcsUtil.start(theServer); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } +} diff --git a/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsUtil.java b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsUtil.java new file mode 100644 index 00000000..ce6a3b73 --- /dev/null +++ b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/IdcsUtil.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2018, 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.security.examples.idcs; + +import java.net.UnknownHostException; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * IDCS login example utilities. + */ +public class IdcsUtil { + // do not change this constant, unless you modify configuration + // of IDCS application redirect URI + static final int PORT = 7987; + private static final int START_TIMEOUT_SECONDS = 10; + + private IdcsUtil() { + } + + static WebServer startIt(Supplier routing) throws UnknownHostException { + return WebServer.builder(routing) + .port(PORT) + .bindAddress("localhost") + .build(); + } + + static WebServer start(WebServer webServer) { + long t = System.nanoTime(); + + CountDownLatch cdl = new CountDownLatch(1); + + webServer.start() + .thenAccept(it -> whenStarted(it, t)) + .thenRun(cdl::countDown); + + try { + cdl.await(START_TIMEOUT_SECONDS, TimeUnit.SECONDS); + } catch (InterruptedException e) { + throw new RuntimeException("Failed to start server within defined timeout: " + START_TIMEOUT_SECONDS + " seconds", e); + } + + return webServer; + } + + static void whenStarted(WebServer webServer, long startNanoTime) { + long time = System.nanoTime() - startNanoTime; + + System.out.printf("Server started in %d ms%n", TimeUnit.MILLISECONDS.convert(time, TimeUnit.NANOSECONDS)); + System.out.printf("Started server on localhost:%d%n", webServer.port()); + System.out.printf("You can access this example at http://localhost:%d/rest/profile%n", webServer.port()); + System.out.println(); + System.out.println(); + System.out.println("Check application.yaml in case you are behind a proxy to configure it"); + } +} diff --git a/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/package-info.java b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/package-info.java new file mode 100644 index 00000000..90194a96 --- /dev/null +++ b/examples/security/idcs-login/src/main/java/io/helidon/security/examples/idcs/package-info.java @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2018, 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 showcasing integration of web server with IDCS server, using Open ID Connect security provider. + * There is another example in "microprofile" directory that shows the same integration for + * a MicroProfile based application. + */ +package io.helidon.security.examples.idcs; diff --git a/examples/security/idcs-login/src/main/resources/application.yaml b/examples/security/idcs-login/src/main/resources/application.yaml new file mode 100644 index 00000000..38e550d3 --- /dev/null +++ b/examples/security/idcs-login/src/main/resources/application.yaml @@ -0,0 +1,64 @@ +# +# Copyright (c) 2018, 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. +# + +server: + port: 7987 + +security: + config.require-encryption: false + properties: + # This is a nice way to be able to override this with local properties or env-vars + idcs-uri: "https://your-tenant-id.identity.oracle.com" + idcs-client-id: "your-client-id" + idcs-client-secret: "${CLEAR=changeit}" + proxy-host: "" + providers: + - abac: + # Adds ABAC Provider - it does not require any configuration + - oidc: + client-id: "${security.properties.idcs-client-id}" + client-secret: "${security.properties.idcs-client-secret}" + identity-uri: "${security.properties.idcs-uri}" + # A prefix used for custom scopes + scope-audience: "http://localhost:7987/test-application" + proxy-host: "${security.properties.proxy-host}" + # Used as a base for redirects back to us (based on Host header now, so no need to explicitly define it) + # If explicitly defined, will override host header + # frontend-uri: "http://localhost:7987" + # support for non-public signature JWK (and maybe other IDCS specific handling) + server-type: "idcs" + logout-enabled: true + # Can define just a path, host will be taken from header + post-logout-uri: "/loggedout" + - idcs-role-mapper: + multitenant: false + oidc-config: + # we must repeat IDCS configuration, as in this case + # IDCS serves both as open ID connect authenticator and + # as a role mapper. Using minimal configuration here + client-id: "${security.properties.idcs-client-id}" + client-secret: "${security.properties.idcs-client-secret}" + identity-uri: "${security.properties.idcs-uri}" + web-server: + # protected paths on the web server - do not include paths served by Jersey, as those are protected directly + paths: + - path: "/rest/profile" + methods: ["get"] + authenticate: true + roles-allowed: ["my_admins"] +# abac: +# scopes: ["first_scope", "second_scope"] + diff --git a/examples/security/idcs-login/src/main/resources/logging.properties b/examples/security/idcs-login/src/main/resources/logging.properties new file mode 100644 index 00000000..bf5760fd --- /dev/null +++ b/examples/security/idcs-login/src/main/resources/logging.properties @@ -0,0 +1,25 @@ +# +# Copyright (c) 2018, 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. +# + +handlers=io.helidon.common.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 + +.level=INFO +AUDIT.level=FINEST +io.helidon.security.level=FINEST + diff --git a/examples/security/jersey/README.md b/examples/security/jersey/README.md new file mode 100644 index 00000000..2fd07bbc --- /dev/null +++ b/examples/security/jersey/README.md @@ -0,0 +1,27 @@ +# Security integration with Jersey + +This example demonstrates integration with Jersey (JAX-RS implementation). + +## Contents + +There are three examples with exactly the same behavior +1. builder - shows how to secure application using security built by hand +2. config - shows how to secure application with configuration + 1. see `src/main/resources/application.yaml` +3. programmatic - shows how to secure application using manual invocation of authentication + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-jersey.jar +``` + +Try the endpoints: +```shell +curl http://localhost:8080/rest +curl -v http://localhost:8080/rest/protected +curl -u "jack:password" http://localhost:8080/rest/protected +curl -u "jack:password" http://localhost:8080/rest/protected +curl -v -u "john:password" http://localhost:8080/rest/protected +``` diff --git a/examples/security/jersey/pom.xml b/examples/security/jersey/pom.xml new file mode 100644 index 00000000..3eb741c4 --- /dev/null +++ b/examples/security/jersey/pom.xml @@ -0,0 +1,98 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-jersey + 1.0.0-SNAPSHOT + Helidon Security Examples Jersey Integration + + + Integration of security with Jersey, shows how to use configuration based approach, builder approach, and programmatic + approach. + + + + io.helidon.security.examples.jersey.JerseyConfigMain + + + + + io.helidon.security.integration + helidon-security-integration-jersey + + + io.helidon.security.integration + helidon-security-integration-jersey-client + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-jersey + + + org.glassfish.jersey.inject + jersey-hk2 + + + io.helidon.bundles + helidon-bundles-config + + + io.helidon.bundles + helidon-bundles-security + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyBuilderMain.java b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyBuilderMain.java new file mode 100644 index 00000000..72dd3eda --- /dev/null +++ b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyBuilderMain.java @@ -0,0 +1,130 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import java.util.Arrays; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; + +import io.helidon.security.Security; +import io.helidon.security.integration.jersey.SecurityFeature; +import io.helidon.security.providers.abac.AbacProvider; +import io.helidon.security.providers.common.OutboundTarget; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.security.providers.httpauth.SecureUserStore; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.jersey.JerseySupport; + +/** + * Example of integration between Jersey and Security module using builders. + */ +public final class JerseyBuilderMain { + private static final Map USERS = new HashMap<>(); + private static volatile WebServer server; + + static { + addUser("jack", "password", List.of("user", "admin")); + addUser("jill", "password", List.of("user")); + addUser("john", "password", List.of()); + } + + private JerseyBuilderMain() { + } + + private static void addUser(String user, String password, List roles) { + USERS.put(user, new SecureUserStore.User() { + @Override + public String login() { + return user; + } + + private char[] password() { + return password.toCharArray(); + } + + @Override + public boolean isPasswordValid(char[] password) { + return Arrays.equals(password(), password); + } + + @Override + public Collection roles() { + return roles; + } + }); + } + + static WebServer getHttpServer() { + return server; + } + + private static SecurityFeature buildSecurity() { + return new SecurityFeature( + Security.builder() + // add the security provider to use + .addProvider(HttpBasicAuthProvider.builder() + .realm("helidon") + .userStore(users()) + .addOutboundTarget(OutboundTarget.builder("propagate-all").build())) + .addProvider(AbacProvider.create()) + .build()); + } + + private static SecureUserStore users() { + return login -> Optional.ofNullable(USERS.get(login)); + } + + private static JerseySupport buildJersey() { + return JerseySupport.builder() + // register JAX-RS resource + .register(JerseyResources.HelloWorldResource.class) + // register JAX-RS resource demonstrating identity propagation + .register(JerseyResources.OutboundSecurityResource.class) + // integrate security + .register(buildSecurity()) + .register(new ExceptionMapper() { + @Override + public Response toResponse(Exception exception) { + exception.printStackTrace(); + return Response.serverError().build(); + } + }) + .build(); + } + + /** + * Main method of example. No arguments required, no configuration required. + * + * @param args empty is OK + * @throws Throwable if server fails to start + */ + public static void main(String[] args) throws Throwable { + Routing.Builder routing = Routing.builder() + .register("/rest", buildJersey()); + + server = JerseyUtil.startIt(routing, 8080); + + JerseyResources.setPort(server.port()); + } +} diff --git a/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyConfigMain.java b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyConfigMain.java new file mode 100644 index 00000000..ea95ac9e --- /dev/null +++ b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyConfigMain.java @@ -0,0 +1,88 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; + +import io.helidon.config.Config; +import io.helidon.security.Security; +import io.helidon.security.integration.jersey.SecurityFeature; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.jersey.JerseySupport; + +/** + * Example of integration between Jersey and Security module using config. + */ +public class JerseyConfigMain { + private static volatile WebServer server; + + private JerseyConfigMain() { + } + + private static SecurityFeature buildSecurity() { + Config config = Config.create().get("security"); + + Security security = Security.create(config); + + return SecurityFeature.builder(security) + .config(config.get("jersey")) + .build(); + } + + private static JerseySupport buildJersey() { + return JerseySupport.builder() + // register JAX-RS resource + .register(JerseyResources.HelloWorldResource.class) + // register JAX-RS resource demonstrating identity propagation + .register(JerseyResources.OutboundSecurityResource.class) + // integrate security + .register(buildSecurity()) + .register(new ExceptionMapper() { + @Override + public Response toResponse(Exception exception) { + if (exception instanceof WebApplicationException) { + return ((WebApplicationException) exception).getResponse(); + } + exception.printStackTrace(); + return Response.serverError().build(); + } + }) + .build(); + } + + static WebServer getHttpServer() { + return server; + } + + /** + * Main method of example. No arguments required, no configuration required. + * + * @param args empty is OK + * @throws Throwable if server fails to start + */ + public static void main(String[] args) throws Throwable { + Routing.Builder routing = Routing.builder() + .register("/rest", buildJersey()); + + server = JerseyUtil.startIt(routing, 8080); + + JerseyResources.setPort(server.port()); + } +} diff --git a/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyProgrammaticMain.java b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyProgrammaticMain.java new file mode 100644 index 00000000..ff69a5f9 --- /dev/null +++ b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyProgrammaticMain.java @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; + +import io.helidon.config.Config; +import io.helidon.security.Security; +import io.helidon.security.integration.jersey.SecurityFeature; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.jersey.JerseySupport; + +/** + * Example of integration between Jersey and Security module using config, + * yet no container security - all security enforcement is by hand. + */ +public final class JerseyProgrammaticMain { + private static volatile WebServer server; + + private JerseyProgrammaticMain() { + } + + private static SecurityFeature buildSecurity() { + return new SecurityFeature(Security.create(Config.create().get("security"))); + } + + private static JerseySupport buildJersey() { + return JerseySupport.builder() + // register JAX-RS resource + .register(JerseyResources.HelloWorldProgrammaticResource.class) + // register JAX-RS resource demonstrating identity propagation (propagation + // itself is programmatic only, this resource uses annotation to protect itself + .register(JerseyResources.OutboundSecurityResource.class) + // integrate security + .register(buildSecurity()) + .register(new ExceptionMapper() { + @Override + public Response toResponse(Exception exception) { + if (exception instanceof WebApplicationException) { + return ((WebApplicationException) exception).getResponse(); + } + exception.printStackTrace(); + return Response.serverError().build(); + } + }) + .build(); + } + + static WebServer getHttpServer() { + return server; + } + + /** + * Main method of example. No arguments required, no configuration required. + * + * @param args empty is OK + */ + public static void main(String[] args) { + Routing.Builder routing = Routing.builder() + .register("/rest", buildJersey()); + + server = JerseyUtil.startIt(routing, 8080); + + JerseyResources.setPort(server.port()); + } + +} diff --git a/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyResources.java b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyResources.java new file mode 100644 index 00000000..ab20d871 --- /dev/null +++ b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyResources.java @@ -0,0 +1,163 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import javax.annotation.security.RolesAllowed; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.HttpHeaders; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.security.AuthenticationResponse; +import io.helidon.security.SecurityContext; +import io.helidon.security.annotations.Authenticated; + +/** + * Resources are contained here. + */ +final class JerseyResources { + private static int port; + + private JerseyResources() { + } + + static void setPort(int port) { + JerseyResources.port = port; + } + + /** + * JAX-RS Resource. + */ + @Path("/") + public static class HelloWorldResource { + /** + * Not authenticated resource. All resources will be authorized though (to support path based authorizers, + * that may have public and protected paths). + * + * @param securityContext Security component's context + * @return Description and current subject + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public String getHello(@Context SecurityContext securityContext) { + return "To test this example, call /protected. If you use a user without \"user\" role, your request will be denied. " + + "Your current subject: " + securityContext.user().orElse(SecurityContext.ANONYMOUS); + } + + /** + * Returns a hello world message and current subject. + * + * @param securityContext Security component's context + * @return returns hello and subject. + */ + //this is the important annotation for authentication to kick in + @Authenticated + @RolesAllowed("user") + @Path("/protected") + @GET + @Produces(MediaType.TEXT_PLAIN) + // due to Jersey approach to path matching, we need two methods to match both the "root" and "root" + subpaths + public String getHelloName(@Context SecurityContext securityContext) { + return "Hello, your current subject: " + securityContext.user().orElse(SecurityContext.ANONYMOUS); + } + } + + /** + * JAX-RS Resource demonstrating outbound security. + */ + @Path("/outbound") + public static class OutboundSecurityResource { + /** + * Propagates identity - will explicitly call {@link HelloWorldResource} on a URI + * that would resolve to user "tomas", but we will get the current subject... + * + * @param securityContext Security component context + * @return returns hello and subject. + */ + @Authenticated //this is the important annotation for authentication to kick in + @GET + @Produces(MediaType.TEXT_PLAIN) + public String propagateIdentity(@Context SecurityContext securityContext) { + String response = ClientBuilder.newBuilder() + .build() + .target("http://localhost:" + port + "/rest/protected") + .request() + .get(String.class); + + return "Hello, your current subject: " + securityContext.user().orElse(SecurityContext.ANONYMOUS) + "\n" + + "Response from hello world: " + response; + } + } + + /** + * JAX-RS Resource protected by hand. + */ + @Path("/") + public static class HelloWorldProgrammaticResource { + /** + * Not authenticated resource. All resources will be authorized though (to support path based authorizers, + * that may have public and protected paths). + * + * @param securityContext Security component's context + * @return Description and current subject + */ + @GET + @Produces(MediaType.TEXT_PLAIN) + public String getHello(@Context SecurityContext securityContext) { + return "To test this example, call /protected. If you use a user without \"user\" role, your request will be denied. " + + "Your current subject: " + securityContext.user().orElse(SecurityContext.ANONYMOUS); + } + + /** + * Returns a hello world message and current subject. + * + * @param securityContext Security component's context + * @param headers http inbound headers + * @return returns hello and subject. + */ + @Path("/protected") + @GET + @Produces(MediaType.TEXT_PLAIN) + // due to Jersey approach to path matching, we need two methods to match both the "root" and "root" + subpaths + public Response getHelloName(@Context SecurityContext securityContext, @Context HttpHeaders headers) { + AuthenticationResponse resp = securityContext.atnClientBuilder().buildAndGet(); + + if (resp.status().isSuccess()) { + //and to authorize + // role provider can be used directly through context + if (securityContext.isUserInRole("user")) { + return Response + .ok("Hello, your current subject: " + securityContext.user().orElse(SecurityContext.ANONYMOUS)) + .build(); + } else { + return Response.status(Response.Status.FORBIDDEN).build(); + } + } + + Response.ResponseBuilder builder = Response + .status(resp.statusCode().orElse(Response.Status.UNAUTHORIZED.getStatusCode())); + + resp.responseHeaders().forEach((key, value) -> value.forEach(hv -> builder.header(key, hv))); + + return builder.build(); + } + } +} diff --git a/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyUtil.java b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyUtil.java new file mode 100644 index 00000000..54241d93 --- /dev/null +++ b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/JerseyUtil.java @@ -0,0 +1,90 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.Supplier; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Utility for this example. + */ +class JerseyUtil { + private static final int START_TIMEOUT_SECONDS = 10; + + private JerseyUtil() { + } + + static WebServer startIt(Supplier routing, int port) { + WebServer server = WebServer.builder(routing) + .port(port) + .build(); + + long t = System.nanoTime(); + + CountDownLatch cdl = new CountDownLatch(1); + + AtomicReference throwableRef = new AtomicReference<>(); + + server.start().whenComplete((webServer, throwable) -> { + if (null != throwable) { + System.err.println("Failed to start server"); + throwableRef.set(throwable); + } else { + long time = System.nanoTime() - t; + + System.out.printf("Server started in %d ms%n", TimeUnit.MILLISECONDS.convert(time, TimeUnit.NANOSECONDS)); + System.out.printf("Started server on localhost:%d%n", webServer.port()); + System.out.println(); + System.out.println("Users:"); + System.out.println("jack/password in roles: user, admin"); + System.out.println("jill/password in roles: user"); + System.out.println("john/password in no roles"); + System.out.println(); + System.out.println("***********************"); + System.out.println("** Endpoints: **"); + System.out.println("***********************"); + System.out.println("Unprotected:"); + System.out.printf(" http://localhost:%1$d/rest%n", server.port()); + System.out.println("Protected:"); + System.out.printf(" http://localhost:%1$d/rest/protected%n", server.port()); + System.out.println("Identity propagation:"); + System.out.printf(" http://localhost:%1$d/rest/outbound%n", server.port()); + } + cdl.countDown(); + }); + + try { + if (cdl.await(START_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + Throwable thrown = throwableRef.get(); + if (null != thrown) { + throw new RuntimeException("Failed to start server", thrown); + } + } else { + throw new RuntimeException("Failed to start server, timed out"); + } + } catch (InterruptedException e) { + throw new RuntimeException("Failed to start server within defined timeout: " + START_TIMEOUT_SECONDS + " seconds"); + } + + return server; + } +} diff --git a/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/package-info.java b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/package-info.java new file mode 100644 index 00000000..e93cda54 --- /dev/null +++ b/examples/security/jersey/src/main/java/io/helidon/security/examples/jersey/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2018, 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 of integration with Jersey. + * + * @see io.helidon.security.examples.jersey.JerseyConfigMain + * @see io.helidon.security.examples.jersey.JerseyBuilderMain + */ +package io.helidon.security.examples.jersey; diff --git a/examples/security/jersey/src/main/resources/application.yaml b/examples/security/jersey/src/main/resources/application.yaml new file mode 100644 index 00000000..88daf4b1 --- /dev/null +++ b/examples/security/jersey/src/main/resources/application.yaml @@ -0,0 +1,43 @@ +# +# Copyright (c) 2016, 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. +# + +security: + jersey: + # Will use exceptions instead of aborting the request - this should make no difference + # to user unless you use a custom error handler + use-abort-with: false + config: + # Configuration of secured config (encryption of passwords in property files) + # Set to true for production - if set to true, clear text passwords will cause failure + require-encryption: false + providers: + # Security provider - basic authentication (supports roles) - default + - http-basic-auth: + realm: "mic" + users: + - login: "jack" + password: "${CLEAR=password}" + roles: ["user", "admin"] + - login: "jill" + password: "${CLEAR=password}" + roles: ["user"] + - login: "john" + password: "${CLEAR=password}" + roles: [] + outbound: + - name: "propagate-to-all-targets" + # Security provider - ABAC (for role based authorization) + - abac: diff --git a/examples/security/jersey/src/main/resources/logging.properties b/examples/security/jersey/src/main/resources/logging.properties new file mode 100644 index 00000000..2d0291f2 --- /dev/null +++ b/examples/security/jersey/src/main/resources/logging.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2018, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +.level=INFO +AUDIT.level=FINEST diff --git a/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyBuilderMainTest.java b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyBuilderMainTest.java new file mode 100644 index 00000000..8a70dc72 --- /dev/null +++ b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyBuilderMainTest.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Test of hello world example. + */ +public class JerseyBuilderMainTest extends JerseyMainTest { + @BeforeAll + public static void initClass() throws Throwable { + JerseyBuilderMain.main(null); + } + + @AfterAll + public static void destroyClass() throws InterruptedException { + stopServer(JerseyBuilderMain.getHttpServer()); + } + + @Override + protected int getPort() { + return JerseyBuilderMain.getHttpServer().port(); + } +} diff --git a/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyConfigMainTest.java b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyConfigMainTest.java new file mode 100644 index 00000000..c4147b6b --- /dev/null +++ b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyConfigMainTest.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Test of hello world example. + */ +public class JerseyConfigMainTest extends JerseyMainTest { + @BeforeAll + public static void initClass() throws Throwable { + JerseyConfigMain.main(null); + } + + @AfterAll + public static void destroyClass() throws InterruptedException { + stopServer(JerseyConfigMain.getHttpServer()); + } + + @Override + protected int getPort() { + return JerseyConfigMain.getHttpServer().port(); + } +} diff --git a/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyMainTest.java b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyMainTest.java new file mode 100644 index 00000000..a365f110 --- /dev/null +++ b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyMainTest.java @@ -0,0 +1,164 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import java.util.Set; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.core.Response; + +import io.helidon.webserver.WebServer; + +import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.glassfish.jersey.client.authentication.HttpAuthenticationFeature.HTTP_AUTHENTICATION_PASSWORD; +import static org.glassfish.jersey.client.authentication.HttpAuthenticationFeature.HTTP_AUTHENTICATION_USERNAME; +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Common unit tests for builder, config and programmatic security. + */ +public abstract class JerseyMainTest { + private static Client client; + private static Client authFeatureClient; + + @BeforeAll + public static void classInit() { + client = ClientBuilder.newClient(); + authFeatureClient = ClientBuilder.newClient() + .register(HttpAuthenticationFeature.basicBuilder().nonPreemptive().build()); + } + + @AfterAll + public static void classDestroy() { + client.close(); + authFeatureClient.close(); + } + + static void stopServer(WebServer server) throws InterruptedException { + if (null == server) { + return; + } + CountDownLatch cdl = new CountDownLatch(1); + long t = System.nanoTime(); + server.shutdown().thenAccept(webServer -> { + long time = System.nanoTime() - t; + System.out.println("Server shutdown in " + TimeUnit.NANOSECONDS.toMillis(time) + " ms"); + cdl.countDown(); + }); + + if (!cdl.await(5, TimeUnit.SECONDS)) { + throw new IllegalStateException("Failed to shutdown server within 5 seconds"); + } + } + + @Test + public void testUnprotected() { + try (Response response = client.target(baseUri()) + .request() + .get()) { + assertThat(response.getStatus(), is(200)); + assertThat(response.readEntity(String.class), containsString("")); + } + } + + @Test + public void testProtectedOk() { + testProtected(baseUri() + "/protected", + "jack", + "password", + Set.of("user", "admin"), + Set.of()); + testProtected(baseUri() + "/protected", + "jill", + "password", + Set.of("user"), + Set.of("admin")); + } + + @Test + public void testWrongPwd() { + // here we call the endpoint + try (Response response = callProtected(baseUri() + "/protected", "jack", "somePassword")) { + assertThat(response.getStatus(), is(401)); + } + } + + @Test + public void testDenied() { + testProtectedDenied(baseUri() + "/protected", "john", "password"); + } + + @Test + public void testOutboundOk() { + testProtected(baseUri() + "/outbound", + "jill", + "password", + Set.of("user"), + Set.of("admin")); + } + + protected abstract int getPort(); + + private String baseUri() { + return "http://localhost:" + getPort() + "/rest"; + } + + private Response callProtected(String uri, String username, String password) { + // here we call the endpoint + return authFeatureClient.target(uri) + .request() + .property(HTTP_AUTHENTICATION_USERNAME, username) + .property(HTTP_AUTHENTICATION_PASSWORD, password) + .get(); + } + + private void testProtectedDenied(String uri, + String username, + String password) { + + try (Response response = callProtected(uri, username, password)) { + assertThat(response.getStatus(), is(403)); + } + } + + private void testProtected(String uri, + String username, + String password, + Set expectedRoles, + Set invalidRoles) { + + try (Response response = callProtected(uri, username, password)) { + String entity = response.readEntity(String.class); + assertThat(response.getStatus(), is(200)); + // check login + assertThat(entity, containsString("id='" + username + "'")); + // check roles + expectedRoles.forEach(role -> assertThat(entity, containsString(":" + role))); + invalidRoles.forEach(role -> assertThat(entity, not(containsString(":" + role)))); + } + } +} diff --git a/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyProgrammaticMainTest.java b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyProgrammaticMainTest.java new file mode 100644 index 00000000..38e6b3ab --- /dev/null +++ b/examples/security/jersey/src/test/java/io/helidon/security/examples/jersey/JerseyProgrammaticMainTest.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2018, 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.security.examples.jersey; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Test of hello world example. + */ +public class JerseyProgrammaticMainTest extends JerseyMainTest { + @BeforeAll + public static void initClass() throws Throwable { + JerseyProgrammaticMain.main(null); + } + + @AfterAll + public static void destroyClass() throws InterruptedException { + stopServer(JerseyProgrammaticMain.getHttpServer()); + } + + @Override + protected int getPort() { + return JerseyProgrammaticMain.getHttpServer().port(); + } +} diff --git a/examples/security/nohttp-programmatic/README.md b/examples/security/nohttp-programmatic/README.md new file mode 100644 index 00000000..cc9017e6 --- /dev/null +++ b/examples/security/nohttp-programmatic/README.md @@ -0,0 +1,10 @@ +# Helidon Security Example + +Example of manually using the security APIs. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-nohttp-programmatic.jar +``` diff --git a/examples/security/nohttp-programmatic/pom.xml b/examples/security/nohttp-programmatic/pom.xml new file mode 100644 index 00000000..e321c2c8 --- /dev/null +++ b/examples/security/nohttp-programmatic/pom.xml @@ -0,0 +1,63 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-nohttp-programmatic + 1.0.0-SNAPSHOT + Helidon Security Examples No-HTTP programmatic + + + Example of programmatic security without an HTTP resource. + + + + io.helidon.security.examples.security.ProgrammaticSecurity + + + + + io.helidon.security + helidon-security + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/MyProvider.java b/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/MyProvider.java new file mode 100644 index 00000000..a88c3214 --- /dev/null +++ b/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/MyProvider.java @@ -0,0 +1,133 @@ +/* + * Copyright (c) 2018, 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.security.examples.security; + +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.List; + +import io.helidon.security.AuthenticationResponse; +import io.helidon.security.AuthorizationResponse; +import io.helidon.security.EndpointConfig; +import io.helidon.security.OutboundSecurityResponse; +import io.helidon.security.Principal; +import io.helidon.security.ProviderRequest; +import io.helidon.security.Role; +import io.helidon.security.SecurityEnvironment; +import io.helidon.security.Subject; +import io.helidon.security.spi.AuthenticationProvider; +import io.helidon.security.spi.AuthorizationProvider; +import io.helidon.security.spi.OutboundSecurityProvider; +import io.helidon.security.spi.SynchronousProvider; + +/** + * Sample provider. + */ +class MyProvider extends SynchronousProvider implements AuthenticationProvider, AuthorizationProvider, OutboundSecurityProvider { + + @Override + protected AuthenticationResponse syncAuthenticate(ProviderRequest providerRequest) { + //get username and password + List headers = providerRequest.env().headers().getOrDefault("authorization", List.of()); + if (headers.isEmpty()) { + return AuthenticationResponse.failed("No authorization header"); + } + + String header = headers.get(0); + if (header.toLowerCase().startsWith("basic ")) { + String base64 = header.substring(6); + String unamePwd = new String(Base64.getDecoder().decode(base64), StandardCharsets.UTF_8); + int index = unamePwd.indexOf(':'); + if (index > 0) { + String name = unamePwd.substring(0, index); + String pwd = unamePwd.substring(index + 1); + if ("aUser".equals(name)) { + //authenticate + Principal principal = Principal.create(name); + Role roleGrant = Role.create("theRole"); + + Subject subject = Subject.builder() + .principal(principal) + .addGrant(roleGrant) + .addPrivateCredential(MyPrivateCreds.class, new MyPrivateCreds(name, pwd.toCharArray())) + .build(); + + return AuthenticationResponse.success(subject); + } + } + } + + return AuthenticationResponse.failed("User not found"); + } + + @Override + protected AuthorizationResponse syncAuthorize(ProviderRequest providerRequest) { + if ("CustomResourceType" + .equals(providerRequest.env().abacAttribute("resourceType").orElseThrow(() -> new IllegalArgumentException( + "Resource type is a required parameter")))) { + //supported resource + return providerRequest.securityContext() + .user() + .map(Subject::principal) + .map(Principal::getName) + .map("aUser"::equals) + .map(correct -> { + if (correct) { + return AuthorizationResponse.permit(); + } + return AuthorizationResponse.deny(); + }) + .orElse(AuthorizationResponse.deny()); + } + + return AuthorizationResponse.deny(); + } + + @Override + protected OutboundSecurityResponse syncOutbound(ProviderRequest providerRequest, + SecurityEnvironment outboundEnv, + EndpointConfig outboundEndpointConfig) { + + return providerRequest.securityContext() + .user() + .flatMap(subject -> subject.privateCredential(MyPrivateCreds.class)) + .map(myPrivateCreds -> OutboundSecurityResponse.builder() + .requestHeader("Authorization", authHeader(myPrivateCreds)) + .build() + ).orElse(OutboundSecurityResponse.abstain()); + } + + private String authHeader(MyPrivateCreds privCreds) { + String creds = privCreds.name + ":" + new String(privCreds.password); + return "basic " + Base64.getEncoder().encodeToString(creds.getBytes(StandardCharsets.UTF_8)); + } + + private static class MyPrivateCreds { + private final String name; + private final char[] password; + + private MyPrivateCreds(String name, char[] password) { + this.name = name; + this.password = password; + } + + @Override + public String toString() { + return "MyPrivateCreds: " + name; + } + } +} diff --git a/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/ProgrammaticSecurity.java b/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/ProgrammaticSecurity.java new file mode 100644 index 00000000..1bfa51af --- /dev/null +++ b/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/ProgrammaticSecurity.java @@ -0,0 +1,157 @@ +/* + * Copyright (c) 2018, 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.security.examples.security; + +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.concurrent.ExecutionException; + +import io.helidon.security.AuthenticationResponse; +import io.helidon.security.AuthorizationResponse; +import io.helidon.security.OutboundSecurityResponse; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; + +/** + * This class shows how to manually secure your application. + */ +public class ProgrammaticSecurity { + private static final ThreadLocal CONTEXT = new ThreadLocal<>(); + private Security security; + + /** + * Entry point to this example. + * + * @param args no needed + * @throws ExecutionException if asynchronous security fails + * @throws InterruptedException if asynchronous security gets interrupted + */ + public static void main(String[] args) throws ExecutionException, InterruptedException { + ProgrammaticSecurity instance = new ProgrammaticSecurity(); + + /* + * Simple single threaded applications - nothing too complicated + */ + //1: initialize security component + instance.init(); + //2: login + Subject subject = instance.login(); + + //3: authorize access to restricted resource + instance.execute(); + //4: propagate identity + instance.propagate(); + + /* + * More complex - multithreaded application + */ + instance.multithreaded(subject); + + } + + private static String buildBasic(String user, String password) { + return "basic " + Base64.getEncoder() + .encodeToString((user + ":" + password).getBytes(StandardCharsets.UTF_8)); + } + + private void multithreaded(Subject subject) { + Thread thread = new Thread(() -> { + try { + SecurityContext context = security.contextBuilder("newThread") + .build(); + + CONTEXT.set(context); + + //this must be done, as there is no subject (yet) for current thread (or event the login attempt may be done + //in this thread - depends on what your application wants to do... + context.runAs(subject, () -> { + //3: authorize access to restricted resource + execute(); + //4: propagate identity + propagate(); + }); + } finally { + CONTEXT.remove(); + } + }); + thread.start(); + } + + private void propagate() { + OutboundSecurityResponse response = CONTEXT.get().outboundClientBuilder().buildAndGet(); + + switch (response.status()) { + case SUCCESS: + //we should have "Authorization" header present and just need to update request headers of our outbound call + System.out.println("Authorization header: " + response.requestHeaders().get("Authorization")); + break; + case SUCCESS_FINISH: + System.out.println("Identity propagation done, request sent..."); + break; + default: + System.out.println("Failed in identity propagation provider: " + response.description().orElse(null)); + break; + } + } + + private void execute() { + SecurityContext context = CONTEXT.get(); + //check role + if (!context.isUserInRole("theRole")) { + throw new IllegalStateException("User is not in expected role"); + } + + context.env(context.env() + .derive() + .addAttribute("resourceType", "CustomResourceType")); + + //check authorization through provider + AuthorizationResponse response = context.atzClientBuilder().buildAndGet(); + + if (response.status().isSuccess()) { + //ok, process resource + System.out.println("Resource processed"); + } else { + System.out.println("You are not permitted to process resource"); + } + } + + private Subject login() { + SecurityContext securityContext = CONTEXT.get(); + securityContext.env(securityContext.env().derive() + .path("/some/path") + .header("Authorization", buildBasic("aUser", "changeit"))); + + AuthenticationResponse response = securityContext.atnClientBuilder().buildAndGet(); + + if (response.status().isSuccess()) { + return response.user().orElseThrow(() -> new IllegalStateException("No user authenticated!")); + } + + throw new RuntimeException("Failed to authenticate", response.throwable().orElse(null)); + } + + private void init() { + //binds security context to current thread + this.security = Security.builder() + .addProvider(new MyProvider(), "FirstProvider") + .build(); + CONTEXT.set(security.contextBuilder("mainThread").build()); + } + +} diff --git a/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/package-info.java b/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/package-info.java new file mode 100644 index 00000000..563cdc53 --- /dev/null +++ b/examples/security/nohttp-programmatic/src/main/java/io/helidon/security/examples/security/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 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 of programmatic approach to security. + */ +package io.helidon.security.examples.security; diff --git a/examples/security/nohttp-programmatic/src/main/resources/logging.properties b/examples/security/nohttp-programmatic/src/main/resources/logging.properties new file mode 100644 index 00000000..2d0291f2 --- /dev/null +++ b/examples/security/nohttp-programmatic/src/main/resources/logging.properties @@ -0,0 +1,19 @@ +# +# Copyright (c) 2018, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +.level=INFO +AUDIT.level=FINEST diff --git a/examples/security/outbound-override/README.md b/examples/security/outbound-override/README.md new file mode 100644 index 00000000..75e70a69 --- /dev/null +++ b/examples/security/outbound-override/README.md @@ -0,0 +1,21 @@ + +# Helidon Security Outbound Override Example + +Example that propagates identity, and on one endpoint explicitly +sets the username and password. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-outbound-override.jar +``` + +Try the endpoints: + +```shell +curl -u "jack:changeit" http://localhost:8080/propagate +curl -u "jack:changeit" http://localhost:8080/override +curl -u "jill:changeit" http://localhost:8080/propagate +curl -u "jill:changeit" http://localhost:8080/override +``` diff --git a/examples/security/outbound-override/pom.xml b/examples/security/outbound-override/pom.xml new file mode 100644 index 00000000..0234d9da --- /dev/null +++ b/examples/security/outbound-override/pom.xml @@ -0,0 +1,94 @@ + + + + + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + 4.0.0 + io.helidon.examples.security + helidon-examples-security-outbound-override + 1.0.0-SNAPSHOT + Helidon Security Examples Outbound Override + + + io.helidon.security.examples.outbound.OutboundOverrideExample + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.security.integration + helidon-security-integration-webserver + + + io.helidon.security.providers + helidon-security-providers-http-auth + + + io.helidon.security.providers + helidon-security-providers-jwt + + + io.helidon.bundles + helidon-bundles-config + + + + io.helidon.webclient + helidon-webclient + + + io.helidon.webclient + helidon-webclient-security + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideExample.java b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideExample.java new file mode 100644 index 00000000..d77672c7 --- /dev/null +++ b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideExample.java @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2018, 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.security.examples.outbound; + +import java.util.concurrent.CompletionStage; + +import io.helidon.config.Config; +import io.helidon.security.Principal; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; + +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.createConfig; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.getSecurityContext; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.sendError; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.startServer; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.webTarget; + +/** + * Creates two services. First service invokes the second with outbound security. There are two endpoints - one that + * does simple identity propagation and one that uses an explicit username and password. + * + * Uses basic authentication both to authenticate users and to propagate identity. + */ +public final class OutboundOverrideExample { + private static volatile int clientPort; + private static volatile int servingPort; + + private OutboundOverrideExample() { + } + + /** + * Example that propagates identity and on one endpoint explicitly sets the username and password. + * + * @param args ignored + */ + public static void main(String[] args) { + CompletionStage first = startClientService(8080); + CompletionStage second = startServingService(9080); + + first.toCompletableFuture().join(); + second.toCompletableFuture().join(); + + System.out.println("Started services. Main endpoints:"); + System.out.println("http://localhost:" + clientPort + "/propagate"); + System.out.println("http://localhost:" + clientPort + "/override"); + System.out.println(); + System.out.println("Backend service started on:"); + System.out.println("http://localhost:" + servingPort + "/hello"); + } + + static CompletionStage startServingService(int port) { + Config config = createConfig("serving-service"); + + Routing routing = Routing.builder() + .register(WebSecurity.create(config.get("security"))) + .get("/hello", (req, res) -> { + res.send(req.context().get(SecurityContext.class).flatMap(SecurityContext::user).map( + Subject::principal).map(Principal::getName).orElse("Anonymous")); + }).build(); + return startServer(routing, port, server -> servingPort = server.port()); + } + + static CompletionStage startClientService(int port) { + Config config = createConfig("client-service"); + + Routing routing = Routing.builder() + .register(WebSecurity.create(config.get("security"))) + .get("/override", OutboundOverrideExample::override) + .get("/propagate", OutboundOverrideExample::propagate) + .build(); + return startServer(routing, port, server -> clientPort = server.port()); + } + + private static void override(ServerRequest req, ServerResponse res) { + SecurityContext context = getSecurityContext(req); + + webTarget(servingPort) + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "jill") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "changeit") + .request(String.class) + .thenAccept(result -> res.send("You are: " + context.userName() + + ", backend service returned: " + result + "\n")) + .exceptionally(throwable -> sendError(throwable, res)); + } + + private static void propagate(ServerRequest req, ServerResponse res) { + SecurityContext context = getSecurityContext(req); + + webTarget(servingPort) + .request(String.class) + .thenAccept(result -> res.send("You are: " + context.userName() + + ", backend service returned: " + result + "\n")) + .exceptionally(throwable -> sendError(throwable, res)); + } + + static int clientPort() { + return clientPort; + } + +} diff --git a/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideJwtExample.java b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideJwtExample.java new file mode 100644 index 00000000..c1694cf1 --- /dev/null +++ b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideJwtExample.java @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2018, 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.security.examples.outbound; + +import java.util.concurrent.CompletionStage; + +import io.helidon.config.Config; +import io.helidon.security.Principal; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.jwt.JwtProvider; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; + +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.createConfig; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.getSecurityContext; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.sendError; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.startServer; +import static io.helidon.security.examples.outbound.OutboundOverrideUtil.webTarget; + +/** + * Creates two services. First service invokes the second with outbound security. There are two endpoints - one that + * does simple identity propagation and one that uses an explicit username. + * + * Uses basic authentication to authenticate users and JWT to propagate identity. + * + * The difference between this example and basic authentication example: + *
    + *
  • Configuration files (this example uses ones with -jwt.yaml suffix)
    • + *
  • Property name used in {@link #override(ServerRequest, ServerResponse)} method to override username
    • + *
+ */ +public final class OutboundOverrideJwtExample { + private static volatile int clientPort; + private static volatile int servingPort; + + private OutboundOverrideJwtExample() { + } + + /** + * Example that propagates identity and on one endpoint explicitly sets the username and password. + * + * @param args ignored + */ + public static void main(String[] args) { + CompletionStage first = startClientService(8080); + CompletionStage second = startServingService(9080); + + first.toCompletableFuture().join(); + second.toCompletableFuture().join(); + + System.out.println("Started services. Main endpoints:"); + System.out.println("http://localhost:" + clientPort + "/propagate"); + System.out.println("http://localhost:" + clientPort + "/override"); + System.out.println(); + System.out.println("Backend service started on:"); + System.out.println("http://localhost:" + servingPort + "/hello"); + } + + static CompletionStage startServingService(int port) { + Config config = createConfig("serving-service-jwt"); + + Routing routing = Routing.builder() + .register(WebSecurity.create(config.get("security"))) + .get("/hello", (req, res) -> { + // This is the token. It should be bearer + req.headers().first("Authorization") + .ifPresent(System.out::println); + res.send(req.context().get(SecurityContext.class).flatMap(SecurityContext::user).map( + Subject::principal).map(Principal::getName).orElse("Anonymous")); + }).build(); + return startServer(routing, port, server -> servingPort = server.port()); + } + + static CompletionStage startClientService(int port) { + Config config = createConfig("client-service-jwt"); + + Routing routing = Routing.builder() + .register(WebSecurity.create(config.get("security"))) + .get("/override", OutboundOverrideJwtExample::override) + .get("/propagate", OutboundOverrideJwtExample::propagate) + .build(); + return startServer(routing, port, server -> clientPort = server.port()); + } + + private static void override(ServerRequest req, ServerResponse res) { + SecurityContext context = getSecurityContext(req); + + webTarget(servingPort) + .property(JwtProvider.EP_PROPERTY_OUTBOUND_USER, "jill") + .request(String.class) + .thenAccept(result -> res.send("You are: " + context.userName() + ", backend service returned: " + result)) + .exceptionally(throwable -> sendError(throwable, res)); + } + + private static void propagate(ServerRequest req, ServerResponse res) { + SecurityContext context = getSecurityContext(req); + + webTarget(servingPort) + .request(String.class) + .thenAccept(result -> res.send("You are: " + context.userName() + ", backend service returned: " + result)) + .exceptionally(throwable -> sendError(throwable, res)); + } + + static int clientPort() { + return clientPort; + } +} diff --git a/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideUtil.java b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideUtil.java new file mode 100644 index 00000000..e6af1f2c --- /dev/null +++ b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/OutboundOverrideUtil.java @@ -0,0 +1,73 @@ +/* + * Copyright (c) 2019, 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.security.examples.outbound; + +import java.util.concurrent.CompletionStage; +import java.util.function.Consumer; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.security.SecurityContext; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientRequestBuilder; +import io.helidon.webclient.security.WebClientSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.WebServer; + +/** + * Example utilities. + */ +public final class OutboundOverrideUtil { + private static final WebClient CLIENT = WebClient.builder() + .addService(WebClientSecurity.create()) + .build(); + + private OutboundOverrideUtil() { + } + + static WebClientRequestBuilder webTarget(int port) { + return CLIENT.get() + .uri("http://localhost:" + port + "/hello"); + } + + static Void sendError(Throwable throwable, ServerResponse res) { + res.status(Http.Status.INTERNAL_SERVER_ERROR_500); + res.send("Error: " + throwable.getClass().getName() + ": " + throwable.getMessage()); + return null; + } + + static Config createConfig(String fileName) { + return Config.builder() + .sources(ConfigSources.classpath(fileName + ".yaml")) + .build(); + } + + static SecurityContext getSecurityContext(ServerRequest req) { + return req.context().get(SecurityContext.class) + .orElseThrow(() -> new RuntimeException("Failed to get security context from request, security not configured")); + } + + static CompletionStage startServer(Routing routing, int port, Consumer callback) { + return WebServer.builder(routing) + .port(port) + .build() + .start() + .thenAccept(callback); + } +} diff --git a/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/package-info.java b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/package-info.java new file mode 100644 index 00000000..05900c04 --- /dev/null +++ b/examples/security/outbound-override/src/main/java/io/helidon/security/examples/outbound/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 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 to show how to override default settings of an outbound provider. + */ +package io.helidon.security.examples.outbound; diff --git a/examples/security/outbound-override/src/main/resources/client-service-jwt.yaml b/examples/security/outbound-override/src/main/resources/client-service-jwt.yaml new file mode 100644 index 00000000..c4d11dba --- /dev/null +++ b/examples/security/outbound-override/src/main/resources/client-service-jwt.yaml @@ -0,0 +1,63 @@ +# +# Copyright (c) 2018, 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. +# + +security: + provider-policy: + type: "COMPOSITE" + authentication: + - name: "http-basic-auth" + outbound: + - name: "jwt" + providers: + - http-basic-auth: + users: + - login: "john" + password: "changeit" + roles: ["admin"] + - login: "jack" + password: "changeit" + roles: ["user", "admin"] + - login: "jill" + password: "changeit" + roles: ["user"] + - jwt: + allow-impersonation: true + atn-token: + # we are not interested in inbound tokens + verify-signature: false + sign-token: + jwk.resource.resource-path: "signing-jwk.json" + jwt-issuer: "example.helidon.io" + outbound: + - name: "propagate-identity" + jwk-kid: "example" + jwt-kid: "helidon" + jwt-audience: "http://example.helidon.io" + outbound-token: + header: "Authorization" + format: "bearer %1$s" + outbound: + - name: "propagate-all" + web-server: + defaults: + authenticate: true + paths: + - path: "/propagate" + methods: ["get"] + roles-allowed: "user" + - path: "/override" + methods: ["get"] + roles-allowed: "user" \ No newline at end of file diff --git a/examples/security/outbound-override/src/main/resources/client-service.yaml b/examples/security/outbound-override/src/main/resources/client-service.yaml new file mode 100644 index 00000000..0219ab30 --- /dev/null +++ b/examples/security/outbound-override/src/main/resources/client-service.yaml @@ -0,0 +1,41 @@ +# +# Copyright (c) 2018, 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. +# + +security: + providers: + - http-basic-auth: + users: + - login: "john" + password: "changeit" + roles: ["admin"] + - login: "jack" + password: "changeit" + roles: ["user", "admin"] + - login: "jill" + password: "changeit" + roles: ["user"] + outbound: + - name: "propagate-all" + web-server: + defaults: + authenticate: true + paths: + - path: "/propagate" + methods: ["get"] + roles-allowed: "user" + - path: "/override" + methods: ["get"] + roles-allowed: "user" \ No newline at end of file diff --git a/examples/security/outbound-override/src/main/resources/serving-service-jwt.yaml b/examples/security/outbound-override/src/main/resources/serving-service-jwt.yaml new file mode 100644 index 00000000..1faec075 --- /dev/null +++ b/examples/security/outbound-override/src/main/resources/serving-service-jwt.yaml @@ -0,0 +1,28 @@ +# +# Copyright (c) 2018, 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. +# + +security: + providers: + - jwt: + atn-token: + jwk.resource.resource-path: "verifying-jwk.json" + jwt-audience: "http://example.helidon.io" + web-server: + defaults: + authenticate: true + paths: + - path: "/hello" + methods: ["get"] diff --git a/examples/security/outbound-override/src/main/resources/serving-service.yaml b/examples/security/outbound-override/src/main/resources/serving-service.yaml new file mode 100644 index 00000000..e40cfd46 --- /dev/null +++ b/examples/security/outbound-override/src/main/resources/serving-service.yaml @@ -0,0 +1,33 @@ +# +# Copyright (c) 2018, 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. +# + +security: + providers: + - http-basic-auth: + users: + - login: "jack" + password: "changeit" + roles: ["user", "admin"] + - login: "jill" + password: "changeit" + roles: ["user"] + web-server: + defaults: + authenticate: true + paths: + - path: "/hello" + methods: ["get"] + roles-allowed: "user" diff --git a/examples/security/outbound-override/src/main/resources/signing-jwk.json b/examples/security/outbound-override/src/main/resources/signing-jwk.json new file mode 100644 index 00000000..09df45ed --- /dev/null +++ b/examples/security/outbound-override/src/main/resources/signing-jwk.json @@ -0,0 +1,14 @@ +{ + "keys": [ + { + "kty": "oct", + "kid": "example", + "alg": "HS256", + "key_ops": [ + "sign", + "verify" + ], + "k": "FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ" + } + ] +} \ No newline at end of file diff --git a/examples/security/outbound-override/src/main/resources/verifying-jwk.json b/examples/security/outbound-override/src/main/resources/verifying-jwk.json new file mode 100644 index 00000000..5bfc9030 --- /dev/null +++ b/examples/security/outbound-override/src/main/resources/verifying-jwk.json @@ -0,0 +1,14 @@ +{ + "keys": [ + { + "kty": "oct", + "kid": "helidon", + "alg": "HS256", + "key_ops": [ + "sign", + "verify" + ], + "k": "FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ" + } + ] +} \ No newline at end of file diff --git a/examples/security/outbound-override/src/test/java/io/helidon/security/examples/outbound/OutboundOverrideExampleTest.java b/examples/security/outbound-override/src/test/java/io/helidon/security/examples/outbound/OutboundOverrideExampleTest.java new file mode 100644 index 00000000..dd641510 --- /dev/null +++ b/examples/security/outbound-override/src/test/java/io/helidon/security/examples/outbound/OutboundOverrideExampleTest.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2020, 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.security.examples.outbound; + +import java.util.concurrent.CompletionStage; + +import io.helidon.security.Security; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.security.WebClientSecurity; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static io.helidon.security.examples.outbound.OutboundOverrideExample.clientPort; +import static io.helidon.security.examples.outbound.OutboundOverrideExample.startClientService; +import static io.helidon.security.examples.outbound.OutboundOverrideExample.startServingService; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +/** + * Test of security override example. + */ +public class OutboundOverrideExampleTest { + + private static WebClient webClient; + + @BeforeAll + public static void setup() { + CompletionStage first = startClientService(-1); + CompletionStage second = startServingService(-1); + + first.toCompletableFuture().join(); + second.toCompletableFuture().join(); + + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.builder().build()) + .build(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + clientPort()) + .addService(WebClientSecurity.create(security)) + .build(); + } + + @Test + public void testOverrideExample() { + String value = webClient.get() + .path("/override") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "jack") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "changeit") + .request(String.class) + .await(); + + assertThat(value, is("You are: jack, backend service returned: jill\n")); + } + + @Test + public void testPropagateExample() { + String value = webClient.get() + .path("/propagate") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "jack") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "changeit") + .request(String.class) + .await(); + + assertThat(value, is("You are: jack, backend service returned: jack\n")); + } + +} diff --git a/examples/security/outbound-override/src/test/java/io/helidon/security/examples/outbound/OutboundOverrideJwtExampleTest.java b/examples/security/outbound-override/src/test/java/io/helidon/security/examples/outbound/OutboundOverrideJwtExampleTest.java new file mode 100644 index 00000000..d6151f51 --- /dev/null +++ b/examples/security/outbound-override/src/test/java/io/helidon/security/examples/outbound/OutboundOverrideJwtExampleTest.java @@ -0,0 +1,83 @@ +/* + * 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. + */ +package io.helidon.security.examples.outbound; + +import java.util.concurrent.CompletionStage; + +import io.helidon.security.Security; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.security.WebClientSecurity; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static io.helidon.security.examples.outbound.OutboundOverrideJwtExample.clientPort; +import static io.helidon.security.examples.outbound.OutboundOverrideJwtExample.startClientService; +import static io.helidon.security.examples.outbound.OutboundOverrideJwtExample.startServingService; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +/** + * Test of security override example. + */ +public class OutboundOverrideJwtExampleTest { + + private static WebClient webClient; + + @BeforeAll + public static void setup() { + CompletionStage first = startClientService(-1); + CompletionStage second = startServingService(-1); + + first.toCompletableFuture().join(); + second.toCompletableFuture().join(); + + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.builder().build()) + .build(); + + webClient = WebClient.builder() + .baseUri("http://localhost:" + clientPort()) + .addService(WebClientSecurity.create(security)) + .build(); + } + + @Test + public void testOverrideExample() { + String value = webClient.get() + .path("/override") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "jack") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "changeit") + .request(String.class) + .await(); + + assertThat(value, is("You are: jack, backend service returned: jill")); + } + + @Test + public void testPropagateExample() { + String value = webClient.get() + .path("/propagate") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER, "jack") + .property(HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD, "changeit") + .request(String.class) + .await(); + + assertThat(value, is("You are: jack, backend service returned: jack")); + } + +} diff --git a/examples/security/pom.xml b/examples/security/pom.xml new file mode 100644 index 00000000..be9d09a6 --- /dev/null +++ b/examples/security/pom.xml @@ -0,0 +1,51 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.security + helidon-examples-security-project + Helidon Security Examples + pom + + + Examples of Helidon Security usage and integrations + + + + nohttp-programmatic + jersey + webserver-digest-auth + webserver-signatures + google-login + spi-examples + attribute-based-access-control + idcs-login + outbound-override + basic-auth-with-static-content + vaults + + diff --git a/examples/security/spi-examples/README.md b/examples/security/spi-examples/README.md new file mode 100644 index 00000000..3e7e9a75 --- /dev/null +++ b/examples/security/spi-examples/README.md @@ -0,0 +1,20 @@ +# SPI implementation + +This example demonstrates how to implement various SPIs of security component. + +Contents +-------- +The following examples are available: +1. Authentication provider +2. Authorization provider +3. Outbound provider +3. Audit provider +4. Provider selection policy + +# Running the Example + +This is an API/SPI example. It is validated through unit tests. + +```shell +mvn package +``` \ No newline at end of file diff --git a/examples/security/spi-examples/pom.xml b/examples/security/spi-examples/pom.xml new file mode 100644 index 00000000..edab11fa --- /dev/null +++ b/examples/security/spi-examples/pom.xml @@ -0,0 +1,83 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-spi + 1.0.0-SNAPSHOT + Helidon Security Examples SPI Implementation + + + Example of implementation of custom providers and other SPI implementations + + + + 2.23.4 + + + + + io.helidon.security + helidon-security + + + io.helidon.bundles + helidon-bundles-config + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-core + test + + + org.mockito + mockito-core + ${version.lib.mockito} + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/AtnProviderSync.java b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/AtnProviderSync.java new file mode 100644 index 00000000..624ad55f --- /dev/null +++ b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/AtnProviderSync.java @@ -0,0 +1,179 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import java.lang.annotation.Annotation; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Optional; +import java.util.Set; + +import io.helidon.config.Config; +import io.helidon.security.AuthenticationResponse; +import io.helidon.security.EndpointConfig; +import io.helidon.security.Principal; +import io.helidon.security.ProviderRequest; +import io.helidon.security.Role; +import io.helidon.security.SecurityLevel; +import io.helidon.security.Subject; +import io.helidon.security.spi.AuthenticationProvider; +import io.helidon.security.spi.SynchronousProvider; + +/** + * Example of an authentication provider implementation - synchronous. + * This is a full-blows example of a provider that requires additional configuration on a resource. + */ +public class AtnProviderSync extends SynchronousProvider implements AuthenticationProvider { + @Override + protected AuthenticationResponse syncAuthenticate(ProviderRequest providerRequest) { + + // first obtain the configuration of this request + // either from annotation, custom object or config + AtnObject myObject = getCustomObject(providerRequest.endpointConfig()); + + if (null == myObject) { + // I do not have my required information, this request is probably not for me + return AuthenticationResponse.abstain(); + } + + if (myObject.isValid()) { + // now authenticate - this example just creates a subject + // based on the value (user subject) and size (group subject) + return AuthenticationResponse.success(Subject.builder() + .addPrincipal(Principal.create(myObject.getValue())) + .addGrant(Role.create("role_" + myObject.getSize())) + .build()); + } else { + return AuthenticationResponse.failed("Invalid request"); + } + } + + private AtnObject getCustomObject(EndpointConfig epConfig) { + // order I choose - this depends on type of security you implement and your choice: + // 1) custom object in request (as this must be explicitly done by a developer) + Optional opt = epConfig.instance(AtnObject.class); + if (opt.isPresent()) { + return opt.get(); + } + + // 2) configuration in request + opt = epConfig.config("atn-object").flatMap(conf -> conf.as(AtnObject::from).asOptional()); + if (opt.isPresent()) { + return opt.get(); + } + + // 3) annotations on target + List annots = new ArrayList<>(); + for (SecurityLevel securityLevel : epConfig.securityLevels()) { + annots.addAll(securityLevel.combineAnnotations(AtnAnnot.class, EndpointConfig.AnnotationScope.values())); + } + if (annots.isEmpty()) { + return null; + } else { + return AtnObject.from(annots.get(0)); + } + } + + @Override + public Collection> supportedAnnotations() { + return Set.of(AtnAnnot.class); + } + + /** + * This is an example annotation to see how to work with them. + */ + @Retention(RetentionPolicy.RUNTIME) + @Target({ElementType.METHOD, ElementType.TYPE, ElementType.FIELD}) + @Documented + public @interface AtnAnnot { + /** + * This is an example value. + * + * @return some value + */ + String value(); + + /** + * This is an example value. + * + * @return some size + */ + int size() default 4; + } + + /** + * This is an example custom object. + * Also acts as an object to get configuration in config. + */ + public static class AtnObject { + private String value; + private int size = 4; + + /** + * Load this object instance from configuration. + * + * @param config configuration + * @return a new instance + */ + public static AtnObject from(Config config) { + AtnObject result = new AtnObject(); + config.get("value").asString().ifPresent(result::setValue); + config.get("size").asInt().ifPresent(result::setSize); + return result; + } + + static AtnObject from(AtnAnnot annot) { + AtnObject result = new AtnObject(); + result.setValue(annot.value()); + result.setSize(annot.size()); + return result; + } + + static AtnObject from(String value, int size) { + AtnObject result = new AtnObject(); + result.setValue(value); + result.setSize(size); + return result; + } + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public int getSize() { + return size; + } + + public void setSize(int size) { + this.size = size; + } + + public boolean isValid() { + return null != value; + } + } +} diff --git a/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/AtzProviderSync.java b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/AtzProviderSync.java new file mode 100644 index 00000000..5ba69a6a --- /dev/null +++ b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/AtzProviderSync.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import io.helidon.security.AuthorizationResponse; +import io.helidon.security.ProviderRequest; +import io.helidon.security.spi.AuthorizationProvider; +import io.helidon.security.spi.SynchronousProvider; + +/** + * Authorization provider example. The most simplistic approach. + * + * @see AtnProviderSync on how to use custom objects, config and annotations in a provider + */ +public class AtzProviderSync extends SynchronousProvider implements AuthorizationProvider { + @Override + protected AuthorizationResponse syncAuthorize(ProviderRequest providerRequest) { + // just check the path contains the string "public", otherwise allow only if user is logged in + // if no path is defined, abstain (e.g. I do not care about such requests - I can neither allow or deny them) + return providerRequest.env().path() + .map(path -> { + if (path.contains("public")) { + return AuthorizationResponse.permit(); + } + if (providerRequest.securityContext().isAuthenticated()) { + return AuthorizationResponse.permit(); + } else { + return AuthorizationResponse.deny(); + } + }).orElse(AuthorizationResponse.abstain()); + } +} diff --git a/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/Auditer.java b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/Auditer.java new file mode 100644 index 00000000..f82963a6 --- /dev/null +++ b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/Auditer.java @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import java.util.LinkedList; +import java.util.List; +import java.util.function.Consumer; + +import io.helidon.security.spi.AuditProvider; + +/** + * Audit provider implementation. + */ +public class Auditer implements AuditProvider { + // BEWARE this is a memory leak. Only for example purposes and for unit-tests + private final List messages = new LinkedList<>(); + + public List getMessages() { + return messages; + } + + @Override + public Consumer auditConsumer() { + return event -> { + // just dump to stdout and store in a list + System.out.println(event.severity() + ": " + event.tracingId() + ": " + event); + messages.add(event); + }; + } + +} diff --git a/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/OutboundProviderSync.java b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/OutboundProviderSync.java new file mode 100644 index 00000000..0c536ae3 --- /dev/null +++ b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/OutboundProviderSync.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import java.util.List; +import java.util.Map; + +import io.helidon.security.EndpointConfig; +import io.helidon.security.OutboundSecurityResponse; +import io.helidon.security.Principal; +import io.helidon.security.ProviderRequest; +import io.helidon.security.SecurityEnvironment; +import io.helidon.security.Subject; +import io.helidon.security.spi.OutboundSecurityProvider; +import io.helidon.security.spi.SynchronousProvider; + +/** + * Example of a simplistic outbound security provider. + */ +public class OutboundProviderSync extends SynchronousProvider implements OutboundSecurityProvider { + @Override + protected OutboundSecurityResponse syncOutbound(ProviderRequest providerRequest, + SecurityEnvironment outboundEnv, + EndpointConfig outboundEndpointConfig) { + + // let's just add current user's id as a custom header, otherwise do nothing + return providerRequest.securityContext() + .user() + .map(Subject::principal) + .map(Principal::getName) + .map(name -> OutboundSecurityResponse + .withHeaders(Map.of("X-AUTH-USER", List.of(name)))) + .orElse(OutboundSecurityResponse.abstain()); + } +} diff --git a/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/ProviderSelector.java b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/ProviderSelector.java new file mode 100644 index 00000000..cfe913b2 --- /dev/null +++ b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/ProviderSelector.java @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import java.util.LinkedList; +import java.util.List; +import java.util.Optional; + +import io.helidon.security.NamedProvider; +import io.helidon.security.spi.OutboundSecurityProvider; +import io.helidon.security.spi.ProviderSelectionPolicy; +import io.helidon.security.spi.SecurityProvider; + +/** + * Simple selector of providers, just chooses first, except for outbound, where it returns all. + */ +public class ProviderSelector implements ProviderSelectionPolicy { + private final Providers providers; + private final List outboundProviders = new LinkedList<>(); + + private ProviderSelector(Providers providers) { + this.providers = providers; + + providers.getProviders(OutboundSecurityProvider.class) + .forEach(np -> outboundProviders.add(np.getProvider())); + } + + /** + * This is the function to register with security. + * + * @param providers Providers from security + * @return selector instance + * @see io.helidon.security.Security.Builder#providerSelectionPolicy(java.util.function.Function) + */ + public static ProviderSelector create(Providers providers) { + return new ProviderSelector(providers); + } + + @Override + public Optional selectProvider(Class providerType) { + List> providers = this.providers.getProviders(providerType); + + if (providers.isEmpty()) { + return Optional.empty(); + } else { + return Optional.of(providers.get(0).getProvider()); + } + } + + @Override + public List selectOutboundProviders() { + return outboundProviders; + } + + @Override + public Optional selectProvider(Class providerType, String requestedName) { + return this.providers.getProviders(providerType) + .stream() + .filter(provider -> provider.getName().equals(requestedName)) + .findFirst() + .map(NamedProvider::getProvider); + } +} diff --git a/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/package-info.java b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/package-info.java new file mode 100644 index 00000000..c427ec51 --- /dev/null +++ b/examples/security/spi-examples/src/main/java/io/helidon/security/examples/spi/package-info.java @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2018, 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. + */ + +/** + * Examples of SPI implementation. + * + * @see io.helidon.security.spi.AuthenticationProvider + */ +package io.helidon.security.examples.spi; diff --git a/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AtnProviderSyncTest.java b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AtnProviderSyncTest.java new file mode 100644 index 00000000..20c953d8 --- /dev/null +++ b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AtnProviderSyncTest.java @@ -0,0 +1,225 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import java.lang.annotation.Annotation; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.security.AuthenticationResponse; +import io.helidon.security.EndpointConfig; +import io.helidon.security.ProviderRequest; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.SecurityEnvironment; +import io.helidon.security.SecurityLevel; +import io.helidon.security.SecurityResponse; +import io.helidon.security.Subject; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.jupiter.api.Assertions.fail; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +/** + * Unit test for {@link AtnProviderSync}. + */ +public class AtnProviderSyncTest { + private static final String VALUE = "aValue"; + private static final int SIZE = 16; + + @Test + public void testAbstain() { + SecurityContext context = mock(SecurityContext.class); + when(context.user()).thenReturn(Optional.empty()); + when(context.service()).thenReturn(Optional.empty()); + + SecurityEnvironment se = SecurityEnvironment.create(); + EndpointConfig ep = EndpointConfig.create(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + AtnProviderSync provider = new AtnProviderSync(); + + AuthenticationResponse response = provider.syncAuthenticate(request); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.ABSTAIN)); + } + + @Test + public void testAnnotationSuccess() { + AtnProviderSync.AtnAnnot annot = new AtnProviderSync.AtnAnnot() { + @Override + public String value() { + return VALUE; + } + + @Override + public int size() { + return SIZE; + } + + @Override + public Class annotationType() { + return AtnProviderSync.AtnAnnot.class; + } + }; + + SecurityContext context = mock(SecurityContext.class); + when(context.user()).thenReturn(Optional.empty()); + when(context.service()).thenReturn(Optional.empty()); + + SecurityEnvironment se = SecurityEnvironment.create(); + + SecurityLevel level = SecurityLevel.create("mock") + .withClassAnnotations(Map.of(AtnProviderSync.AtnAnnot.class, List.of(annot))) + .build(); + + EndpointConfig ep = EndpointConfig.builder() + .securityLevels(List.of(level)) + .build(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + testSuccess(request); + } + + @Test + public void testCustomObjectSuccess() { + AtnProviderSync.AtnObject obj = new AtnProviderSync.AtnObject(); + obj.setSize(SIZE); + obj.setValue(VALUE); + + SecurityContext context = mock(SecurityContext.class); + when(context.user()).thenReturn(Optional.empty()); + when(context.service()).thenReturn(Optional.empty()); + + SecurityEnvironment se = SecurityEnvironment.create(); + EndpointConfig ep = EndpointConfig.builder() + .customObject(AtnProviderSync.AtnObject.class, obj) + .build(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + testSuccess(request); + } + + @Test + public void testConfigSuccess() { + Config config = Config.create( + ConfigSources.create(Map.of("value", VALUE, + "size", String.valueOf(SIZE))) + ); + + SecurityContext context = mock(SecurityContext.class); + when(context.user()).thenReturn(Optional.empty()); + when(context.service()).thenReturn(Optional.empty()); + + SecurityEnvironment se = SecurityEnvironment.create(); + EndpointConfig ep = EndpointConfig.builder() + .config("atn-object", config) + .build(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + + testSuccess(request); + } + + @Test + public void testFailure() { + Config config = Config.create( + ConfigSources.create(Map.of("atn-object.size", String.valueOf(SIZE))) + ); + + SecurityContext context = mock(SecurityContext.class); + when(context.user()).thenReturn(Optional.empty()); + when(context.service()).thenReturn(Optional.empty()); + + SecurityEnvironment se = SecurityEnvironment.create(); + EndpointConfig ep = EndpointConfig.builder() + .config("atn-object", config) + .build(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + AtnProviderSync provider = new AtnProviderSync(); + + AuthenticationResponse response = provider.syncAuthenticate(request); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.FAILURE)); + } + + @Test + public void integrationTest() { + Security security = Security.builder() + .addProvider(new AtnProviderSync()) + .build(); + + // this part is usually done by container integration component + // in Jersey you have access to security context through annotations + // in Web server you have access to security context through context + SecurityContext context = security.createContext("unit-test"); + context.endpointConfig(EndpointConfig.builder() + .customObject(AtnProviderSync.AtnObject.class, + AtnProviderSync.AtnObject.from(VALUE, SIZE))); + AuthenticationResponse response = context.authenticate(); + + validateResponse(response); + } + + private void validateResponse(AuthenticationResponse response) { + assertThat(response.status(), is(SecurityResponse.SecurityStatus.SUCCESS)); + Optional maybeuser = response.user(); + + maybeuser.ifPresentOrElse(user -> { + assertThat(user.principal().id(), is(VALUE)); + Set roles = Security.getRoles(user); + assertThat(roles.size(), is(1)); + assertThat(roles.iterator().next(), is("role_" + SIZE)); + }, () -> fail("User should have been returned")); + } + + private void testSuccess(ProviderRequest request) { + AtnProviderSync provider = new AtnProviderSync(); + + AuthenticationResponse response = provider.syncAuthenticate(request); + validateResponse(response); + } +} diff --git a/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AtzProviderSyncTest.java b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AtzProviderSyncTest.java new file mode 100644 index 00000000..83f7d65d --- /dev/null +++ b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AtzProviderSyncTest.java @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import io.helidon.security.AuthorizationResponse; +import io.helidon.security.EndpointConfig; +import io.helidon.security.ProviderRequest; +import io.helidon.security.SecurityContext; +import io.helidon.security.SecurityEnvironment; +import io.helidon.security.SecurityResponse; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +/** + * Unit test for {@link AtzProviderSync}. + */ +public class AtzProviderSyncTest { + @Test + public void testPublic() { + SecurityEnvironment se = SecurityEnvironment.builder() + .path("/public/some/path") + .build(); + EndpointConfig ep = EndpointConfig.create(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + AtzProviderSync provider = new AtzProviderSync(); + + AuthorizationResponse response = provider.syncAuthorize(request); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.SUCCESS)); + } + + @Test + public void testAbstain() { + SecurityEnvironment se = SecurityEnvironment.create(); + EndpointConfig ep = EndpointConfig.create(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + AtzProviderSync provider = new AtzProviderSync(); + + AuthorizationResponse response = provider.syncAuthorize(request); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.ABSTAIN)); + } + + @Test + public void testDenied() { + SecurityContext context = mock(SecurityContext.class); + when(context.isAuthenticated()).thenReturn(false); + + SecurityEnvironment se = SecurityEnvironment.builder() + .path("/private/some/path") + .build(); + EndpointConfig ep = EndpointConfig.create(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + AtzProviderSync provider = new AtzProviderSync(); + + AuthorizationResponse response = provider.syncAuthorize(request); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.FAILURE)); + } + + @Test + public void testPermitted() { + SecurityContext context = mock(SecurityContext.class); + when(context.isAuthenticated()).thenReturn(true); + + SecurityEnvironment se = SecurityEnvironment.builder() + .path("/private/some/path") + .build(); + EndpointConfig ep = EndpointConfig.create(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + when(request.endpointConfig()).thenReturn(ep); + + AtzProviderSync provider = new AtzProviderSync(); + + AuthorizationResponse response = provider.syncAuthorize(request); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.SUCCESS)); + } +} diff --git a/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AuditerTest.java b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AuditerTest.java new file mode 100644 index 00000000..8b048c00 --- /dev/null +++ b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/AuditerTest.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import java.util.List; +import java.util.stream.Collectors; + +import io.helidon.security.AuditEvent; +import io.helidon.security.AuthorizationResponse; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.SecurityEnvironment; +import io.helidon.security.spi.AuditProvider; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Unit test for {@link Auditer}. + */ +public class AuditerTest { + @Test + public void integrateIt() throws InterruptedException { + Auditer auditer = new Auditer(); + + Security sec = Security.builder() + .addAuthorizationProvider(new AtzProviderSync()) + .addAuditProvider(auditer) + .build(); + + SecurityContext context = sec.createContext("unit-test"); + context.env(SecurityEnvironment.builder() + .path("/public/path")); + + AuthorizationResponse response = context.authorize(); + + // as auditing is asynchronous, we must give it some time to process + Thread.sleep(100); + + List messages = auditer.getMessages(); + // there should be two messages - configuration of security and authorization + + List atzEvents = messages.stream() + .filter(event -> event.eventType().startsWith(AuditEvent.AUTHZ_TYPE_PREFIX)) + .collect(Collectors.toList()); + + assertThat("We only expect a single authorization event", atzEvents.size(), is(1)); + + } +} diff --git a/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/OutboundProviderSyncTest.java b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/OutboundProviderSyncTest.java new file mode 100644 index 00000000..41ebc99d --- /dev/null +++ b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/OutboundProviderSyncTest.java @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import java.util.List; +import java.util.Optional; + +import io.helidon.security.EndpointConfig; +import io.helidon.security.OutboundSecurityResponse; +import io.helidon.security.Principal; +import io.helidon.security.ProviderRequest; +import io.helidon.security.SecurityContext; +import io.helidon.security.SecurityEnvironment; +import io.helidon.security.SecurityResponse; +import io.helidon.security.Subject; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +/** + * Unit test for {@link OutboundProviderSync}. + */ +public class OutboundProviderSyncTest { + @Test + public void testAbstain() { + SecurityContext context = mock(SecurityContext.class); + when(context.user()).thenReturn(Optional.empty()); + when(context.service()).thenReturn(Optional.empty()); + + SecurityEnvironment se = SecurityEnvironment.create(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + + OutboundProviderSync ops = new OutboundProviderSync(); + OutboundSecurityResponse response = ops.syncOutbound(request, SecurityEnvironment.create(), EndpointConfig.create()); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.ABSTAIN)); + } + + @Test + public void testSuccess() { + String username = "aUser"; + Subject subject = Subject.create(Principal.create(username)); + + SecurityContext context = mock(SecurityContext.class); + when(context.user()).thenReturn(Optional.of(subject)); + when(context.service()).thenReturn(Optional.empty()); + + SecurityEnvironment se = SecurityEnvironment.create(); + + ProviderRequest request = mock(ProviderRequest.class); + when(request.securityContext()).thenReturn(context); + when(request.env()).thenReturn(se); + + OutboundProviderSync ops = new OutboundProviderSync(); + OutboundSecurityResponse response = ops.syncOutbound(request, SecurityEnvironment.create(), EndpointConfig.create()); + + assertThat(response.status(), is(SecurityResponse.SecurityStatus.SUCCESS)); + assertThat(response.requestHeaders().get("X-AUTH-USER"), is(List.of(username))); + } +} diff --git a/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/ProviderSelectorTest.java b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/ProviderSelectorTest.java new file mode 100644 index 00000000..54030081 --- /dev/null +++ b/examples/security/spi-examples/src/test/java/io/helidon/security/examples/spi/ProviderSelectorTest.java @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2018, 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.security.examples.spi; + +import io.helidon.security.AuthorizationResponse; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.SecurityEnvironment; + +import org.junit.jupiter.api.Test; + +/** + * Unit test for {@link ProviderSelector}. + */ +public class ProviderSelectorTest { + @Test + public void integrateIt() { + Security security = Security.builder() + .providerSelectionPolicy(ProviderSelector::create) + .addProvider(new AtnProviderSync()) + .addProvider(new AtzProviderSync()) + .build(); + + SecurityContext context = security.createContext("unit-test"); + context.env(SecurityEnvironment.builder().path("/public/path")); + + AuthorizationResponse response = context.authorize(); + + // if we reached here, the policy worked + } +} diff --git a/examples/security/vaults/README.md b/examples/security/vaults/README.md new file mode 100644 index 00000000..e052a960 --- /dev/null +++ b/examples/security/vaults/README.md @@ -0,0 +1,39 @@ +Vaults example +---- + +This example demonstrates the use of `Security` to: +- access secrets +- generate digests (such as Signatures and HMAC) +- verify digests (dtto) +- encrypt secret text +- decrypt cipher text + +The example uses three implementations of security providers that implement these features: + +1. OCI Vault provider (supports all) +2. Config provider (supports encryption/decryption and secrets) +3. Hashicorp (HCP) Vault provider (supports all + HMAC digest) + + +# OCI Vault + +The following information/configuration is needed: + +1. `~/.oci/config` file should be present (TODO link to description how to get it) +2. A secret (for password) must be created and its OCID configured in `${oci.properties.secret-ocid}` +3. An RSA key must be created and its OCID configured in `${oci.properties.vault-rsa-key-ocid}` for signature +4. Key must be created and its OCID configured in `${oci.properties.vault-key-ocid}` for encryption + +# HCP Vault + +1. Vault address must be defined in `vault.address` +2. Vault token must be defined in `vault.token` +3. A secret must be defined in the default secrets under path `app/secret` with key `username` defining a user +4. Vault `transit` secret engine must be enabled +5. A key named `signature-key` must be created (RSA) in `transit` secret engine for signature +6. A key named `encryption-key` must be created in `transit` secret engine for encryption and HMAC + +```shell +mvn package +java -jar target/helidon-examples-security-vaults.jar +``` \ No newline at end of file diff --git a/examples/security/vaults/pom.xml b/examples/security/vaults/pom.xml new file mode 100644 index 00000000..edafdd95 --- /dev/null +++ b/examples/security/vaults/pom.xml @@ -0,0 +1,109 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-vaults + 1.0.0-SNAPSHOT + Helidon Security Examples Vaults + + + This example demonstrates usage of vault implementations - OCI, Hashicorp Vault, and Config based vault + + + + io.helidon.examples.security.vaults.VaultsExampleMain + + + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + io.helidon.config + helidon-config-encryption + + + io.helidon.security + helidon-security + + + io.helidon.security.providers + helidon-security-providers-config-vault + + + io.helidon.webserver + helidon-webserver + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-kv2 + + + io.helidon.integrations.vault.secrets + helidon-integrations-vault-secrets-transit + + + io.helidon.integrations.vault.auths + helidon-integrations-vault-auths-token + + + io.helidon.integrations.oci + helidon-integrations-oci-vault + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-core + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/DigestService.java b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/DigestService.java new file mode 100644 index 00000000..f088a3d1 --- /dev/null +++ b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/DigestService.java @@ -0,0 +1,59 @@ +/* + * 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. + */ + +package io.helidon.examples.security.vaults; + +import java.nio.charset.StandardCharsets; + +import io.helidon.security.Security; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +class DigestService implements Service { + private final Security security; + + DigestService(Security security) { + this.security = security; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/digest/{config}/{text}", this::digest) + .get("/verify/{config}/{text}/{digest:.*}", this::verify); + } + + private void digest(ServerRequest req, ServerResponse res) { + String configName = req.path().param("config"); + String text = req.path().param("text"); + + security.digest(configName, text.getBytes(StandardCharsets.UTF_8)) + .forSingle(res::send) + .exceptionally(res::send); + } + + private void verify(ServerRequest req, ServerResponse res) { + String configName = req.path().param("config"); + String text = req.path().param("text"); + String digest = req.path().param("digest"); + + security.verifyDigest(configName, text.getBytes(StandardCharsets.UTF_8), digest) + .map(it -> it ? "Valid" : "Invalid") + .forSingle(res::send) + .exceptionally(res::send); + } +} diff --git a/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/EncryptionService.java b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/EncryptionService.java new file mode 100644 index 00000000..b8a99674 --- /dev/null +++ b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/EncryptionService.java @@ -0,0 +1,57 @@ +/* + * 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. + */ + +package io.helidon.examples.security.vaults; + +import java.nio.charset.StandardCharsets; + +import io.helidon.security.Security; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +class EncryptionService implements Service { + private final Security security; + + EncryptionService(Security security) { + this.security = security; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/encrypt/{config}/{text:.*}", this::encrypt) + .get("/decrypt/{config}/{cipherText:.*}", this::decrypt); + } + + private void encrypt(ServerRequest req, ServerResponse res) { + String configName = req.path().param("config"); + String text = req.path().param("text"); + + security.encrypt(configName, text.getBytes(StandardCharsets.UTF_8)) + .forSingle(res::send) + .exceptionally(res::send); + } + + private void decrypt(ServerRequest req, ServerResponse res) { + String configName = req.path().param("config"); + String cipherText = req.path().param("cipherText"); + + security.decrypt(configName, cipherText) + .forSingle(res::send) + .exceptionally(res::send); + } +} diff --git a/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/SecretsService.java b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/SecretsService.java new file mode 100644 index 00000000..93af482a --- /dev/null +++ b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/SecretsService.java @@ -0,0 +1,43 @@ +/* + * 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. + */ + +package io.helidon.examples.security.vaults; + +import io.helidon.security.Security; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +class SecretsService implements Service { + private final Security security; + + SecretsService(Security security) { + this.security = security; + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/{name}", this::secret); + } + + private void secret(ServerRequest req, ServerResponse res) { + String secretName = req.path().param("name"); + security.secret(secretName, "default-" + secretName) + .forSingle(res::send) + .exceptionally(res::send); + } +} diff --git a/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/VaultsExampleMain.java b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/VaultsExampleMain.java new file mode 100644 index 00000000..943337e9 --- /dev/null +++ b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/VaultsExampleMain.java @@ -0,0 +1,112 @@ +/* + * 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. + */ + +package io.helidon.examples.security.vaults; + +import java.util.concurrent.TimeUnit; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.security.Security; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.file; + +/** + * Main class of the example based on configuration. + */ +public final class VaultsExampleMain { + private VaultsExampleMain() { + } + + /** + * Start the server. + * + * @param args ignored + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + // as I cannot share my configuration of OCI, let's combine the configuration + // from my home directory with the one compiled into the jar + // when running this example, you can either update the application.yaml in resources directory + // or use the same approach + Config config = buildConfig(); + + System.out.println("This example requires a valid OCI Vault, Secret and keys configured. It also requires " + + "a Hashicorp Vault running with preconfigured data. Please see README.md"); + + Security security = Security.create(config.get("security")); + + WebServer server = WebServer.builder() + .config(config.get("server")) + .routing(Routing.builder() + .register("/secrets", new SecretsService(security)) + .register("/encryption", new EncryptionService(security)) + .register("/digests", new DigestService(security))) + .build() + .start() + .await(10, TimeUnit.SECONDS); + + System.out.println("Server started on port: " + server.port()); + String baseAddress = "http://localhost:" + server.port() + "/"; + + System.out.println("Secrets endpoints:"); + System.out.println(); + System.out.println("OCI secret:"); + System.out.println("\t" + baseAddress + "secrets/password"); + System.out.println("Config secret:"); + System.out.println("\t" + baseAddress + "secrets/token"); + System.out.println("HCP Vault secret:"); + System.out.println("\t" + baseAddress + "secrets/username"); + System.out.println(); + + System.out.println("Encryption endpoints:"); + System.out.println("OCI encrypted:"); + System.out.println("\t" + baseAddress + "encryption/encrypt/crypto-1/text"); + System.out.println("\t" + baseAddress + "encryption/decrypt/crypto-1/cipherText"); + System.out.println("Config encrypted:"); + System.out.println("\t" + baseAddress + "encryption/encrypt/crypto-2/text"); + System.out.println("\t" + baseAddress + "encryption/decrypt/crypto-2/cipherText"); + System.out.println("HCP Vault encrypted:"); + System.out.println("\t" + baseAddress + "encryption/encrypt/crypto-3/text"); + System.out.println("\t" + baseAddress + "encryption/decrypt/crypto-3/cipherText"); + System.out.println(); + + System.out.println("Signature/HMAC endpoints:"); + System.out.println("OCI Signature:"); + System.out.println("\t" + baseAddress + "digests/digest/sig-1/text"); + System.out.println("\t" + baseAddress + "digests/verify/sig-1/text/signature"); + System.out.println("HCP Vault Signature:"); + System.out.println("\t" + baseAddress + "digests/digest/sig-2/text"); + System.out.println("\t" + baseAddress + "digests/digest/sig-2/text/signature"); + System.out.println("HCP Vault HMAC:"); + System.out.println("\t" + baseAddress + "digests/digest/hmac-1/text"); + System.out.println("\t" + baseAddress + "digests/digest/hmac-2/text/hmac"); + } + + private static Config buildConfig() { + return Config.builder() + .sources( + // you can use this file to override the defaults that are built-in + file(System.getProperty("user.home") + "/helidon/conf/examples.yaml").optional(), + // in jar file (see src/main/resources/application.yaml) + classpath("application.yaml")) + .build(); + } +} diff --git a/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/package-info.java b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/package-info.java new file mode 100644 index 00000000..5dfa30de --- /dev/null +++ b/examples/security/vaults/src/main/java/io/helidon/examples/security/vaults/package-info.java @@ -0,0 +1,20 @@ +/* + * 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 of basic vault operations available in {@link io.helidon.security.Security}. + */ +package io.helidon.examples.security.vaults; diff --git a/examples/security/vaults/src/main/resources/application.yaml b/examples/security/vaults/src/main/resources/application.yaml new file mode 100644 index 00000000..f2328b35 --- /dev/null +++ b/examples/security/vaults/src/main/resources/application.yaml @@ -0,0 +1,92 @@ +# +# 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. +# + +# +# All Hashicorp Vault configuration is commented out, as this PR only handles OCI +# This should be added in HCP Vault PR +# + +server: + port: 8080 + +app.token: "argb-urgx-harsps" + +vault: + token: "myroot" + address: "http://localhost:8200" + +security: + providers: + - config-vault: + master-password: "very much secret" + - vault-kv2: + address: "${vault.address}" + token: "${vault.token}" + - vault-transit: + address: "${vault.address}" + token: "${vault.token}" + - oci-vault: + # We need either the cryptographic endpoint (recommended), or management-endpoint configured + # Also ~/.oci/config must be correctly set up, otherwise all information is required here + # The crypto endpoint may be configured per digest/encryption, as we may use more than one + # vault in a single application + # vault.cryptographic-endpoint: "${oci.properties.cryptographic-endpoint}" + # vault.management-endpoint: "${oci.properties.management-endpoint}" + secrets: + - name: "username" + provider: "vault-kv2" + config: + path: "app/secret" + key: "username" + - name: "changeit" + provider: "oci-vault" + config: + ocid: "${oci.properties.secret-ocid}" + - name: "token" + provider: "config-vault" + config: + value: "${app.token}" + digest: + # Signatures and hmac + - name: "sig-2" + provider: "vault-transit" + config: + type: "signature" + key-name: "signature-key" + - name: "hmac-1" + provider: "vault-transit" + config: + type: "hmac" + key-name: "encryption-key" + - name: "sig-1" + provider: "oci-vault" + config: + cryptographic-endpoint: "${oci.properties.cryptographic-endpoint}" + key-ocid: "${oci.properties.vault-rsa-key-ocid}" + algorithm: "SHA_256_RSA_PKCS_PSS" + encryption: + # encryption and decryption + - name: "crypto-3" + provider: "vault-transit" + config: + key-name: "encryption-key" + - name: "crypto-1" + provider: "oci-vault" + config: + cryptographic-endpoint: "${oci.properties.cryptographic-endpoint}" + key-ocid: "${oci.properties.vault-key-ocid}" + - name: "crypto-2" + provider: "config-vault" diff --git a/examples/security/vaults/src/main/resources/logging.properties b/examples/security/vaults/src/main/resources/logging.properties new file mode 100644 index 00000000..02a8f58f --- /dev/null +++ b/examples/security/vaults/src/main/resources/logging.properties @@ -0,0 +1,27 @@ +# +# 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. +# + +# Send messages to the console +handlers=io.helidon.common.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 + +io.helidon.level=INFO +io.helidon.integrations.level=INFO diff --git a/examples/security/webserver-digest-auth/README.md b/examples/security/webserver-digest-auth/README.md new file mode 100644 index 00000000..969649f4 --- /dev/null +++ b/examples/security/webserver-digest-auth/README.md @@ -0,0 +1,31 @@ +# Web Server Integration and Digest Authentication + +This example demonstrates Integration of WebServer +based application with Security component and Digest authentication (from HttpAuthProvider). + +## Contents + +There are two examples with exactly the same behavior: +1. DigestExampleMain - shows how to programmatically secure application +2. DigestExampleConfigMain - shows how to secure application with configuration + 1. see src/main/resources/application.yaml for configuration + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-webserver-digest-auth.jar +``` + +Try the application: + +The application starts on a random port, the following assumes it is `56551` +```shell +export PORT=42677 +curl http://localhost:56551/public +curl --digest -u "jill:changeit" http://localhost:56551/noRoles +curl --digest -u "john:changeit" http://localhost:56551/user +curl --digest -u "jack:changeit" http://localhost:56551/admin +curl -v --digest -u "john:changeit" http://localhost:56551/deny +curl --digest -u "jack:changeit" http://localhost:56551/noAuthn +``` diff --git a/examples/security/webserver-digest-auth/pom.xml b/examples/security/webserver-digest-auth/pom.xml new file mode 100644 index 00000000..21fad2a5 --- /dev/null +++ b/examples/security/webserver-digest-auth/pom.xml @@ -0,0 +1,99 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-webserver-digest-auth + 1.0.0-SNAPSHOT + Helidon Security Examples Digest Authentication + + + This example demonstrates Integration of RX Web Server based application with Security component and Digest + authentication (from HttpAuthProvider). + + + + io.helidon.security.examples.webserver.digest.DigestExampleConfigMain + + + + + io.helidon.security.integration + helidon-security-integration-webserver + + + io.helidon.config + helidon-config-encryption + + + io.helidon.security.providers + helidon-security-providers-http-auth + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + io.helidon.jersey + helidon-jersey-client + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-core + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleBuilderMain.java b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleBuilderMain.java new file mode 100644 index 00000000..64bee43d --- /dev/null +++ b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleBuilderMain.java @@ -0,0 +1,169 @@ +/* + * Copyright (c) 2018, 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.security.examples.webserver.digest; + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.Set; + +import io.helidon.common.LogConfig; +import io.helidon.common.http.MediaType; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.httpauth.HttpDigest; +import io.helidon.security.providers.httpauth.HttpDigestAuthProvider; +import io.helidon.security.providers.httpauth.SecureUserStore; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Example of HTTP digest authentication with WebServer fully configured programmatically. + */ +public final class DigestExampleBuilderMain { + // used from unit tests + private static WebServer server; + // simple approach to user storage - for real world, use data store... + private static Map users = new HashMap<>(); + + private static final char[] HEX_ARRAY = "0123456789abcdef".toCharArray(); + + static { + users.put("jack", new MyUser("jack", "changeit".toCharArray(), Set.of("user", "admin"))); + users.put("jill", new MyUser("jill", "changeit".toCharArray(), Set.of("user"))); + users.put("john", new MyUser("john", "changeit".toCharArray(), Set.of())); + } + + private DigestExampleBuilderMain() { + } + + /** + * Starts this example. Programmatical configuration. See standard output for instructions. + * + * @param args ignored + */ + public static void main(String[] args) { + // load logging configuration + LogConfig.configureRuntime(); + + // build routing (same as done in application.conf) + Routing routing = Routing.builder() + .register(buildWebSecurity().securityDefaults(WebSecurity.authenticate())) + .get("/noRoles", WebSecurity.enforce()) + .get("/user[/{*}]", WebSecurity.rolesAllowed("user")) + .get("/admin", WebSecurity.rolesAllowed("admin")) + // audit is not enabled for GET methods by default + .get("/deny", WebSecurity.rolesAllowed("deny").audit()) + // roles allowed imply authn and authz + .any("/noAuthn", WebSecurity.rolesAllowed("admin") + .authenticationOptional() + .audit()) + .get("/{*}", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Hello, you are: \n" + securityContext + .map(ctx -> ctx.user().orElse(SecurityContext.ANONYMOUS).toString()) + .orElse("Security context is null")); + }) + .build(); + + // start server (blocks until started) + server = DigestExampleUtil.startServer(routing); + } + + private static WebSecurity buildWebSecurity() { + Security security = Security.builder() + .addAuthenticationProvider( + HttpDigestAuthProvider.builder() + .realm("mic") + .digestServerSecret("changeit".toCharArray()) + .userStore(buildUserStore()), + "digest-auth") + .build(); + return WebSecurity.create(security); + } + + private static SecureUserStore buildUserStore() { + return login -> Optional.ofNullable(users.get(login)); + } + + static WebServer getServer() { + return server; + } + + private static class MyUser implements SecureUserStore.User { + private String login; + private char[] password; + private Set roles; + + private MyUser(String login, char[] password, Set roles) { + this.login = login; + this.password = password; + this.roles = roles; + } + + private char[] password() { + return password; + } + + private static String bytesToHex(byte[] bytes) { + char[] hexChars = new char[bytes.length * 2]; + for (int j = 0; j < bytes.length; j++) { + int v = bytes[j] & 0xFF; + hexChars[j * 2] = HEX_ARRAY[v >>> 4]; + hexChars[j * 2 + 1] = HEX_ARRAY[v & 0x0F]; + } + return new String(hexChars); + } + + @Override + public boolean isPasswordValid(char[] password) { + return Arrays.equals(password(), password); + } + + @Override + public Optional digestHa1(String realm, HttpDigest.Algorithm algorithm) { + if (algorithm != HttpDigest.Algorithm.MD5) { + throw new IllegalArgumentException("Unsupported algorithm " + algorithm); + } + String a1 = login + ":" + realm + ":" + new String(password()); + byte[] bytes = a1.getBytes(StandardCharsets.UTF_8); + MessageDigest digest; + try { + digest = MessageDigest.getInstance("MD5"); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException("MD5 algorithm should be supported", e); + } + return Optional.of(bytesToHex(digest.digest(bytes))); + } + + @Override + public Set roles() { + return roles; + } + + @Override + public String login() { + return login; + } + } +} diff --git a/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleConfigMain.java b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleConfigMain.java new file mode 100644 index 00000000..b29db733 --- /dev/null +++ b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleConfigMain.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2018, 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.security.examples.webserver.digest; + +import java.util.Optional; + +import io.helidon.common.LogConfig; +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.security.SecurityContext; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Example of HTTP digest authentication with RX Web Server fully configured in config file. + */ +public final class DigestExampleConfigMain { + // used from unit tests + private static WebServer server; + + private DigestExampleConfigMain() { + } + + /** + * Starts this example. Loads configuration from src/main/resources/application.conf. See standard output for instructions. + * + * @param args ignored + */ + public static void main(String[] args) { + // load logging configuration + LogConfig.configureRuntime(); + + // load configuration + Config config = Config.create(); + + // build routing (security is loaded from config) + Routing routing = Routing.builder() + // helper method to load both security and web server security from configuration + .register(WebSecurity.create(config.get("security"))) + // web server does not (yet) have possibility to configure routes in config files, so explicit... + .get("/{*}", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Hello, you are: \n" + securityContext + .map(ctx -> ctx.user().orElse(SecurityContext.ANONYMOUS).toString()) + .orElse("Security context is null")); + }) + .build(); + + server = DigestExampleUtil.startServer(routing); + } + + static WebServer getServer() { + return server; + } +} diff --git a/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleUtil.java b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleUtil.java new file mode 100644 index 00000000..c9d347cf --- /dev/null +++ b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/DigestExampleUtil.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2018, 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.security.examples.webserver.digest; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Utility for this example. + */ +final class DigestExampleUtil { + private static final int START_TIMEOUT_SECONDS = 10; + + private DigestExampleUtil() { + } + + static WebServer startServer(Routing routing) { + WebServer server = WebServer.create(routing); + long t = System.nanoTime(); + + CountDownLatch cdl = new CountDownLatch(1); + + server.start().thenAccept(webServer -> { + long time = System.nanoTime() - t; + System.out.printf("Server started in %d ms ms%n", TimeUnit.MILLISECONDS.convert(time, TimeUnit.NANOSECONDS)); + System.out.printf("Started server on localhost:%d%n", webServer.port()); + System.out.println(); + System.out.println("Users:"); + System.out.println("Jack/password in roles: user, admin"); + System.out.println("Jill/password in roles: user"); + System.out.println("John/password in no roles"); + System.out.println(); + System.out.println("***********************"); + System.out.println("** Endpoints: **"); + System.out.println("***********************"); + System.out.println("No authentication:"); + System.out.printf(" http://localhost:%1$d/public%n", webServer.port()); + System.out.println("No roles required, authenticated:"); + System.out.printf(" http://localhost:%1$d/noRoles%n", webServer.port()); + System.out.println("User role required:"); + System.out.printf(" http://localhost:%1$d/user%n", webServer.port()); + System.out.println("Admin role required:"); + System.out.printf(" http://localhost:%1$d/admin%n", webServer.port()); + System.out.println("Always forbidden (uses role nobody is in), audited:"); + System.out.printf(" http://localhost:%1$d/deny%n", webServer.port()); + System.out.println( + "Admin role required, authenticated, authentication optional, audited (always forbidden - challenge is not " + + "returned as authentication is optional):"); + System.out.printf(" http://localhost:%1$d/noAuthn%n", webServer.port()); + System.out.println(); + cdl.countDown(); + }); + + try { + cdl.await(START_TIMEOUT_SECONDS, TimeUnit.SECONDS); + } catch (InterruptedException e) { + throw new RuntimeException("Failed to start server within defined timeout: " + START_TIMEOUT_SECONDS + " seconds", e); + } + return server; + } +} diff --git a/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/package-info.java b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/package-info.java new file mode 100644 index 00000000..b6444483 --- /dev/null +++ b/examples/security/webserver-digest-auth/src/main/java/io/helidon/security/examples/webserver/digest/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2018, 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 of Digest authentication on top of RX web server. + * + * @see io.helidon.security.examples.webserver.digest.DigestExampleConfigMain Configuration based example + * @see io.helidon.security.examples.webserver.digest.DigestExampleBuilderMain Programmatic example + */ +package io.helidon.security.examples.webserver.digest; diff --git a/examples/security/webserver-digest-auth/src/main/resources/application.yaml b/examples/security/webserver-digest-auth/src/main/resources/application.yaml new file mode 100644 index 00000000..151f5917 --- /dev/null +++ b/examples/security/webserver-digest-auth/src/main/resources/application.yaml @@ -0,0 +1,56 @@ +# +# Copyright (c) 2016, 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. +# + +security: + config: + # Configuration of secured config (encryption of passwords in property files) + # Set to true for production - if set to true, clear text passwords will cause failure + require-encryption: false + providers: + - http-digest-auth: + realm: "mic" + server-secret: "changeit" + users: + - login: "jack" + password: "${CLEAR=changeit}" + roles: ["user", "admin"] + - login: "jill" + password: "${CLEAR=changeit}" + roles: ["user"] + - login: "john" + password: "${CLEAR=changeit}" + roles: [] + web-server: + # Configuration of integration with web server + defaults: + authenticate: true + paths: + - path: "/noRoles" + methods: ["get"] + - path: "/user[/{*}]" + methods: ["get"] + roles-allowed: ["user"] + - path: "/admin" + methods: ["get"] + roles-allowed: ["admin"] + - path: "/deny" + methods: ["get"] + roles-allowed: ["deny"] + audit: true + - path: "/noAuthn" + roles-allowed: ["admin"] + authentication-optional: true + audit: true diff --git a/examples/security/webserver-digest-auth/src/main/resources/logging.properties b/examples/security/webserver-digest-auth/src/main/resources/logging.properties new file mode 100644 index 00000000..6c50cf04 --- /dev/null +++ b/examples/security/webserver-digest-auth/src/main/resources/logging.properties @@ -0,0 +1,23 @@ +# +# Copyright (c) 2018, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +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 +#All log level details +.level=WARNING +io.helidon.webserver.level=FINEST +io.helidon.security.level=FINEST +AUDIT.level=FINEST diff --git a/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleBuilderTest.java b/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleBuilderTest.java new file mode 100644 index 00000000..832d0f3c --- /dev/null +++ b/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleBuilderTest.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2018, 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.security.examples.webserver.digest; + +import java.io.IOException; + +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link DigestExampleBuilderMain}. + */ +public class DigestExampleBuilderTest extends DigestExampleTest { + + private static WebServer server; + + @BeforeAll + public static void startServer() throws IOException { + // start the test + DigestExampleBuilderMain.main(new String[0]); + server = DigestExampleBuilderMain.getServer(); + } + + @AfterAll + public static void stopServer() throws InterruptedException { + stopServer(server); + } + + @Override + String getServerBase() { + return "http://localhost:" + server.port(); + } +} diff --git a/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleConfigTest.java b/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleConfigTest.java new file mode 100644 index 00000000..617fd98f --- /dev/null +++ b/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleConfigTest.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2018, 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.security.examples.webserver.digest; + +import java.io.IOException; + +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link DigestExampleConfigMain}. + */ +public class DigestExampleConfigTest extends DigestExampleTest { + + private static WebServer server; + + @BeforeAll + public static void startServer() throws IOException { + // start the test + DigestExampleConfigMain.main(new String[0]); + server = DigestExampleConfigMain.getServer(); + } + + @AfterAll + public static void stopServer() throws InterruptedException { + stopServer(server); + } + + @Override + String getServerBase() { + return "http://localhost:" + server.port(); + } +} diff --git a/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleTest.java b/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleTest.java new file mode 100644 index 00000000..1fd90845 --- /dev/null +++ b/examples/security/webserver-digest-auth/src/test/java/io/helidon/security/examples/webserver/digest/DigestExampleTest.java @@ -0,0 +1,199 @@ +/* + * Copyright (c) 2018, 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.security.examples.webserver.digest; + +import java.util.Set; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.core.Response; + +import io.helidon.webserver.WebServer; + +import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.glassfish.jersey.client.authentication.HttpAuthenticationFeature.HTTP_AUTHENTICATION_PASSWORD; +import static org.glassfish.jersey.client.authentication.HttpAuthenticationFeature.HTTP_AUTHENTICATION_USERNAME; +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.CoreMatchers.notNullValue; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Abstract class with tests for this example (used by programmatic and config based tests). + */ +public abstract class DigestExampleTest { + private static Client client; + private static Client authFeatureClient; + + @BeforeAll + public static void classInit() { + client = ClientBuilder.newClient(); + authFeatureClient = ClientBuilder.newClient() + .register(HttpAuthenticationFeature.digest()); + } + + @AfterAll + public static void classDestroy() { + client.close(); + authFeatureClient.close(); + } + + static void stopServer(WebServer server) throws InterruptedException { + CountDownLatch cdl = new CountDownLatch(1); + long t = System.nanoTime(); + server.shutdown().thenAccept(webServer -> { + long time = System.nanoTime() - t; + System.out.println("Server shutdown in " + TimeUnit.NANOSECONDS.toMillis(time) + " ms"); + cdl.countDown(); + }); + + if (!cdl.await(5, TimeUnit.SECONDS)) { + throw new IllegalStateException("Failed to shutdown server within 5 seconds"); + } + } + + abstract String getServerBase(); + + //now for the tests + @Test + public void testPublic() { + //Must be accessible without authentication + try (Response response = client.target(getServerBase() + "/public").request().get()) { + assertThat(response.getStatus(), is(200)); + String entity = response.readEntity(String.class); + assertThat(entity, containsString("")); + } + } + + @Test + public void testNoRoles() { + String url = getServerBase() + "/noRoles"; + + testNotAuthorized(client, url); + + //Must be accessible with authentication - to everybody + testProtected(url, "jack", "changeit", Set.of("admin", "user"), Set.of()); + testProtected(url, "jill", "changeit", Set.of("user"), Set.of("admin")); + testProtected(url, "john", "changeit", Set.of(), Set.of("admin", "user")); + } + + @Test + public void testUserRole() { + String url = getServerBase() + "/user"; + + testNotAuthorized(client, url); + + //Jack and Jill allowed (user role) + testProtected(url, "jack", "changeit", Set.of("admin", "user"), Set.of()); + testProtected(url, "jill", "changeit", Set.of("user"), Set.of("admin")); + testProtectedDenied(url, "john", "changeit"); + } + + @Test + public void testAdminRole() { + String url = getServerBase() + "/admin"; + + testNotAuthorized(client, url); + + //Only jack is allowed - admin role... + testProtected(url, "jack", "changeit", Set.of("admin", "user"), Set.of()); + testProtectedDenied(url, "jill", "changeit"); + testProtectedDenied(url, "john", "changeit"); + } + + @Test + public void testDenyRole() { + String url = getServerBase() + "/deny"; + + testNotAuthorized(client, url); + + // nobody has the correct role + testProtectedDenied(url, "jack", "changeit"); + testProtectedDenied(url, "jill", "changeit"); + testProtectedDenied(url, "john", "changeit"); + } + + @Test + public void getNoAuthn() { + String url = getServerBase() + "/noAuthn"; + //Must NOT be accessible without authentication + try (Response response = client.target(url).request().get()) { + // authentication is optional, so we are not challenged, only forbidden, as the role can never be there... + assertThat(response.getStatus(), is(403)); + + // doesn't matter, we are never challenged + testProtectedDenied(url, "jack", "changeit"); + testProtectedDenied(url, "jill", "changeit"); + testProtectedDenied(url, "john", "changeit"); + } + } + + private void testNotAuthorized(Client client, String uri) { + //Must NOT be accessible without authentication + try (Response response = client.target(uri).request().get()) { + assertThat(response.getStatus(), is(401)); + String header = response.getHeaderString("WWW-Authenticate"); + assertThat(header, notNullValue()); + assertThat(header.toLowerCase(), containsString("digest")); + assertThat(header, containsString("mic")); + } + } + + private Response callProtected(String uri, String username, String password) { + // here we call the endpoint + return authFeatureClient.target(uri) + .request() + .property(HTTP_AUTHENTICATION_USERNAME, username) + .property(HTTP_AUTHENTICATION_PASSWORD, password) + .get(); + } + + private void testProtectedDenied(String uri, + String username, + String password) { + + try (Response response = callProtected(uri, username, password)) { + assertThat(response.getStatus(), is(403)); + } + } + + private void testProtected(String uri, + String username, + String password, + Set expectedRoles, + Set invalidRoles) { + + try (Response response = callProtected(uri, username, password)) { + String entity = response.readEntity(String.class); + + assertThat(response.getStatus(), is(200)); + + // check login + assertThat(entity, containsString("id='" + username + "'")); + // check roles + expectedRoles.forEach(role -> assertThat(entity, containsString(":" + role))); + invalidRoles.forEach(role -> assertThat(entity, not(containsString(":" + role)))); + } + } +} diff --git a/examples/security/webserver-signatures/README.md b/examples/security/webserver-signatures/README.md new file mode 100644 index 00000000..e43d3812 --- /dev/null +++ b/examples/security/webserver-signatures/README.md @@ -0,0 +1,30 @@ +# Web Server Integration and HTTP Signatures + +This example demonstrates Integration of WebServer +based application with Security component and HTTP Signatures. + +## Contents + +There are two examples with exactly the same behavior +1. builder - shows how to programmatically secure application +2. config - shows how to secure application with configuration + 1. see `src/main/resources/service1.yaml` and `src/main/resources/service2.conf` for configuration +3. Each consists of two services + 1. "public" service protected by basic authentication (for simplicity) + 2. "internal" service protected by a combination of basic authentication (for user propagation) and http signature + (for service authentication) + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-security-webserver-signatures.jar +``` + +Try the endpoints: + +```shell +curl -u "jack:changeit" http://localhost:8080/service1 +curl -u "jill:changeit" http://localhost:8080/service1-rsa +curl -v -u "john:changeit" http://localhost:8080/service1 +``` diff --git a/examples/security/webserver-signatures/pom.xml b/examples/security/webserver-signatures/pom.xml new file mode 100644 index 00000000..8db10070 --- /dev/null +++ b/examples/security/webserver-signatures/pom.xml @@ -0,0 +1,102 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.security + helidon-examples-security-webserver-signatures + 1.0.0-SNAPSHOT + Helidon Security Examples HTTP Signatures + + + This example demonstrates Integration of RX Web Server based application with Security component and HTTP + Signatures + + + + io.helidon.security.examples.signatures.SignatureExampleConfigMain + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.security.integration + helidon-security-integration-webserver + + + io.helidon.security.integration + helidon-security-integration-jersey-client + + + io.helidon.bundles + helidon-bundles-security + + + io.helidon.bundles + helidon-bundles-config + + + io.helidon.config + helidon-config-hocon + + + io.helidon.webclient + helidon-webclient + + + io.helidon.webclient + helidon-webclient-security + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleBuilderMain.java b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleBuilderMain.java new file mode 100644 index 00000000..3b506a3c --- /dev/null +++ b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleBuilderMain.java @@ -0,0 +1,242 @@ + +/* + * Copyright (c) 2018, 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.security.examples.signatures; + +import java.nio.file.Paths; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import io.helidon.common.configurable.Resource; +import io.helidon.common.http.MediaType; +import io.helidon.common.pki.KeyConfig; +import io.helidon.security.CompositeProviderFlag; +import io.helidon.security.CompositeProviderSelectionPolicy; +import io.helidon.security.Security; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.security.providers.common.OutboundConfig; +import io.helidon.security.providers.common.OutboundTarget; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.security.providers.httpauth.SecureUserStore; +import io.helidon.security.providers.httpsign.HttpSignProvider; +import io.helidon.security.providers.httpsign.InboundClientDefinition; +import io.helidon.security.providers.httpsign.OutboundTargetDefinition; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Example of authentication of service with http signatures, using configuration file as much as possible. + */ +public class SignatureExampleBuilderMain { + private static final Map USERS = new HashMap<>(); + // used from unit tests + private static WebServer service1Server; + private static WebServer service2Server; + + static { + addUser("jack", "changeit", List.of("user", "admin")); + addUser("jill", "changeit", List.of("user")); + addUser("john", "changeit", List.of()); + } + + private SignatureExampleBuilderMain() { + } + + public static WebServer getService1Server() { + return service1Server; + } + + public static WebServer getService2Server() { + return service2Server; + } + + private static void addUser(String user, String password, List roles) { + USERS.put(user, new SecureUserStore.User() { + @Override + public String login() { + return user; + } + + char[] password() { + return password.toCharArray(); + } + + @Override + public boolean isPasswordValid(char[] password) { + return Arrays.equals(password(), password); + } + + @Override + public Collection roles() { + return roles; + } + }); + } + + /** + * Starts this example. + * + * @param args ignored + */ + public static void main(String[] args) { + // to allow us to set host header explicitly + System.setProperty("sun.net.http.allowRestrictedHeaders", "true"); + + // start service 2 first, as it is required by service 1 + service2Server = SignatureExampleUtil.startServer(routing2(), 9080); + service1Server = SignatureExampleUtil.startServer(routing1(), 8080); + + System.out.println("Signature example: from builder"); + System.out.println(); + System.out.println("Users:"); + System.out.println("jack/changeit in roles: user, admin"); + System.out.println("jill/changeit in roles: user"); + System.out.println("john/changeit in no roles"); + System.out.println(); + System.out.println("***********************"); + System.out.println("** Endpoints: **"); + System.out.println("***********************"); + System.out.println("Basic authentication, user role required, will use symmetric signatures for outbound:"); + System.out.printf(" http://localhost:%1$d/service1%n", service1Server.port()); + System.out.println("Basic authentication, user role required, will use asymmetric signatures for outbound:"); + System.out.printf(" http://localhost:%1$d/service1-rsa%n", service2Server.port()); + System.out.println(); + } + + private static Routing routing2() { + + // build routing (security is loaded from config) + return Routing.builder() + // helper method to load both security and web server security from configuration + .register(WebSecurity.create(security2()).securityDefaults(WebSecurity.authenticate())) + .get("/service2", WebSecurity.rolesAllowed("user")) + .get("/service2-rsa", WebSecurity.rolesAllowed("user")) + // web server does not (yet) have possibility to configure routes in config files, so explicit... + .get("/{*}", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Response from service2, you are: \n" + securityContext + .flatMap(SecurityContext::user) + .map(Subject::toString) + .orElse("Security context is null") + ", service: " + securityContext + .flatMap(SecurityContext::service) + .map(Subject::toString)); + }) + .build(); + } + + private static Routing routing1() { + // build routing (security is loaded from config) + return Routing.builder() + .register(WebSecurity.create(security1()).securityDefaults(WebSecurity.authenticate())) + .get("/service1", + WebSecurity.rolesAllowed("user"), + (req, res) -> SignatureExampleUtil.processService1Request(req, res, "/service2", service2Server.port())) + .get("/service1-rsa", + WebSecurity.rolesAllowed("user"), + (req, res) -> SignatureExampleUtil.processService1Request(req, res, "/service2-rsa", service2Server.port())) + .build(); + } + + private static Security security2() { + return Security.builder() + .providerSelectionPolicy(CompositeProviderSelectionPolicy.builder() + .addAuthenticationProvider("http-signatures", CompositeProviderFlag.OPTIONAL) + .addAuthenticationProvider("basic-auth") + .build()) + .addProvider(HttpBasicAuthProvider.builder() + .realm("mic") + .userStore(users()), + "basic-auth") + .addProvider(HttpSignProvider.builder() + .addInbound(InboundClientDefinition.builder("service1-hmac") + .principalName("Service1 - HMAC signature") + .hmacSecret("changeit") + .build()) + .addInbound(InboundClientDefinition.builder("service1-rsa") + .principalName("Service1 - RSA signature") + .publicKeyConfig(KeyConfig.keystoreBuilder() + .keystore(Resource.create(Paths.get( + "src/main/resources/keystore.p12"))) + .keystorePassphrase("changeit".toCharArray()) + .certAlias("service_cert") + .build()) + .build()) + .build(), + "http-signatures") + .build(); + } + + private static Security security1() { + return Security.builder() + .providerSelectionPolicy(CompositeProviderSelectionPolicy.builder() + .addOutboundProvider("basic-auth") + .addOutboundProvider("http-signatures") + .build()) + .addProvider(HttpBasicAuthProvider.builder() + .realm("mic") + .userStore(users()) + .addOutboundTarget(OutboundTarget.builder("propagate-all").build()), + "basic-auth") + .addProvider(HttpSignProvider.builder() + .outbound(OutboundConfig.builder() + .addTarget(hmacTarget()) + .addTarget(rsaTarget()) + .build()), + "http-signatures") + .build(); + } + + private static OutboundTarget rsaTarget() { + return OutboundTarget.builder("service2-rsa") + .addHost("localhost") + .addPath("/service2-rsa.*") + .customObject(OutboundTargetDefinition.class, + OutboundTargetDefinition.builder("service1-rsa") + .privateKeyConfig(KeyConfig.keystoreBuilder() + .keystore(Resource.create(Paths.get( + "src/main/resources/keystore.p12"))) + .keystorePassphrase("changeit".toCharArray()) + .keyAlias("myPrivateKey") + .build()) + .build()) + .build(); + } + + private static OutboundTarget hmacTarget() { + return OutboundTarget.builder("service2") + .addHost("localhost") + .addPath("/service2") + .customObject( + OutboundTargetDefinition.class, + OutboundTargetDefinition.builder("service1-hmac") + .hmacSecret("changeit") + .build()) + .build(); + } + + private static SecureUserStore users() { + return login -> Optional.ofNullable(USERS.get(login)); + } +} diff --git a/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleConfigMain.java b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleConfigMain.java new file mode 100644 index 00000000..887d865f --- /dev/null +++ b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleConfigMain.java @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2018, 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.security.examples.signatures; + +import java.util.Optional; + +import io.helidon.common.http.MediaType; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Example of authentication of service with http signatures, using configuration file as much as possible. + */ +public class SignatureExampleConfigMain { + + // used from unit tests + private static WebServer service1Server; + private static WebServer service2Server; + + private SignatureExampleConfigMain() { + } + + /** + * Starts this example. + * + * @param args ignored + */ + public static void main(String[] args) { + // to allow us to set host header explicitly + System.setProperty("sun.net.http.allowRestrictedHeaders", "true"); + + // start service 2 first, as it is required by service 1 + service2Server = SignatureExampleUtil.startServer(routing2(), 9080); + service1Server = SignatureExampleUtil.startServer(routing1(), 8080); + + System.out.println("Signature example: from configuration"); + System.out.println(); + System.out.println("Users:"); + System.out.println("jack/password in roles: user, admin"); + System.out.println("jill/password in roles: user"); + System.out.println("john/password in no roles"); + System.out.println(); + System.out.println("***********************"); + System.out.println("** Endpoints: **"); + System.out.println("***********************"); + System.out.println("Basic authentication, user role required, will use symmetric signatures for outbound:"); + System.out.printf(" http://localhost:%1$d/service1%n", service1Server.port()); + System.out.println("Basic authentication, user role required, will use asymmetric signatures for outbound:"); + System.out.printf(" http://localhost:%1$d/service1-rsa%n", service1Server.port()); + System.out.println(); + } + + private static Routing routing2() { + Config config = config("service2.yaml"); + // build routing (security is loaded from config) + return Routing.builder() + // helper method to load both security and web server security from configuration + .register(WebSecurity.create(config.get("security"))) + // web server does not (yet) have possibility to configure routes in config files, so explicit... + .get("/{*}", (req, res) -> { + Optional securityContext = req.context().get(SecurityContext.class); + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Response from service2, you are: \n" + securityContext + .flatMap(SecurityContext::user) + .map(Subject::toString) + .orElse("Security context is null") + ", service: " + securityContext + .flatMap(SecurityContext::service) + .map(Subject::toString)); + }) + .build(); + } + + private static Routing routing1() { + Config config = config("service1.yaml"); + + // build routing (security is loaded from config) + return Routing.builder() + // helper method to load both security and web server security from configuration + .register(WebSecurity.create(config.get("security"))) + // web server does not (yet) have possibility to configure routes in config files, so explicit... + .get("/service1", (req, res) -> { + SignatureExampleUtil.processService1Request(req, res, "/service2", service2Server.port()); + }) + .get("/service1-rsa", (req, res) -> { + SignatureExampleUtil.processService1Request(req, res, "/service2-rsa", service2Server.port()); + }) + .build(); + } + + private static Config config(String confFile) { + // load configuration + return Config.builder() + .sources(ConfigSources.classpath(confFile)) + .build(); + } + + static WebServer getService1Server() { + return service1Server; + } + + static WebServer getService2Server() { + return service2Server; + } +} diff --git a/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleUtil.java b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleUtil.java new file mode 100644 index 00000000..87a9c7e4 --- /dev/null +++ b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/SignatureExampleUtil.java @@ -0,0 +1,103 @@ +/* + * Copyright (c) 2018, 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.security.examples.signatures; + +import java.util.Optional; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.security.SecurityContext; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.security.WebClientSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.WebServer; + +/** + * Common code for both examples (builder and config based). + */ +final class SignatureExampleUtil { + private static final WebClient CLIENT = WebClient.builder() + .addService(WebClientSecurity.create()) + .build(); + + private static final int START_TIMEOUT_SECONDS = 10; + + private SignatureExampleUtil() { + } + + /** + * Start a web server. + * + * @param routing routing to configre + * @return started web server instance + */ + public static WebServer startServer(Routing routing, int port) { + WebServer server = WebServer.builder(routing) + .port(port) + .build(); + long t = System.nanoTime(); + + CountDownLatch cdl = new CountDownLatch(1); + + server.start().thenAccept(webServer -> { + long time = System.nanoTime() - t; + + System.out.printf("Server started in %d ms ms%n", TimeUnit.MILLISECONDS.convert(time, TimeUnit.NANOSECONDS)); + System.out.printf("Started server on localhost:%d%n", webServer.port()); + System.out.println(); + cdl.countDown(); + }).exceptionally(throwable -> { + throw new RuntimeException("Failed to start server", throwable); + }); + + try { + cdl.await(START_TIMEOUT_SECONDS, TimeUnit.SECONDS); + } catch (InterruptedException e) { + throw new RuntimeException("Failed to start server within defined timeout: " + START_TIMEOUT_SECONDS + " seconds"); + } + return server; + } + + static void processService1Request(ServerRequest req, ServerResponse res, String path, int svc2port) { + Optional securityContext = req.context().get(SecurityContext.class); + + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + + securityContext.ifPresentOrElse(context -> { + CLIENT.get() + .uri("http://localhost:" + svc2port + path) + .request() + .thenAccept(it -> { + if (it.status() == Http.Status.OK_200) { + it.content().as(String.class) + .thenAccept(res::send) + .exceptionally(throwable -> { + res.send("Getting server response failed!"); + return null; + }); + } else { + res.send("Request failed, status: " + it.status()); + } + }); + + }, () -> res.send("Security context is null")); + } +} diff --git a/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/package-info.java b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/package-info.java new file mode 100644 index 00000000..83b795ca --- /dev/null +++ b/examples/security/webserver-signatures/src/main/java/io/helidon/security/examples/signatures/package-info.java @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2018, 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 of HTTP Signatures (both inbound and outbound). + * Based on RFC draft: https://tools.ietf + * .org/html/draft-cavage-http-signatures-03 + */ +package io.helidon.security.examples.signatures; diff --git a/examples/security/webserver-signatures/src/main/resources/keystore.p12 b/examples/security/webserver-signatures/src/main/resources/keystore.p12 new file mode 100644 index 00000000..96df5962 Binary files /dev/null and b/examples/security/webserver-signatures/src/main/resources/keystore.p12 differ diff --git a/examples/security/webserver-signatures/src/main/resources/service1.yaml b/examples/security/webserver-signatures/src/main/resources/service1.yaml new file mode 100644 index 00000000..7af4407c --- /dev/null +++ b/examples/security/webserver-signatures/src/main/resources/service1.yaml @@ -0,0 +1,83 @@ +# +# Copyright (c) 2016, 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. +# + +security: + config: + # Configuration of secured config (encryption of passwords in property files) + # Set to true for production - if set to true, clear text passwords will cause failure + require-encryption: false + + # composite provider policy + provider-policy: + type: "COMPOSITE" + outbound: + - name: "http-basic-auth" + - name: "http-signatures" + + providers: + # Security provider - basic authentication (supports roles) - default + - http-basic-auth: + realm: "helidon" + users: + - login: "jack" + password: "${CLEAR=changeit}" + roles: ["user", "admin"] + - login: "jill" + # master password is "changeit", password is "changeit" + password: "${CLEAR=changeit}" + roles: ["user"] + - login: "john" + password: "${CLEAR=changeit}" + roles: [] + outbound: + - name: "propagate-all" + # only configured for outbound security + - http-signatures: + outbound: + - name: "service2" + hosts: ["localhost"] + paths: ["/service2"] + signature: + key-id: "service1-hmac" + hmac.secret: "${CLEAR=changeit}" + - name: "service2-rsa" + hosts: ["localhost"] + paths: ["/service2-rsa.*"] + signature: + key-id: "service1-rsa" + private-key: + keystore: + # path to keystore + resource.path: "src/main/resources/keystore.p12" + # Keystore type + # PKCS12, JSK or RSA (not really a keystore, but directly the linux style private key unencrypted) + # defaults to jdk default + type: "PKCS12" + # password of the keystore + passphrase: "changeit" + # alias of the key to sign request + key.alias: "myPrivateKey" + web-server: + # Configuration of integration with web server + defaults: + authenticate: true + paths: + - path: "/service1" + methods: ["get"] + roles-allowed: ["user"] + - path: "/service1-rsa" + methods: ["get"] + roles-allowed: ["user"] diff --git a/examples/security/webserver-signatures/src/main/resources/service2.yaml b/examples/security/webserver-signatures/src/main/resources/service2.yaml new file mode 100644 index 00000000..55f426a5 --- /dev/null +++ b/examples/security/webserver-signatures/src/main/resources/service2.yaml @@ -0,0 +1,75 @@ +# +# Copyright (c) 2016, 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. +# + +security: + config: + # Configuration of secured config (encryption of passwords in property files) + # Set to true for production - if set to true, clear text passwords will cause failure + require-encryption: false + # composite provider policy + provider-policy: + type: "COMPOSITE" + authentication: + # first resolve signature, then resolve basic-auth + - name: "http-signatures" + flag: "OPTIONAL" + # must be present + - name: "http-basic-auth" + providers: + # Signatures + - http-signatures: + # only inbound configured, no outbound calls + inbound: + keys: + - key-id: "service1-hmac" + principal-name: "Service1 - HMAC signature" + hmac.secret: "${CLEAR=changeit}" + - key-id: "service1-rsa" + principal-name: "Service1 - RSA signature" + public-key: + keystore: + # path to keystore + resource.path: "src/main/resources/keystore.p12" + # Keystore type + # PKCS12 or JKS + # defaults to jdk default + # keystore-type: "PKCS12" + # password of the keystore + passphrase: "changeit" + # alias of the certificate to get public key from + cert.alias: "service_cert" + # Security provider - basic authentication (supports roles) + - http-basic-auth: + realm: "helidon" + users: + - login: "jack" + password: "${CLEAR=changeit}" + roles: [ "user", "admin" ] + - login: "jill" + password: "${CLEAR=changeit}" + roles: [ "user" ] + - login: "john" + password: "${CLEAR=changeit}" + roles: [] + web-server: + # Configuration of integration with web server + defaults: + authenticate: true + paths: + - path: "/service2" + roles-allowed: [ "user" ] + - path: "/service2-rsa" + roles-allowed: [ "user" ] \ No newline at end of file diff --git a/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleBuilderMainTest.java b/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleBuilderMainTest.java new file mode 100644 index 00000000..86aa6368 --- /dev/null +++ b/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleBuilderMainTest.java @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2018, 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.security.examples.signatures; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link SignatureExampleBuilderMain}. + */ +public class SignatureExampleBuilderMainTest extends SignatureExampleTest { + private static int svc1Port; + private static int svc2Port; + + @BeforeAll + public static void initClass() { + SignatureExampleBuilderMain.main(null); + svc1Port = SignatureExampleBuilderMain.getService1Server().port(); + svc2Port = SignatureExampleBuilderMain.getService2Server().port(); + } + + @AfterAll + public static void destroyClass() throws InterruptedException { + stopServer(SignatureExampleBuilderMain.getService2Server()); + stopServer(SignatureExampleBuilderMain.getService1Server()); + } + + @Override + int getService1Port() { + return svc1Port; + } + + @Override + int getService2Port() { + return svc2Port; + } +} diff --git a/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleConfigMainTest.java b/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleConfigMainTest.java new file mode 100644 index 00000000..9600cd21 --- /dev/null +++ b/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleConfigMainTest.java @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2018, 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.security.examples.signatures; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; + +/** + * Unit test for {@link SignatureExampleBuilderMain}. + */ +public class SignatureExampleConfigMainTest extends SignatureExampleTest { + private static int svc1Port; + private static int svc2Port; + + @BeforeAll + public static void initClass() { + SignatureExampleConfigMain.main(null); + svc1Port = SignatureExampleConfigMain.getService1Server().port(); + svc2Port = SignatureExampleConfigMain.getService2Server().port(); + } + + @AfterAll + public static void destroyClass() throws InterruptedException { + stopServer(SignatureExampleConfigMain.getService2Server()); + stopServer(SignatureExampleConfigMain.getService1Server()); + } + + @Override + int getService1Port() { + return svc1Port; + } + + @Override + int getService2Port() { + return svc2Port; + } +} diff --git a/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleTest.java b/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleTest.java new file mode 100644 index 00000000..7ae2c76a --- /dev/null +++ b/examples/security/webserver-signatures/src/test/java/io/helidon/security/examples/signatures/SignatureExampleTest.java @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2018, 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.security.examples.signatures; + +import java.util.Set; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import io.helidon.security.Security; +import io.helidon.security.providers.httpauth.HttpBasicAuthProvider; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.security.WebClientSecurity; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static io.helidon.security.providers.httpauth.HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_PASSWORD; +import static io.helidon.security.providers.httpauth.HttpBasicAuthProvider.EP_PROPERTY_OUTBOUND_USER; +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.not; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Actual unit tests are shared by config and builder example. + */ +public abstract class SignatureExampleTest { + private static WebClient client; + + @BeforeAll + public static void classInit() { + Security security = Security.builder() + .addProvider(HttpBasicAuthProvider.builder().build()) + .build(); + + client = WebClient.builder() + .addService(WebClientSecurity.create(security)) + .build(); + } + + static void stopServer(WebServer server) throws InterruptedException { + CountDownLatch cdl = new CountDownLatch(1); + long t = System.nanoTime(); + server.shutdown().thenAccept(webServer -> { + long time = System.nanoTime() - t; + System.out.println("Server shutdown in " + TimeUnit.NANOSECONDS.toMillis(time) + " ms"); + cdl.countDown(); + }); + + if (!cdl.await(5, TimeUnit.SECONDS)) { + throw new IllegalStateException("Failed to shutdown server within 5 seconds"); + } + } + + abstract int getService1Port(); + + abstract int getService2Port(); + + @Test + public void testService1Hmac() { + testProtected("http://localhost:" + getService1Port() + "/service1", + "jack", + "changeit", + Set.of("user", "admin"), + Set.of(), + "Service1 - HMAC signature"); + } + + @Test + public void testService1Rsa() { + testProtected("http://localhost:" + getService1Port() + "/service1-rsa", + "jack", + "changeit", + Set.of("user", "admin"), + Set.of(), + "Service1 - RSA signature"); + } + + + private void testProtected(String uri, + String username, + String password, + Set expectedRoles, + Set invalidRoles, + String service) { + client.get() + .uri(uri) + .property(EP_PROPERTY_OUTBOUND_USER, username) + .property(EP_PROPERTY_OUTBOUND_PASSWORD, password) + .request(String.class) + .thenAccept(it -> { + // check login + assertThat(it, containsString("id='" + username + "'")); + // check roles + expectedRoles.forEach(role -> assertThat(it, containsString(":" + role))); + invalidRoles.forEach(role -> assertThat(it, not(containsString(":" + role)))); + + assertThat(it, containsString("id='" + service + "'")); + }) + .await(); + } +} diff --git a/examples/todo-app/README.md b/examples/todo-app/README.md new file mode 100644 index 00000000..bdaae1f0 --- /dev/null +++ b/examples/todo-app/README.md @@ -0,0 +1,41 @@ +# TODO Demo Application + +This application implements todomvc[http://todomvc.com] with two microservices +implemented with Helidon MP and Helidon SE. + +## Build + +```shell +mvn clean package +docker build -t helidon-examples-todo-cassandra cassandra +``` + +## Run + +```shell +docker run -d -p 9042:9042 --name helidon-examples-todo-cassandra helidon-examples-todo-cassandra +docker run --name zipkin -d -p 9411:9411 openzipkin/zipkin +java -jar backend/target/helidon-examples-todo-backend.jar & +java -jar frontend/target/helidon-examples-todo-frontend.jar & +``` + +- Open http://localhost:8080 in your browser +- Login with a Google account +- Add some TODO entries +- Check-out the traces at http://localhost:9411 + +### HTTP proxy + +If you want to run behind an HTTP proxy: + +```shell +export security_providers_0_google_dash_login_proxy_dash_host=proxy.acme.com +export security_providers_0_google_dash_login_proxy_dash_port=80 +``` + +## Stop + +```shell +kill %1 %2 +docker rm -f zipkin helidon-examples-todo-cassandra +``` diff --git a/examples/todo-app/backend/pom.xml b/examples/todo-app/backend/pom.xml new file mode 100644 index 00000000..47990769 --- /dev/null +++ b/examples/todo-app/backend/pom.xml @@ -0,0 +1,161 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-mp + 2.6.8-SNAPSHOT + + + io.helidon.examples.todos + helidon-examples-todo-backend + 1.0.0-SNAPSHOT + Helidon Examples TODO Demo Backend + + + Back-end part of the application uses Helidon MP + + + + io.helidon.demo.todos.backend.Main + 3.10.2 + 4.3.1.0 + 4.9.0 + 4.9.0 + 3.0.2 + 1.32 + + + + + + com.datastax.cassandra + cassandra-driver-core + ${version.lib.cassandra} + + + io.dropwizard.metrics + metrics-core + + + + + org.yaml + snakeyaml + ${version.lib.snakeyaml.override} + + + + + + + io.helidon.microprofile.bundles + helidon-microprofile-core + + + io.helidon.microprofile + helidon-microprofile-security + + + io.helidon.security.providers + helidon-security-providers-google-login + + + io.helidon.security.providers + helidon-security-providers-http-sign + + + io.helidon.security.providers + helidon-security-providers-abac + + + io.helidon.microprofile.tracing + helidon-microprofile-tracing + + + io.helidon.tracing + helidon-tracing-zipkin + + + com.datastax.cassandra + cassandra-driver-core + + + org.junit.jupiter + junit-jupiter-api + test + + + io.helidon.microprofile.tests + helidon-microprofile-tests-junit5 + test + + + org.cassandraunit + cassandra-unit + ${version.cassandra.unit} + test + + + com.datastax.oss + java-driver-core + ${version.datastax.driver.core} + test + + + com.datastax.oss + java-driver-query-builder + ${version.datastax.driver.query.builder} + test + + + com.codahale.metrics + metrics-core + ${version.codahale.metrics.core} + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + org.jboss.jandex + jandex-maven-plugin + + + make-index + + + + + + diff --git a/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/DbService.java b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/DbService.java new file mode 100644 index 00000000..5dc28c83 --- /dev/null +++ b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/DbService.java @@ -0,0 +1,245 @@ +/* + * Copyright (c) 2017, 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.demo.todos.backend; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.function.Supplier; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; + +import io.helidon.config.Config; +import io.helidon.security.SecurityException; + +import com.datastax.driver.core.BoundStatement; +import com.datastax.driver.core.Cluster; +import com.datastax.driver.core.PreparedStatement; +import com.datastax.driver.core.ResultSet; +import com.datastax.driver.core.Row; +import com.datastax.driver.core.Session; +import io.opentracing.Span; +import io.opentracing.SpanContext; +import io.opentracing.tag.Tags; +import io.opentracing.util.GlobalTracer; + +/** + * A service showing to access a no-SQL database. + */ +@ApplicationScoped +public class DbService { + + private static final String LIST_QUERY = "select * from backend where user = ? ALLOW FILTERING"; + private static final String GET_QUERY = "select * from backend where id = ?"; + private static final String INSERT_QUERY = "insert into backend (id, user, message, completed, created)" + + " values (?, ?, ?, ?, ?)"; + private static final String UPDATE_QUERY = "update backend set message = ?, completed = ? where id = ? if user = ?"; + private static final String DELETE_QUERY = "delete from backend where id = ?"; + + private final Session session; + private final PreparedStatement listStatement; + private final PreparedStatement getStatement; + private final PreparedStatement insertStatement; + private final PreparedStatement updateStatement; + private final PreparedStatement deleteStatement; + + /** + * Create a new {@code DbService} instance. + * @param config the configuration root + */ + @Inject + public DbService(Config config) { + Cluster.Builder clusterBuilder = Cluster.builder() + .withoutMetrics(); + + Config cConfig = config.get("cassandra"); + cConfig.get("servers").asList(Config.class).stream() + .flatMap(Collection::stream) + .map(server -> server.get("host").asString().get()) + .forEach(clusterBuilder::addContactPoints); + cConfig.get("port").asInt().ifPresent(clusterBuilder::withPort); + + Cluster cluster = clusterBuilder.build(); + session = cluster.connect("backend"); + + listStatement = session.prepare(LIST_QUERY); + getStatement = session.prepare(GET_QUERY); + insertStatement = session.prepare(INSERT_QUERY); + updateStatement = session.prepare(UPDATE_QUERY); + deleteStatement = session.prepare(DELETE_QUERY); + } + + /** + * Invoke the given supplier and wrap it around with a tracing + * {@code Span}. + * @param the supplier return type + * @param tracingSpan the parent span to use + * @param operation the name of the operation + * @param supplier the supplier to invoke + * @return the object returned by the supplier + */ + private static T execute(SpanContext tracingSpan, String operation, Supplier supplier) { + Span span = startSpan(tracingSpan, operation); + + try { + return supplier.get(); + } catch (Exception e) { + Tags.ERROR.set(span, true); + span.log(Map.of("event", "error", "error.object", e)); + throw e; + } finally { + span.finish(); + } + } + + /** + * Utility method to create and start a child span of the given span. + * @param span the parent span + * @param operation the name for the new span + * @return the created span + */ + private static Span startSpan(SpanContext span, String operation) { + return GlobalTracer.get().buildSpan(operation).asChildOf(span).start(); + } + + /** + * Retrieve the TODOs entries from the database. + * @param tracingSpan the tracing span to use + * @param userId the database user id + * @return retrieved entries as {@code Iterable} + */ + Iterable list(SpanContext tracingSpan, String userId) { + return execute(tracingSpan, "cassandra::list", () -> { + BoundStatement bs = listStatement.bind(userId); + ResultSet rs = session.execute(bs); + + List result = new ArrayList<>(); + for (Row r : rs) { + result.add(Todo.fromDb(r)); + } + + return result; + }); + } + + /** + * Get the entry identified by the given ID from the database. + * @param tracingSpan the tracing span to use + * @param id the ID identifying the entry to retrieve + * @param userId the database user id + * @return retrieved entry as {@code Optional} + */ + Optional get(SpanContext tracingSpan, String id, String userId) { + return execute(tracingSpan, "cassandra::get", () -> getNoContext(id, userId)); + } + + /** + * Get the entry identified by the given ID from the database, fails if the + * entry is not associated with the given {@code userId}. + * @param id the ID identifying the entry to retrieve + * @param userId the database user id + * @return retrieved entry as {@code Optional} + */ + private Optional getNoContext(String id, String userId) { + BoundStatement bs = getStatement.bind(id); + ResultSet rs = session.execute(bs); + Row one = rs.one(); + if (null == one) { + return Optional.empty(); + } + Todo result = Todo.fromDb(one); + if (userId.equals(result.getUserId())) { + return Optional.of(result); + } + throw new SecurityException(String.format( + "User %s attempted to read record %s of another user", + userId, id)); + } + + /** + * Update the given entry in the database. + * @param tracingSpan the tracing span to use + * @param entry the entry to update + * @return {@code Optional} of updated entry if the update was successful, + * otherwise an empty {@code Optional} + */ + Optional update(SpanContext tracingSpan, Todo entry) { + return execute(tracingSpan, "cassandra::update", () -> { + //update backend set message = ? + // , completed = ? where id = ? if user = ? + BoundStatement bs = updateStatement.bind( + entry.getTitle(), + entry.getCompleted(), + entry.getId(), + entry.getUserId()); + ResultSet execute = session.execute(bs); + + if (execute.wasApplied()) { + return Optional.of(entry); + } else { + return Optional.empty(); + } + }); + } + + /** + * Delete the entry identified by the given ID in from the database. + * @param tracingSpan the tracing span to use + * @param id the ID identifying the entry to delete + * @param userId the database user id + * @return the deleted entry as {@code Optional} + */ + Optional delete(SpanContext tracingSpan, String id, String userId) { + return execute(tracingSpan, "cassandra::delete", + () -> getNoContext(id, userId) + .map(todo -> { + BoundStatement bs = deleteStatement.bind(id); + ResultSet rs = session.execute(bs); + if (!rs.wasApplied()) { + throw new RuntimeException("Failed to delete todo: " + + todo); + } + return todo; + })); + } + + /** + * Insert a new entry in the database. + * @param tracingSpan the tracing span to use + * @param entry the entry to insert + */ + void insert(SpanContext tracingSpan, Todo entry) { + execute(tracingSpan, "cassandra::insert", () -> { + BoundStatement bs = insertStatement + .bind(entry.getId(), + entry.getUserId(), + entry.getTitle(), + entry.getCompleted(), + new Date(entry.getCreated())); + + ResultSet execute = session.execute(bs); + if (!execute.wasApplied()) { + throw new RuntimeException("Failed to insert todo: " + entry); + } + return null; + }); + } +} diff --git a/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/JaxRsBackendResource.java b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/JaxRsBackendResource.java new file mode 100644 index 00000000..d0238b9d --- /dev/null +++ b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/JaxRsBackendResource.java @@ -0,0 +1,179 @@ +/* + * Copyright (c) 2017, 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.demo.todos.backend; + +import java.util.Collections; +import java.util.UUID; + +import javax.enterprise.context.ApplicationScoped; +import javax.inject.Inject; +import javax.json.Json; +import javax.json.JsonArrayBuilder; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; +import javax.ws.rs.Consumes; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import io.helidon.security.Principal; +import io.helidon.security.SecurityContext; +import io.helidon.security.Subject; +import io.helidon.security.annotations.Authenticated; +import io.helidon.security.annotations.Authorized; + +import io.opentracing.Tracer; +import org.eclipse.microprofile.opentracing.Traced; + +/** + * The TODO backend REST service. + */ +@Path("/api/backend") +@Authenticated +@Authorized +@ApplicationScoped +public class JaxRsBackendResource { + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private final DbService backendService; + private final Tracer tracer; + + /** + * Create new {@code JaxRsBackendResource} instance. + * @param dbs the database service facade to use + * @param tracer tracer to use + */ + @Inject + public JaxRsBackendResource(DbService dbs, Tracer tracer) { + this.backendService = dbs; + this.tracer = tracer; + } + + /** + * Retrieve all TODO entries. + * + * @param context security context to map the user + * @return the response with the retrieved entries as entity + */ + @GET + @Produces(MediaType.APPLICATION_JSON) + @Traced(operationName = "jaxrs:list") + public Response list(@Context SecurityContext context) { + JsonArrayBuilder builder = JSON.createArrayBuilder(); + backendService.list(tracer.activeSpan().context(), getUserId(context)) + .forEach(data -> builder.add(data.forRest())); + return Response.ok(builder.build()).build(); + } + + /** + * Get the TODO entry identified by the given ID. + * @param id the ID of the entry to retrieve + * @param context security context to map the user + * @return the response with the retrieved entry as entity + */ + @GET + @Path("/{id}") + @Produces(MediaType.APPLICATION_JSON) + public Response get(@PathParam("id") String id, @Context SecurityContext context) { + + return backendService + .get(tracer.activeSpan().context(), id, getUserId(context)) + .map(Todo::forRest) + .map(Response::ok) + .orElse(Response.status(Response.Status.NOT_FOUND)) + .build(); + } + + /** + * Delete the TODO entry identified by the given ID. + * @param id the id of the entry to delete + * @param context security context to map the user + * @return the response with the deleted entry as entity + */ + @DELETE + @Path("/{id}") + @Produces(MediaType.APPLICATION_JSON) + public Response delete(@PathParam("id") String id, @Context SecurityContext context) { + + return backendService + .delete(tracer.activeSpan().context(), id, getUserId(context)) + .map(Todo::forRest) + .map(Response::ok) + .orElse(Response.status(Response.Status.NOT_FOUND)) + .build(); + } + + /** + * Create a new TODO entry. + * @param jsonObject the value of the new entry + * @param context security context to map the user + * @return the response ({@code 200} status if successful + */ + @POST + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + public Response createIt(JsonObject jsonObject, @Context SecurityContext context) { + + String newId = UUID.randomUUID().toString(); + String userId = getUserId(context); + Todo newBackend = Todo.newTodoFromRest(jsonObject, userId, newId); + + backendService.insert(tracer.activeSpan().context(), newBackend); + + return Response.ok(newBackend.forRest()).build(); + } + + /** + * Update the TODO entry identified by the given ID. + * @param id the ID of the entry to update + * @param jsonObject the updated value of the entry + * @param context security context to map the user + * @return the response with the updated entry as entity + */ + @PUT + @Path("/{id}") + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + public Response update(@PathParam("id") String id, JsonObject jsonObject, @Context SecurityContext context) { + return backendService + .update(tracer.activeSpan().context(), Todo.fromRest(jsonObject, getUserId(context), id)) + .map(Todo::forRest) + .map(Response::ok) + .orElse(Response.status(Response.Status.NOT_FOUND)) + .build(); + } + + /** + * Get the user id from the security context. + * @param context the security context + * @return user id found in the context or {@code } otherwise + */ + private String getUserId(SecurityContext context) { + return context.user() + .map(Subject::principal) + .map(Principal::id) + .orElse(""); + } +} diff --git a/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/Main.java b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/Main.java new file mode 100644 index 00000000..584b7d26 --- /dev/null +++ b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/Main.java @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2017, 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.demo.todos.backend; + +import java.util.List; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.microprofile.server.Server; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.environmentVariables; +import static io.helidon.config.ConfigSources.file; + +/** + * Main class to start the service. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * + * @param args command line arguments + */ + public static void main(final String[] args) { + + // load logging configuration + LogConfig.configureRuntime(); + + Config config = buildConfig(); + + // as we need to use custom filter + // we need to build Server with custom config + Server server = Server.builder() + .config(config) + .build(); + + server.start(); + } + + /** + * Load the configuration from all sources. + * @return the configuration root + */ + static Config buildConfig() { + return Config.builder() + .sources(List.of( + environmentVariables(), + // expected on development machine + // to override props for dev + file("dev.yaml").optional(), + // expected in k8s runtime + // to configure testing/production values + file("prod.yaml").optional(), + // in jar file + // (see src/main/resources/application.yaml) + classpath("application.yaml"))) + // support for passwords in configuration + //.addFilter(SecureConfigFilter.fromConfig()) + .build(); + } +} diff --git a/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/Todo.java b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/Todo.java new file mode 100644 index 00000000..d1672195 --- /dev/null +++ b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/Todo.java @@ -0,0 +1,261 @@ +/* + * Copyright (c) 2017, 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.demo.todos.backend; + +import java.time.Instant; +import java.time.format.DateTimeFormatter; +import java.util.Collections; +import java.util.UUID; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonNumber; +import javax.json.JsonObject; +import javax.json.JsonObjectBuilder; + +import com.datastax.driver.core.Row; + +/** + * Data object for backend. + */ +public final class Todo { + + /** + * Date formatter to format the dates of the TODO entries. + */ + private static final DateTimeFormatter DATE_FORMAT = + DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSSVV"); + + /** + * Factory for creating JSON builders. + */ + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + /** + * The TODO ID. + */ + private String id; + + /** + * The user ID associated with this TODO. + */ + private String userId; + + /** + * The TODO title. + */ + private String title; + + /** + * The TODO completed flag. + */ + private Boolean completed; + + /** + * The TODO creation timestamp. + */ + private long created; + + /** + * Create a new {@code Todo} instance from a database entry in JSON format. + * @param jsonObject the database entry + * @return the created instance + */ + public static Todo fromDb(final JsonObject jsonObject) { + + Todo result = new Todo(); + result.id = jsonObject.getString("id"); + result.userId = jsonObject.getString("user"); + result.title = jsonObject.getString("message"); + result.completed = jsonObject.getBoolean("completed"); + result.created = Instant.from(DATE_FORMAT + .parse(jsonObject.getString("created"))).toEpochMilli(); + return result; + } + + /** + * Create a new {@code Todo} instance from a REST entry. + * The created entry will be new, i.e the {@code completed} flag will be set + * to {@code false} and the {@code created} timestamp set to the current + * time. + * @param jsonObject the REST entry + * @param userId the user ID associated with this entry + * @param id the entry ID + * @return the created instance + */ + public static Todo newTodoFromRest(final JsonObject jsonObject, + final String userId, + final String id) { + + Todo result = new Todo(); + result.id = id; + result.userId = userId; + result.title = jsonObject.getString("title"); + result.completed = jsonObject.getBoolean("completed", false); + result.created = System.currentTimeMillis(); + return result; + } + + /** + * Create a new {@code Todo} instance from a REST entry. + * @param jsonObject the REST entry + * @param userId the user ID associated with this entry + * @param id the entry ID + * @return the created instance + */ + public static Todo fromRest(final JsonObject jsonObject, + final String userId, + final String id) { + + Todo result = new Todo(); + result.id = id; + result.userId = userId; + result.title = jsonObject.getString("title", ""); + result.completed = jsonObject.getBoolean("completed"); + JsonNumber created = jsonObject.getJsonNumber("created"); + if (null != created) { + result.created = created.longValue(); + } + return result; + } + + /** + * Create a new {@code Todo} instance from a database entry. + * @param row the database entry + * @return the created instance + */ + public static Todo fromDb(final Row row) { + + Todo result = new Todo(); + result.id = row.getString("id"); + result.userId = row.getString("user"); + result.title = row.getString("message"); + result.completed = row.getBool("completed"); + result.created = row.getTimestamp("created").getTime(); + return result; + } + + /** + * Create a new {@code Todo} instance. + * The created entry will be new, i.e the {@code completed} flag will be set + * to {@code false} and the {@code created} timestamp set to the current + * time. + * @param userId the user ID associated with the new entry + * @param title the title for the new entry + * @return the created instance + */ + public static Todo create(final String userId, final String title) { + Todo result = new Todo(); + + result.id = UUID.randomUUID().toString(); + result.userId = userId; + result.title = title; + result.completed = false; + result.created = System.currentTimeMillis(); + + return result; + } + + /** + * Convert this {@code Todo} instance to the JSON database format. + * @return {@code JsonObject} + */ + public JsonObject forDb() { + //to store to DB + JsonObjectBuilder builder = JSON.createObjectBuilder(); + return builder.add("id", id) + .add("user", userId) + .add("message", title) + .add("completed", completed) + .add("created", created) + .build(); + } + + /** + * Convert this {@code Todo} instance to the JSON REST format. + * @return {@code JsonObject} + */ + public JsonObject forRest() { + //to send over to rest + JsonObjectBuilder builder = JSON.createObjectBuilder(); + return builder.add("id", id) + .add("user", userId) + .add("title", title) + .add("completed", completed) + .add("created", created) + .build(); + } + + /** + * Get the TODO ID. + * @return the {@code String} identifying this entry + */ + public String getId() { + return id; + } + + /** + * Get the user ID associated with this TODO. + * @return the {@code String} identifying the user + */ + public String getUserId() { + return userId; + } + + /** + * Get the TODO title. + * @return title + */ + public String getTitle() { + return title; + } + + /** + * Get the completed flag. + * @return completed flag. + */ + public Boolean getCompleted() { + return completed; + } + + /** + * Set the completed flag. + * @param iscomplete the completed flag value + */ + public void setCompleted(final boolean iscomplete) { + this.completed = iscomplete; + } + + /** + * Get the creation timestamp. + * @return timestamp + */ + public long getCreated() { + return created; + } + + @Override + public String toString() { + return "Todo{" + + "id='" + id + '\'' + + ", userId='" + userId + '\'' + + ", title='" + title + '\'' + + ", completed=" + completed + + ", created=" + created + + '}'; + } +} diff --git a/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/package-info.java b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/package-info.java new file mode 100644 index 00000000..111b64f6 --- /dev/null +++ b/examples/todo-app/backend/src/main/java/io/helidon/demo/todos/backend/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * TODOs Demo application backend. + */ +package io.helidon.demo.todos.backend; diff --git a/examples/todo-app/backend/src/main/resources/META-INF/beans.xml b/examples/todo-app/backend/src/main/resources/META-INF/beans.xml new file mode 100644 index 00000000..7075ac07 --- /dev/null +++ b/examples/todo-app/backend/src/main/resources/META-INF/beans.xml @@ -0,0 +1,26 @@ + + + + + diff --git a/examples/todo-app/backend/src/main/resources/application.yaml b/examples/todo-app/backend/src/main/resources/application.yaml new file mode 100644 index 00000000..8727766d --- /dev/null +++ b/examples/todo-app/backend/src/main/resources/application.yaml @@ -0,0 +1,48 @@ +# +# Copyright (c) 2018, 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. +# +env: docker + +server: + port: 8854 + host: 0.0.0.0 + +tracing: + service: "todo:back" + port: 9411 + +cassandra: + port: 9042 + servers: + - host: "localhost" + +security: + config: + require-encryption: false + aes.insecure-passphrase: "changeit" + provider-policy: + type: "COMPOSITE" + authentication: + - name: "google-login" + - name: "http-signatures" + providers: + - google-login: + client-id: "1048216952820-6a6ke9vrbjlhngbc0al0dkj9qs9tqbk2.apps.googleusercontent.com" + - abac: + - http-signatures: + inbound.keys: + - key-id: "frontend" + principal-name: "Frontend Service" + hmac.secret: "${CLEAR=changeit}" diff --git a/examples/todo-app/backend/src/main/resources/logging.properties b/examples/todo-app/backend/src/main/resources/logging.properties new file mode 100644 index 00000000..3ed94f67 --- /dev/null +++ b/examples/todo-app/backend/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# Copyright (c) 2017, 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. +# + +#All attributes details +handlers=io.helidon.common.HelidonConsoleHandler +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 + +#All log level details +.level=WARNING +io.helidon.webserver.level=INFO +io.helidon.security.level=INFO +io.helidon.tracing.level=FINE +AUDIT.level=FINEST + + diff --git a/examples/todo-app/backend/src/test/java/io/helidon/demo/todos/backend/BackendTests.java b/examples/todo-app/backend/src/test/java/io/helidon/demo/todos/backend/BackendTests.java new file mode 100644 index 00000000..52a2d5a0 --- /dev/null +++ b/examples/todo-app/backend/src/test/java/io/helidon/demo/todos/backend/BackendTests.java @@ -0,0 +1,158 @@ +/* + * 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. + */ + +package io.helidon.demo.todos.backend; + +import java.io.IOException; +import java.util.Base64; +import java.util.Properties; + +import javax.inject.Inject; +import javax.json.Json; +import javax.json.JsonArray; +import javax.json.JsonObject; +import javax.ws.rs.client.Entity; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MediaType; + +import io.helidon.common.http.Http; +import io.helidon.config.mp.MpConfigSources; +import io.helidon.config.yaml.mp.YamlMpConfigSource; +import io.helidon.microprofile.tests.junit5.Configuration; +import io.helidon.microprofile.tests.junit5.HelidonTest; + +import com.datastax.driver.core.Cluster; +import com.datastax.driver.core.Session; +import org.cassandraunit.utils.EmbeddedCassandraServerHelper; +import org.eclipse.microprofile.config.spi.ConfigProviderResolver; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +@HelidonTest +@Configuration(useExisting = true) +class BackendTests { + + private final static String CASSANDRA_HOST = "127.0.0.1"; + + @Inject + private WebTarget webTarget; + + @BeforeAll + static void init() throws IOException { + Properties cassandraProperties = initCassandra(); + + ClassLoader cl = Thread.currentThread().getContextClassLoader(); + ConfigProviderResolver configResolver = ConfigProviderResolver.instance(); + + org.eclipse.microprofile.config.Config mpConfig = configResolver.getBuilder() + .withSources(YamlMpConfigSource.create(cl.getResource("test-application.yaml")), + MpConfigSources.create(cassandraProperties)) + .build(); + + configResolver.registerConfig(mpConfig, null); + } + + @AfterAll + static void stopServer() { + EmbeddedCassandraServerHelper.cleanEmbeddedCassandra(); + } + + private static Properties initCassandra() throws IOException { + EmbeddedCassandraServerHelper.startEmbeddedCassandra(EmbeddedCassandraServerHelper.CASSANDRA_RNDPORT_YML_FILE, + 20000L); + Properties prop = new Properties(); + prop.put("cassandra.port", String.valueOf(EmbeddedCassandraServerHelper.getNativeTransportPort())); + prop.put("cassandra.servers.host.host", CASSANDRA_HOST); + + Cluster cluster = Cluster.builder() + .withoutMetrics() + .addContactPoint(CASSANDRA_HOST) + .withPort(EmbeddedCassandraServerHelper.getNativeTransportPort()) + .build(); + + Session session = cluster.connect(); + session.execute("CREATE KEYSPACE backend WITH REPLICATION = {'class' : 'SimpleStrategy', 'replication_factor' : 1};"); + session.execute( + "CREATE TABLE backend.backend (id ascii, user ascii, message ascii, completed Boolean, created timestamp, " + + "PRIMARY KEY (id));"); + session.execute("select * from backend.backend;"); + + session.close(); + cluster.close(); + + return prop; + } + + @Test + void testTodoScenario() { + String basicAuth = "Basic " + Base64.getEncoder().encodeToString("john:changeit".getBytes()); + JsonObject todo = Json.createObjectBuilder() + .add("title", "todo title") + .build(); + + // Add a new todo + JsonObject returnedTodo = webTarget + .path("/api/backend") + .request(MediaType.APPLICATION_JSON_TYPE) + .header(Http.Header.AUTHORIZATION, basicAuth) + .post(Entity.json(todo), JsonObject.class); + + assertThat(returnedTodo.getString("user"), is("john")); + assertThat(returnedTodo.getString("title"), is(todo.getString("title"))); + + // Get the todo created earlier + JsonObject fromServer = webTarget.path("/api/backend/" + returnedTodo.getString("id")) + .request(MediaType.APPLICATION_JSON_TYPE) + .header(Http.Header.AUTHORIZATION, basicAuth) + .get(JsonObject.class); + + assertThat(fromServer, is(returnedTodo)); + + // Update the todo created earlier + JsonObject updatedTodo = Json.createObjectBuilder() + .add("title", "updated title") + .add("completed", false) + .build(); + + fromServer = webTarget.path("/api/backend/" + returnedTodo.getString("id")) + .request(MediaType.APPLICATION_JSON_TYPE) + .header(Http.Header.AUTHORIZATION, basicAuth) + .put(Entity.json(updatedTodo), JsonObject.class); + + assertThat(fromServer.getString("title"), is(updatedTodo.getString("title"))); + + // Delete the todo created earlier + fromServer = webTarget.path("/api/backend/" + returnedTodo.getString("id")) + .request(MediaType.APPLICATION_JSON_TYPE) + .header(Http.Header.AUTHORIZATION, basicAuth) + .delete(JsonObject.class); + + assertThat(fromServer.getString("id"), is(returnedTodo.getString("id"))); + + // Get list of todos + JsonArray jsonValues = webTarget.path("/api/backend") + .request(MediaType.APPLICATION_JSON_TYPE) + .header(Http.Header.AUTHORIZATION, basicAuth) + .get(JsonArray.class); + + assertThat("There should be no todos on server", jsonValues.size(), is(0)); + } + +} diff --git a/examples/todo-app/backend/src/test/resources/test-application.yaml b/examples/todo-app/backend/src/test/resources/test-application.yaml new file mode 100644 index 00000000..299eed13 --- /dev/null +++ b/examples/todo-app/backend/src/test/resources/test-application.yaml @@ -0,0 +1,40 @@ +# +# 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. +# + +# increase importance +config_ordinal: 500 + +# we use custom config and Helidon JUnit integration, must allow initializer +mp: + initializer: + allow: true + no-warn: true + +server: + port: 0 + host: localhost + +tracing: + service: "todo:back" + enabled: false + +security: + providers: + - http-basic-auth: + realm: "helidon" + users: + - login: "john" + password: "changeit" diff --git a/examples/todo-app/cassandra/Dockerfile b/examples/todo-app/cassandra/Dockerfile new file mode 100644 index 00000000..b41a1b50 --- /dev/null +++ b/examples/todo-app/cassandra/Dockerfile @@ -0,0 +1,27 @@ +# +# Copyright (c) 2017, 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. +# + +FROM cassandra:3.11.16 + +ADD startup.sh / + +RUN chmod -v u=rx,og-rwx /startup.sh + +ENTRYPOINT ["/startup.sh"] + +EXPOSE 7000 7001 7199 9042 9160 + +CMD ["cassandra", "-f"] diff --git a/examples/todo-app/cassandra/startup.sh b/examples/todo-app/cassandra/startup.sh new file mode 100644 index 00000000..0cb1765d --- /dev/null +++ b/examples/todo-app/cassandra/startup.sh @@ -0,0 +1,42 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# +set -e + +echo 'Starting Cassandra database' +/docker-entrypoint.sh "$@" > /var/log/cassandra.log & + +echo 'Waiting for database to become available' +COUNT='1' +while test $COUNT -lt '120' && ! timeout 1 bash -c 'cat < /dev/null > /dev/tcp/127.0.0.1/9042' > /dev/null 2>&1 ; do + if [ "$((COUNT%10))" -eq '0' ]; then + echo " ...$COUNT s" + fi + sleep 1 + COUNT=$((COUNT+1)) +done + +echo 'Creating todos table' +cqlsh -e " + CREATE KEYSPACE backend WITH REPLICATION = {'class' : 'SimpleStrategy', 'replication_factor' : 1}; + CREATE TABLE backend.backend (id ascii, user ascii, message ascii, completed Boolean, created timestamp, PRIMARY KEY (id)); + select * from backend.backend; +" \ + || true + +echo 'Opening database log file' +echo '-------------------------' +tail -f /var/log/cassandra.log diff --git a/examples/todo-app/frontend/pom.xml b/examples/todo-app/frontend/pom.xml new file mode 100644 index 00000000..167fee39 --- /dev/null +++ b/examples/todo-app/frontend/pom.xml @@ -0,0 +1,159 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.todo + helidon-examples-todo-frontend + 1.0.0-SNAPSHOT + Helidon Examples TODO Demo Frontend + + + Front-end part of the application, uses Helidon SE + + + + io.helidon.demo.todos.frontend.Main + ${mainClass} + + + + + io.helidon.common + helidon-common + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.webclient + helidon-webclient + + + io.helidon.webclient + helidon-webclient-security + + + io.helidon.webclient + helidon-webclient-tracing + + + io.helidon.webserver + helidon-webserver-access-log + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.tracing + helidon-tracing + + + io.helidon.tracing + helidon-tracing-zipkin + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + io.helidon.config + helidon-config-encryption + + + io.helidon.security + helidon-security + + + io.helidon.security.providers + helidon-security-providers-google-login + + + io.helidon.security.providers + helidon-security-providers-abac + + + io.helidon.security.providers + helidon-security-providers-http-sign + + + io.helidon.security.integration + helidon-security-integration-webserver + + + io.helidon.metrics + helidon-metrics-api + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + + + io.helidon.security.providers + helidon-security-providers-http-auth + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/BackendServiceClient.java b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/BackendServiceClient.java new file mode 100644 index 00000000..c39cea7c --- /dev/null +++ b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/BackendServiceClient.java @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2017, 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.demo.todos.frontend; + +import java.util.function.Function; + +import javax.json.JsonArray; +import javax.json.JsonObject; + +import io.helidon.common.http.Http.ResponseStatus.Family; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webclient.security.WebClientSecurity; +import io.helidon.webclient.tracing.WebClientTracing; +import io.helidon.webserver.HttpException; + +/** + * Client to invoke the backend service. + */ +final class BackendServiceClient { + + private final WebClient client; + + BackendServiceClient(Config config) { + String serviceEndpoint = config.get("services.backend.endpoint").asString().get(); + this.client = WebClient.builder() + .useSystemServiceLoader(false) + .addService(WebClientTracing.create()) + .addService(WebClientSecurity.create()) + .addMediaSupport(JsonpSupport.create()) + .baseUri(serviceEndpoint + "/api/backend").build(); + } + + /** + * Retrieve all entries from the backend. + * + * @return single with all records + */ + Single list() { + return client.get() + .request() + .flatMapSingle(processResponse(JsonArray.class)); + } + + /** + * Retrieve the entry identified by the given ID. + * + * @param id the ID identifying the entry to retrieve + * @return retrieved entry as a {@code JsonObject} + */ + Single get(String id) { + return client.get() + .path(id) + .request() + .flatMapSingle(processResponse(JsonObject.class)); + } + + /** + * Delete the entry identified by the given ID. + * + * @param id the ID identifying the entry to delete + * @return deleted entry as a {@code JsonObject} + */ + Single deleteSingle(String id) { + return client.delete() + .path(id) + .request() + .flatMapSingle(processResponse(JsonObject.class)); + } + + /** + * Create a new entry. + * + * @param json the new entry value to create as {@code JsonObject} + * @return created entry as {@code JsonObject} + */ + Single create(JsonObject json) { + return client.post() + .submit(json) + .flatMapSingle(processResponse(JsonObject.class)); + } + + /** + * Update an entry identified by the given ID. + * + * @param id the ID identifying the entry to update + * @param json the update entry value as {@code JsonObject} + * @return updated entry as {@code JsonObject} + */ + Single update(String id, JsonObject json) { + return client.put() + .path(id) + .submit(json) + .flatMapSingle(processResponse(JsonObject.class)); + } + + private Function> processResponse(Class clazz) { + return response -> { + if (response.status().family() != Family.SUCCESSFUL) { + return Single.error(new HttpException("backend error", response.status())); + } + return response.content().as(clazz); + }; + } +} diff --git a/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/Main.java b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/Main.java new file mode 100644 index 00000000..534e5798 --- /dev/null +++ b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/Main.java @@ -0,0 +1,159 @@ +/* + * Copyright (c) 2017, 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.demo.todos.frontend; + +import java.time.Duration; +import java.util.List; + +import io.helidon.common.LogConfig; +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.config.FileSystemWatcher; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.security.Security; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.accesslog.AccessLogSupport; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +import io.opentracing.Tracer; + +import static io.helidon.config.ConfigSources.classpath; +import static io.helidon.config.ConfigSources.environmentVariables; +import static io.helidon.config.ConfigSources.file; +import static io.helidon.config.PollingStrategies.regular; + +/** + * Main class to start the service. + */ +public final class Main { + + /** + * Interval for config polling. + */ + private static final Long POLLING_INTERVAL = 5L; + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * + * @param args command line arguments + */ + public static void main(final String[] args) { + + // load logging configuration + LogConfig.configureRuntime(); + + Config config = buildConfig(); + + Security security = Security.create(config.get("security")); + + // create a web server + WebServer server = WebServer.builder() + .routing(createRouting(security, config)) + .config(config.get("webserver")) + .addMediaSupport(JsonpSupport.create()) + .tracer(registerTracer(config)) + .build(); + + // start the web server + server.start().whenComplete(Main::started); + } + + /** + * Create a {@code Tracer} instance using the given {@code Config}. + * @param config the configuration root + * @return the created {@code Tracer} + */ + private static Tracer registerTracer(Config config) { + return TracerBuilder.create(config.get("tracing")).build(); + } + + /** + * Create the web server routing and register all handlers. + * @param security the security features + * @param config the configuration root + * @return the created {@code Routing} + */ + private static Routing createRouting(Security security, Config config) { + return Routing.builder() + .register(AccessLogSupport.create()) + // register metrics features (on "/metrics") + .register(MetricsSupport.create()) + // register security features + .register(WebSecurity.create(security, config.get("security"))) + // redirect POST / to GET / + .post("/", (req, res) -> { + res.addHeader(Http.Header.LOCATION, "/"); + res.status(Http.Status.SEE_OTHER_303); + res.send(); + }) + // register static content support (on "/") + .register(StaticContentSupport.builder("/WEB").welcomeFileName("index.html")) + // register API handler (on "/api") - this path is secured (see application.yaml) + .register("/api", new TodoService(new BackendServiceClient(config))) + .build(); + } + + /** + * Handle web server started event: if successful print server started + * message in the console with the corresponding URL, otherwise print an + * error message and exit the application. + * @param webServer the {@code WebServer} instance + * @param throwable if non {@code null}, indicate a server startup error + */ + private static void started(WebServer webServer, Throwable throwable) { + if (throwable == null) { + System.out.println("WEB server is up! http://localhost:" + webServer.port()); + } else { + throwable.printStackTrace(System.out); + System.exit(1); + } + } + + /** + * Load the configuration from all sources. + * @return the configuration root + */ + private static Config buildConfig() { + return Config.builder() + .sources(List.of( + environmentVariables(), + // expected on development machine + // to override props for dev + file("dev.yaml") + .changeWatcher(FileSystemWatcher.create()) + .optional(), + // expected in k8s runtime + // to configure testing/production values + file("prod.yaml") + .pollingStrategy(regular(Duration.ofSeconds(POLLING_INTERVAL))) + .optional(), + // in jar file + // (see src/main/resources/application.yaml) + classpath("application.yaml"))) + .build(); + } +} diff --git a/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/TodoService.java b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/TodoService.java new file mode 100644 index 00000000..26542bd4 --- /dev/null +++ b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/TodoService.java @@ -0,0 +1,153 @@ +/* + * Copyright (c) 2018, 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.demo.todos.frontend; + +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.Metadata; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.eclipse.microprofile.metrics.MetricType; +import org.eclipse.microprofile.metrics.MetricUnits; + +/** + * TODO service. + *

+ * An entry is structured as follows: + * { 'title': string, 'completed': boolean, 'id': string } + *

+ * The IDs are server generated on the initial POST operation (so they are not + * included in that case). + *

+ * Here is a summary of the operations: + * GET /api/todo: Get all entries + * GET /api/todo/{id}: Get an entry by ID + * POST /api/todo: Create a new entry, created entry is returned + * DELETE /api/todo/{id}: Delete an entry, deleted entry is returned + * PUT /api/todo/{id}: Update an entry, updated entry is returned + */ +public final class TodoService implements Service { + + private final BackendServiceClient bsc; + private final Counter createCounter; + private final Counter updateCounter; + private final Counter deleteCounter; + + /** + * Create a new {@code TodosHandler} instance. + * + * @param bsc the {@code BackendServiceClient} to use + */ + TodoService(BackendServiceClient bsc) { + MetricRegistry registry = RegistryFactory.getInstance().getRegistry(MetricRegistry.Type.APPLICATION); + this.bsc = bsc; + this.createCounter = registry.counter("created"); + this.updateCounter = registry.counter("updates"); + this.deleteCounter = registry.counter(Metadata.builder() + .withName("deletes") + .withDisplayName("deletes") + .withDescription("Number of deleted todos") + .withType(MetricType.COUNTER) + .withUnit(MetricUnits.NONE) + .build()); + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/todo/{id}", this::get) + .delete("/todo/{id}", this::delete) + .put("/todo/{id}", this::update) + .get("/todo", this::list) + .post("/todo", this::create); + } + + /** + * Handler for {@code POST /todo}. + * + * @param req the server request + * @param res the server response + */ + private void create(ServerRequest req, ServerResponse res) { + req.content() + .as(JsonObject.class) + .flatMapSingle(bsc::create) + .peek(ignored -> createCounter.inc()) + .onError(res::send) + .forSingle(json -> { + res.status(Http.Status.CREATED_201); + res.send(json); + }); + } + + /** + * Handler for {@code GET /todo}. + * + * @param req the server request + * @param res the server response + */ + private void list(ServerRequest req, ServerResponse res) { + bsc.list() + .onError(res::send) + .forSingle(res::send); + } + + /** + * Handler for {@code PUT /todo/id}. + * + * @param req the server request + * @param res the server response + */ + private void update(ServerRequest req, ServerResponse res) { + req.content() + .as(JsonObject.class) + .flatMapSingle(json -> bsc.update(req.path().param("id"), json)) + .peek(ignored -> updateCounter.inc()) + .onError(res::send) + .forSingle(res::send); + } + + /** + * Handler for {@code DELETE /todo/id}. + * + * @param req the server request + * @param res the server response + */ + private void delete(ServerRequest req, ServerResponse res) { + bsc.deleteSingle(req.path().param("id")) + .peek(ignored -> deleteCounter.inc()) + .onError(res::send) + .forSingle(res::send); + } + + /** + * Handler for {@code GET /todo/id}. + * + * @param req the server request + * @param res the server response + */ + private void get(ServerRequest req, ServerResponse res) { + bsc.get(req.path().param("id")) + .onError(res::send) + .forSingle(res::send); + } +} diff --git a/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/package-info.java b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/package-info.java new file mode 100644 index 00000000..94289600 --- /dev/null +++ b/examples/todo-app/frontend/src/main/java/io/helidon/demo/todos/frontend/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2018, 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. + */ + +/** + * TODOs Demo application frontend. + */ +package io.helidon.demo.todos.frontend; diff --git a/examples/todo-app/frontend/src/main/resources/WEB/css/styles.css b/examples/todo-app/frontend/src/main/resources/WEB/css/styles.css new file mode 100644 index 00000000..7c36bb76 --- /dev/null +++ b/examples/todo-app/frontend/src/main/resources/WEB/css/styles.css @@ -0,0 +1,427 @@ +/* + * Copyright (c) 2023, 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. + */ + +html, +body { + margin: 0 auto; + padding: 0; + font: 14px 'Helvetica Neue', Helvetica, Arial, sans-serif; + line-height: 1.4em; + background: #f5f5f5; + color: #4d4d4d; + min-width: 600px; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + font-weight: 300; +} + +input { + font-family: inherit; + font-weight: inherit; + color: inherit; + border: 0; +} + +button { + margin: 0; + padding: 0; + border: 0; + background: none; + font-size: 100%; + vertical-align: baseline; + font-family: inherit; + font-weight: inherit; + color: inherit; + cursor: pointer; + -webkit-appearance: none; + appearance: none; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +:focus { + outline: 0; +} + +.hidden { + display: none; +} + +nav { + display: flex; + align-items: center; + padding: 0 20px 0 20px; + height: 80px; +} + +.spacer { + flex-grow: 1; +} + +.row { + display: flex; + flex-direction: row; + align-items: center; +} + +.column { + display: flex; + flex-direction: column; + align-items: center; +} + +.wrap { + display: none; +} + +.todoapp { + width: 550px; + background: #fff; + margin: 130px 0 40px 0; + position: relative; + box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.2), + 0 25px 50px 0 rgba(0, 0, 0, 0.1); +} + +.todoapp input::-webkit-input-placeholder { + font-style: italic; + font-weight: 300; + color: #e6e6e6; +} + +.todoapp input::-moz-placeholder { + font-style: italic; + font-weight: 300; + color: #e6e6e6; +} + +.todoapp h1 { + position: absolute; + top: -155px; + width: 100%; + font-size: 100px; + font-weight: 100; + text-align: center; + color: rgba(175, 47, 47, 0.15); + text-rendering: optimizeLegibility; +} + +.new-todo { + position: relative; + margin: 0; + width: 100%; + font-size: 24px; + font-family: inherit; + font-weight: inherit; + line-height: 1.4em; + color: inherit; + padding: 6px; + border: 1px solid #999; + box-shadow: inset 0 -1px 5px 0 rgba(0, 0, 0, 0.2); + box-sizing: border-box; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +.new-todo { + padding: 16px 16px 16px 60px; + border: none; + background: rgba(0, 0, 0, 0.003); + box-shadow: inset 0 -2px 1px rgba(0, 0, 0, 0.03); +} + +.main { + position: relative; + z-index: 2; + border-top: 1px solid #e6e6e6; +} + +.checkbox { + border: none; /* Mobile Safari */ + appearance: none; + opacity: 0.25; + -webkit-appearance: none; + margin: 10px; +} + +.checkbox:after { + font-family: 'Material Symbols Outlined'; + font-size: 25px; + transition: opacity 0.2s ease-out; + cursor: pointer; +} + +.checkbox:hover { + opacity: 0.5; +} + +.checkbox:active { + opacity: 0.75; +} + +.toggle-all:after { + content: "\e877"; +} + +.todo-list { + margin: 0; + padding: 0; + list-style: none; +} + +.todo-list li { + position: relative; + font-size: 24px; + border-bottom: 1px solid #ededed; +} + +.todo-list li:last-child { + border-bottom: none; +} + +.todo-list .view, .todo-list .edit { + flex-grow: 1; + padding: 15px 15px 15px 60px; + line-height: 1.2; + font-size: 24px; +} + +.todo-list li.editing { + padding: 0; +} + +.todo-list li.editing .edit { + display: block; +} + +.todo-list li.editing .view { + display: none; +} + +.todo-list li .toggle { + margin: 10px; + display: flex; + align-items: center; +} + +.toggle:after { + content: "\ef4a"; +} + +.toggle:checked:after { + content: "\e86c"; +} + +.todo-list li label { + word-break: break-all; + padding: 15px 15px 15px 60px; + display: block; + line-height: 1.2; + transition: color 0.4s; +} + +.todo-list li.completed label { + color: #d9d9d9; + text-decoration: line-through; +} + +.todo-list li .actions { + display: flex; + align-items: center; + margin: 10px; +} + +.todo-list li .actions button { + margin: 5px; + opacity: 0.25; + font-size: 0; + cursor: pointer; + transition: opacity 0.2s ease-out; +} + +.todo-list li .actions button:hover { + opacity: 0.5; +} + +.todo-list li .actions button:active { + opacity: 0.75; +} + +.todo-list li .actions button:before { + font-family: 'Material Symbols Outlined'; + font-size: 25px; +} + +.todo-list li .actions .update:before { + content: '\e3c9' +} + +.todo-list li.editing .actions .update:before { + content: '\e5ca' !important; +} + +.todo-list li .actions .delete:before { + content: '\e872' +} + +.todo-list li .edit { + display: none; +} + +.todo-list li.editing:last-child { + margin-bottom: -1px; +} + +.footer { + color: #777; + padding: 10px 15px; + height: 20px; + text-align: center; + border-top: 1px solid #e6e6e6; +} + +.footer:before { + content: ''; + position: absolute; + right: 0; + bottom: 0; + left: 0; + height: 50px; + overflow: hidden; + box-shadow: 0 1px 1px rgba(0, 0, 0, 0.2), + 0 8px 0 -3px #f6f6f6, + 0 9px 1px -3px rgba(0, 0, 0, 0.2), + 0 16px 0 -6px #f6f6f6, + 0 17px 2px -6px rgba(0, 0, 0, 0.2); +} + +.todo-count { + float: left; + text-align: left; +} + +.todo-count strong { + font-weight: 300; +} + +.filters { + margin: 0; + padding: 0; + list-style: none; + position: absolute; + right: 0; + left: 0; +} + +.filters li { + display: inline; +} + +.filters li a { + color: inherit; + margin: 3px; + padding: 3px 7px; + text-decoration: none; + border: 1px solid transparent; + border-radius: 3px; +} + +.filters li a:hover { + border-color: rgba(175, 47, 47, 0.1); +} + +.filters li a.selected { + border-color: rgba(175, 47, 47, 0.2); +} + +.clear-completed, html .clear-completed:active { + float: right; + position: relative; + line-height: 20px; + text-decoration: none; + cursor: pointer; +} + +.clear-completed:hover { + text-decoration: underline; +} + +.info { + margin: 0; + color: #bfbfbf; + font-size: 14px; + text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5); + text-align: center; +} + +.info p { + line-height: 1; +} + +.info a { + color: inherit; + text-decoration: none; + font-weight: 400; +} + +.info a:hover { + text-decoration: underline; +} + +@media screen and (-webkit-min-device-pixel-ratio: 0) { + .toggle-all, .todo-list li .toggle { + background: none; + } + + .todo-list li .toggle { + height: 40px; + } +} + +@media (max-width: 430px) { + .footer { + height: 50px; + } + + .filters { + bottom: 10px; + } +} + +#user-info { + display:none; +} + +#user-info > div { + display:flex; +} + +#user-info .sign-out { + margin-right: 10px; + background: white; + padding: 5px; + border: 1px solid #dadce0; + border-radius: 4px; + transition: background-color .218s, border-color .218s; +} + +#user-info .sign-out:hover { + border-color: #d2e3fc; + background-color: rgba(66,133,244,.04); +} +#user-info .sign-out:active { + background-color: rgba(66,133,244,.1); +} diff --git a/examples/todo-app/frontend/src/main/resources/WEB/index.html b/examples/todo-app/frontend/src/main/resources/WEB/index.html new file mode 100644 index 00000000..6e45e004 --- /dev/null +++ b/examples/todo-app/frontend/src/main/resources/WEB/index.html @@ -0,0 +1,91 @@ + + + + + + Helidon TodoMVC + + + + +

+
+
+
+
+

todos

+
+ + +
+
+
+
    +
    +
    +
    +
    +
    +

    Helidon implementation of TodoMVC

    +
    +
    + + + + + + + + + diff --git a/examples/todo-app/frontend/src/main/resources/WEB/js/app.js b/examples/todo-app/frontend/src/main/resources/WEB/js/app.js new file mode 100644 index 00000000..560a075b --- /dev/null +++ b/examples/todo-app/frontend/src/main/resources/WEB/js/app.js @@ -0,0 +1,465 @@ +/* + * Copyright (c) 2018, 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. + */ + +/* global jQuery, Router */ + +/** + * @typedef {Object} Handlebars + * @property {function(string, function(*, *, HandlebarsOpts))} registerHelper + * @property {function(HTMLElement):function(object):string} compile + */ + +/** + * @typedef {Object} HandlebarsOpts + * @property {function(object)} fn + * @property {function(object)} inverse + */ + +/** + * @typedef {Object} Google + * @property {GoogleAccount} accounts + */ + +/** + * @typedef {Object} GoogleAccount + * @property {GoogleId} id + */ + +/** + * @typedef {Object} GoogleId + * @property {function({})} initialize + * @property {function()} prompt + * @property {function(Element, Object)} renderButton + * @property {function(string} revoke + */ + +/** + * @typedef {Object} Todo + * @property {string} title + * @property {string=} id + * @property {boolean} completed + */ + +class TodoClient { + + constructor(access_token) { + this.access_token = access_token + } + + /** + * List all entries. + * @return {Promise} + */ + list() { + return this._ajax('GET', '/api/todo'); + } + + /** + * Create a new entry. + * @property {Todo} data + * @return {Promise} + */ + create(item) { + return this._ajax('POST', '/api/todo', item); + } + + /** + * Toggle an entry. + * @param {Todo} item + * @param {boolean} completed + */ + toggle(item, completed) { + const data = {...item, completed}; + return this._ajax('PUT', `/api/todo/${item.id}`, data); + } + + /** + * Update an entry. + * @param {Todo} item + * @return {Promise} + */ + update(item) { + return this._ajax('PUT', `/api/todo/${item.id}`, item); + } + + /** + * Delete an entry. + * @param {string} id + * @return {Promise} + */ + delete(id) { + return this._ajax('DELETE', `/api/todo/${id}`); + } + + /** + * Batch requests. + * @param {Todo[]} items + * @param {function(Todo):boolean} filter + * @param {function(Todo, number): Promise} fn + * @return {Promise[]>} + */ + batch(items, filter, fn) { + const promises = []; + items.forEach((e, i) => { + if (filter(e)) { + promises.push(fn(e, i)); + } + }) + return Promise.all(promises); + } + + /** + * Toggle all items. + * @property {Todo[]} items + * @property {boolean} completed + * @return {Promise} + */ + toggleAll(items, completed) { + const result = [...items]; + return this.batch(items, e => e.completed !== completed, (e, i) => { + return this.toggle(e, completed).then(data => { + result[i] = data; + }) + }).then(() => result); + } + + /** + * Delete all completed items. + * @param {Todo[]} items + * @return {Promise} + */ + deleteCompleted(items) { + const indexes = []; + const result = [...items]; + return this.batch(items, e => e.completed, (data, index) => { + indexes.push(index); + return this._ajax('DELETE', `/api/todo/${data.id}`); + }).then(() => { + indexes.sort(); + for (let i = indexes.length - 1; i >= 0; i--) { + result.splice(indexes[i], 1); + } + return result; + }) + } + + /** + * @param {string} type + * @param {string} path + * @param {object=} data + * @return {Promise} + */ + _ajax(type, path, data) { + while (path.startsWith('/')) { + path = path.substring(1); + } + return new Promise((resolve, reject) => { + // noinspection JSUnusedGlobalSymbols + $.ajax({ + type: type, + beforeSend: (request) => { + if (this.access_token) { + request.setRequestHeader('Authorization', `Bearer ${this.access_token}`); + } + }, + url: window.location.pathname + path, + dataType: 'json', + contentType: 'application/json;charset=utf-8', + data: data && JSON.stringify(data) + }).done((resData) => { + resolve(resData); + }).fail((data, textStatus) => { + reject(textStatus); + }); + }) + } +} + +class App { + + constructor() { + this.client = null; + this.token = null; + this.todos = []; + this.todoTemplate = Handlebars.compile($('#todo-template').html()); + this.footerTemplate = Handlebars.compile($('#footer-template').html()); + this.router = new Router({ + '/:filter': (filter) => { + this.filter = filter; + this.render(); + } + }); + $('.sign-out').on('click', e => this.signOut()); + $('.new-todo').on('keyup', e => this.create(e)); + $('.toggle-all').on('change', e => this.toggleAll(e)); + $('.footer').on('click', '.clear-completed', () => this.deleteCompleted()); + $('.todo-list') + .on('change', '.toggle', e => this.toggle(e)) + .on('click', '.update', e => this.editingMode(e)) + .on('focusout', '.edit', e => this.update(e)) + .on('click', '.delete', e => this.destroy(e)); + } + + signOut() { + const google = /** @type {Google} */ (window['google']); + google.accounts.id.revoke(this.token.sub); + this.client = null; + this.token = null; + $('#user-info').fadeOut(); + $('.wrap').fadeOut(); + google.accounts.id.prompt(); + } + + /** + * Init the application. + */ + init(access_token) { + this.client = new TodoClient(access_token); + this.token = JSON.parse(atob(access_token.split(".")[1])); + const signedIn = access_token && true || false; + if (signedIn) { + this.init0().then(() => { + $('.wrap').fadeIn(); + $('#user-info').fadeIn(); + }) + } + } + + init0() { + return this.client.list().then(items => { + this.todos = items; + this.router.init('/all'); + }).catch(console.error); + } + + /** + * Render. + */ + render() { + const todos = this.getFilteredTodos(); + $('.todo-list').html(this.todoTemplate(todos.map((e, i) => { + e.index = i; + return e; + }))); + $('.main').toggle(todos.length > 0); + $('.toggle-all').prop('checked', this.getActiveTodos().length === 0); + this.renderFooter(); + $('.new-todo').focus(); + } + + /** + * Render the footer. + */ + renderFooter() { + const todoCount = this.todos.length; + const activeTodoCount = this.getActiveTodos().length; + const template = this.footerTemplate({ + activeTodoCount: activeTodoCount, + activeTodoWord: this.pluralize(activeTodoCount, 'item'), + completedTodos: todoCount - activeTodoCount, + filter: this.filter + }); + $('.footer').toggle(todoCount > 0).html(template); + } + + /** + * Pluralize the given word. + * @param {number} count + * @param {string} word + * @return {string} + */ + pluralize(count, word) { + return count === 1 ? word : word + 's'; + } + + /** + * Get the active entries. + * @return {Todo[]} + */ + getActiveTodos() { + return this.todos.filter((todo) => { + return !todo.completed; + }); + } + + /** + * Get the completed entries. + * @return {Todo[]} + */ + getCompletedTodos() { + return this.todos.filter((todo) => todo.completed); + } + + /** + * Get the entries for the current filter. + * @return {Todo[]} + */ + getFilteredTodos() { + if (this.filter === 'active') { + return this.getActiveTodos(); + } + if (this.filter === 'completed') { + return this.getCompletedTodos(); + } + return this.todos; + } + + /** + * Toggle all entries. + * @param {Event} e + */ + toggleAll(e) { + const isChecked = $(e.target).prop('checked'); + this.client.toggleAll(this.todos, isChecked).then(items => { + this.todos = items; + this.render(); + }).catch(console.error); + } + + /** + * Delete all completed entries. + */ + deleteCompleted() { + this.client.deleteCompleted(this.todos).then(items => { + this.todos = items; + this.render(); + }).catch(console.error); + } + + /** + * Create a new entry. + * @param {KeyboardEvent} e + */ + create(e) { + const input = $(e.target); + const val = input.val().trim(); + if (e.key !== "Enter" || !val) { + return; + } + input.val(''); + const item = {title: val, completed: false}; + this.client.create(item).then((data) => { + this.todos.push(data); + this.render(); + }).catch(console.error) + } + + /** + * Toggle an entry. + * @param {Event} e + * @return {Promise} + */ + toggle(e) { + const info = this.entryInfo(e.target); + const entry = this.todos[info.index]; + return this.client.toggle(entry, !entry.completed).then((data) => { + this.todos[info.index] = data; + this.render(); + }).catch(console.error); + } + + /** + * Update an entry. + * @param {{target: Element}} e + * @return {Promise} + */ + update(e) { + const input = $(e.target); + const val = input.val().trim(); + if (!val) { + this.destroy(e); + return Promise.resolve(); + } else { + const info = this.entryInfo(e.target); + const newData = {...this.todos[info.index], title: val}; + return this.client.update(newData).then(data => { + this.todos[info.index] = data; + this.render(); + }).catch(console.error); + } + } + + /** + * Destroy an entry. + * @param {{target: Element}} e + */ + destroy(e) { + const info = this.entryInfo(e.target); + this.client.delete(info.id).then(() => { + this.todos.splice(info.index, 1); + this.render(); + }).catch(console.error); + } + + /** + * Edit an entry. + * @param {Event} e + */ + editingMode(e) { + const listElt = $(e.target).closest('li'); + const editing = listElt.hasClass('editing'); + if (editing) { + const input = listElt.find('.edit'); + this.update({ + target: input[0] + }).then(() => listElt.removeClass('editing')); + } else { + const input = listElt.addClass('editing').find('.edit'); + // puts caret at end of input + const tmpStr = input.val(); + input.val(''); + input.val(tmpStr); + input.focus(); + } + } + + /** + * Get the entry info for an element. + * @param {Element} el + * @return {{index: number, id: string}} + */ + entryInfo(el) { + const id = $(el).closest('li').data('id'); + const todos = this.todos; + let i = todos.length; + while (i--) { + if (todos[i].id === id) { + return {id, index: i}; + } + } + } +} + +window.onload = () => { + const google = /** @type {Google} */ (window['google']); + const Handlebars = /** @type {Handlebars} */ (window['Handlebars']); + + Handlebars.registerHelper('eq', (a, b, options) => { + return a === b ? options.fn(this) : options.inverse(this); + }); + + const app = new App(); + + // noinspection JSUnusedGlobalSymbols,SpellCheckingInspection + google.accounts.id.initialize({ + client_id: '1048216952820-6a6ke9vrbjlhngbc0al0dkj9qs9tqbk2.apps.googleusercontent.com', + auto_select: true, + callback: response => { + app.init(response.credential) + } + }); + google.accounts.id.prompt(); +} diff --git a/examples/todo-app/frontend/src/main/resources/application.yaml b/examples/todo-app/frontend/src/main/resources/application.yaml new file mode 100644 index 00000000..2544d24d --- /dev/null +++ b/examples/todo-app/frontend/src/main/resources/application.yaml @@ -0,0 +1,60 @@ +# +# Copyright (c) 2018, 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. +# +env: docker + +webserver: + port: 8080 + +cors: + allow-origins: ["https://cdnjs.cloudflare.com", "https://raw.githubusercontent.com"] + allow-methods: ["GET"] + +tracing: + service: "todo:front" + port: 9411 + +services: + backend.endpoint: "http://localhost:8854" + +security: + config: + require-encryption: false + aes.insecure-passphrase: "changeit" + provider-policy: + type: "COMPOSITE" + authentication: + - name: "google-login" + outbound: + - name: "google-login" + - name: "http-signatures" + providers: + - google-login: + client-id: "1048216952820-6a6ke9vrbjlhngbc0al0dkj9qs9tqbk2.apps.googleusercontent.com" + outbound: + - name: "backend" + hosts: [ "localhost" ] + - abac: + - http-signatures: + outbound: + - name: "backend" + hosts: [ "localhost" ] + signature: + key-id: "frontend" + hmac.secret: "${CLEAR=changeit}" + web-server: + paths: + - path: "/api/{+}" + authenticate: true diff --git a/examples/todo-app/frontend/src/main/resources/logging.properties b/examples/todo-app/frontend/src/main/resources/logging.properties new file mode 100644 index 00000000..3ed94f67 --- /dev/null +++ b/examples/todo-app/frontend/src/main/resources/logging.properties @@ -0,0 +1,28 @@ +# +# Copyright (c) 2017, 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. +# + +#All attributes details +handlers=io.helidon.common.HelidonConsoleHandler +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 + +#All log level details +.level=WARNING +io.helidon.webserver.level=INFO +io.helidon.security.level=INFO +io.helidon.tracing.level=FINE +AUDIT.level=FINEST + + diff --git a/examples/todo-app/frontend/src/test/java/io/helidon/demo/todos/frontend/TodoServiceTest.java b/examples/todo-app/frontend/src/test/java/io/helidon/demo/todos/frontend/TodoServiceTest.java new file mode 100644 index 00000000..22b88f6c --- /dev/null +++ b/examples/todo-app/frontend/src/test/java/io/helidon/demo/todos/frontend/TodoServiceTest.java @@ -0,0 +1,191 @@ +/* + * 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. + */ + +package io.helidon.demo.todos.frontend; + +import java.time.Duration; +import java.util.Base64; +import java.util.List; +import java.util.Map; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.security.Security; +import io.helidon.security.integration.webserver.WebSecurity; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webclient.security.WebClientSecurity; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; +import io.helidon.webserver.WebServer; + +import javax.json.Json; +import javax.json.JsonArray; +import javax.json.JsonObject; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static io.helidon.config.ConfigSources.classpath; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class TodoServiceTest { + + private static final JsonObject TODO = Json.createObjectBuilder().add("msg", "todo").build(); + private static final JsonArray TODOS = Json.createArrayBuilder().add(TODO).build(); + private static final String ENCODED_ID = Base64.getEncoder().encodeToString("john:changeit".getBytes()); + + private static WebServer serverBackend; + private static WebServer serverFrontend; + private static WebClient client; + + private static class BackendServiceMock implements Service { + + @Override + public void update(Routing.Rules rules) { + rules.get("/", this::list) + .get("/{id}", this::get) + .delete("/{id}", this::get) + .post(this::echo) + .put("/{id}", this::echo); + } + + void list(ServerRequest req, ServerResponse res) { + res.send(TODOS); + } + + void get(ServerRequest req, ServerResponse res) { + res.send(TODO); + } + + void echo(ServerRequest req, ServerResponse res) { + req.content().as(JsonObject.class) + .onError(res::send) + .forSingle(res::send); + } + } + + @BeforeAll + public static void init() { + serverBackend = WebServer.builder() + .routing(Routing.builder() + .register("/api/backend", new BackendServiceMock())) + .addMediaSupport(JsonpSupport.create()) + .build() + .start() + .await(Duration.ofMinutes(1)); + + Config config = Config.builder() + .sources(List.of( + classpath("application-test.yaml"), + ConfigSources.create(Map.of("services.backend.endpoint", "http://127.0.0.1:" + serverBackend.port())))) + .build(); + + Security security = Security.create(config.get("security")); + + serverFrontend = WebServer.builder() + .routing(Routing.builder() + .register(WebSecurity.create(security, config.get("security"))) + .register("/api", new TodoService(new BackendServiceClient(config)))) + .config(config.get("webserver")) + .addMediaSupport(JsonpSupport.create()) + .build() + .start() + .await(Duration.ofMinutes(1)); + + client = WebClient.builder() + .baseUri("http://localhost:" + serverFrontend.port()) + .addMediaSupport(JsonpSupport.create()) + .useSystemServiceLoader(false) + .addService(WebClientSecurity.create(security)) + .addHeader(Http.Header.AUTHORIZATION, "Basic " + ENCODED_ID) + .build(); + } + + @AfterAll + public static void stopServers() { + if (serverBackend != null) { + serverBackend.shutdown(); + } + if (serverFrontend != null) { + serverFrontend.shutdown(); + } + } + + @Test + public void testList() { + WebClientResponse response = client.get() + .path("/api/todo") + .request() + .await(); + assertThat(response.status(), is(Http.Status.OK_200)); + JsonArray jsonValues = response.content().as(JsonArray.class).await(); + assertThat(jsonValues.getJsonObject(0), is(TODO)); + } + + @Test + public void testCreate() { + WebClientResponse response = client.post() + .path("/api/todo") + .submit(TODO) + .await(); + assertThat(response.status(), is(Http.Status.CREATED_201)); + JsonObject jsonObject = response.content().as(JsonObject.class).await(); + assertThat(jsonObject, is(TODO)); + } + + @Test + public void testGet() { + WebClientResponse response = client.get() + .path("/api/todo/1") + .request() + .await(); + + assertThat(response.status(), is(Http.Status.OK_200)); + JsonObject jsonObject = response.content().as(JsonObject.class).await(); + assertThat(jsonObject, is(TODO)); + } + + @Test + public void testDelete() { + WebClientResponse response = client.delete() + .path("/api/todo/1") + .request() + .await(); + + assertThat(response.status(), is(Http.Status.OK_200)); + JsonObject jsonObject = response.content().as(JsonObject.class).await(); + assertThat(jsonObject, is(TODO)); + } + + @Test + public void testUpdate() { + WebClientResponse response = client.put() + .path("/api/todo/1") + .submit(TODO) + .await(); + + assertThat(response.status(), is(Http.Status.OK_200)); + JsonObject jsonObject = response.content().as(JsonObject.class).await(); + assertThat(jsonObject, is(TODO)); + } +} diff --git a/examples/todo-app/frontend/src/test/resources/application-test.yaml b/examples/todo-app/frontend/src/test/resources/application-test.yaml new file mode 100644 index 00000000..37993bfc --- /dev/null +++ b/examples/todo-app/frontend/src/test/resources/application-test.yaml @@ -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. +# + +webserver: + port: 0 + +security: + providers: + - http-basic-auth: + realm: "helidon" + users: + - login: "john" + password: "changeit" + web-server: + paths: + - path: "/api/{+}" + authenticate: true diff --git a/examples/todo-app/pom.xml b/examples/todo-app/pom.xml new file mode 100644 index 00000000..b487aeeb --- /dev/null +++ b/examples/todo-app/pom.xml @@ -0,0 +1,43 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + + io.helidon.examples.todos + helidon-examples-todo-app-project + pom + Helidon Examples TODO Demo + + + TODO demo application + + + + frontend + backend + + diff --git a/examples/translator-app/README.md b/examples/translator-app/README.md new file mode 100644 index 00000000..e3e51efe --- /dev/null +++ b/examples/translator-app/README.md @@ -0,0 +1,85 @@ +# Translator Example Application + +This application demonstrates a pseudo application composed of two microservices + implemented with Helidon SE. + +## Start Zipkin + +With Docker: +```shell +docker run --name zipkin -d -p 9411:9411 openzipkin/zipkin +``` + +```shell +curl -sSL https://zipkin.io/quickstart.sh | bash -s +java -jar zipkin.jar +``` + +With Kubernetes: +```shell +kubectl apply \ + -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/ingress-nginx-3.15.2/deploy/static/provider/cloud/deploy.yaml \ + -f ../k8s/zipkin.yaml +``` + +## Build and run + +With Docker: +```shell +docker build -t helidon-examples-translator-backend backend/ +docker build -t helidon-examples--translator-frontend frontend/ +docker run --rm -d -p 9080:9080 \ + --link zipkin \ + --name helidon-examples-translator-backend \ + helidon-examples-translator-backend:latest +docker run --rm -d -p 8080:8080 \ + --link zipkin \ + --link helidon-examples-translator-backend \ + --name helidon-examples-translator-frontend \ + helidon-examples-translator-frontend:latest +``` + +With Java 8+: +```shell +mvn package +java -jar backend/target/helidon-examples-translator-backend.jar & +java -jar frontend/target/helidon-examples-translator-frontend.jar +``` + +Try the endpoint: +```shell +curl "http://localhost:8080?q=cloud&lang=czech" +curl "http://localhost:8080?q=cloud&lang=french" +curl "http://localhost:8080?q=cloud&lang=italian" +``` + +Then check out the traces at http://localhost:9411. + +## Run with Kubernetes (docker for desktop) + +```shell +docker build -t helidon-examples-translator-backend backend/ +docker build -t helidon-examples-translator-frontend frontend/ +kubectl apply -f backend/app.yaml -f frontend/app.yaml +``` + +Try the endpoint: +```shell +curl "http://localhost/translator?q=cloud&lang=czech" +curl "http://localhost/translator?q=cloud&lang=french" +curl "http://localhost/translator?q=cloud&lang=italian" +``` + +Then check out the traces at http://localhost/zipkin. + +Stop the docker containers: +```shell +docker stop zipkin \ + helidon-examples-translator-backend \ + helidon-examples-translator-frontend +``` + +Delete the Kubernetes resources: +```shell +kubectl delete -f backend/app.yaml -f frontend/app.yaml +``` \ No newline at end of file diff --git a/examples/translator-app/backend/Dockerfile b/examples/translator-app/backend/Dockerfile new file mode 100644 index 00000000..969a8835 --- /dev/null +++ b/examples/translator-app/backend/Dockerfile @@ -0,0 +1,47 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-translator-backend.jar ./ +COPY --from=build /helidon/target/libs ./libs + +ENV tracing.host="zipkin" + +CMD ["java", "-jar", "helidon-examples-translator-backend.jar"] + +EXPOSE 9080 diff --git a/examples/translator-app/backend/app.yaml b/examples/translator-app/backend/app.yaml new file mode 100644 index 00000000..e4f601e6 --- /dev/null +++ b/examples/translator-app/backend/app.yaml @@ -0,0 +1,54 @@ +# +# Copyright (c) 2017, 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. +# + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-examples-translator-backend + labels: + app: helidon-examples-translator-backend +spec: + replicas: 1 + template: + metadata: + labels: + app: helidon-examples-translator-backend + spec: + containers: + - name: helidon-examples-translator-backend + image: helidon-examples-translator-backend:latest + imagePullPolicy: IfNotPresent + ports: + - containerPort: 9080 + env: + - name: tracing.host + value: zipkin +--- + +apiVersion: v1 +kind: Service +metadata: + name: helidon-examples-translator-backend + labels: + app: helidon-examples-translator-backend +spec: + type: ClusterIP + selector: + app: helidon-examples-translator-backend + ports: + - port: 9080 + targetPort: 9080 + name: http diff --git a/examples/translator-app/backend/pom.xml b/examples/translator-app/backend/pom.xml new file mode 100644 index 00000000..13912361 --- /dev/null +++ b/examples/translator-app/backend/pom.xml @@ -0,0 +1,71 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.translator + helidon-examples-translator-backend + 1.0.0-SNAPSHOT + Helidon Examples Translator Backend + + + A translator backend example app. + + + + io.helidon.examples.translator.backend.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.tracing + helidon-tracing-zipkin + + + io.helidon.config + helidon-config + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/Main.java b/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/Main.java new file mode 100644 index 00000000..8c471e1f --- /dev/null +++ b/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/Main.java @@ -0,0 +1,76 @@ +/* + * Copyright (c) 2017, 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.translator.backend; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Translator application backend main class. + */ +public class Main { + + private Main() { + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + public static Single startBackendServer() { + // configure logging in order to not have the standard JVM defaults + LogConfig.configureRuntime(); + + Config config = Config.builder() + .sources(ConfigSources.environmentVariables()) + .build(); + + WebServer webServer = WebServer.builder( + Routing.builder() + .register(new TranslatorBackendService())) + .port(9080) + .tracer(TracerBuilder.create(config.get("tracing")) + .serviceName("helidon-webserver-translator-backend") + .build()) + .build(); + + return webServer.start() + .peek(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port()); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }).onError(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + } + + /** + * The main method of Translator backend. + * + * @param args command-line args, currently ignored. + */ + public static void main(String[] args) { + startBackendServer(); + } +} diff --git a/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/TranslatorBackendService.java b/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/TranslatorBackendService.java new file mode 100644 index 00000000..bb194d11 --- /dev/null +++ b/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/TranslatorBackendService.java @@ -0,0 +1,178 @@ +/* + * Copyright (c) 2019, 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.translator.backend; + +import java.util.HashMap; +import java.util.Map; + +import io.helidon.webserver.BadRequestException; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Translator backend service. + */ +public class TranslatorBackendService implements Service { + + private static final String CZECH = "czech"; + private static final String SPANISH = "spanish"; + private static final String CHINESE = "chinese"; + private static final String HINDI = "hindi"; + private static final String ITALIAN = "italian"; + private static final String FRENCH = "french"; + + private static final String SEPARATOR = "."; + private static final Map TRANSLATED_WORDS_REPOSITORY = new HashMap<>(); + + static { + //translation for word "cloud" + TRANSLATED_WORDS_REPOSITORY.put("cloud" + SEPARATOR + CZECH, "oblak"); + TRANSLATED_WORDS_REPOSITORY.put("cloud" + SEPARATOR + SPANISH, "nube"); + TRANSLATED_WORDS_REPOSITORY.put("cloud" + SEPARATOR + CHINESE, "云"); + TRANSLATED_WORDS_REPOSITORY.put("cloud" + SEPARATOR + HINDI, "बादल"); + TRANSLATED_WORDS_REPOSITORY.put("cloud" + SEPARATOR + ITALIAN, "nube"); + TRANSLATED_WORDS_REPOSITORY.put("cloud" + SEPARATOR + FRENCH, "nuage"); + + //one two three four five six seven eight nine ten + //jedna dvě tři čtyři pět šest sedm osm devět deset + //uno dos tres cuatro cinco seis siete ocho nueve diez + //一二三四五六七八九十 + //एक दो तीन चार पांच छ सात आठ नौ दस + // uno due tre quattro cinque sei sette otto nove dieci + // un deux trois quatre cinq six sept huit neuf dix + + //translation for word "one" + TRANSLATED_WORDS_REPOSITORY.put("one" + SEPARATOR + CZECH, "jedna"); + TRANSLATED_WORDS_REPOSITORY.put("one" + SEPARATOR + SPANISH, "uno"); + TRANSLATED_WORDS_REPOSITORY.put("one" + SEPARATOR + CHINESE, "一"); + TRANSLATED_WORDS_REPOSITORY.put("one" + SEPARATOR + HINDI, "एक"); + TRANSLATED_WORDS_REPOSITORY.put("one" + SEPARATOR + ITALIAN, "uno"); + TRANSLATED_WORDS_REPOSITORY.put("one" + SEPARATOR + FRENCH, "un"); + //translation for word "two" + TRANSLATED_WORDS_REPOSITORY.put("two" + SEPARATOR + CZECH, "dvě"); + TRANSLATED_WORDS_REPOSITORY.put("two" + SEPARATOR + SPANISH, "dos"); + TRANSLATED_WORDS_REPOSITORY.put("two" + SEPARATOR + CHINESE, "二"); + TRANSLATED_WORDS_REPOSITORY.put("two" + SEPARATOR + HINDI, "दो"); + TRANSLATED_WORDS_REPOSITORY.put("two" + SEPARATOR + ITALIAN, "due"); + TRANSLATED_WORDS_REPOSITORY.put("two" + SEPARATOR + FRENCH, "deux"); + //translation for word "three" + TRANSLATED_WORDS_REPOSITORY.put("three" + SEPARATOR + CZECH, "tři"); + TRANSLATED_WORDS_REPOSITORY.put("three" + SEPARATOR + SPANISH, "tres"); + TRANSLATED_WORDS_REPOSITORY.put("three" + SEPARATOR + CHINESE, "三"); + TRANSLATED_WORDS_REPOSITORY.put("three" + SEPARATOR + HINDI, "तीन"); + TRANSLATED_WORDS_REPOSITORY.put("three" + SEPARATOR + ITALIAN, "tre"); + TRANSLATED_WORDS_REPOSITORY.put("three" + SEPARATOR + FRENCH, "trois"); + //translation for word "four" + TRANSLATED_WORDS_REPOSITORY.put("four" + SEPARATOR + CZECH, "čtyři"); + TRANSLATED_WORDS_REPOSITORY.put("four" + SEPARATOR + SPANISH, "cuatro"); + TRANSLATED_WORDS_REPOSITORY.put("four" + SEPARATOR + CHINESE, "四"); + TRANSLATED_WORDS_REPOSITORY.put("four" + SEPARATOR + HINDI, "चार"); + TRANSLATED_WORDS_REPOSITORY.put("four" + SEPARATOR + ITALIAN, "quattro"); + TRANSLATED_WORDS_REPOSITORY.put("four" + SEPARATOR + FRENCH, "quatre"); + //translation for word "five" + TRANSLATED_WORDS_REPOSITORY.put("five" + SEPARATOR + CZECH, "pět"); + TRANSLATED_WORDS_REPOSITORY.put("five" + SEPARATOR + SPANISH, "cinco"); + TRANSLATED_WORDS_REPOSITORY.put("five" + SEPARATOR + CHINESE, "五"); + TRANSLATED_WORDS_REPOSITORY.put("five" + SEPARATOR + HINDI, "पांच"); + TRANSLATED_WORDS_REPOSITORY.put("five" + SEPARATOR + ITALIAN, "cinque"); + TRANSLATED_WORDS_REPOSITORY.put("five" + SEPARATOR + FRENCH, "cinq"); + //translation for word "six" + TRANSLATED_WORDS_REPOSITORY.put("six" + SEPARATOR + CZECH, "šest"); + TRANSLATED_WORDS_REPOSITORY.put("six" + SEPARATOR + SPANISH, "seis"); + TRANSLATED_WORDS_REPOSITORY.put("six" + SEPARATOR + CHINESE, "六"); + TRANSLATED_WORDS_REPOSITORY.put("six" + SEPARATOR + HINDI, "छ"); + TRANSLATED_WORDS_REPOSITORY.put("six" + SEPARATOR + ITALIAN, "sei"); + TRANSLATED_WORDS_REPOSITORY.put("six" + SEPARATOR + FRENCH, "six"); + //translation for word "seven" + TRANSLATED_WORDS_REPOSITORY.put("seven" + SEPARATOR + CZECH, "sedm"); + TRANSLATED_WORDS_REPOSITORY.put("seven" + SEPARATOR + SPANISH, "siete"); + TRANSLATED_WORDS_REPOSITORY.put("seven" + SEPARATOR + CHINESE, "七"); + TRANSLATED_WORDS_REPOSITORY.put("seven" + SEPARATOR + HINDI, "सात"); + TRANSLATED_WORDS_REPOSITORY.put("seven" + SEPARATOR + ITALIAN, "sette"); + TRANSLATED_WORDS_REPOSITORY.put("seven" + SEPARATOR + FRENCH, "sept"); + //translation for word "eight" + TRANSLATED_WORDS_REPOSITORY.put("eight" + SEPARATOR + CZECH, "osm"); + TRANSLATED_WORDS_REPOSITORY.put("eight" + SEPARATOR + SPANISH, "ocho"); + TRANSLATED_WORDS_REPOSITORY.put("eight" + SEPARATOR + CHINESE, "八"); + TRANSLATED_WORDS_REPOSITORY.put("eight" + SEPARATOR + HINDI, "आठ"); + TRANSLATED_WORDS_REPOSITORY.put("eight" + SEPARATOR + ITALIAN, "otto"); + TRANSLATED_WORDS_REPOSITORY.put("eight" + SEPARATOR + FRENCH, "huit"); + //translation for word "nine" + TRANSLATED_WORDS_REPOSITORY.put("nine" + SEPARATOR + CZECH, "devět"); + TRANSLATED_WORDS_REPOSITORY.put("nine" + SEPARATOR + SPANISH, "nueve"); + TRANSLATED_WORDS_REPOSITORY.put("nine" + SEPARATOR + CHINESE, "九"); + TRANSLATED_WORDS_REPOSITORY.put("nine" + SEPARATOR + HINDI, "नौ"); + TRANSLATED_WORDS_REPOSITORY.put("nine" + SEPARATOR + ITALIAN, "nove"); + TRANSLATED_WORDS_REPOSITORY.put("nine" + SEPARATOR + FRENCH, "neuf"); + //translation for word "ten" + TRANSLATED_WORDS_REPOSITORY.put("ten" + SEPARATOR + CZECH, "deset"); + TRANSLATED_WORDS_REPOSITORY.put("ten" + SEPARATOR + SPANISH, "diez"); + TRANSLATED_WORDS_REPOSITORY.put("ten" + SEPARATOR + CHINESE, "十"); + TRANSLATED_WORDS_REPOSITORY.put("ten" + SEPARATOR + HINDI, "दस"); + TRANSLATED_WORDS_REPOSITORY.put("ten" + SEPARATOR + ITALIAN, "dieci"); + TRANSLATED_WORDS_REPOSITORY.put("ten" + SEPARATOR + FRENCH, "dix"); + } + + @Override + public void update(Routing.Rules rules) { + rules.get(this::getText); + } + + private void getText(ServerRequest request, ServerResponse response) { + + String query = request.queryParams().first("q") + .orElseThrow(() -> new BadRequestException("missing query parameter 'q'")); + String language = request.queryParams().first("lang") + .orElseThrow(() -> new BadRequestException("missing query parameter 'lang'")); + String translation; + switch (language) { + case CZECH: + translation = TRANSLATED_WORDS_REPOSITORY.get(query + SEPARATOR + CZECH); + break; + case SPANISH: + translation = TRANSLATED_WORDS_REPOSITORY.get(query + SEPARATOR + SPANISH); + break; + case CHINESE: + translation = TRANSLATED_WORDS_REPOSITORY.get(query + SEPARATOR + CHINESE); + break; + case HINDI: + translation = TRANSLATED_WORDS_REPOSITORY.get(query + SEPARATOR + HINDI); + break; + case ITALIAN: + translation = TRANSLATED_WORDS_REPOSITORY.get(query + SEPARATOR + ITALIAN); + break; + case FRENCH: + translation = TRANSLATED_WORDS_REPOSITORY.get(query + SEPARATOR + FRENCH); + break; + default: + response.status(404) + .send(String.format( + "Language '%s' not in supported. Supported languages: %s, %s, %s, %s.", + language, + CZECH, SPANISH, CHINESE, HINDI)); + return; + } + + if (translation != null) { + response.send(translation); + } else { + response.status(404) + .send(String.format("Word '%s' not in the dictionary", query)); + } + } +} diff --git a/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/package-info.java b/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/package-info.java new file mode 100644 index 00000000..8bc85e4d --- /dev/null +++ b/examples/translator-app/backend/src/main/java/io/helidon/examples/translator/backend/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * Demo examples Translator Backend package. + */ +package io.helidon.examples.translator.backend; diff --git a/examples/translator-app/backend/src/main/resources/logging.properties b/examples/translator-app/backend/src/main/resources/logging.properties new file mode 100644 index 00000000..16e07ca9 --- /dev/null +++ b/examples/translator-app/backend/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +#All attributes details +handlers=io.helidon.common.HelidonConsoleHandler +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 + +#All log level details +.level=INFO + +io.helidon.webserver.level=FINEST +org.glassfish.jersey.internal.Errors.level=SEVERE diff --git a/examples/translator-app/frontend/Dockerfile b/examples/translator-app/frontend/Dockerfile new file mode 100644 index 00000000..ee83509c --- /dev/null +++ b/examples/translator-app/frontend/Dockerfile @@ -0,0 +1,48 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -Dmaven.test.skip + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-translator-frontend.jar ./ +COPY --from=build /helidon/target/libs ./libs + +ENV tracing.host="zipkin" +ENV backend.host="helidon-examples-translator-backend" + +CMD ["java", "-jar", "helidon-examples-translator-frontend.jar"] + +EXPOSE 8080 diff --git a/examples/translator-app/frontend/app.yaml b/examples/translator-app/frontend/app.yaml new file mode 100644 index 00000000..0d6a36ba --- /dev/null +++ b/examples/translator-app/frontend/app.yaml @@ -0,0 +1,76 @@ +# +# Copyright (c) 2017, 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. +# + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: helidon-examples-translator-frontend + labels: + app: helidon-examples-translator-frontend +spec: + replicas: 1 + template: + metadata: + labels: + app: helidon-examples-translator-frontend + spec: + containers: + - name: translator-frontend + image: helidon-examples-translator-frontend:latest + imagePullPolicy: IfNotPresent + ports: + - containerPort: 8080 + env: + - name: tracing.host + value: zipkin + - name: backend.host + value: helidon-examples-translator-backend + +--- + +apiVersion: v1 +kind: Service +metadata: + name: helidon-examples-translator-frontend + labels: + app: helidon-examples-translator-frontend +spec: + type: ClusterIP + ports: + - name: http + port: 8080 + selector: + app: helidon-examples-translator-frontend + sessionAffinity: None + +--- + +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: helidon-examples-translator-frontend +spec: + rules: + - host: localhost + http: + paths: + - path: /translator + pathType: Prefix + backend: + service: + name: helidon-examples-translator-frontend + port: + number: 8080 diff --git a/examples/translator-app/frontend/pom.xml b/examples/translator-app/frontend/pom.xml new file mode 100644 index 00000000..572051ec --- /dev/null +++ b/examples/translator-app/frontend/pom.xml @@ -0,0 +1,112 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.translator + helidon-examples-translator-frontend + 1.0.0-SNAPSHOT + Helidon Examples Translator Frontend + + + A translator frontend example app. + + + + io.helidon.examples.translator.frontend.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config + + + io.helidon.tracing + helidon-tracing-jersey-client + + + io.helidon.tracing + helidon-tracing-zipkin + + + io.helidon.common + helidon-common + + + jakarta.inject + jakarta.inject-api + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + + + add-backend-dependency + + + !maven.test.skip + + + + + io.helidon.examples.translator + helidon-examples-translator-backend + ${project.version} + test + + + + + diff --git a/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/Main.java b/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/Main.java new file mode 100644 index 00000000..c464c222 --- /dev/null +++ b/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/Main.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2017, 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.translator.frontend; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Translator application frontend main class. + */ +public class Main { + + private Main() { + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + public static Single startFrontendServer() { + // configure logging in order to not have the standard JVM defaults + LogConfig.configureRuntime(); + + Config config = Config.builder() + .sources(ConfigSources.environmentVariables()) + .build(); + + WebServer webServer = WebServer.builder( + Routing.builder() + .register(new TranslatorFrontendService( + config.get("backend.host").asString().orElse("localhost"), + 9080))) + .port(8080) + .tracer(TracerBuilder.create(config.get("tracing")) + .serviceName("helidon-webserver-translator-frontend") + .registerGlobal(false) + .build()) + .build(); + + return webServer.start() + .peek(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port()); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }).onError(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + } + + /** + * The main method of Translator frontend. + * + * @param args command-line args, currently ignored. + */ + public static void main(String[] args) { + startFrontendServer(); + } +} diff --git a/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/TranslatorFrontendService.java b/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/TranslatorFrontendService.java new file mode 100644 index 00000000..2cb9bb39 --- /dev/null +++ b/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/TranslatorFrontendService.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2019, 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.translator.frontend; + +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.ws.rs.ProcessingException; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; + +import io.helidon.tracing.jersey.client.ClientTracingFilter; +import io.helidon.webserver.BadRequestException; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Translator frontend resource. + */ +public final class TranslatorFrontendService implements Service { + + private static final Logger LOGGER = Logger.getLogger(TranslatorFrontendService.class.getName()); + private final WebTarget backendTarget; + + TranslatorFrontendService(String backendHostname, int backendPort) { + backendTarget = ClientBuilder.newClient() + .target("http://" + backendHostname + ":" + backendPort); + } + + @Override + public void update(Routing.Rules rules) { + rules.get(this::getText); + } + + private void getText(ServerRequest request, ServerResponse response) { + try { + String query = request.queryParams().first("q") + .orElseThrow(() -> new BadRequestException("missing query parameter 'q'")); + String language = request.queryParams().first("lang") + .orElseThrow(() -> new BadRequestException("missing query parameter 'lang'")); + + try (Response backendResponse = backendTarget + .property(ClientTracingFilter.TRACER_PROPERTY_NAME, request.tracer()) + .property(ClientTracingFilter.CURRENT_SPAN_CONTEXT_PROPERTY_NAME, request.spanContext().orElse(null)) + .queryParam("q", query) + .queryParam("lang", language) + .request() + .get()) { + final String result; + if (backendResponse.getStatusInfo().getFamily() == Response.Status.Family.SUCCESSFUL) { + result = backendResponse.readEntity(String.class); + } else { + result = "Error: " + backendResponse.readEntity(String.class); + } + response.send(result + "\n"); + } + } catch (ProcessingException pe) { + LOGGER.log(Level.WARNING, "Problem to call translator frontend.", pe); + response.status(503).send("Translator backend service isn't available."); + } + } +} diff --git a/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/package-info.java b/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/package-info.java new file mode 100644 index 00000000..0e591dde --- /dev/null +++ b/examples/translator-app/frontend/src/main/java/io/helidon/examples/translator/frontend/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * Demo examples Translator Frontend package. + */ +package io.helidon.examples.translator.frontend; diff --git a/examples/translator-app/frontend/src/main/resources/logging.properties b/examples/translator-app/frontend/src/main/resources/logging.properties new file mode 100644 index 00000000..16e07ca9 --- /dev/null +++ b/examples/translator-app/frontend/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +#All attributes details +handlers=io.helidon.common.HelidonConsoleHandler +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 + +#All log level details +.level=INFO + +io.helidon.webserver.level=FINEST +org.glassfish.jersey.internal.Errors.level=SEVERE diff --git a/examples/translator-app/frontend/src/test/java/io/helidon/examples/translator/TranslatorTest.java b/examples/translator-app/frontend/src/test/java/io/helidon/examples/translator/TranslatorTest.java new file mode 100644 index 00000000..c67d8628 --- /dev/null +++ b/examples/translator-app/frontend/src/test/java/io/helidon/examples/translator/TranslatorTest.java @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2017, 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.translator; + +import java.util.concurrent.TimeUnit; + +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.Response; + +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static io.helidon.examples.translator.backend.Main.startBackendServer; +import static io.helidon.examples.translator.frontend.Main.startFrontendServer; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * The TranslatorTest. + */ +public class TranslatorTest { + + private static WebServer webServerFrontend; + private static WebServer webServerBackend; + private static Client client; + private static WebTarget target; + + @BeforeAll + public static void setUp() { + webServerBackend = startBackendServer().await(10, TimeUnit.SECONDS); + webServerFrontend = startFrontendServer().await(10, TimeUnit.SECONDS); + client = ClientBuilder.newClient(); + target = client.target("http://localhost:" + webServerFrontend.port()); + } + + @AfterAll + public static void tearDown() { + webServerFrontend.shutdown().await(10, TimeUnit.SECONDS); + webServerBackend.shutdown().await(10, TimeUnit.SECONDS); + if (client != null) { + client.close(); + } + } + + @Test + public void testCzech() { + try (Response response = target.queryParam("q", "cloud") + .queryParam("lang", "czech") + .request() + .get()) { + assertThat("Unexpected response! Status code: " + response.getStatus(), + response.readEntity(String.class), is("oblak\n")); + } + } + + @Test + public void testItalian() { + try (Response response = target.queryParam("q", "cloud") + .queryParam("lang", "italian") + .request() + .get()) { + assertThat("Unexpected response! Status code: " + response.getStatus(), + response.readEntity(String.class), is("nube\n")); + } + } + + @Test + public void testFrench() { + try (Response response = target.queryParam("q", "cloud") + .queryParam("lang", "french") + .request() + .get()) { + assertThat("Unexpected response! Status code: " + response.getStatus(), + response.readEntity(String.class), is("nuage\n")); + } + } +} diff --git a/examples/translator-app/pom.xml b/examples/translator-app/pom.xml new file mode 100644 index 00000000..29a3de7d --- /dev/null +++ b/examples/translator-app/pom.xml @@ -0,0 +1,42 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.translator + helidon-examples-translator-project + pom + Helidon Examples Translator Demo + + + A translator example app. + + + + backend + frontend + + diff --git a/examples/webclient/pom.xml b/examples/webclient/pom.xml new file mode 100644 index 00000000..6fb6e2a3 --- /dev/null +++ b/examples/webclient/pom.xml @@ -0,0 +1,37 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + + io.helidon.examples.webclient + helidon-examples-webclient-project + Helidon WebClient Example + + pom + + + standalone + + diff --git a/examples/webclient/standalone/README.md b/examples/webclient/standalone/README.md new file mode 100644 index 00000000..630dba56 --- /dev/null +++ b/examples/webclient/standalone/README.md @@ -0,0 +1,32 @@ +# Standalone WebClient Example + +This example demonstrates how to use the Helidon SE WebClient from a +standalone Java program to connect to a server. + +## Build + +```shell +mvn package +``` + +## Run + +First, start the server: + +```shell +java -jar target/helidon-examples-webclient-standalone.jar +``` + +Note the port number that it displays. For example: + +```text +WEB server is up! http://localhost:${PORT}/greet +``` + +Then run the client, passing the port number. It will connect +to the server: + +```shell +java -cp "target/classes:target/libs/*" io.helidon.examples.webclient.standalone.ClientMain PORT +``` + diff --git a/examples/webclient/standalone/pom.xml b/examples/webclient/standalone/pom.xml new file mode 100644 index 00000000..ebb8230a --- /dev/null +++ b/examples/webclient/standalone/pom.xml @@ -0,0 +1,95 @@ + + + + + 4.0.0 + + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.webclient + helidon-examples-webclient-standalone + 1.0.0-SNAPSHOT + Helidon WebClient Standalone Example + + + io.helidon.examples.webclient.standalone.ServerMain + + + + + io.helidon.bundles + helidon-bundles-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.metrics + helidon-metrics-api + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.webclient + helidon-webclient + + + io.helidon.webclient + helidon-webclient-metrics + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/ClientMain.java b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/ClientMain.java new file mode 100644 index 00000000..53463ae6 --- /dev/null +++ b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/ClientMain.java @@ -0,0 +1,199 @@ +/* + * Copyright (c) 2020, 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.webclient.standalone; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.Arrays; +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.common.http.DataChunk; +import io.helidon.common.http.Http; +import io.helidon.common.reactive.IoMulti; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.config.ConfigValue; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webclient.metrics.WebClientMetrics; +import io.helidon.webclient.spi.WebClientService; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.MetricRegistry; + +/** + * A simple WebClient usage class. + * + * Each of the methods demonstrates different usage of the WebClient. + */ +public class ClientMain { + + private static final MetricRegistry METRIC_REGISTRY = RegistryFactory.getInstance() + .getRegistry(MetricRegistry.Type.APPLICATION); + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject JSON_NEW_GREETING; + + static { + JSON_NEW_GREETING = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + private ClientMain() { + } + + /** + * Executes WebClient examples. + * + * If no argument provided it will take server port from configuration server.port. + * + * User can override port from configuration by main method parameter with the specific port. + * + * @param args main method + */ + public static void main(String[] args) { + Config config = Config.create(); + String url; + if (args.length == 0) { + ConfigValue port = config.get("server.port").asInt(); + if (!port.isPresent() || port.get() == -1) { + throw new IllegalStateException("Unknown port! Please specify port as a main method parameter " + + "or directly to config server.port"); + } + url = "http://localhost:" + port.get() + "/greet"; + } else { + url = "http://localhost:" + Integer.parseInt(args[0]) + "/greet"; + } + + WebClient webClient = WebClient.builder() + .baseUri(url) + .config(config.get("client")) + //Since JSON processing support is not present by default, we have to add it. + .addMediaSupport(JsonpSupport.create()) + .build(); + + performPutMethod(webClient) + .flatMapSingle(it -> performGetMethod(webClient)) + .flatMapSingle(it -> followRedirects(webClient)) + .flatMapSingle(it -> getResponseAsAnJsonObject(webClient)) + .flatMapSingle(it -> saveResponseToFile(webClient)) + .flatMapSingle(it -> clientMetricsExample(url, config)) + //Now we need to wait until all requests are done. + .await(); + } + + static Single performPutMethod(WebClient webClient) { + System.out.println("Put request execution."); + return webClient.put() + .path("/greeting") + .submit(JSON_NEW_GREETING) + .map(WebClientResponse::status) + .peek(status -> System.out.println("PUT request executed with status: " + status)); + } + + static Single performGetMethod(WebClient webClient) { + System.out.println("Get request execution."); + return webClient.get() + .request(String.class) + .peek(string -> { + System.out.println("GET request successfully executed."); + System.out.println(string); + }); + } + + static Single followRedirects(WebClient webClient) { + System.out.println("Following request redirection."); + return webClient.get() + .path("/redirect") + .request() + .flatMapSingle(response -> { + if (response.status() != Http.Status.OK_200) { + throw new IllegalStateException("Follow redirection failed!"); + } + return response.content().as(String.class); + }) + .peek(string -> { + System.out.println("Redirected request successfully followed."); + System.out.println(string); + }); + } + + static Single getResponseAsAnJsonObject(WebClient webClient) { + //Support for JsonObject reading from response is not present by default. + //In case of this example it was registered at creation time of the WebClient instance. + System.out.println("Requesting from JsonObject."); + return webClient.get() + .request(JsonObject.class) + .peek(jsonObject -> { + System.out.println("JsonObject successfully obtained."); + System.out.println(jsonObject); + }); + } + + static Single saveResponseToFile(WebClient webClient) { + //We have to create file subscriber first. This subscriber will save the content of the response to the file. + Path file = Paths.get("test.txt"); + try { + Files.deleteIfExists(file); + Files.createFile(file); + } catch (IOException e) { + e.printStackTrace(); + } + + System.out.println("Downloading server response to file: " + file); + return webClient.get() + .request() + .map(WebClientResponse::content) + .flatMapSingle(content -> content + .map(DataChunk::data) + .flatMapIterable(Arrays::asList) + .to(IoMulti.writeToFile(file).build())) + .peek(path -> System.out.println("Download complete!")); + } + + static Single clientMetricsExample(String url, Config config) { + //This part here is only for verification purposes, it is not needed to be done for actual usage. + String counterName = "example.metric.GET.localhost"; + Counter counter = METRIC_REGISTRY.counter(counterName); + System.out.println(counterName + ": " + counter.getCount()); + + //Creates new metric which will count all GET requests and has format of example.metric.GET. + WebClientService clientService = WebClientMetrics.counter() + .methods(Http.Method.GET) + .nameFormat("example.metric.%1$s.%2$s") + .build(); + + //This newly created metric now needs to be registered to WebClient. + WebClient webClient = WebClient.builder() + .baseUri(url) + .config(config) + .addService(clientService) + .build(); + + //Perform any GET request using this newly created WebClient instance. + return performGetMethod(webClient) + //Verification for example purposes that metric has been incremented. + .peek(s -> System.out.println(counterName + ": " + counter.getCount())); + } +} diff --git a/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/GreetService.java b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/GreetService.java new file mode 100644 index 00000000..6d112a8e --- /dev/null +++ b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/GreetService.java @@ -0,0 +1,170 @@ +/* + * Copyright (c) 2020, 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.webclient.standalone; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + GreetService(Config config) { + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + } + + /** + * A service registers itself by updating the routing rules. + * + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/redirect", this::redirect) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + } + + /** + * Return a worldly greeting message. + * + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, + ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a status code of {@link Http.Status#MOVED_PERMANENTLY_301} and the new location where should + * client redirect. + * + * @param request the server request + * @param response the server response + */ + private void redirect(ServerRequest request, + ServerResponse response) { + response.headers().add(Http.Header.LOCATION, "http://localhost:" + ServerMain.getServerPort() + "/greet/"); + response.status(Http.Status.MOVED_PERMANENTLY_301).send(); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, + ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + /** + * Set the greeting to use in future messages. + * + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } + + private void sendResponse(ServerResponse response, String name) { + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException) { + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } +} diff --git a/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/ServerMain.java b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/ServerMain.java new file mode 100644 index 00000000..f7ea1333 --- /dev/null +++ b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/ServerMain.java @@ -0,0 +1,98 @@ +/* + * Copyright (c) 2020, 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.webclient.standalone; + +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The application main class. + */ +public final class ServerMain { + + private static int serverPort = -1; + + /** + * Cannot be instantiated. + */ + private ServerMain() { + } + + /** + * WebServer starting method. + * + * @param args starting arguments + */ + public static void main(String[] args) { + startServer(); + } + + /** + * Returns current port of the running server. + * + * @return server port + */ + public static int getServerPort() { + return serverPort; + } + + /** + * Start the server. + * + * @return the created {@link WebServer} instance + */ + static Single startServer() { + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + + WebServer server = WebServer.builder(createRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + // Server threads are not daemon. No need to block. Just react. + return server.start() + .peek(ws -> { + serverPort = ws.port(); + System.out.println("WEB server is up! http://localhost:" + ws.port() + "/greet"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }).onError(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + } + + /** + * Creates new {@link Routing}. + * + * @param config configuration of this server + * @return routing configured with JSON support, a health check, and a service + */ + private static Routing createRouting(Config config) { + MetricsSupport metrics = MetricsSupport.create(); + GreetService greetService = new GreetService(config); + return Routing.builder() + .register(metrics) + .register("/greet", greetService) + .build(); + } +} diff --git a/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/package-info.java b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/package-info.java new file mode 100644 index 00000000..b080637e --- /dev/null +++ b/examples/webclient/standalone/src/main/java/io/helidon/examples/webclient/standalone/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2020, 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. + */ +/** + * Basic examples of webclient usage. + */ +package io.helidon.examples.webclient.standalone; diff --git a/examples/webclient/standalone/src/main/resources/application.yaml b/examples/webclient/standalone/src/main/resources/application.yaml new file mode 100644 index 00000000..825d1ef6 --- /dev/null +++ b/examples/webclient/standalone/src/main/resources/application.yaml @@ -0,0 +1,26 @@ +# +# Copyright (c) 2020, 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. +# + +app: + greeting: "Hello" + +server: + port: -1 + host: 0.0.0.0 + +client: + follow-redirects: true + max-redirects: 8 \ No newline at end of file diff --git a/examples/webclient/standalone/src/main/resources/full-webclient-config.yaml b/examples/webclient/standalone/src/main/resources/full-webclient-config.yaml new file mode 100644 index 00000000..e106ffd7 --- /dev/null +++ b/examples/webclient/standalone/src/main/resources/full-webclient-config.yaml @@ -0,0 +1,75 @@ +# +# Copyright (c) 2020, 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. +# +client: + event-loop: + name-prefix: client-thread- + workers: 1 + connect-timeout-millis: 2000 + read-timeout-millis: 2000 + follow-redirects: true + max-redirects: 5 + user-agent: "Helidon" + cookies: + automatic-store-enabled: true + default-cookies: + - name: "env" + value: "dev" + headers: + - name: "Accept" + value: ["application/json","text/plain"] + services: + exclude: ["some.webclient.service.Provider"] + config: + metrics: + - type: METER + name-format: "client.meter.overall" + - type: TIMER + # meter per method + name-format: "client.meter.%1$s" + - methods: ["GET"] + type: COUNTER + errors: false + name-format: "client.counter.%1$s.success" + description: "Counter of successful GET requests" + - methods: ["PUT", "POST", "DELETE"] + type: COUNTER + success: false + name-format: "wc.counter.%1$s.error" + description: "Counter of failed PUT, POST and DELETE requests" + - methods: ["GET"] + type: GAUGE_IN_PROGRESS + name-format: "client.inprogress.%2$s" + description: "In progress requests to host" + tracing: + proxy: + use-system-selector: false + host: "hostName" + port: 80 + no-proxy: ["localhost:8080", ".helidon.io", "192.168.1.1"] + ssl: + server: + disable-hostname-verification: false + trust-all: false + truststore: + keystore-resource-path: "path to the keystore" + keystore-type: "JKS" + keystore-passphrase: "changeit" + trust-store: true + client: + keystore: + keystore-resource-path: "path to client keystore" + keystore-passphrase: "changeit" + trust-store: true diff --git a/examples/webclient/standalone/src/test/java/io/helidon/examples/webclient/standalone/ClientMainTest.java b/examples/webclient/standalone/src/test/java/io/helidon/examples/webclient/standalone/ClientMainTest.java new file mode 100644 index 00000000..3599e53e --- /dev/null +++ b/examples/webclient/standalone/src/test/java/io/helidon/examples/webclient/standalone/ClientMainTest.java @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2020, 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.webclient.standalone; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +import io.helidon.common.http.Http; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.api.RegistryFactory; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientRequestBuilder; +import io.helidon.webclient.WebClientServiceRequest; +import io.helidon.webclient.WebClientServiceResponse; +import io.helidon.webclient.spi.WebClientService; +import io.helidon.webserver.WebServer; + +import org.eclipse.microprofile.metrics.Counter; +import org.eclipse.microprofile.metrics.MetricRegistry; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * Test for verification of WebClient example. + */ +public class ClientMainTest { + + private static final MetricRegistry METRIC_REGISTRY = RegistryFactory.getInstance() + .getRegistry(MetricRegistry.Type.APPLICATION); + + private WebClient webClient; + private Path testFile; + + @BeforeEach + public void beforeEach() { + testFile = Paths.get("test.txt"); + WebServer server = ServerMain.startServer().await(); + createWebClient(server.port()); + } + + @AfterEach + public void afterEach() throws IOException { + Files.deleteIfExists(testFile); + } + + private void createWebClient(int port, WebClientService... services) { + Config config = Config.create(); + WebClient.Builder builder = WebClient.builder() + .baseUri("http://localhost:" + port + "/greet") + .config(config.get("client")) + .addMediaSupport(JsonpSupport.create()); + for (WebClientService service : services) { + builder.addService(service); + } + webClient = builder.build(); + } + + @Test + public void testPerformPutAndGetMethod() { + ClientMain.performGetMethod(webClient) + .thenAccept(it -> assertThat(it, is("{\"message\":\"Hello World!\"}"))) + .thenCompose(it -> ClientMain.performPutMethod(webClient)) + .thenCompose(it -> ClientMain.performGetMethod(webClient)) + .thenAccept(it -> assertThat(it, is("{\"message\":\"Hola World!\"}"))) + .await(); + } + + @Test + public void testPerformRedirect() { + createWebClient(ServerMain.getServerPort(), new RedirectClientServiceTest()); + ClientMain.followRedirects(webClient) + .thenAccept(it -> assertThat(it, is("{\"message\":\"Hello World!\"}"))) + .await(); + } + + @Test + public void testFileDownload() { + ClientMain.saveResponseToFile(webClient) + .thenAccept(it -> assertThat(Files.exists(testFile), is(true))) + .thenAccept(it -> { + try { + assertThat(Files.readString(testFile), is("{\"message\":\"Hello World!\"}")); + } catch (IOException e) { + fail(e); + } + }) + .await(); + } + + @Test + public void testMetricsExample() { + String counterName = "example.metric.GET.localhost"; + Counter counter = METRIC_REGISTRY.counter(counterName); + assertThat("Counter " + counterName + " has not been 0", counter.getCount(), is(0L)); + ClientMain.clientMetricsExample("http://localhost:" + ServerMain.getServerPort() + "/greet", Config.create()) + .thenAccept(it -> assertThat("Counter " + counterName + " " + + "has not been 1", counter.getCount(), is(1L))) + .await(); + } + + private static final class RedirectClientServiceTest implements WebClientService { + + private volatile boolean redirect = true; + + @Override + public Single response(WebClientRequestBuilder.ClientRequest request, + WebClientServiceResponse response) { + + if (response.status() == Http.Status.MOVED_PERMANENTLY_301 && redirect) { + fail("Received second redirect! Only one redirect expected here."); + } else if (response.status() == Http.Status.OK_200 && !redirect) { + fail("There was status 200 without status 301 before it."); + } + // not used for now, this test must be refactored + //redirect = !redirect; + return Single.just(response); + } + + @Override + public Single request(WebClientServiceRequest request) { + return Single.just(request); + } + } + +} diff --git a/examples/webserver/README.md b/examples/webserver/README.md new file mode 100644 index 00000000..41c29e61 --- /dev/null +++ b/examples/webserver/README.md @@ -0,0 +1,3 @@ +# Helidon SE WebServer Examples + +This directory contains Helidon SE webserver examples. \ No newline at end of file diff --git a/examples/webserver/basics/README.md b/examples/webserver/basics/README.md new file mode 100644 index 00000000..c146d43f --- /dev/null +++ b/examples/webserver/basics/README.md @@ -0,0 +1,45 @@ + +# Helidon WebServer Basic Example + +This example consists of various methods that can be selected +at runtime. Each method illustrates a different WebServer concept. +See the comments in `Main.java` for a description of the various +methods. + +## Build and run + +```shell +mvn package +``` + +To see the list of methods that are available run: + +```shell +java -DexampleName=help -jar target/helidon-examples-webserver-basics.jar +``` + +You should see output like: + +``` +Example method names: + help + h + firstRouting + startServer + routingAsFilter + parametersAndHeaders + advancedRouting + organiseCode + readContentEntity + filterAndProcessEntity + supports + errorHandling +``` + +You can then choose the method to execute by setting the `exampleName` system property: + +``` +java -DexampleName=firstRouting -jar target/helidon-examples-webserver-basics.jar +``` + +This will start the Helidon SE WebServer using the method indicated. diff --git a/examples/webserver/basics/pom.xml b/examples/webserver/basics/pom.xml new file mode 100644 index 00000000..6b3ad1de --- /dev/null +++ b/examples/webserver/basics/pom.xml @@ -0,0 +1,90 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-basics + 1.0.0-SNAPSHOT + Helidon WebServer Examples Basics + + + Examples of elementary use of the Web Server + + + + io.helidon.webserver.examples.basics.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.webserver + helidon-webserver-jersey + + + io.helidon.media + helidon-media-jsonp + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Catalog.java b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Catalog.java new file mode 100644 index 00000000..f0e2917f --- /dev/null +++ b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Catalog.java @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.basics; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Skeleton example of catalog resource use in {@link Main} class. + */ +public class Catalog implements Service { + + @Override + public void update(Routing.Rules rules) { + rules.get("/", this::list) + .get("/{id}", (req, res) -> getSingle(res, req.path().param("id"))); + } + + private void list(ServerRequest request, ServerResponse response) { + response.send("1, 2, 3, 4, 5"); + } + + private void getSingle(ServerResponse response, String id) { + response.send("Item: " + id); + } +} diff --git a/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/HelloWorldResource.java b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/HelloWorldResource.java new file mode 100644 index 00000000..acdc366a --- /dev/null +++ b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/HelloWorldResource.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.basics; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; + +/** + * Example of the JAX-RS resource. It is integrated with WebServer in {@link Main} class example. + */ +@Path("hw") +public class HelloWorldResource { + + /** + * Jest returns Hello world!. + * + * @return 'Hello world!' literal + */ + @GET + public String helloWorld() { + return "Hello world!"; + } +} diff --git a/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Main.java b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Main.java new file mode 100644 index 00000000..85f7f231 --- /dev/null +++ b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Main.java @@ -0,0 +1,384 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.basics; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.util.Collections; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; + +import io.helidon.common.http.DataChunk; +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.common.http.Parameters; +import io.helidon.media.common.MediaContext; +import io.helidon.media.common.MessageBodyReader; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webserver.Handler; +import io.helidon.webserver.HttpException; +import io.helidon.webserver.RequestPredicate; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.jersey.JerseySupport; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +/** + * This example consists of few first tutorial steps of WebServer API. Each step is represented by a single method. + *

    + * Principles: + *

      + *
    • Reactive principles
      • + *
    • Reflection free
      • + *
    • Fluent
      • + *
    • Integration platform
      • + *
    + *

    + * It is also java executable main class. Use a method name as a command line parameter to execute. + */ +public class Main { + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + // ---------------- EXAMPLES + + /** + * True heart of WebServer API is {@link Routing}. It provides fluent way how to assign custom {@link Handler} to the routing + * rule. The rule consists from two main factors - HTTP method and path pattern. + *

    + * The (route) {@link Handler} is a functional interface which process HTTP {@link io.helidon.webserver.ServerRequest request} and + * writes to the {@link io.helidon.webserver.ServerResponse response}. + */ + public void firstRouting() { + Routing routing = Routing.builder() + .post("/post-endpoint", (req, res) -> res.status(Http.Status.CREATED_201) + .send()) + .get("/get-endpoint", (req, res) -> res.status(Http.Status.NO_CONTENT_204) + .send("Hello World!")) + .build(); + startServer(routing); + } + + /** + * {@link Routing} instance can be used to create {@link WebServer} instance. + * It provides a simple, non-blocking life-cycle API returning + * {@link java.util.concurrent.CompletionStage CompletionStages} to provide reactive access. + * + * @param routing the routing to drive by WebServer instance + * @param mediaContext media support + */ + protected void startServer(Routing routing, MediaContext mediaContext) { + WebServer.builder(routing) + .mediaContext(mediaContext) + .build() + .start() + // All lifecycle operations are non-blocking and provides CompletionStage + .whenComplete((ws, thr) -> { + if (thr == null) { + System.out.println("Server is UP: http://localhost:" + ws.port()); + } else { + System.out.println("Can NOT start WebServer!"); + thr.printStackTrace(System.out); + } + }); + } + + /** + * {@link Routing} + * can be used to create {@link WebServer} instance.It provides a simple, non-blocking life-cycle API returning + * {@link java.util.concurrent.CompletionStage CompletionStages} to provide reactive access. + * + * @param routing the routing to drive by WebServer instance + */ + protected void startServer(Routing routing) { + startServer(routing, MediaContext.create()); + } + + /** + * All routing rules (routes) are evaluated in a definition order. The {@link Handler} assigned with the first valid route + * for given request is called. It is a responsibility of each handler to process in one of the following ways: + *

      + *
    • Respond using one of {@link io.helidon.webserver.ServerResponse#send() ServerResponse.send(...)} method.
      • + *
    • Continue to next valid route using {@link io.helidon.webserver.ServerRequest#next() ServerRequest.next()} method. + * It is possible to define filtering handlers.
      • + *
    + *

    + * If no valid {@link Handler} is found then routing respond by {@code HTTP 404} code. + *

    + * If selected {@link Handler} doesn't process request than the request stacks! + *

    + * Blocking operations:
    + * For performance reason, {@link Handler} can be called directly by a selector thread. It is not good idea to block + * such thread. If request must be processed by a blocking operation then such processing should be deferred to another + * thread. + */ + public void routingAsFilter() { + Routing routing = Routing.builder() + .any((req, res) -> { + System.out.println(req.method() + " " + req.path()); + // Filters are just routing handlers which calls next() + req.next(); + }) + .post("/post-endpoint", (req, res) -> res.status(Http.Status.CREATED_201) + .send()) + .get("/get-endpoint", (req, res) -> res.status(Http.Status.NO_CONTENT_204) + .send("Hello World!")) + .build(); + startServer(routing); + } + + /** + * {@link io.helidon.webserver.ServerRequest ServerRequest} provides access to three types of "parameters": + *

      + *
    • Headers
      • + *
    • Query parameters
      • + *
    • Path parameters - Evaluated from provided {@code path pattern}
      • + *
    + *

    + * {@link java.util.Optional Optional} API is heavily used to represent parameters optionality. + *

    + * WebServer {@link Parameters Parameters} API is used to represent fact, that headers and + * query parameters can contain multiple values. + */ + public void parametersAndHeaders() { + Routing routing = Routing.builder() + .get("/context/{id}", (req, res) -> { + StringBuilder sb = new StringBuilder(); + // Request headers + req.headers() + .first("foo") + .ifPresent(v -> sb.append("foo: ").append(v).append("\n")); + // Request parameters + req.queryParams() + .first("bar") + .ifPresent(v -> sb.append("bar: ").append(v).append("\n")); + // Path parameters + sb.append("id: ").append(req.path().param("id")); + // Response headers + res.headers().contentType(MediaType.TEXT_PLAIN); + // Response entity (payload) + res.send(sb.toString()); + }) + .build(); + startServer(routing); + } + + /** + * Routing rules (routes) are limited on two criteria - HTTP method and path. {@link RequestPredicate} can be used + * to specify more complex criteria. + */ + public void advancedRouting() { + Routing routing = Routing.builder() + .get("/foo", RequestPredicate.create() + .accepts(MediaType.TEXT_PLAIN) + .containsHeader("bar") + .thenApply((req, res) -> res.send())) + .build(); + startServer(routing); + } + + /** + * Larger applications with many routing rules can cause complicated readability (maintainability) if all rules are + * defined in a single fluent code. It is possible to register {@link io.helidon.webserver.Service Service} and organise + * the code into services and resources. {@code Service} is an interface which can register more routing rules (routes). + */ + public void organiseCode() { + Routing routing = Routing.builder() + .register("/catalog-context-path", new Catalog()) + .build(); + startServer(routing); + } + + /** + * Request payload (body/entity) is represented by {@link java.util.concurrent.Flow.Publisher Flow.Publisher} + * of {@link DataChunk RequestChunks} to enable reactive processing of the content of any size. + * But it is more convenient to process entity in some type specific form. WebServer supports few types which can be + * used te read the whole entity: + *

      + *
    • {@code byte[]}
      • + *
    • {@code String}
      • + *
    • {@code InputStream}
      • + *
    + *

    + * Similar approach is used for the response entity. + */ + public void readContentEntity() { + Routing routing = Routing.builder() + .post("/foo", (req, res) -> { + req.content() + .as(String.class) + // The whole entity can be read when all request chunks are processed - CompletionStage + .whenComplete((data, thr) -> { + if (thr == null) { + System.out.println("/foo DATA: " + data); + res.send(data); + } else { + res.status(Http.Status.BAD_REQUEST_400); + } + }); + }) + // It is possible to use Hanlder.of() method to automatically cover all error states. + .post("/bar", Handler.create(String.class, (req, res, data) -> { + System.out.println("/foo DATA: " + data); + res.send(data); + })) + .build(); + startServer(routing); + } + + /** + * Use a custom {@link MessageBodyReader reader} to convert the request content into an object of a given type. + */ + public void mediaReader() { + Routing routing = Routing.builder() + .post("/create-record", Handler.create(Name.class, (req, res, name) -> { + System.out.println("Name: " + name); + res.status(Http.Status.CREATED_201) + .send(name.toString()); + })) + .build(); + + // Create a media support that contains the defaults and our custom Name reader + MediaContext mediaContext = MediaContext.builder() + .addReader(NameReader.create()) + .build(); + + startServer(routing, mediaContext); + } + + /** + * Combination of filtering {@link Handler} pattern with {@link io.helidon.webserver.Service Service} registration capabilities + * can be used by other frameworks for the integration. WebServer is shipped with several integrated libraries (supports) + * including static content, JSON and Jersey. See {@code POM.xml} for requested dependencies. + */ + public void supports() { + Routing routing = Routing.builder() + .register(StaticContentSupport.create("/static")) + .get("/hello/{what}", (req, res) -> res.send(JSON.createObjectBuilder() + .add("message", + "Hello " + req.path() + .param("what")) + .build())) + .register("/api", JerseySupport.builder() + .register(HelloWorldResource.class) + .build()) + .build(); + + MediaContext mediaContext = MediaContext.builder() + .addWriter(JsonpSupport.writer()) + .build(); + + startServer(routing, mediaContext); + } + + /** + * Request processing can cause error represented by {@link Throwable}. It is possible to register custom + * {@link io.helidon.webserver.ErrorHandler ErrorHandlers} for specific processing. + *

    + * If error is not processed by a custom {@link io.helidon.webserver.ErrorHandler ErrorHandler} than default one is used. + * It respond with HTTP 500 code unless error is not represented + * by {@link HttpException HttpException}. In such case it reflects its content. + */ + public void errorHandling() { + Routing routing = Routing.builder() + .post("/compute", Handler.create(String.class, (req, res, str) -> { + int result = 100 / Integer.parseInt(str); + res.send(String.valueOf("100 / " + str + " = " + result)); + })) + .error(Throwable.class, (req, res, ex) -> { + ex.printStackTrace(System.out); + req.next(); + }) + .error(NumberFormatException.class, + (req, res, ex) -> res.status(Http.Status.BAD_REQUEST_400).send()) + .error(ArithmeticException.class, + (req, res, ex) -> res.status(Http.Status.PRECONDITION_FAILED_412).send()) + .build(); + startServer(routing); + } + + + // ---------------- EXECUTION + + private static final String SYSPROP_EXAMPLE_NAME = "exampleName"; + private static final String ENVVAR_EXAMPLE_NAME = "EXAMPLE_NAME"; + + /** + * Prints usage instructions. + */ + public void help() { + StringBuilder hlp = new StringBuilder(); + hlp.append("java -jar example-basics.jar \n"); + hlp.append("Example method names:\n"); + Method[] methods = Main.class.getDeclaredMethods(); + for (Method method : methods) { + if (Modifier.isPublic(method.getModifiers()) && !Modifier.isStatic(method.getModifiers())) { + hlp.append(" ").append(method.getName()).append('\n'); + } + } + hlp.append('\n'); + hlp.append("Example method name can be also provided as a\n"); + hlp.append(" - -D").append(SYSPROP_EXAMPLE_NAME).append(" jvm property.\n"); + hlp.append(" - ").append(ENVVAR_EXAMPLE_NAME).append(" environment variable.\n"); + System.out.println(hlp); + } + + /** + * Prints usage instructions. (Shortcut to {@link #help()} method. + */ + public void h() { + help(); + } + + /** + * Java main method. + * + * @param args Command line arguments. + */ + public static void main(String[] args) { + String exampleName = null; + if (args.length > 0) { + exampleName = args[0]; + } else if (System.getProperty(SYSPROP_EXAMPLE_NAME) != null) { + exampleName = System.getProperty(SYSPROP_EXAMPLE_NAME); + } else if (System.getenv(ENVVAR_EXAMPLE_NAME) != null) { + exampleName = System.getenv(ENVVAR_EXAMPLE_NAME); + } else { + System.out.println("Missing example name. It can be provided as a \n" + + " - first command line argument.\n" + + " - -D" + SYSPROP_EXAMPLE_NAME + " jvm property.\n" + + " - " + ENVVAR_EXAMPLE_NAME + " environment variable.\n"); + System.exit(1); + } + while (exampleName.startsWith("-")) { + exampleName = exampleName.substring(1); + } + Main m = new Main(); + try { + Method method = Main.class.getMethod(exampleName); + method.invoke(m); + } catch (NoSuchMethodException e) { + System.out.println("Missing example method named: " + exampleName); + System.exit(2); + } catch (IllegalAccessException | InvocationTargetException e) { + e.printStackTrace(System.out); + System.exit(100); + } + } +} diff --git a/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Name.java b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Name.java new file mode 100644 index 00000000..a4cca07f --- /dev/null +++ b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Name.java @@ -0,0 +1,90 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.basics; + +/** + * Represents a simple entity - the name. + */ +public class Name { + + private final String firstName; + private final String middleName; + private final String lastName; + + /** + * An naive implementation of name parser. + * + * @param fullName a full name + */ + public Name(String fullName) { + String[] split = fullName.split(" "); + switch (split.length) { + case 0: + throw new IllegalArgumentException("An empty name"); + case 1: + firstName = null; + middleName = null; + lastName = split[0]; + break; + case 2: + firstName = split[0]; + middleName = null; + lastName = split[1]; + break; + case 3: + firstName = split[0]; + middleName = split[1]; + lastName = split[2]; + break; + default: + throw new IllegalArgumentException("To many name parts!"); + } + } + + public String getFirstName() { + return firstName; + } + + public String getMiddleName() { + return middleName; + } + + public String getLastName() { + return lastName; + } + + @Override + public String toString() { + StringBuilder result = new StringBuilder(); + if (firstName != null) { + result.append(firstName); + } + if (middleName != null) { + if (result.length() > 0) { + result.append(' '); + } + result.append(middleName); + } + if (lastName != null) { + if (result.length() > 0) { + result.append(' '); + } + result.append(lastName); + } + return result.toString(); + } +} diff --git a/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/NameReader.java b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/NameReader.java new file mode 100644 index 00000000..8da93a12 --- /dev/null +++ b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/NameReader.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.basics; + +import java.util.concurrent.Flow; + +import io.helidon.common.GenericType; +import io.helidon.common.http.DataChunk; +import io.helidon.common.http.MediaType; +import io.helidon.common.reactive.Single; +import io.helidon.media.common.ContentReaders; +import io.helidon.media.common.MessageBodyReader; +import io.helidon.media.common.MessageBodyReaderContext; + +/** + * Reader for the custom media type. + */ +public class NameReader implements MessageBodyReader { + + private static final MediaType TYPE = MediaType.parse("application/name"); + + private NameReader() { + } + + static NameReader create() { + return new NameReader(); + } + + @Override + public Single read(Flow.Publisher publisher, GenericType type, + MessageBodyReaderContext context) { + return (Single) ContentReaders.readString(publisher, context.charset()).map(Name::new); + } + + @Override + public PredicateResult accept(GenericType type, MessageBodyReaderContext context) { + return context.contentType() + .filter(TYPE::equals) + .map(it -> PredicateResult.supports(Name.class, type)) + .orElse(PredicateResult.NOT_SUPPORTED); + } +} + + + + diff --git a/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/package-info.java b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/package-info.java new file mode 100644 index 00000000..ee535e91 --- /dev/null +++ b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * A set of small usage examples. Start with {@link io.helidon.webserver.examples.basics.Main Main} class. + */ +package io.helidon.webserver.examples.basics; diff --git a/examples/webserver/basics/src/main/resources/static/index.html b/examples/webserver/basics/src/main/resources/static/index.html new file mode 100644 index 00000000..598a9bc6 --- /dev/null +++ b/examples/webserver/basics/src/main/resources/static/index.html @@ -0,0 +1,28 @@ + + + + + + + Just index + + +

    Example

    + + diff --git a/examples/webserver/basics/src/test/java/io/helidon/webserver/examples/basics/MainTest.java b/examples/webserver/basics/src/test/java/io/helidon/webserver/examples/basics/MainTest.java new file mode 100644 index 00000000..1630aa4b --- /dev/null +++ b/examples/webserver/basics/src/test/java/io/helidon/webserver/examples/basics/MainTest.java @@ -0,0 +1,167 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.basics; + +import java.util.function.Consumer; + +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.media.common.MediaContext; +import io.helidon.webserver.Routing; +import io.helidon.webserver.testsupport.MediaPublisher; +import io.helidon.webserver.testsupport.TestClient; +import io.helidon.webserver.testsupport.TestResponse; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.notNullValue; +import static org.hamcrest.MatcherAssert.assertThat; + +public class MainTest { + + @Test + public void firstRouting() throws Exception { + // POST + TestResponse response = createClient(Main::firstRouting).path("/post-endpoint").post(); + assertThat(response.status().code(), is(201)); + // GET + response = createClient(Main::firstRouting).path("/get-endpoint").get(); + assertThat(response.status().code(), is(204)); + assertThat(response.asString().get(), is("Hello World!")); + } + + @Test + public void routingAsFilter() throws Exception { + // POST + TestResponse response = createClient(Main::routingAsFilter).path("/post-endpoint").post(); + assertThat(response.status().code(), is(201)); + // GET + response = createClient(Main::routingAsFilter).path("/get-endpoint").get(); + assertThat(response.status().code(), is(204)); + } + + @Test + public void parametersAndHeaders() throws Exception { + TestResponse response = createClient(Main::parametersAndHeaders).path("/context/aaa") + .queryParameter("bar", "bbb") + .header("foo", "ccc") + .get(); + assertThat(response.status().code(), is(200)); + String s = response.asString().get(); + assertThat(s, containsString("id: aaa")); + assertThat(s, containsString("bar: bbb")); + assertThat(s, containsString("foo: ccc")); + } + + @Test + public void organiseCode() throws Exception { + // List + TestResponse response = createClient(Main::organiseCode).path("/catalog-context-path").get(); + assertThat(response.status().code(), is(200)); + assertThat(response.asString().get(), is("1, 2, 3, 4, 5")); + // Get by id + response = createClient(Main::organiseCode).path("/catalog-context-path/aaa").get(); + assertThat(response.status().code(), is(200)); + assertThat(response.asString().get(), is("Item: aaa")); + } + + @Test + public void readContentEntity() throws Exception { + // foo + TestResponse response + = createClient(Main::readContentEntity).path("/foo") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "aaa")); + assertThat(response.status().code(), is(200)); + assertThat(response.asString().get(), is("aaa")); + // bar + response = createClient(Main::readContentEntity).path("/bar") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "aaa")); + assertThat(response.status().code(), is(200)); + assertThat(response.asString().get(), is("aaa")); + } + + @Test + public void mediaReader() throws Exception { + TestResponse response = createClient(Main::mediaReader) + .path("/create-record") + .post(MediaPublisher.create(MediaType.parse("application/name"), "John Smith")); + assertThat(response.status().code(), is(201)); + assertThat(response.asString().get(), is("John Smith")); + // Unsupported Content-Type + response = createClient(Main::mediaReader) + .path("/create-record") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "John Smith")); + assertThat(response.status().code(), is(500)); + } + + @Test + public void supports() throws Exception { + // Jersey + TestResponse response = createClient(Main::supports).path("/api/hw").get(); + assertThat(response.status().code(), is(200)); + assertThat(response.asString().get(), is("Hello world!")); + // Static content + response = createClient(Main::supports).path("/index.html").get(); + assertThat(response.status().code(), is(200)); + assertThat(response.headers().first(Http.Header.CONTENT_TYPE).orElse(null), is(MediaType.TEXT_HTML.toString())); + // JSON + response = createClient(Main::supports).path("/hello/Europe").get(); + assertThat(response.status().code(), is(200)); + assertThat(response.asString().get(), is("{\"message\":\"Hello Europe\"}")); + } + + @Test + public void errorHandling() throws Exception { + // Valid + TestResponse response = createClient(Main::errorHandling) + .path("/compute") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "2")); + assertThat(response.status().code(), is(200)); + assertThat(response.asString().get(), is("100 / 2 = 50")); + // Zero + response = createClient(Main::errorHandling) + .path("/compute") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "0")); + assertThat(response.status().code(), is(412)); + // NaN + response = createClient(Main::errorHandling) + .path("/compute") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "aaa")); + assertThat(response.status().code(), is(400)); + } + + private TestClient createClient(Consumer
    callTestedMethod) { + TMain tm = new TMain(); + callTestedMethod.accept(tm); + assertThat(tm.routing, notNullValue()); + return TestClient.create(tm.routing, tm.mediaContext); + } + + static class TMain extends Main { + + private Routing routing; + private MediaContext mediaContext; + + @Override + protected void startServer(Routing routing, MediaContext mediaContext) { + this.routing = routing; + this.mediaContext = mediaContext; + } + } +} diff --git a/examples/webserver/comment-aas/README.md b/examples/webserver/comment-aas/README.md new file mode 100644 index 00000000..3918c032 --- /dev/null +++ b/examples/webserver/comment-aas/README.md @@ -0,0 +1,20 @@ +# Comments As a Service + +This application allows users to add or read short comments related to a single topic. + Topic can be anything including blog post, newspaper article, and others. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-webserver-comment-aas.jar +``` + +Try the application: + +```shell +curl http://localhost:8080/comments/java -d "I use Helidon!" +curl http://localhost:8080/comments/java -d "I use vertx" +curl http://localhost:8080/comments/java -d "I use spring" +curl http://localhost:8080/comments/java +``` diff --git a/examples/webserver/comment-aas/etc/add-comment b/examples/webserver/comment-aas/etc/add-comment new file mode 100755 index 00000000..ff3d1c2d --- /dev/null +++ b/examples/webserver/comment-aas/etc/add-comment @@ -0,0 +1,38 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +if [ -f "$SCRIPT_DIR/user.txt" ]; then + export SVC_USER=`cat "$SCRIPT_DIR/user.txt"` +fi + +if [ -z "$2" ]; then + echo "Missing command line parameter! Usage: comment.sh " + exit 1 +fi + +if [ -z "$SVC_USER" ]; then + echo "Contacting service http://localhost:8080" + echo "" + curl --noproxy localhost -X POST --data "$2" http://localhost:8080/comments/$1 +else + echo "Contacting service http://localhost:8080 as $SVC_USER" + echo "" + curl --noproxy localhost -H "user-identity: $SVC_USER" -X POST --data "$2" http://localhost:8080/comments/$1 +fi +echo "" diff --git a/examples/webserver/comment-aas/etc/config.yaml b/examples/webserver/comment-aas/etc/config.yaml new file mode 100644 index 00000000..da7cd340 --- /dev/null +++ b/examples/webserver/comment-aas/etc/config.yaml @@ -0,0 +1,17 @@ +# +# Copyright (c) 2017, 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. +# + +anonymous-enabled: false diff --git a/examples/webserver/comment-aas/etc/create-etcd b/examples/webserver/comment-aas/etc/create-etcd new file mode 100755 index 00000000..e0ecae7e --- /dev/null +++ b/examples/webserver/comment-aas/etc/create-etcd @@ -0,0 +1,43 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +export SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +export ETCD_DATA_DIRS=/tmp/etcd-data/config-gerrit-etcd-data-dirs +rm -rf $ETCD_DATA_DIRS +export CONTAINER_NAME="config-etcd" + +docker rm -f $CONTAINER_NAME +export HOST_IP=`ifconfig | grep -Eo 'inet (addr:)?([0-9]*\.){3}[0-9]*' | grep -Eo '([0-9]*\.){3}[0-9]*' | grep -v '127.0.0.1'` + +docker run -d \ + -v $ETCD_DATA_DIRS:/var/data-dir \ + -p 2380:2380 \ + -p 2379:2379 \ + --name $CONTAINER_NAME \ + quay.io/coreos/etcd:v3.1.3 \ + etcd \ + -name etcd \ + -data-dir /var/data-dir \ + -advertise-client-urls http://$HOST_IP:2380 \ + -listen-client-urls http://0.0.0.0:2379 \ + -initial-advertise-peer-urls http://$HOST_IP:2380 \ + -listen-peer-urls http://0.0.0.0:2380 + +echo "Run with name $CONTAINER_NAME" + +echo "Test:" +docker exec $CONTAINER_NAME /bin/sh -c "ETCDCTL_API=3 etcdctl put my-key my-value" diff --git a/examples/webserver/comment-aas/etc/get-etcd-config b/examples/webserver/comment-aas/etc/get-etcd-config new file mode 100755 index 00000000..ee3c1f9f --- /dev/null +++ b/examples/webserver/comment-aas/etc/get-etcd-config @@ -0,0 +1,22 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +HOST_IP=`ifconfig | grep -Eo 'inet (addr:)?([0-9]*\.){3}[0-9]*' | grep -Eo '([0-9]*\.){3}[0-9]*' | grep -v '127.0.0.1'` + +echo "Retrieving configuration from ETCD:" +curl --noproxy $HOST_IP http://$HOST_IP:2379/v2/keys/comments-aas-config | python -m json.tool diff --git a/examples/webserver/comment-aas/etc/list-comments b/examples/webserver/comment-aas/etc/list-comments new file mode 100755 index 00000000..38280937 --- /dev/null +++ b/examples/webserver/comment-aas/etc/list-comments @@ -0,0 +1,38 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +if [ -f "$SCRIPT_DIR/user.txt" ]; then + export SVC_USER=`cat "$SCRIPT_DIR/user.txt"` +fi + +if [ -z "$1" ]; then + echo "Missing command line parameter! Usage: list_comments.sh " + exit 1 +fi + +if [ -z "$SVC_USER" ]; then + echo "Contacting service http://localhost:8080" + echo "" + curl --noproxy localhost http://localhost:8080/comments/$1 +else + echo "Contacting service http://localhost:8080 as $SVC_USER" + echo "" + curl --noproxy localhost -H "user-identity: $SVC_USER" http://localhost:8080/comments/$1 +fi +echo "" diff --git a/examples/webserver/comment-aas/etc/put-etcd-config b/examples/webserver/comment-aas/etc/put-etcd-config new file mode 100755 index 00000000..afe3b329 --- /dev/null +++ b/examples/webserver/comment-aas/etc/put-etcd-config @@ -0,0 +1,27 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +HOST_IP=`ifconfig | grep -Eo 'inet (addr:)?([0-9]*\.){3}[0-9]*' | grep -Eo '([0-9]*\.){3}[0-9]*' | grep -v '127.0.0.1'` +CONFIG_FILE="$SCRIPT_DIR/config.yaml" + +if [ -f "$CONFIG_FILE" ]; then + echo "Storing configuration into ETCD: $CONFIG_FILE" + curl --noproxy $HOST_IP -vvv http://$HOST_IP:2379/v2/keys/comments-aas-config -XPUT --data-urlencode value@$CONFIG_FILE +else + echo "Configuration file $CONFIG_FILE not found. DO NOT IMPORT INTO ETCD!" +fi diff --git a/examples/webserver/comment-aas/etc/start-etcd b/examples/webserver/comment-aas/etc/start-etcd new file mode 100755 index 00000000..3fa8af56 --- /dev/null +++ b/examples/webserver/comment-aas/etc/start-etcd @@ -0,0 +1,19 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +CONTAINER_NAME="config-etcd" +docker start $CONTAINER_NAME diff --git a/examples/webserver/comment-aas/etc/stop-comment-service b/examples/webserver/comment-aas/etc/stop-comment-service new file mode 100755 index 00000000..0bfdcd99 --- /dev/null +++ b/examples/webserver/comment-aas/etc/stop-comment-service @@ -0,0 +1,33 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +if [ -f "$SCRIPT_DIR/user.txt" ]; then + export SVC_USER=`cat "$SCRIPT_DIR/user.txt"` +fi + +if [ -z "$SVC_USER" ]; then + echo "Contacting service http://localhost:8080" + echo "" + curl --noproxy localhost -X POST http://localhost:8080/mgmt/shutdown +else + echo "Contacting service http://localhost:8080 as $SVC_USER" + echo "" + curl --noproxy localhost -H "user-identity: $SVC_USER" -X POST http://localhost:8080/mgmt/shutdown +fi +echo "" diff --git a/examples/webserver/comment-aas/etc/stop-etcd b/examples/webserver/comment-aas/etc/stop-etcd new file mode 100755 index 00000000..8f81778c --- /dev/null +++ b/examples/webserver/comment-aas/etc/stop-etcd @@ -0,0 +1,19 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +CONTAINER_NAME="config-etcd" +docker stop $CONTAINER_NAME diff --git a/examples/webserver/comment-aas/etc/switch-user b/examples/webserver/comment-aas/etc/switch-user new file mode 100755 index 00000000..356fd351 --- /dev/null +++ b/examples/webserver/comment-aas/etc/switch-user @@ -0,0 +1,26 @@ +#!/bin/bash +# +# Copyright (c) 2017, 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. +# + +SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +if [ -z "$1" ]; then + echo "set empty context user!" + rm -f "$SCRIPT_DIR/user.txt" +else + echo "set context user: $1" + echo "$1" > "$SCRIPT_DIR/user.txt" +fi diff --git a/examples/webserver/comment-aas/pom.xml b/examples/webserver/comment-aas/pom.xml new file mode 100644 index 00000000..d5283352 --- /dev/null +++ b/examples/webserver/comment-aas/pom.xml @@ -0,0 +1,88 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-comment-aas + 1.0.0-SNAPSHOT + Helidon WebServer Examples CommentsAAS + + Comments As A Service example application + + + io.helidon.webserver.examples.comments.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.common + helidon-common + + + io.helidon.config + helidon-config + + + io.helidon.config + helidon-config-yaml + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/CommentsService.java b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/CommentsService.java new file mode 100644 index 00000000..29de0b9f --- /dev/null +++ b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/CommentsService.java @@ -0,0 +1,121 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.comments; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + +import io.helidon.common.http.MediaType; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Basic service for comments. + */ +@SuppressWarnings("Duplicates") +public class CommentsService implements Service { + + private final ConcurrentHashMap> topicsAndComments = new ConcurrentHashMap<>(); + + @Override + public void update(Routing.Rules routingRules) { + routingRules + .get("/{topic}", this::handleListComments) + .post("/{topic}", this::handleAddComment); + } + + private void handleListComments(ServerRequest req, ServerResponse resp) { + String topic = req.path().param("topic"); + resp.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + resp.send(listComments(topic)); + } + + private void handleAddComment(ServerRequest req, ServerResponse resp) { + String topic = req.path().param("topic"); + + String userName = req.context().get("user", String.class) + .orElse("anonymous"); + + req.content() + .as(String.class) + .thenAccept(msg -> addComment(msg, userName, topic)) + .thenRun(resp::send) + .exceptionally(t -> { + req.next(t); + return null; + }); + } + + /** + * Adds new comment into the comment-room. + * + * @param message a comment message + * @param fromUser a user alias of the comment author + */ + void addComment(String message, String fromUser, String toTopic) { + ProfanityDetector.detectProfanity(message); + if (fromUser == null) { + fromUser = "anonymous"; + } + List comments = + topicsAndComments.computeIfAbsent(toTopic, k -> Collections.synchronizedList(new ArrayList<>())); + comments.add(new Comment(fromUser, message)); + } + + /** + * List all comments in original order as a string with single comment on the line. + * + * @param roomName a name of the room + * @return all comments, line-by-line + */ + String listComments(String roomName) { + List comments = topicsAndComments.get(roomName); + if (comments != null) { + return comments.stream() + .map(String::valueOf) + .collect(Collectors.joining("\n")); + } else { + return ""; + } + } + + private static class Comment { + private final String userName; + private final String message; + + Comment(String userName, String message) { + this.userName = userName; + this.message = message; + } + + @Override + public String toString() { + StringBuilder result = new StringBuilder(); + if (userName != null) { + result.append(userName); + } + result.append(": "); + result.append(message); + return result.toString(); + } + } +} diff --git a/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/Main.java b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/Main.java new file mode 100644 index 00000000..33b22947 --- /dev/null +++ b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/Main.java @@ -0,0 +1,94 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.comments; + +import java.util.Optional; +import java.util.concurrent.CompletionException; + +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.HttpException; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Application java main class. + *

    + *

    The COMMENTS-As-a-Service application example demonstrates Web Server in its integration role. + * It integrates various components including Configuration and Security. + *

    + *

    This WEB application provides possibility to store and read comment related to various topics. + */ +public final class Main { + + private Main() { + } + + /** + * A java main class. + * + * @param args command line arguments. + */ + public static void main(String[] args) { + // Load configuration + Config config = Config.create(); + + boolean acceptAnonymousUsers = config.get("anonymous-enabled").asBoolean().orElse(false); + + WebServer server = WebServer.create(createRouting(acceptAnonymousUsers), + config.get("webserver")); + + // Start the server and print some info. + server.start().thenAccept((ws) -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port() + "/comments"); + }); + + server.whenShutdown() + .thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + } + + static Routing createRouting(boolean acceptAnonymousUsers) { + return Routing.builder() + // Filter that translates user identity header into the contextual "user" information + .any((req, res) -> { + String user = req.headers().first("user-identity") + .or(() -> acceptAnonymousUsers ? Optional.of("anonymous") : Optional.empty()) + .orElseThrow(() -> new HttpException("Anonymous access is forbidden!", Http.Status.FORBIDDEN_403)); + + req.context().register("user", user); + req.next(); + }) + // Main service logic part is registered as a separated class to "/comments" context root + .register("/comments", new CommentsService()) + // Error handling for argot expressions. + .error(CompletionException.class, (req, res, ex) -> req.next(ex.getCause())) + .error(ProfanityException.class, (req, res, ex) -> { + res.status(Http.Status.NOT_ACCEPTABLE_406); + res.send("Expressions like '" + ex.getObfuscatedProfanity() + "' are unacceptable!"); + }) + .error(HttpException.class, (req, res, ex) -> { + if (ex.status() == Http.Status.FORBIDDEN_403) { + res.status(ex.status()); + res.send(ex.getMessage()); + } else { + req.next(); + } + }) + .build(); + } +} diff --git a/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/ProfanityDetector.java b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/ProfanityDetector.java new file mode 100644 index 00000000..65ae8d6f --- /dev/null +++ b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/ProfanityDetector.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.comments; + +/** + * Simple profanity detection utility class. + */ +class ProfanityDetector { + private static final String[] BANNED_TERMS = new String[] {"spring", "nodejs", "vertx"}; + + private ProfanityDetector() { + } + + /** + * Detects if a message contains one of the profane words. + * + * @param message a message to check. + */ + static void detectProfanity(String message) { + if (message == null) { + return; + } + message = message.toLowerCase(); + for (String bannedTerm : BANNED_TERMS) { + if (message.contains(bannedTerm)) { + throw new ProfanityException(bannedTerm); + } + } + } +} diff --git a/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/ProfanityException.java b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/ProfanityException.java new file mode 100644 index 00000000..e1dafdda --- /dev/null +++ b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/ProfanityException.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.comments; + +/** + * Thrown to indicate that a message contains illegal argot word. + */ +public class ProfanityException extends IllegalArgumentException { + + private final String profanity; + + /** + * Creates new instance. + * + * @param profanity an illegal argot word. + */ + public ProfanityException(String profanity) { + super("Do not use such an ugly word as '" + obfuscate(profanity) + "'!"); + this.profanity = profanity; + } + + /** + * Returns an illegal argot word! + * + * @return an argot word + */ + public String getProfanity() { + return profanity; + } + + /** + * Returns an illegal argot word in obfuscated form! + * + * @return an argot word in obfuscated form + */ + public String getObfuscatedProfanity() { + return obfuscate(profanity); + } + + private static String obfuscate(String argot) { + if (argot == null || argot.length() < 2) { + return argot; + } + if (argot.length() == 2) { + return argot.charAt(0) + "*"; + } + return argot.charAt(0) + "*" + argot.charAt(argot.length() - 1); + } +} diff --git a/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/package-info.java b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/package-info.java new file mode 100644 index 00000000..aaf70e70 --- /dev/null +++ b/examples/webserver/comment-aas/src/main/java/io/helidon/webserver/examples/comments/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * The COMMENTS-As-a-Service application example demonstrates Web Server in its integration role. + * It integrates various components including Configuration and Security. + * + *

    This WEB application provides possibility to store and read comment related to various topics. + */ +package io.helidon.webserver.examples.comments; diff --git a/examples/webserver/comment-aas/src/main/resources/application.yaml b/examples/webserver/comment-aas/src/main/resources/application.yaml new file mode 100644 index 00000000..869b357d --- /dev/null +++ b/examples/webserver/comment-aas/src/main/resources/application.yaml @@ -0,0 +1,21 @@ +# +# Copyright (c) 2017, 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. +# + +webserver: + port: 8080 + +# If true then anonymous access is enabled. +anonymous-enabled: true diff --git a/examples/webserver/comment-aas/src/test/java/io/helidon/webserver/examples/comments/CommentsServiceTest.java b/examples/webserver/comment-aas/src/test/java/io/helidon/webserver/examples/comments/CommentsServiceTest.java new file mode 100644 index 00000000..56d18b05 --- /dev/null +++ b/examples/webserver/comment-aas/src/test/java/io/helidon/webserver/examples/comments/CommentsServiceTest.java @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.comments; + +import java.nio.charset.StandardCharsets; + +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.webserver.Routing; +import io.helidon.webserver.testsupport.MediaPublisher; +import io.helidon.webserver.testsupport.TestClient; +import io.helidon.webserver.testsupport.TestResponse; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.isEmptyString; + + +/** + * Tests {@link CommentsService}. + */ +public class CommentsServiceTest { + + @Test + public void addAndGetComments() throws Exception { + CommentsService service = new CommentsService(); + assertThat(service.listComments("one"), isEmptyString()); + assertThat(service.listComments("two"), isEmptyString()); + + service.addComment("aaa", null, "one"); + assertThat(service.listComments("one"), is("anonymous: aaa")); + assertThat(service.listComments("two"), isEmptyString()); + + service.addComment("bbb", "Foo", "one"); + assertThat(service.listComments("one"), is("anonymous: aaa\nFoo: bbb")); + assertThat(service.listComments("two"), isEmptyString()); + + service.addComment("bbb", "Bar", "two"); + assertThat(service.listComments("one"), is("anonymous: aaa\nFoo: bbb")); + assertThat(service.listComments("two"), is("Bar: bbb")); + } + + @Test + public void testRouting() throws Exception { + Routing routing = Routing.builder() + .register(new CommentsService()) + .build(); + TestResponse response = TestClient.create(routing) + .path("one") + .get(); + assertThat(response.status(), is(Http.Status.OK_200)); + + response = TestClient.create(routing) + .path("one") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "aaa")); + assertThat(response.status(), is(Http.Status.OK_200)); + + response = TestClient.create(routing) + .path("one") + .get(); + assertThat(response.status(), is(Http.Status.OK_200)); + byte[] data = response.asBytes().toCompletableFuture().join(); + assertThat(new String(data, StandardCharsets.UTF_8), is("anonymous: aaa")); + } + +} diff --git a/examples/webserver/comment-aas/src/test/java/io/helidon/webserver/examples/comments/MainTest.java b/examples/webserver/comment-aas/src/test/java/io/helidon/webserver/examples/comments/MainTest.java new file mode 100644 index 00000000..65ff5fd8 --- /dev/null +++ b/examples/webserver/comment-aas/src/test/java/io/helidon/webserver/examples/comments/MainTest.java @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.comments; + +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.webserver.testsupport.MediaPublisher; +import io.helidon.webserver.testsupport.TestClient; +import io.helidon.webserver.testsupport.TestResponse; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Tests {@link Main} class. + */ +public class MainTest { + + @Test + public void argot() throws Exception { + TestResponse response = TestClient.create(Main.createRouting(true)) + .path("/comments/one") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "Spring framework is the BEST!")); + assertThat(response.status(), is(Http.Status.NOT_ACCEPTABLE_406)); + } + + @Test + public void anonymousDisabled() throws Exception { + TestResponse response = TestClient.create(Main.createRouting(false)) + .path("/comment/one") + .get(); + + assertThat(response.status(), is(Http.Status.FORBIDDEN_403)); + } +} diff --git a/examples/webserver/fault-tolerance/pom.xml b/examples/webserver/fault-tolerance/pom.xml new file mode 100644 index 00000000..74f35fb6 --- /dev/null +++ b/examples/webserver/fault-tolerance/pom.xml @@ -0,0 +1,86 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.webserver + helidon-examples-webserver-fault-tolerance + 1.0.0-SNAPSHOT + Helidon WebServer Examples FT + + + Application demonstrates Fault tolerance used in webserver. + + + + io.helidon.webserver.examples.faulttolerance.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.fault-tolerance + helidon-fault-tolerance + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/FtService.java b/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/FtService.java new file mode 100644 index 00000000..da3a7080 --- /dev/null +++ b/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/FtService.java @@ -0,0 +1,168 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.faulttolerance; + +import java.time.Duration; +import java.util.concurrent.atomic.AtomicInteger; + +import io.helidon.common.reactive.Single; +import io.helidon.faulttolerance.Async; +import io.helidon.faulttolerance.Bulkhead; +import io.helidon.faulttolerance.CircuitBreaker; +import io.helidon.faulttolerance.Fallback; +import io.helidon.faulttolerance.Retry; +import io.helidon.faulttolerance.Timeout; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Simple service to demonstrate fault tolerance. + */ +public class FtService implements Service { + + private final Async async; + private final Bulkhead bulkhead; + private final CircuitBreaker breaker; + private final Fallback fallback; + private final Retry retry; + private final Timeout timeout; + + FtService() { + this.async = Async.create(); + this.bulkhead = Bulkhead.builder() + .queueLength(1) + .limit(1) + .name("helidon-example-bulkhead") + .build(); + this.breaker = CircuitBreaker.builder() + .volume(4) + .errorRatio(40) + .successThreshold(1) + .delay(Duration.ofSeconds(5)) + .build(); + this.fallback = Fallback.create(this::fallbackToMethod); + this.retry = Retry.builder() + .retryPolicy(Retry.DelayingRetryPolicy.noDelay(3)) + .build(); + this.timeout = Timeout.create(Duration.ofMillis(100)); + } + + @Override + public void update(Routing.Rules rules) { + rules.get("/async", this::asyncHandler) + .get("/bulkhead/{millis}", this::bulkheadHandler) + .get("/circuitBreaker/{success}", this::circuitBreakerHandler) + .get("/fallback/{success}", this::fallbackHandler) + .get("/retry/{count}", this::retryHandler) + .get("/timeout/{millis}", this::timeoutHandler); + } + + private void timeoutHandler(ServerRequest request, ServerResponse response) { + long sleep = Long.parseLong(request.path().param("millis")); + + timeout.invoke(() -> sleep(sleep)) + .thenAccept(response::send) + .exceptionally(response::send); + } + + private void retryHandler(ServerRequest request, ServerResponse response) { + int count = Integer.parseInt(request.path().param("count")); + + AtomicInteger call = new AtomicInteger(1); + AtomicInteger failures = new AtomicInteger(); + + retry.invoke(() -> { + int current = call.getAndIncrement(); + if (current < count) { + failures.incrementAndGet(); + return reactiveFailure(); + } + return Single.just("calls/failures: " + current + "/" + failures.get()); + }).thenAccept(response::send) + .exceptionally(response::send); + } + + private void fallbackHandler(ServerRequest request, ServerResponse response) { + boolean success = "true".equalsIgnoreCase(request.path().param("success")); + + if (success) { + fallback.invoke(this::reactiveData).thenAccept(response::send); + } else { + fallback.invoke(this::reactiveFailure).thenAccept(response::send); + } + } + + private void circuitBreakerHandler(ServerRequest request, ServerResponse response) { + boolean success = "true".equalsIgnoreCase(request.path().param("success")); + + if (success) { + breaker.invoke(this::reactiveData) + .thenAccept(response::send) + .exceptionally(response::send); + } else { + breaker.invoke(this::reactiveFailure) + .thenAccept(response::send) + .exceptionally(response::send); + } + + } + + private void bulkheadHandler(ServerRequest request, ServerResponse response) { + long sleep = Long.parseLong(request.path().param("millis")); + + bulkhead.invoke(() -> sleep(sleep)) + .thenAccept(response::send) + .exceptionally(response::send); + } + + private void asyncHandler(ServerRequest request, ServerResponse response) { + async.invoke(this::blockingData).thenApply(response::send); + } + + private Single reactiveFailure() { + return Single.error(new RuntimeException("reactive failure")); + } + + private Single sleep(long sleepMillis) { + return async.invoke(() -> { + try { + Thread.sleep(sleepMillis); + } catch (InterruptedException ignored) { + } + return "Slept for " + sleepMillis + " ms"; + }); + } + + private Single reactiveData() { + return async.invoke(this::blockingData); + } + + private String blockingData() { + try { + Thread.sleep(100); + } catch (InterruptedException ignored) { + } + return "blocked for 100 millis"; + } + + private Single fallbackToMethod(Throwable e) { + return Single.just("Failed back because of " + e.getMessage()); + } + +} diff --git a/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/Main.java b/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/Main.java new file mode 100644 index 00000000..f4508618 --- /dev/null +++ b/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/Main.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.faulttolerance; + +import java.util.concurrent.TimeoutException; + +import io.helidon.common.LogConfig; +import io.helidon.common.http.Http; +import io.helidon.common.reactive.Single; +import io.helidon.faulttolerance.BulkheadException; +import io.helidon.faulttolerance.CircuitBreakerOpenException; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Main class of Fault tolerance example. + */ +public final class Main { + // utility class + private Main() { + } + + /** + * Start the example. + * + * @param args start arguments are ignored + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + startServer(8079).thenRun(() -> {}); + } + + static Single startServer(int port) { + return WebServer.builder() + .routing(routing()) + .port(port) + .build() + .start() + .peek(server -> { + String url = "http://localhost:" + server.port(); + System.out.println("Server started on " + url); + }); + } + + private static Routing routing() { + return Routing.builder() + .register("/ft", new FtService()) + .error(BulkheadException.class, + (req, res, ex) -> res.status(Http.Status.SERVICE_UNAVAILABLE_503).send("bulkhead")) + .error(CircuitBreakerOpenException.class, + (req, res, ex) -> res.status(Http.Status.SERVICE_UNAVAILABLE_503).send("circuit breaker")) + .error(TimeoutException.class, + (req, res, ex) -> res.status(Http.Status.REQUEST_TIMEOUT_408).send("timeout")) + .error(Throwable.class, + (req, res, ex) -> res.status(Http.Status.INTERNAL_SERVER_ERROR_500) + .send(ex.getClass().getName() + ": " + ex.getMessage())) + .build(); + } +} diff --git a/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/package-info.java b/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/package-info.java new file mode 100644 index 00000000..d0005776 --- /dev/null +++ b/examples/webserver/fault-tolerance/src/main/java/io/helidon/webserver/examples/faulttolerance/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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 of Fault Tolerance usage in webserver. + */ +package io.helidon.webserver.examples.faulttolerance; diff --git a/examples/webserver/fault-tolerance/src/main/resources/logging.properties b/examples/webserver/fault-tolerance/src/main/resources/logging.properties new file mode 100644 index 00000000..016a6d06 --- /dev/null +++ b/examples/webserver/fault-tolerance/src/main/resources/logging.properties @@ -0,0 +1,22 @@ +# +# Copyright (c) 2020, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.server.level=INFO + +#io.helidon.faulttolerance.level=FINEST diff --git a/examples/webserver/fault-tolerance/src/test/java/io/helidon/webserver/examples/faulttolerance/MainTest.java b/examples/webserver/fault-tolerance/src/test/java/io/helidon/webserver/examples/faulttolerance/MainTest.java new file mode 100644 index 00000000..c485b2b1 --- /dev/null +++ b/examples/webserver/fault-tolerance/src/test/java/io/helidon/webserver/examples/faulttolerance/MainTest.java @@ -0,0 +1,199 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.faulttolerance; + +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.http.Http; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +class MainTest { + private static WebServer server; + private static WebClient client; + + @BeforeAll + static void initClass() throws ExecutionException, InterruptedException { + server = Main.startServer(0) + .await(10, TimeUnit.SECONDS); + + client = WebClient.builder() + .baseUri("http://localhost:" + server.port() + "/ft") + .build(); + } + + @AfterAll + static void destroyClass() { + server.shutdown() + .await(5, TimeUnit.SECONDS); + } + + @Test + void testAsync() { + String response = client.get() + .path("/async") + .request(String.class) + .await(5, TimeUnit.SECONDS); + + assertThat(response, is("blocked for 100 millis")); + } + + @Test + void testBulkhead() throws InterruptedException { + // bulkhead is configured for limit of 1 and queue of 1, so third + // request should fail + client.get() + .path("/bulkhead/10000") + .request(); + + client.get() + .path("/bulkhead/10000") + .request(); + + // I want to make sure the above is connected + Thread.sleep(300); + + WebClientResponse third = client.get() + .path("/bulkhead/10000") + .request() + .await(1, TimeUnit.SECONDS); + + // registered an error handler in Main + assertThat(third.status(), is(Http.Status.SERVICE_UNAVAILABLE_503)); + assertThat(third.content().as(String.class).await(1, TimeUnit.SECONDS), is("bulkhead")); + } + + @Test + void testCircuitBreaker() { + String response = client.get() + .path("/circuitBreaker/true") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("blocked for 100 millis")); + + // error ratio is 20% within 10 request + client.get() + .path("/circuitBreaker/false") + .request() + .await(1, TimeUnit.SECONDS); + + // should work after first + response = client.get() + .path("/circuitBreaker/true") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("blocked for 100 millis")); + + // should open after second + client.get() + .path("/circuitBreaker/false") + .request() + .await(1, TimeUnit.SECONDS); + + WebClientResponse clientResponse = client.get() + .path("/circuitBreaker/true") + .request() + .await(1, TimeUnit.SECONDS); + response = clientResponse.content().as(String.class).await(1, TimeUnit.SECONDS); + + // registered an error handler in Main + assertThat(clientResponse.status(), is(Http.Status.SERVICE_UNAVAILABLE_503)); + assertThat(response, is("circuit breaker")); + } + + @Test + void testFallback() { + String response = client.get() + .path("/fallback/true") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("blocked for 100 millis")); + + response = client.get() + .path("/fallback/false") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("Failed back because of reactive failure")); + } + + @Test + void testRetry() { + String response = client.get() + .path("/retry/1") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("calls/failures: 1/0")); + + response = client.get() + .path("/retry/2") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("calls/failures: 2/1")); + + response = client.get() + .path("/retry/3") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("calls/failures: 3/2")); + + WebClientResponse clientResponse = client.get() + .path("/retry/4") + .request() + .await(1, TimeUnit.SECONDS); + + response = clientResponse.content().as(String.class).await(1, TimeUnit.SECONDS); + // no error handler specified + assertThat(clientResponse.status(), is(Http.Status.INTERNAL_SERVER_ERROR_500)); + assertThat(response, is("java.lang.RuntimeException: reactive failure")); + } + + @Test + void testTimeout() { + String response = client.get() + .path("/timeout/10") + .request(String.class) + .await(1, TimeUnit.SECONDS); + + assertThat(response, is("Slept for 10 ms")); + + WebClientResponse clientResponse = client.get() + .path("/timeout/1000") + .request() + .await(1, TimeUnit.SECONDS); + + response = clientResponse.content().as(String.class).await(1, TimeUnit.SECONDS); + // error handler specified in Main + assertThat(clientResponse.status(), is(Http.Status.REQUEST_TIMEOUT_408)); + assertThat(response, is("timeout")); + } +} \ No newline at end of file diff --git a/examples/webserver/jersey/README.md b/examples/webserver/jersey/README.md new file mode 100644 index 00000000..c6d6bcea --- /dev/null +++ b/examples/webserver/jersey/README.md @@ -0,0 +1,18 @@ +# WebServer Jersey Application Example + +An example of **Jersey** integration into the **Web Server**. + +This is just a simple Hello World example. A user can start the application using the `WebServerJerseyMain` class +and `GET` the `Hello World!` response by accessing `http://localhost:8080/jersey/hello`. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-webserver-jersey.jar +``` + +Make an HTTP request to application: +```shell +curl http://localhost:8080/jersey/hello +``` diff --git a/examples/webserver/jersey/pom.xml b/examples/webserver/jersey/pom.xml new file mode 100644 index 00000000..0bff5ebf --- /dev/null +++ b/examples/webserver/jersey/pom.xml @@ -0,0 +1,82 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-jersey + 1.0.0-SNAPSHOT + Helidon WebServer Examples Jersey + + + WebServer Jersey example application + + + + io.helidon.webserver.examples.jersey.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-jersey + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/HelloWorld.java b/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/HelloWorld.java new file mode 100644 index 00000000..7aeb96eb --- /dev/null +++ b/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/HelloWorld.java @@ -0,0 +1,39 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.jersey; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.core.Response; + +/** + * The Hello World Example JAX-RS resource. + */ +@Path("/") +public class HelloWorld { + + /** + * A simple resource returning {@code Hello World!} string. + * + * @return {@code Hello World!} string as a response + */ + @GET + @Path("hello") + public Response hello() { + return Response.ok("Hello World!").build(); + } +} diff --git a/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/Main.java b/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/Main.java new file mode 100644 index 00000000..0518e9e1 --- /dev/null +++ b/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/Main.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.jersey; + +import java.util.concurrent.CompletionStage; + +import io.helidon.common.LogConfig; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.jersey.JerseySupport; + +import org.glassfish.jersey.server.ResourceConfig; + +/** + * The WebServer Jersey Main example class. + * + * @see #main(String[]) + * @see #startServer(int) + */ +public final class Main { + + private Main() { + } + + /** + * Run the Jersey WebServer Example. + * + * @param args arguments are not used + */ + public static void main(String[] args) { + // configure logging in order to not have the standard JVM defaults + LogConfig.configureRuntime(); + + // start the server on port 8080 + startServer(8080); + } + + /** + * Start the WebServer based on the provided configuration. When running from + * a test, pass {@link null} to have a dynamically allocated port + * the server listens on. + * + * @param port port to start server on + * @return a completion stage indicating that the server has started and is ready to + * accept http requests + */ + static CompletionStage startServer(int port) { + WebServer webServer = WebServer.builder( + Routing.builder() + // register a Jersey Application at the '/jersey' context path + .register("/jersey", + JerseySupport.create(new ResourceConfig(HelloWorld.class))) + .build()) + .port(port) + .build(); + + return webServer.start() + .whenComplete((server, t) -> { + System.out.println("Jersey WebServer started."); + System.out.println("To stop the application, hit CTRL+C"); + System.out.println("Try the hello world resource at: http://localhost:" + server + .port() + "/jersey/hello"); + }); + } +} diff --git a/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/package-info.java b/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/package-info.java new file mode 100644 index 00000000..1537cec0 --- /dev/null +++ b/examples/webserver/jersey/src/main/java/io/helidon/webserver/examples/jersey/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * An example of Jersey integration into the Web Server. + * + * @see io.helidon.webserver.jersey.JerseySupport + * @see io.helidon.webserver.WebServer + */ +package io.helidon.webserver.examples.jersey; diff --git a/examples/webserver/jersey/src/main/resources/logging.properties b/examples/webserver/jersey/src/main/resources/logging.properties new file mode 100644 index 00000000..5b636c03 --- /dev/null +++ b/examples/webserver/jersey/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +#All attributes details +handlers=io.helidon.common.HelidonConsoleHandler +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 + +#All log level details +.level=WARNING + +io.helidon.webserver.level=INFO +org.glassfish.jersey.internal.Errors.level=SEVERE diff --git a/examples/webserver/jersey/src/test/java/io/helidon/webserver/examples/jersey/HelloWorldTest.java b/examples/webserver/jersey/src/test/java/io/helidon/webserver/examples/jersey/HelloWorldTest.java new file mode 100644 index 00000000..76151fe6 --- /dev/null +++ b/examples/webserver/jersey/src/test/java/io/helidon/webserver/examples/jersey/HelloWorldTest.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.jersey; + +import java.util.concurrent.TimeUnit; + +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.core.Response; + +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * The Jersey Client based example that tests the {@link HelloWorld} resource + * that gets served by running {@link Main#startServer(int)} + * + * @see HelloWorld + * @see Main + */ +public class HelloWorldTest { + + private static WebServer webServer; + + @BeforeAll + public static void startTheServer() throws Exception { + webServer = Main.startServer(0) + .toCompletableFuture() + .get(10, TimeUnit.SECONDS); + } + + @AfterAll + public static void stopServer() throws Exception { + if (webServer != null) { + webServer.shutdown() + .toCompletableFuture() + .get(10, TimeUnit.SECONDS); + } + } + + @Test + public void testHelloWorld() throws Exception { + Client client = ClientBuilder.newClient(); + try (Response response = client.target("http://localhost:" + webServer.port()) + .path("jersey/hello") + .request() + .get()) { + assertThat("Unexpected response; status: " + response.getStatus(), + response.readEntity(String.class), is("Hello World!")); + } finally { + client.close(); + } + } +} diff --git a/examples/webserver/multiport/README.md b/examples/webserver/multiport/README.md new file mode 100644 index 00000000..fbdc9d86 --- /dev/null +++ b/examples/webserver/multiport/README.md @@ -0,0 +1,38 @@ +# Helidon WebServer Multiple Port Example + +It is common when deploying a microservice to run your service on +multiple ports so that you can control the visibility of your +service's endpoints. For example you might want to use three ports: + +- 8080: public REST endpoints of application +- 8081: private REST endpoints of application +- 8082: admin endpoints for health, metrics, etc. + +This lets you expose only the public endpoints via your +ingress controller or load balancer. + +This example shows a Helidon application running on three ports +as described above. + +The ports are configured in `application.yaml` by using named sockets. + +Seperate routing is defined for each named socket in `Main.java` + +## Build and run + +With JDK11+ +```shell +mvn package +java -jar target/helidon-examples-webserver-multiport.jar +``` +## Exercise the application + +```shell +curl -X GET http://localhost:8080/hello + +curl -X GET http://localhost:8081/private/hello + +curl -X GET http://localhost:8082/health + +curl -X GET http://localhost:8082/metrics +``` diff --git a/examples/webserver/multiport/pom.xml b/examples/webserver/multiport/pom.xml new file mode 100644 index 00000000..6018c4f5 --- /dev/null +++ b/examples/webserver/multiport/pom.xml @@ -0,0 +1,99 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-multiport + 1.0.0-SNAPSHOT + Helidon WebServer Examples Multiple Ports + + + io.helidon.examples.webserver.multiport.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + org.junit.jupiter + junit-jupiter-params + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/multiport/src/main/java/io/helidon/examples/webserver/multiport/Main.java b/examples/webserver/multiport/src/main/java/io/helidon/examples/webserver/multiport/Main.java new file mode 100644 index 00000000..920c9941 --- /dev/null +++ b/examples/webserver/multiport/src/main/java/io/helidon/examples/webserver/multiport/Main.java @@ -0,0 +1,126 @@ +/* + * 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. + */ + +package io.helidon.examples.webserver.multiport; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * @param args command line arguments. + */ + public static void main(final String[] args) { + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + startServer(config); + } + + /** + * Start the server. + * @return the created {@link WebServer} instance + */ + static Single startServer(Config config) { + // load logging configuration + LogConfig.configureRuntime(); + + // Build server using three ports: + // default public port, admin port, private port + WebServer server = WebServer.builder(createPublicRouting()) + .config(config.get("server")) + // Add a set of routes on the named socket "admin" + .addNamedRouting("admin", createAdminRouting()) + // Add a set of routes on the named socket "private" + .addNamedRouting("private", createPrivateRouting()) + .build(); + + Single webserver = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webserver.thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port()); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + + // Server threads are not daemon. No need to block. Just react. + + return webserver; + } + + /** + * Creates private {@link Routing}. + * + * @return routing for use on "private" port + */ + private static Routing createPrivateRouting() { + return Routing.builder() + .get("/private/hello", (req, res) -> res.send("Private Hello!!")) + .build(); + } + + /** + * Creates public {@link Routing}. + * + * @return routing for use on "public" port + */ + private static Routing createPublicRouting() { + return Routing.builder() + .get("/hello", (req, res) -> res.send("Public Hello!!")) + .build(); + } + + /** + * Creates admin {@link Routing}. + * + * @return routing for use on admin port + */ + private static Routing createAdminRouting() { + MetricsSupport metrics = MetricsSupport.create(); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + + return Routing.builder() + .register(health) + .register(metrics) + .build(); + } +} diff --git a/examples/webserver/multiport/src/main/java/io/helidon/examples/webserver/multiport/package-info.java b/examples/webserver/multiport/src/main/java/io/helidon/examples/webserver/multiport/package-info.java new file mode 100644 index 00000000..1bc7189f --- /dev/null +++ b/examples/webserver/multiport/src/main/java/io/helidon/examples/webserver/multiport/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ +/** + * Application that exposes multiple ports. + */ +package io.helidon.examples.webserver.multiport; diff --git a/examples/webserver/multiport/src/main/resources/application.yaml b/examples/webserver/multiport/src/main/resources/application.yaml new file mode 100644 index 00000000..0c249e92 --- /dev/null +++ b/examples/webserver/multiport/src/main/resources/application.yaml @@ -0,0 +1,25 @@ +# +# 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. +# +server: + port: 8080 + host: "localhost" + sockets: + - name: "private" + port: 8081 + bind-address: "localhost" + - name: "admin" + port: 8082 + bind-address: "localhost" diff --git a/examples/webserver/multiport/src/main/resources/logging.properties b/examples/webserver/multiport/src/main/resources/logging.properties new file mode 100644 index 00000000..1395ed17 --- /dev/null +++ b/examples/webserver/multiport/src/main/resources/logging.properties @@ -0,0 +1,34 @@ +# +# 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.common.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 + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/webserver/multiport/src/test/java/io/helidon/examples/webserver/multiport/MainTest.java b/examples/webserver/multiport/src/test/java/io/helidon/examples/webserver/multiport/MainTest.java new file mode 100644 index 00000000..b5bfdc72 --- /dev/null +++ b/examples/webserver/multiport/src/test/java/io/helidon/examples/webserver/multiport/MainTest.java @@ -0,0 +1,143 @@ +/* + * 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. + */ + +package io.helidon.examples.webserver.multiport; + +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.stream.Stream; + +import io.helidon.common.http.Http; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.MethodSource; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + private static int publicPort; + private static int privatePort; + private static int adminPort; + + @BeforeAll + public static void startTheServer() { + // Use test configuration so we can have ports allocated dynamically + Config config = Config.builder().addSource(ConfigSources.classpath("application-test.yaml")).build(); + Single w = Main.startServer(config); + webServer = w.await(); + webClient = WebClient.builder().build(); + + publicPort = webServer.port(); + privatePort = webServer.port("private"); + adminPort = webServer.port("admin"); + } + + static Stream initParams() { + final String PUBLIC_PATH = "/hello"; + final String PRIVATE_PATH = "/private/hello"; + final String HEALTH_PATH = "/health"; + final String METRICS_PATH = "/health"; + + return List.of( + new Params(publicPort, PUBLIC_PATH, Http.Status.OK_200), + new Params(publicPort, PRIVATE_PATH, Http.Status.NOT_FOUND_404), + new Params(publicPort, HEALTH_PATH, Http.Status.NOT_FOUND_404), + new Params(publicPort, METRICS_PATH, Http.Status.NOT_FOUND_404), + + new Params(privatePort, PUBLIC_PATH, Http.Status.NOT_FOUND_404), + new Params(privatePort, PRIVATE_PATH, Http.Status.OK_200), + new Params(privatePort, HEALTH_PATH, Http.Status.NOT_FOUND_404), + new Params(privatePort, METRICS_PATH, Http.Status.NOT_FOUND_404), + + new Params(adminPort, PUBLIC_PATH, Http.Status.NOT_FOUND_404), + new Params(adminPort, PRIVATE_PATH, Http.Status.NOT_FOUND_404), + new Params(adminPort, HEALTH_PATH, Http.Status.OK_200), + new Params(adminPort, METRICS_PATH, Http.Status.OK_200) + ).stream(); + } + + @AfterAll + public static void stopServer() throws Exception { + if (webServer != null) { + webServer.shutdown() + .toCompletableFuture() + .get(10, TimeUnit.SECONDS); + } + } + + @MethodSource("initParams") + @ParameterizedTest + public void portAccessTest(Params params) throws Exception { + // Verifies we can access endpoints only on the proper port + webClient.get() + .uri("http://localhost:" + params.port) + .path(params.path) + .request() + .thenAccept(response -> assertThat(response.status(), is(params.httpStatus))) + .toCompletableFuture() + .get(); + } + + @Test + public void portTest() throws Exception { + + webClient.get() + .uri("http://localhost:" + publicPort) + .path("/hello") + .request(String.class) + .thenAccept(s -> assertThat(s, is("Public Hello!!"))) + .toCompletableFuture() + .get(); + + webClient.get() + .uri("http://localhost:" + privatePort) + .path("/private/hello") + .request(String.class) + .thenAccept(s -> assertThat(s, is("Private Hello!!"))) + .toCompletableFuture() + .get(); + } + + private static class Params { + int port; + String path; + Http.Status httpStatus; + + private Params(int port, String path, Http.Status httpStatus) { + this.port = port; + this.path = path; + this.httpStatus = httpStatus; + } + + @Override + public String toString() { + return port + ":" + path + " should return " + httpStatus; + } + } + +} diff --git a/examples/webserver/multiport/src/test/resources/application-test.yaml b/examples/webserver/multiport/src/test/resources/application-test.yaml new file mode 100644 index 00000000..2730bb31 --- /dev/null +++ b/examples/webserver/multiport/src/test/resources/application-test.yaml @@ -0,0 +1,25 @@ +# +# 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. +# +server: + port: 0 + host: "localhost" + sockets: + - name: "private" + port: 0 + bind-address: "localhost" + - name: "admin" + port: 0 + bind-address: "localhost" diff --git a/examples/webserver/mutual-tls/README.md b/examples/webserver/mutual-tls/README.md new file mode 100644 index 00000000..a1a1c6ce --- /dev/null +++ b/examples/webserver/mutual-tls/README.md @@ -0,0 +1,26 @@ +# Mutual TLS Example + +This application demonstrates use of client certificates to +authenticate HTTP client. + +## Build and run + +This example requires two components - the server and the client. + +For each, there is an example using configuration, and an example using +builder APIs. + +To test the example: +Start one of + - `ServerBuilderMain` - main class for WebServer using builders + - `ServerConfigMain` - main class for WebServer using Config + +Once the server is running, use one of: + - `ClientBuilderMain` - main class for WebClient using builders + - `ClientConfigMain` - main class for WebClient using Config + +to invoke the endpoint using client certificate. + +Alternative approach is to install the private key and certificate +to your browser and invoke the endpoint manually. + \ No newline at end of file diff --git a/examples/webserver/mutual-tls/automatic-store-generator.sh b/examples/webserver/mutual-tls/automatic-store-generator.sh new file mode 100644 index 00000000..03d7da1c --- /dev/null +++ b/examples/webserver/mutual-tls/automatic-store-generator.sh @@ -0,0 +1,163 @@ +#!/bin/bash -e +# +# Copyright (c) 2020, 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. +# + +# Windows Mingwin fix for path resolving +#export MSYS_NO_PATHCONV=1 + +NAME="" +TYPE=PKCS12 +SINGLE=true + +createCertificatesAndStores() { + mkdir out + echo 'Generating new key stores...' + keytool -genkeypair -keyalg RSA -keysize 2048 -alias root-ca -dname "CN=$NAME-CA" -validity 21650 -keystore ca.jks -storepass changeit -keypass changeit -deststoretype pkcs12 -ext KeyUsage=digitalSignature,keyEncipherment,keyCertSign -ext ExtendedKeyUsage=serverAuth,clientAuth -ext BasicConstraints=ca:true,PathLen:3 + keytool -genkeypair -keyalg RSA -keysize 2048 -alias server -dname "CN=localhost" -validity 21650 -keystore server.jks -storepass changeit -keypass changeit -deststoretype pkcs12 + keytool -genkeypair -keyalg RSA -keysize 2048 -alias client -dname "C=CZ,CN=$NAME-client,OU=Prague,O=Oracle" -validity 21650 -keystore client.jks -storepass changeit -keypass changeit -deststoretype pkcs12 + echo 'Obtaining client and server certificates...' + keytool -exportcert -keystore client.jks -storepass changeit -alias client -rfc -file client.cer + keytool -exportcert -keystore server.jks -storepass changeit -alias server -rfc -file server.cer + echo 'Generating CSR for client and server...' + keytool -certreq -keystore server.jks -alias server -keypass changeit -storepass changeit -keyalg rsa -file server.csr + keytool -certreq -keystore client.jks -alias client -keypass changeit -storepass changeit -keyalg rsa -file client.csr + echo 'Obtaining CA pem and key...' + keytool -importkeystore -srckeystore ca.jks -destkeystore ca.p12 -srcstoretype jks -deststoretype pkcs12 -srcstorepass changeit -deststorepass changeit + openssl pkcs12 -in ca.p12 -out ca.key -nocerts -passin pass:changeit -passout pass:changeit + openssl pkcs12 -in ca.p12 -out ca.pem -nokeys -passin pass:changeit -passout pass:changeit + echo 'Signing client and server certificates...' + openssl x509 -req -in client.csr -CA ca.pem -CAkey ca.key -CAcreateserial -out client-signed.cer -days 21650 -passin pass:changeit + openssl x509 -req -in server.csr -CA ca.pem -CAkey ca.key -CAcreateserial -out server-signed.cer -sha256 -days 21650 -passin pass:changeit + echo 'Replacing server and client certificates with the signed ones...' + keytool -importkeystore -srckeystore client.jks -destkeystore client.p12 -srcstoretype jks -deststoretype pkcs12 -srcstorepass changeit -deststorepass changeit + openssl pkcs12 -in client.p12 -nodes -out client-private.key -nocerts -passin pass:changeit + openssl pkcs12 -export -in client-signed.cer -inkey client-private.key -out client-signed.p12 -name client -passout pass:changeit + keytool -delete -alias client -keystore client.jks -storepass changeit + keytool -importkeystore -srckeystore client-signed.p12 -srcstoretype PKCS12 -destkeystore client.jks -srcstorepass changeit -deststorepass changeit + keytool -importkeystore -srckeystore server.jks -destkeystore server.p12 -srcstoretype jks -deststoretype pkcs12 -srcstorepass changeit -deststorepass changeit + openssl pkcs12 -in server.p12 -nodes -out server-private.key -nocerts -passin pass:changeit + openssl pkcs12 -export -in server-signed.cer -inkey server-private.key -out server-signed.p12 -name server -passout pass:changeit + keytool -delete -alias server -keystore server.jks -storepass changeit + keytool -importkeystore -srckeystore server-signed.p12 -srcstoretype PKCS12 -destkeystore server.jks -srcstorepass changeit -deststorepass changeit + + echo "Importing CA cert to the client and server stores..." + if [ "$SINGLE" = true ] ; then + keytool -v -trustcacerts -keystore client.jks -importcert -file ca.pem -alias root-ca -storepass changeit -noprompt + keytool -v -trustcacerts -keystore server.jks -importcert -file ca.pem -alias root-ca -storepass changeit -noprompt + else + keytool -v -trustcacerts -keystore client-truststore.jks -importcert -file ca.pem -alias root-ca -storepass changeit -noprompt + keytool -v -trustcacerts -keystore server-truststore.jks -importcert -file ca.pem -alias root-ca -storepass changeit -noprompt + fi + + echo "Changing aliases to 1..." + keytool -changealias -alias server -destalias 1 -keypass changeit -keystore server.jks -storepass changeit + keytool -changealias -alias client -destalias 1 -keypass changeit -keystore client.jks -storepass changeit + + echo "Generating requested type of stores..." + if [ "$TYPE" = PKCS12 ] || [ "$TYPE" = P12 ] ; then + keytool -importkeystore -srckeystore client.jks -destkeystore out/client.p12 -srcstoretype JKS -deststoretype PKCS12 -srcstorepass changeit -deststorepass changeit + keytool -importkeystore -srckeystore server.jks -destkeystore out/server.p12 -srcstoretype JKS -deststoretype PKCS12 -srcstorepass changeit -deststorepass changeit + if [ "$SINGLE" = false ] ; then + keytool -importkeystore -srckeystore server-truststore.jks -destkeystore out/server-truststore.p12 -srcstoretype JKS -deststoretype PKCS12 -srcstorepass changeit -deststorepass changeit + keytool -importkeystore -srckeystore client-truststore.jks -destkeystore out/client-truststore.p12 -srcstoretype JKS -deststoretype PKCS12 -srcstorepass changeit -deststorepass changeit + fi + else + mv client.jks out/client.jks + mv server.jks out/server.jks + if [ "$SINGLE" = false ] ; then + mv client-truststore.jks out/client-truststore.jks + mv server-truststore.jks out/server-truststore.jks + fi + fi +} + +removeAllPreviouslyCreatedStores() { + echo 'Removing all of previously created items...' + + rm -fv ca.key + rm -fv ca.jks + rm -fv ca.p12 + rm -fv ca.pem + rm -fv ca.srl + rm -fv server.jks + rm -fv server.cer + rm -fv server.csr + rm -fv server.p12 + rm -fv server-private.key + rm -fv server-signed.cer + rm -fv server-signed.p12 + rm -fv server-truststore.jks + rm -fv client.cer + rm -fv client.csr + rm -fv client.p12 + rm -fv client-private.key + rm -fv client-signed.cer + rm -fv client-signed.p12 + rm -fv client.jks + rm -fv client-truststore.jks + rm -rf out + + echo 'Clean up finished' +} + +while [ "$1" != "" ]; do + case $1 in + -n | --name ) shift + NAME=$1 + ;; + -t | --type ) shift + TYPE=$1 + ;; + -s | --single ) shift + SINGLE=$1 + ;; + -h | --help ) echo "Some cool help" + exit + ;; + * ) echo "ERROR: Invalid parameter" $1 + exit 1 + esac + shift +done +if [ -z "$NAME" ]; then + echo "ERROR: Please specify the name of Organization/Application by parameter -n | --name" + exit 1 +else + echo "Generating certs for Organization/Application "$NAME +fi +case $TYPE in + JKS | P12 | PKCS12 ) + echo "Output file will be of type" $TYPE + ;; + *) + echo 'ERROR: Invalid output type' $TYPE + echo 'Only JKS | P12 | PKCS12 supported' + return 1 +esac +case $SINGLE in + true ) + echo "Truststore and private key will be in single file" + ;; + false ) + echo "Truststore and private key will be in separate files" + ;; + *) + echo "ERROR: Only value true/false valid in single parameter! Current " $SINGLE + exit 1 +esac + +removeAllPreviouslyCreatedStores +createCertificatesAndStores diff --git a/examples/webserver/mutual-tls/pom.xml b/examples/webserver/mutual-tls/pom.xml new file mode 100644 index 00000000..ea47d83d --- /dev/null +++ b/examples/webserver/mutual-tls/pom.xml @@ -0,0 +1,84 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-mutual-tls + 1.0.0-SNAPSHOT + Helidon WebServer Examples Mutual TLS + + + Application demonstrates the use of mutual TLS with WebServer and WebClient + + + + io.helidon.webserver.examples.mtls.ServerConfigMain + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.webclient + helidon-webclient + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + + diff --git a/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ClientBuilderMain.java b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ClientBuilderMain.java new file mode 100644 index 00000000..6410ac07 --- /dev/null +++ b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ClientBuilderMain.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.mtls; + +import io.helidon.common.configurable.Resource; +import io.helidon.common.pki.KeyConfig; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientTls; + +/** + * Setting up {@link WebClient} to support mutual TLS via builder. + */ +public class ClientBuilderMain { + + private ClientBuilderMain() { + } + + /** + * Start the example. + * This example executes two requests by Helidon {@link WebClient} which are configured + * by the {@link WebClient.Builder}. + * + * You have to execute either {@link ServerBuilderMain} or {@link ServerConfigMain} for this to work. + * + * If any of the ports has been changed, you have to update ports in this main method also. + * + * @param args start arguments are ignored + */ + public static void main(String[] args) { + WebClient webClient = createWebClient(); + + System.out.println("Contacting unsecured endpoint!"); + System.out.println("Response: " + callUnsecured(webClient, 8080)); + + System.out.println("Contacting secured endpoint!"); + System.out.println("Response: " + callSecured(webClient, 443)); + + } + + static WebClient createWebClient() { + KeyConfig keyConfig = KeyConfig.keystoreBuilder() + .trustStore() + .keystore(Resource.create("client.p12")) + .keystorePassphrase("changeit") + .build(); + return WebClient.builder() + .tls(WebClientTls.builder() + .certificateTrustStore(keyConfig) + .clientKeyStore(keyConfig) + .build()) + .build(); + } + + static String callUnsecured(WebClient webClient, int port) { + return webClient.get() + .uri("http://localhost:" + port) + .request(String.class) + .await(); + } + + static String callSecured(WebClient webClient, int port) { + return webClient.get() + .uri("https://localhost:" + port) + .request(String.class) + .await(); + } + + + +} diff --git a/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ClientConfigMain.java b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ClientConfigMain.java new file mode 100644 index 00000000..1dfdae44 --- /dev/null +++ b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ClientConfigMain.java @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.mtls; + +import io.helidon.config.Config; +import io.helidon.webclient.WebClient; + +/** + * Setting up {@link WebClient} to support mutual TLS via configuration. + */ +public class ClientConfigMain { + + private ClientConfigMain() { + } + + /** + * Start the example. + * This example executes two requests by Helidon {@link WebClient} which are configured + * by the configuration. + * + * You have to execute either {@link ServerBuilderMain} or {@link ServerConfigMain} for this to work. + * + * If any of the ports has been changed, you have to update ports in this main method also. + * + * @param args start arguments are ignored + */ + public static void main(String[] args) { + Config config = Config.create(); + WebClient webClient = WebClient.create(config.get("client")); + + System.out.println("Contacting unsecured endpoint!"); + System.out.println("Response: " + callUnsecured(webClient, 8080)); + + System.out.println("Contacting secured endpoint!"); + System.out.println("Response: " + callSecured(webClient, 443)); + + } + + static String callUnsecured(WebClient webClient, int port) { + return webClient.get() + .uri("http://localhost:" + port) + .request(String.class) + .await(); + } + + static String callSecured(WebClient webClient, int port) { + return webClient.get() + .uri("https://localhost:" + port) + .request(String.class) + .await(); + } + + + +} diff --git a/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ServerBuilderMain.java b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ServerBuilderMain.java new file mode 100644 index 00000000..800ff81e --- /dev/null +++ b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ServerBuilderMain.java @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.mtls; + +import io.helidon.common.configurable.Resource; +import io.helidon.common.http.Http; +import io.helidon.common.pki.KeyConfig; +import io.helidon.common.reactive.Single; +import io.helidon.webserver.ClientAuthentication; +import io.helidon.webserver.Routing; +import io.helidon.webserver.SocketConfiguration; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.WebServerTls; + +/** + * Setting up {@link WebServer} to support mutual TLS via builder. + */ +public class ServerBuilderMain { + + private ServerBuilderMain() { + } + + /** + * Start the example. + * This will start Helidon {@link WebServer} which is configured by the {@link WebServer.Builder}. + * There will be two sockets running: + *

      + *
    • {@code 8080} - without TLS protection + *
    • {@code 443} - with TLS protection + *

    + * Both of the ports mentioned above are default ports for this example and can be changed by updating + * values in this method. + * + * @param args start arguments are ignored + */ + public static void main(String[] args) { + startServer(8080, 443); + } + + static Single startServer(int unsecured, int secured) { + SocketConfiguration socketConf = SocketConfiguration.builder() + .name("secured") + .port(secured) + .tls(tlsConfig()) + .build(); + Single webServer = WebServer.builder() + .port(unsecured) + .routing(createPlainRouting()) + .addSocket(socketConf, createMtlsRouting()) + .build() + .start(); + + webServer.thenAccept(ws -> { + System.out.println("WebServer is up!"); + System.out.println("Unsecured: http://localhost:" + ws.port() + "/"); + System.out.println("Secured: https://localhost:" + ws.port("secured") + "/"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + return webServer; + } + + private static WebServerTls tlsConfig() { + KeyConfig keyConfig = KeyConfig.keystoreBuilder() + .trustStore() + .keystore(Resource.create("server.p12")) + .keystorePassphrase("changeit") + .build(); + return WebServerTls.builder() + .clientAuth(ClientAuthentication.REQUIRE) + .trust(keyConfig) + .privateKey(keyConfig) + .build(); + } + + private static Routing createPlainRouting() { + return Routing.builder() + .get("/", (req, res) -> res.send("Hello world unsecured!")) + .build(); + } + + private static Routing createMtlsRouting() { + return Routing.builder() + .get("/", (req, res) -> { + String cn = req.headers().first(Http.Header.X_HELIDON_CN).orElse("Unknown CN"); + res.send("Hello " + cn + "!"); + }) + .build(); + } + +} diff --git a/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ServerConfigMain.java b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ServerConfigMain.java new file mode 100644 index 00000000..0ec09b9e --- /dev/null +++ b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/ServerConfigMain.java @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.mtls; + +import io.helidon.common.http.Http; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Setting up {@link WebServer} to support mutual TLS via configuration. + */ +public class ServerConfigMain { + + private ServerConfigMain() { + } + + /** + * Start the example. + * This will start Helidon {@link WebServer} which is configured by the configuration. + * There will be two sockets running: + *

      + *
    • {@code 8080} - without TLS protection + *
    • {@code 443} - with TLS protection + *

    + * Both of the ports mentioned above are default ports for this example and can be changed via configuration file. + * + * @param args start arguments are ignored + */ + public static void main(String[] args) { + Config config = Config.create(); + startServer(config.get("server")); + } + + static Single startServer(Config config) { + Single webServer = WebServer.builder(createPlainRouting()) + .config(config) + .addNamedRouting("secured", createMtlsRouting()) + .build() + .start(); + + webServer.thenAccept(ws -> { + System.out.println("WebServer is up!"); + System.out.println("Unsecured: http://localhost:" + ws.port() + "/"); + System.out.println("Secured: https://localhost:" + ws.port("secured") + "/"); + ws.whenShutdown().thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionally(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + return null; + }); + return webServer; + } + + private static Routing createPlainRouting() { + return Routing.builder() + .get("/", (req, res) -> res.send("Hello world unsecured!")) + .build(); + } + + private static Routing createMtlsRouting() { + return Routing.builder() + .get("/", (req, res) -> { + String cn = req.headers().first(Http.Header.X_HELIDON_CN).orElse("Unknown CN"); + res.send("Hello " + cn + "!"); + }) + .build(); + } + +} diff --git a/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/package-info.java b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/package-info.java new file mode 100644 index 00000000..b234e390 --- /dev/null +++ b/examples/webserver/mutual-tls/src/main/java/io/helidon/webserver/examples/mtls/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2020, 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 of mutual TLS configuration for {@link io.helidon.webserver.WebServer} and {@link io.helidon.webclient.WebClient}, + * using both {@link io.helidon.config.Config} and builder based approach. + */ +package io.helidon.webserver.examples.mtls; diff --git a/examples/webserver/mutual-tls/src/main/resources/application.yaml b/examples/webserver/mutual-tls/src/main/resources/application.yaml new file mode 100644 index 00000000..c969bd70 --- /dev/null +++ b/examples/webserver/mutual-tls/src/main/resources/application.yaml @@ -0,0 +1,49 @@ +# +# Copyright (c) 2020, 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. +# + +server: + port: 8080 + sockets: + - name: "secured" + port: 443 + tls: + client-auth: "REQUIRE" + trust: + keystore: + passphrase: "changeit" + trust-store: true + resource: + resource-path: "server.p12" + private-key: + keystore: + passphrase: "changeit" + resource: + resource-path: "server.p12" + +client: + tls: + server: + keystore: + passphrase: "changeit" + trust-store: true + resource: + resource-path: "client.p12" + client: + keystore: + passphrase: "changeit" + resource: + resource-path: "client.p12" + diff --git a/examples/webserver/mutual-tls/src/main/resources/client.p12 b/examples/webserver/mutual-tls/src/main/resources/client.p12 new file mode 100644 index 00000000..9529b672 Binary files /dev/null and b/examples/webserver/mutual-tls/src/main/resources/client.p12 differ diff --git a/examples/webserver/mutual-tls/src/main/resources/server.p12 b/examples/webserver/mutual-tls/src/main/resources/server.p12 new file mode 100644 index 00000000..5fc1fba0 Binary files /dev/null and b/examples/webserver/mutual-tls/src/main/resources/server.p12 differ diff --git a/examples/webserver/mutual-tls/src/test/java/io/helidon/webserver/examples/mtls/MutualTlsExampleTest.java b/examples/webserver/mutual-tls/src/test/java/io/helidon/webserver/examples/mtls/MutualTlsExampleTest.java new file mode 100644 index 00000000..39491514 --- /dev/null +++ b/examples/webserver/mutual-tls/src/test/java/io/helidon/webserver/examples/mtls/MutualTlsExampleTest.java @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.mtls; + +import java.util.concurrent.TimeUnit; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Test of mutual TLS example. + */ +public class MutualTlsExampleTest { + + private WebServer webServer; + + @AfterEach + public void killServer() { + if (webServer != null) { + webServer.shutdown() + .await(10, TimeUnit.SECONDS); + } + } + + @Test + public void testConfigAccessSuccessful() { + Config config = Config.just(() -> ConfigSources.classpath("application-test.yaml").build()); + webServer = ServerConfigMain.startServer(config.get("server")).await(); + WebClient webClient = WebClient.create(config.get("client")); + + assertThat(ClientConfigMain.callUnsecured(webClient, webServer.port()), is("Hello world unsecured!")); + assertThat(ClientConfigMain.callSecured(webClient, webServer.port("secured")), is("Hello Helidon-client!")); + } + + @Test + public void testBuilderAccessSuccessful() { + webServer = ServerBuilderMain.startServer(-1, -1).await(); + WebClient webClient = ClientBuilderMain.createWebClient(); + + assertThat(ClientBuilderMain.callUnsecured(webClient, webServer.port()), is("Hello world unsecured!")); + assertThat(ClientBuilderMain.callSecured(webClient, webServer.port("secured")), is("Hello Helidon-client!")); + } +} \ No newline at end of file diff --git a/examples/webserver/mutual-tls/src/test/resources/application-test.yaml b/examples/webserver/mutual-tls/src/test/resources/application-test.yaml new file mode 100644 index 00000000..eecb089e --- /dev/null +++ b/examples/webserver/mutual-tls/src/test/resources/application-test.yaml @@ -0,0 +1,49 @@ +# +# Copyright (c) 2020, 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. +# + +server: + port: 0 + sockets: + - name: "secured" + port: 0 + tls: + client-auth: "REQUIRE" + trust: + keystore: + passphrase: "changeit" + trust-store: true + resource: + resource-path: "server.p12" + private-key: + keystore: + passphrase: "changeit" + resource: + resource-path: "server.p12" + +client: + tls: + server: + keystore: + passphrase: "changeit" + trust-store: true + resource: + resource-path: "client.p12" + client: + keystore: + passphrase: "changeit" + resource: + resource-path: "client.p12" + diff --git a/examples/webserver/opentracing/Dockerfile b/examples/webserver/opentracing/Dockerfile new file mode 100644 index 00000000..0f174ea2 --- /dev/null +++ b/examples/webserver/opentracing/Dockerfile @@ -0,0 +1,47 @@ +# +# Copyright (c) 2018, 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. +# + +# 1st stage, build the app +FROM maven:3.6-jdk-11 as build + +WORKDIR /helidon + +# Create a first layer to cache the "Maven World" in the local repository. +# Incremental docker builds will always resume after that, unless you update +# the pom +ADD pom.xml . +RUN mvn package -Dmaven.test.skip + +# Do the Maven build! +# Incremental docker builds will resume here when you change sources +ADD src src +RUN mvn package -DskipTests + +RUN echo "done!" + +# 2nd stage, build the runtime image +FROM openjdk:11-jre-slim +WORKDIR /helidon + +# Copy the binary built in the 1st stage +COPY --from=build /helidon/target/helidon-examples-webserver-opentracing.jar ./ +COPY --from=build /helidon/target/libs ./libs + +ENV tracing.host="zipkin" + +CMD ["java", "-jar", "helidon-examples-webserver-opentracing.jar"] + +EXPOSE 8080 diff --git a/examples/webserver/opentracing/README.md b/examples/webserver/opentracing/README.md new file mode 100644 index 00000000..028aa628 --- /dev/null +++ b/examples/webserver/opentracing/README.md @@ -0,0 +1,39 @@ +# Opentracing Example Application + +## Start Zipkin + +With Docker: +```shell +docker run --name zipkin -d -p 9411:9411 openzipkin/zipkin +``` + +```shell +curl -sSL https://zipkin.io/quickstart.sh | bash -s +java -jar zipkin.jar +``` + +## Build and run + +With Docker: +```shell +docker build -t helidon-webserver-opentracing-example . +docker run --rm -d --link zipkin --name helidon-webserver-opentracing-example \ + -p 8080:8080 helidon-webserver-opentracing-example:latest +``` + +```shell +mvn package +java -jar target/helidon-examples-webserver-opentracing.jar +``` + +Try the endpoint: +```shell +curl http://localhost:8080/test +``` + +Then check out the traces at http://localhost:9411. + +Stop the docker containers: +```shell +docker stop zipkin helidon-webserver-opentracing-example +``` diff --git a/examples/webserver/opentracing/pom.xml b/examples/webserver/opentracing/pom.xml new file mode 100644 index 00000000..d83df8cb --- /dev/null +++ b/examples/webserver/opentracing/pom.xml @@ -0,0 +1,93 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-opentracing + 1.0.0-SNAPSHOT + Helidon WebServer Examples OpenTracing + + + An example app with Open Tracing support. + + + + io.helidon.webserver.examples.opentracing.Main + 2.23.4 + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-jersey + + + io.helidon.tracing + helidon-tracing-zipkin + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + org.mockito + mockito-core + ${version.lib.mockito} + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/opentracing/src/main/java/io/helidon/webserver/examples/opentracing/Main.java b/examples/webserver/opentracing/src/main/java/io/helidon/webserver/examples/opentracing/Main.java new file mode 100644 index 00000000..770cd160 --- /dev/null +++ b/examples/webserver/opentracing/src/main/java/io/helidon/webserver/examples/opentracing/Main.java @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.opentracing; + +import io.helidon.common.LogConfig; +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.tracing.TracerBuilder; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The ZipkinExampleMain is an app that leverages a use of Open Tracing and sends + * the collected data to Zipkin. + * + * @see io.helidon.tracing.TracerBuilder + * @see io.helidon.tracing.zipkin.ZipkinTracerBuilder + */ +public final class Main { + + private Main() { + } + + /** + * Run the OpenTracing application. + * + * @param args not used + */ + public static void main(String[] args) { + + // configure logging in order to not have the standard JVM defaults + LogConfig.configureRuntime(); + + Config config = Config.builder() + .sources(ConfigSources.environmentVariables()) + .build(); + + WebServer webServer = WebServer.builder( + Routing.builder() + .any((req, res) -> { + System.out.println("Received another request."); + req.next(); + }) + .get("/test", (req, res) -> res.send("Hello World!")) + .post("/hello", (req, res) -> { + req.content() + .as(String.class) + .thenAccept(s -> res.send("Hello: " + s)) + .exceptionally(t -> { + req.next(t); + return null; + }); + })) + .port(8080) + .tracer(TracerBuilder.create(config.get("tracing")) + .serviceName("demo-first") + .registerGlobal(true) + .build()) + .build(); + + webServer.start() + .whenComplete((server, throwable) -> { + System.out.println("Started at http://localhost:" + server.port()); + }); + } + +} diff --git a/examples/webserver/opentracing/src/main/java/io/helidon/webserver/examples/opentracing/package-info.java b/examples/webserver/opentracing/src/main/java/io/helidon/webserver/examples/opentracing/package-info.java new file mode 100644 index 00000000..73cc93ce --- /dev/null +++ b/examples/webserver/opentracing/src/main/java/io/helidon/webserver/examples/opentracing/package-info.java @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * An example of WebServer app supporting Open Tracing. + * + * @see io.helidon.webserver.examples.opentracing.ZipkinExampleMain + */ +package io.helidon.webserver.examples.opentracing; diff --git a/examples/webserver/opentracing/src/main/resources/logging.properties b/examples/webserver/opentracing/src/main/resources/logging.properties new file mode 100644 index 00000000..b1aa6c0d --- /dev/null +++ b/examples/webserver/opentracing/src/main/resources/logging.properties @@ -0,0 +1,26 @@ +# +# Copyright (c) 2017, 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. +# + + +#All attributes details +handlers=io.helidon.common.HelidonConsoleHandler +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 + +#All log level details +.level=FINEST + +io.helidon.webserver.level=FINEST +org.glassfish.jersey.internal.Errors.level=SEVERE diff --git a/examples/webserver/pom.xml b/examples/webserver/pom.xml new file mode 100644 index 00000000..d3abbfca --- /dev/null +++ b/examples/webserver/pom.xml @@ -0,0 +1,49 @@ + + + + + 4.0.0 + + io.helidon.examples + helidon-examples-project + 1.0.0-SNAPSHOT + + io.helidon.examples.webserver + helidon-examples-webserver-project + Helidon WebServer Examples + pom + + + basics + tutorial + comment-aas + static-content + jersey + opentracing + streaming + websocket + tls + mutual-tls + fault-tolerance + threadpool + multiport + + diff --git a/examples/webserver/static-content/README.md b/examples/webserver/static-content/README.md new file mode 100644 index 00000000..cab3abc9 --- /dev/null +++ b/examples/webserver/static-content/README.md @@ -0,0 +1,13 @@ +# Static Content Example + +This application demonstrates use of the StaticContentSupport to serve static files + together with a simple REST service. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-webserver-static-content.jar +``` + +Open http://localhost:8080 in your browser. diff --git a/examples/webserver/static-content/pom.xml b/examples/webserver/static-content/pom.xml new file mode 100644 index 00000000..36b8337b --- /dev/null +++ b/examples/webserver/static-content/pom.xml @@ -0,0 +1,87 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-static-content + 1.0.0-SNAPSHOT + Helidon WebServer Examples Static Content + + + Application demonstrates combination of the static content with a simple REST API. It counts accesses and display it + on the WEB page. + + + + io.helidon.webserver.examples.staticcontent.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.media + helidon-media-jsonp + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/CounterService.java b/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/CounterService.java new file mode 100644 index 00000000..f7c22db1 --- /dev/null +++ b/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/CounterService.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.staticcontent; + +import java.util.Collections; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.LongAdder; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Counts access to the WEB service. + */ +public class CounterService implements Service { + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + private final LongAdder allAccessCounter = new LongAdder(); + private final AtomicInteger apiAccessCounter = new AtomicInteger(); + + @Override + public void update(Routing.Rules routingRules) { + routingRules.any(this::handleAny) + .get("/api/counter", this::handleGet); + } + + private void handleAny(ServerRequest request, ServerResponse response) { + allAccessCounter.increment(); + request.next(); + } + + private void handleGet(ServerRequest request, ServerResponse response) { + int apiAcc = apiAccessCounter.incrementAndGet(); + JsonObject result = JSON.createObjectBuilder() + .add("all", allAccessCounter.longValue()) + .add("api", apiAcc) + .build(); + response.send(result); + } +} diff --git a/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/Main.java b/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/Main.java new file mode 100644 index 00000000..4a9bc7fa --- /dev/null +++ b/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/Main.java @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.staticcontent; + +import io.helidon.common.http.Http; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; + +/** + * Application demonstrates combination of the static content with a simple REST API. It counts accesses and display it + * on the WEB page. + */ +public class Main { + + private Main() { + } + + /** + * Creates new {@link Routing}. + * + * @return the new instance + */ + static Routing createRouting() { + return Routing.builder() + .any("/", (req, res) -> { + // showing the capability to run on any path, and redirecting from root + res.status(Http.Status.MOVED_PERMANENTLY_301); + res.headers().put(Http.Header.LOCATION, "/ui"); + res.send(); + }) + .register("/ui", new CounterService()) + .register("/ui", StaticContentSupport.builder("WEB") + .welcomeFileName("index.html") + .build()) + .build(); + } + + /** + * A java main class. + * + * @param args command line arguments. + */ + public static void main(String[] args) { + WebServer server = WebServer.builder(createRouting()) + .port(8080) + .addMediaSupport(JsonpSupport.create()) + .build(); + + // Start the server and print some info. + server.start().thenAccept(ws -> { + System.out.println("WEB server is up! http://localhost:" + ws.port()); + }); + + // Server threads are not demon. NO need to block. Just react. + server.whenShutdown() + .thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + + } +} diff --git a/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/package-info.java b/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/package-info.java new file mode 100644 index 00000000..e996f2d5 --- /dev/null +++ b/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/package-info.java @@ -0,0 +1,25 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * Application demonstrates combination of the static content with a simple REST API. It counts accesses and display it + * on the WEB page. + *

    + * Start with {@link io.helidon.webserver.examples.staticcontent.Main} class. + * + * @see io.helidon.webserver.examples.staticcontent.Main + */ +package io.helidon.webserver.examples.staticcontent; diff --git a/examples/webserver/static-content/src/main/resources/WEB/css/app.css b/examples/webserver/static-content/src/main/resources/WEB/css/app.css new file mode 100644 index 00000000..028dee61 --- /dev/null +++ b/examples/webserver/static-content/src/main/resources/WEB/css/app.css @@ -0,0 +1,19 @@ +/* + * Copyright (c) 2017, 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. + */ + +body { + padding-top: 2rem; +} diff --git a/examples/webserver/static-content/src/main/resources/WEB/index.html b/examples/webserver/static-content/src/main/resources/WEB/index.html new file mode 100644 index 00000000..413268e4 --- /dev/null +++ b/examples/webserver/static-content/src/main/resources/WEB/index.html @@ -0,0 +1,88 @@ + + + + + + + + + + Static Content Example + + + + + + + +

    + + +
    +
    +

    Hello!

    +

    +
    +
    + +
    + +
    +
    +

    Heading

    +

    Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui.

    +

    View details »

    +
    +
    +

    Heading

    +

    Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui.

    +

    View details »

    +
    +
    +

    Heading

    +

    Donec sed odio dui. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Vestibulum id ligula porta felis euismod semper. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.

    +

    View details »

    +
    +
    + +
    + +
    +

    © Oracle 2017

    +
    +
    + + + + + + + diff --git a/examples/webserver/static-content/src/main/resources/WEB/js/app.js b/examples/webserver/static-content/src/main/resources/WEB/js/app.js new file mode 100644 index 00000000..f132a708 --- /dev/null +++ b/examples/webserver/static-content/src/main/resources/WEB/js/app.js @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2017, 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. + */ + +$(document).ready(function() { + $.get("api/counter", function (data) { + $("#hello-message").html("This page was reloaded " + data.api + " times. " + + "This WebServer already served " + data.all + " requests."); + }); +}); diff --git a/examples/webserver/streaming/README.md b/examples/webserver/streaming/README.md new file mode 100644 index 00000000..ca171f6c --- /dev/null +++ b/examples/webserver/streaming/README.md @@ -0,0 +1,19 @@ +# Streaming Example + +This application uses NIO and data buffers to show the implementation of a simple streaming service. + Files can be uploaded and downloaded in a streaming fashion using `Subscriber` and +`Producer`. As a result, service runs in constant space instead of proportional +to the size of the file being uploaded or downloaded. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-webserver-streaming.jar +``` + +Upload a file and download it back with `curl`: +```shell +curl --data-binary "@target/classes/large-file.bin" http://localhost:8080/upload +curl http://localhost:8080/download +``` diff --git a/examples/webserver/streaming/pom.xml b/examples/webserver/streaming/pom.xml new file mode 100644 index 00000000..a5194cb5 --- /dev/null +++ b/examples/webserver/streaming/pom.xml @@ -0,0 +1,79 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-streaming + 1.0.0-SNAPSHOT + Helidon WebServer Examples Streaming + + + Application that demonstrates how to write a service that uploads and downloads + a file using chunks, in a streaming manner. + + + + io.helidon.webserver.examples.streaming.Main + + + + + io.helidon.webserver + helidon-webserver + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/Main.java b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/Main.java new file mode 100644 index 00000000..a7e118e2 --- /dev/null +++ b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/Main.java @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2018, 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.webserver.examples.streaming; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * Class Main. Entry point to streaming application. + */ +public class Main { + + static final String LARGE_FILE_RESOURCE = "/large-file.bin"; + + private Main() { + } + + /** + * Creates new {@link Routing}. + * + * @return the new instance + */ + static Routing createRouting() { + return Routing.builder() + .register(new StreamingService()) + .build(); + } + + /** + * A java main class. + * + * @param args command line arguments. + */ + public static void main(String[] args) { + WebServer server = WebServer.builder(createRouting()) + .port(8080) + .build(); + + server.start().thenAccept(ws -> + System.out.println("Steaming service is up at http://localhost:" + ws.port()) + ); + + server.whenShutdown().thenRun(() -> + System.out.println("Streaming service is down") + ); + } +} diff --git a/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/ServerFileReader.java b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/ServerFileReader.java new file mode 100644 index 00000000..12e0c4d1 --- /dev/null +++ b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/ServerFileReader.java @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2018, 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.webserver.examples.streaming; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.nio.channels.FileChannel; +import java.nio.file.Path; +import java.nio.file.StandardOpenOption; +import java.util.concurrent.Flow; +import java.util.logging.Logger; + +import io.helidon.common.http.DataChunk; + +/** + * Class ServerFileReader. Reads a file using NIO and produces data chunks for a + * {@code Subscriber} to process. + */ +public class ServerFileReader implements Flow.Publisher { + private static final Logger LOGGER = Logger.getLogger(ServerFileReader.class.getName()); + + static final int BUFFER_SIZE = 4096; + + private final Path path; + + ServerFileReader(Path path) { + this.path = path; + } + + @Override + public void subscribe(Flow.Subscriber s) { + FileChannel channel; + ByteBuffer buffer = ByteBuffer.allocate(BUFFER_SIZE); + + try { + channel = FileChannel.open(path, StandardOpenOption.READ); + } catch (IOException e) { + throw new RuntimeException(e); + } + + s.onSubscribe(new Flow.Subscription() { + @Override + public void request(long n) { + try { + while (n > 0) { + int bytes = channel.read(buffer); + if (bytes < 0) { + s.onComplete(); + channel.close(); + return; + } + if (bytes > 0) { + LOGGER.info(buffer.toString()); + buffer.flip(); + s.onNext(DataChunk.create(buffer)); + n--; + } + buffer.rewind(); + } + } catch (IOException e) { + s.onError(e); + } + } + + @Override + public void cancel() { + try { + channel.close(); + } catch (IOException e) { + LOGGER.info(e.getMessage()); + } + } + }); + } +} diff --git a/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/ServerFileWriter.java b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/ServerFileWriter.java new file mode 100644 index 00000000..9264d467 --- /dev/null +++ b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/ServerFileWriter.java @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2018, 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.webserver.examples.streaming; + +import java.io.IOException; +import java.nio.channels.FileChannel; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardOpenOption; +import java.util.concurrent.Flow; +import java.util.logging.Logger; + +import io.helidon.common.http.DataChunk; +import io.helidon.webserver.ServerResponse; + +/** + * Class ServerFileWriter. Process data chunks from a {@code Producer} and + * writes them to a temporary file using NIO. For simplicity, this {@code + * Subscriber} requests an unbounded number of chunks on its subscription. + */ +public class ServerFileWriter implements Flow.Subscriber { + private static final Logger LOGGER = Logger.getLogger(ServerFileWriter.class.getName()); + + private final FileChannel channel; + + private final ServerResponse response; + + ServerFileWriter(ServerResponse response) { + this.response = response; + try { + Path tempFilePath = Files.createTempFile("large-file", ".tmp"); + channel = FileChannel.open(tempFilePath, StandardOpenOption.WRITE); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + @Override + public void onSubscribe(Flow.Subscription subscription) { + subscription.request(Long.MAX_VALUE); + } + + @Override + public void onNext(DataChunk chunk) { + try { + channel.write(chunk.data()); + LOGGER.info(chunk.data().toString() + " " + Thread.currentThread()); + chunk.release(); + } catch (IOException e) { + LOGGER.info(e.getMessage()); + } + } + + @Override + public void onError(Throwable throwable) { + throwable.printStackTrace(); + } + + @Override + public void onComplete() { + try { + channel.close(); + response.send("DONE"); + } catch (IOException e) { + LOGGER.info(e.getMessage()); + } + } +} diff --git a/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/StreamingService.java b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/StreamingService.java new file mode 100644 index 00000000..208d10a2 --- /dev/null +++ b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/StreamingService.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2018, 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.webserver.examples.streaming; + +import java.net.URISyntaxException; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.logging.Logger; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +import static io.helidon.webserver.examples.streaming.Main.LARGE_FILE_RESOURCE; + +/** + * StreamingService class. Uses a {@code Subscriber} and a + * {@code Publisher} for uploading and downloading files. + */ +public class StreamingService implements Service { + private static final Logger LOGGER = Logger.getLogger(StreamingService.class.getName()); + + private final Path filePath; + + StreamingService() { + try { + filePath = Paths.get(getClass().getResource(LARGE_FILE_RESOURCE).toURI()); + } catch (URISyntaxException e) { + throw new RuntimeException(e); + } + } + + @Override + public void update(Routing.Rules routingRules) { + routingRules.get("/download", this::download) + .post("/upload", this::upload); + } + + private void upload(ServerRequest request, ServerResponse response) { + LOGGER.info("Entering upload ... " + Thread.currentThread()); + request.content().subscribe(new ServerFileWriter(response)); + LOGGER.info("Exiting upload ..."); + } + + private void download(ServerRequest request, ServerResponse response) { + LOGGER.info("Entering download ..." + Thread.currentThread()); + long length = filePath.toFile().length(); + response.headers().add("Content-Length", String.valueOf(length)); + response.send(new ServerFileReader(filePath)); + LOGGER.info("Exiting download ..."); + } +} diff --git a/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/package-info.java b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/package-info.java new file mode 100644 index 00000000..a630ae35 --- /dev/null +++ b/examples/webserver/streaming/src/main/java/io/helidon/webserver/examples/streaming/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2018, 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. + */ + +/** + *

    + * Start with {@link io.helidon.webserver.examples.streaming.Main} class. + * + * @see io.helidon.webserver.examples.streaming.Main + */ +package io.helidon.webserver.examples.streaming; diff --git a/examples/webserver/streaming/src/main/resources/large-file.bin b/examples/webserver/streaming/src/main/resources/large-file.bin new file mode 100644 index 00000000..909e3e3e Binary files /dev/null and b/examples/webserver/streaming/src/main/resources/large-file.bin differ diff --git a/examples/webserver/threadpool/README.md b/examples/webserver/threadpool/README.md new file mode 100644 index 00000000..f3e5dbac --- /dev/null +++ b/examples/webserver/threadpool/README.md @@ -0,0 +1,66 @@ +# Helidon WebServer Thread Pool Example + +This example shows how to use an application specific threadpool. + +With the Helidon WebServer you do not want to block the Netty thread that is executing +your Handler. So you either need to use WebServer's reactive APIs: + +``` + request.content().as(JsonObject.class) + .thenAccept(jo -> doSomething(jo, response)) +``` + +Or pass the request off to a thread pool dedicated to your business logic. This +example shows how to do this in `getMessageSlowlyHandler`. + +Helidon's `ThreadPoolSupplier` provides thread pools that automatically propagate +request `Context` so that tracing and authentication information is preserved across +threads. + +You can use the `Context` registry to propagate your own data across threads. You can + also do this by passing the information directly to your `Runnable`. The +example shows both techniques. + +## Configuration + +See `application.yaml` for an example of how you can configure the number of Netty +worker threads, as well as provide a configuration for the dedicated application +threadpool. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-webserver-threadpool.jar +``` + +When the server starts up you will see it log some information about the application +thread pool. This should reflect what is specified in `application.yaml`. For example: + +``` +2021.03.16 13:50:31 FINE io.helidon.common.configurable.ThreadPool Thread[main,5,main]: ThreadPool 'helidon-thread-pool-2' {corePoolSize=5, maxPoolSize=50, queueCapacity=10000, growthThreshold=1000, growthRate=0%, averageQueueSize=0.00, peakQueueSize=0, averageActiveThreads=0.00, peakPoolSize=0, currentPoolSize=0, completedTasks=0, failedTasks=0, rejectedTasks=0} +``` + +See `logging.properties` for the logging configuration. + +## Exercise the application + +Each request will return the name of the thread the created the response. For example: + +```shell +$ curl -X GET http://localhost:8080/greet/Jane +#{"message":"Hello Jane!","thread":"Thread[nioEventLoopGroup-3-2,10,main]"} +``` + +`nioEventLoopGroup-` indicates that this is a Netty worker thread. To exercise +the application thread pool do this: + +```shell +curl -X GET http://localhost:8080/greet/slowly/Jane +#{"message":"Hello Jane!","thread":"Thread[my-thread-1,5,helidon-thread-pool-2]"} +``` + +You'll notice that the response takes ~3 seconds to return -- that's an artificial delay +we have in our handler. Also note that the thread name starts with `my-thread-`. That indicates +this is a thread from the dedicated application thread pool. + diff --git a/examples/webserver/threadpool/pom.xml b/examples/webserver/threadpool/pom.xml new file mode 100644 index 00000000..7a475eea --- /dev/null +++ b/examples/webserver/threadpool/pom.xml @@ -0,0 +1,98 @@ + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-threadpool + 1.0.0-SNAPSHOT + Helidon WebServer Examples Thread Pools + + + io.helidon.examples.webserver.threadpool.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.media + helidon-media-jsonp + + + io.helidon.config + helidon-config-yaml + + + io.helidon.health + helidon-health + + + io.helidon.health + helidon-health-checks + + + io.helidon.metrics + helidon-metrics-service-api + + + io.helidon.metrics + helidon-metrics + runtime + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webclient + helidon-webclient + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/GreetService.java b/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/GreetService.java new file mode 100644 index 00000000..af2c7dfa --- /dev/null +++ b/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/GreetService.java @@ -0,0 +1,205 @@ +/* + * 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. + */ + +package io.helidon.examples.webserver.threadpool; + +import java.util.Collections; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.atomic.AtomicReference; +import java.util.logging.Level; +import java.util.logging.Logger; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonException; +import javax.json.JsonObject; + +import io.helidon.common.configurable.ThreadPoolSupplier; +import io.helidon.common.context.Contexts; +import io.helidon.common.http.Http; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * A simple service to greet you. Examples: + * + * Get default greeting message: + * curl -X GET http://localhost:8080/greet + * + * Get greeting message for Joe: + * curl -X GET http://localhost:8080/greet/Joe + * + * Change greeting + * curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Howdy"}' http://localhost:8080/greet/greeting + * + * The message is returned as a JSON object + */ + +public class GreetService implements Service { + + /** + * The config value for the key {@code greeting}. + */ + private final AtomicReference greeting = new AtomicReference<>(); + + private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap()); + + private static final Logger LOGGER = Logger.getLogger(GreetService.class.getName()); + + private static ExecutorService myThreadPool; + + GreetService(Config config) { + greeting.set(config.get("app.greeting").asString().orElse("Ciao")); + + // Build a thread pool using the configuration + myThreadPool = ThreadPoolSupplier.builder().config(config.get("application-thread-pool")).build().get(); + } + + /** + * A service registers itself by updating the routing rules. + * @param rules the routing rules. + */ + @Override + public void update(Routing.Rules rules) { + rules + .get("/", this::getDefaultMessageHandler) + .get("/slowly/{name}", this::getMessageSlowlyHandler) + .get("/{name}", this::getMessageHandler) + .put("/greeting", this::updateGreetingHandler); + + } + + /** + * Return a worldly greeting message. + * @param request the server request + * @param response the server response + */ + private void getDefaultMessageHandler(ServerRequest request, ServerResponse response) { + sendResponse(response, "World"); + } + + /** + * Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageHandler(ServerRequest request, ServerResponse response) { + String name = request.path().param("name"); + sendResponse(response, name); + } + + /** + * Slowly Return a greeting message using the name that was provided. + * @param request the server request + * @param response the server response + */ + private void getMessageSlowlyHandler(ServerRequest request, ServerResponse response) { + + String name = request.path().param("name"); + + // One way to pass data to new thread is to use Context + request.context().register("NAME_PARAM", name + "_from_context"); + + // Another way, just pass via Runnable. + myThreadPool.submit(() -> sendResponseSlowly(response, name, 3)); + } + + /** + * Send a response slowly. This simulates blocking business logic. + * + * @param response server response + * @param name name to greet + * @param sleepSeconds artificial delay to simulate blocking business logic + */ + private void sendResponseSlowly(ServerResponse response, String name, int sleepSeconds) { + + // Fetch NAME_PARAM from Context + String nameFromContext = Contexts.context() + .flatMap(ctx -> ctx.get("NAME_PARAM", String.class)) + .orElseThrow(() -> new IllegalStateException("No NAME_PARAM in current context")); + + LOGGER.info("Name from method parameter: " + name + ". Name from context: " + nameFromContext); + + // Simulate blocking business logic + try { + Thread.sleep(sleepSeconds * 1000); + } catch (InterruptedException ex) { } + + sendResponse(response, name); + } + + private void sendResponse(ServerResponse response, String name) { + LOGGER.info("Response sent by thread " + Thread.currentThread().toString()); + + String msg = String.format("%s %s!", greeting.get(), name); + + JsonObject returnObject = JSON.createObjectBuilder() + .add("message", msg) + .add("thread", Thread.currentThread().toString()) + .build(); + response.send(returnObject); + } + + private static T processErrors(Throwable ex, ServerRequest request, ServerResponse response) { + + if (ex.getCause() instanceof JsonException){ + + LOGGER.log(Level.FINE, "Invalid JSON", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Invalid JSON") + .build(); + response.status(Http.Status.BAD_REQUEST_400).send(jsonErrorObject); + } else { + + LOGGER.log(Level.FINE, "Internal error", ex); + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "Internal error") + .build(); + response.status(Http.Status.INTERNAL_SERVER_ERROR_500).send(jsonErrorObject); + } + + return null; + } + + private void updateGreetingFromJson(JsonObject jo, ServerResponse response) { + if (!jo.containsKey("greeting")) { + JsonObject jsonErrorObject = JSON.createObjectBuilder() + .add("error", "No greeting provided") + .build(); + response.status(Http.Status.BAD_REQUEST_400) + .send(jsonErrorObject); + return; + } + + greeting.set(jo.getString("greeting")); + response.status(Http.Status.NO_CONTENT_204).send(); + } + + /** + * Set the greeting to use in future messages. + * @param request the server request + * @param response the server response + */ + private void updateGreetingHandler(ServerRequest request, + ServerResponse response) { + request.content().as(JsonObject.class) + .thenAccept(jo -> updateGreetingFromJson(jo, response)) + .exceptionally(ex -> processErrors(ex, request, response)); + } +} diff --git a/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/Main.java b/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/Main.java new file mode 100644 index 00000000..4458b4c9 --- /dev/null +++ b/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/Main.java @@ -0,0 +1,106 @@ +/* + * 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. + */ + +package io.helidon.examples.webserver.threadpool; + +import io.helidon.common.LogConfig; +import io.helidon.common.reactive.Single; +import io.helidon.config.Config; +import io.helidon.health.HealthSupport; +import io.helidon.health.checks.HealthChecks; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.metrics.serviceapi.MetricsSupport; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; + +/** + * The application main class. + */ +public final class Main { + + /** + * Cannot be instantiated. + */ + private Main() { + } + + /** + * Application main entry point. + * + * @param args command line arguments. + */ + public static void main(final String[] args) { + // By default this will pick up application.yaml from the classpath + Config config = Config.create(); + startServer(config); + } + + /** + * Start the server. + * + * @return the created {@link WebServer} instance + */ + static Single startServer(Config config) { + // load logging configuration + LogConfig.configureRuntime(); + + // Build server using three ports: + // default public port, admin port, private port + WebServer server = WebServer.builder(createPublicRouting(config)) + .config(config.get("server")) + .addMediaSupport(JsonpSupport.create()) + .build(); + + Single webServerSingle = server.start(); + + // Try to start the server. If successful, print some info and arrange to + // print a message at shutdown. If unsuccessful, print the exception. + webServerSingle + .thenAccept(ws -> { + System.out.println( + "WEB server is up! http://localhost:" + ws.port()); + ws.whenShutdown().thenRun(() + -> System.out.println("WEB server is DOWN. Good bye!")); + }) + .exceptionallyAccept(t -> { + System.err.println("Startup failed: " + t.getMessage()); + t.printStackTrace(System.err); + }); + + // Server threads are not daemon. No need to block. Just react. + + return webServerSingle; + } + + /** + * Creates public {@link Routing}. + * + * @return routing for use on "public" port + */ + private static Routing createPublicRouting(Config config) { + MetricsSupport metrics = MetricsSupport.create(); + HealthSupport health = HealthSupport.builder() + .addLiveness(HealthChecks.healthChecks()) // Adds a convenient set of checks + .build(); + GreetService greetService = new GreetService(config); + return Routing.builder() + .register(health) + .register(metrics) + .register("/greet", greetService) + .build(); + } + +} diff --git a/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/package-info.java b/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/package-info.java new file mode 100644 index 00000000..d37c0438 --- /dev/null +++ b/examples/webserver/threadpool/src/main/java/io/helidon/examples/webserver/threadpool/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ +/** + * Application that exposes multiple ports. + */ +package io.helidon.examples.webserver.threadpool; diff --git a/examples/webserver/threadpool/src/main/resources/application.yaml b/examples/webserver/threadpool/src/main/resources/application.yaml new file mode 100644 index 00000000..4f22c0a1 --- /dev/null +++ b/examples/webserver/threadpool/src/main/resources/application.yaml @@ -0,0 +1,29 @@ +# +# 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. +# +server: + port: 8080 + host: "localhost" + # This controls the size of the Netty worker thread pool + worker-count: 10 + +app: + greeting: "Hello" + +# Configuration for the application thread pool. For config options see +# ThreadPoolSupplier.Builder.config() +application-thread-pool: + thread-name-prefix: "my-thread-" + core-pool-size: 5 \ No newline at end of file diff --git a/examples/webserver/threadpool/src/main/resources/logging.properties b/examples/webserver/threadpool/src/main/resources/logging.properties new file mode 100644 index 00000000..52b003fb --- /dev/null +++ b/examples/webserver/threadpool/src/main/resources/logging.properties @@ -0,0 +1,38 @@ +# +# 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.common.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 + +# Increase ThreadPool logging so we can see what values are used +# to create the application ThreadPool +io.helidon.common.configurable.ThreadPool.level=FINE + +# Component specific log levels +#io.helidon.webserver.level=INFO +#io.helidon.config.level=INFO +#io.helidon.security.level=INFO +#io.helidon.common.level=INFO +#io.netty.level=INFO diff --git a/examples/webserver/threadpool/src/test/java/io/helidon/examples/webserver/threadpool/MainTest.java b/examples/webserver/threadpool/src/test/java/io/helidon/examples/webserver/threadpool/MainTest.java new file mode 100644 index 00000000..15f8b7fc --- /dev/null +++ b/examples/webserver/threadpool/src/test/java/io/helidon/examples/webserver/threadpool/MainTest.java @@ -0,0 +1,116 @@ +/* + * 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. + */ + +package io.helidon.examples.webserver.threadpool; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import javax.json.Json; +import javax.json.JsonBuilderFactory; +import javax.json.JsonObject; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.media.jsonp.JsonpSupport; +import io.helidon.webclient.WebClient; +import io.helidon.webclient.WebClientResponse; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class MainTest { + + private static WebServer webServer; + private static WebClient webClient; + private static final JsonBuilderFactory JSON_BUILDER = Json.createBuilderFactory(Collections.emptyMap()); + private static final JsonObject TEST_JSON_OBJECT; + + static { + TEST_JSON_OBJECT = JSON_BUILDER.createObjectBuilder() + .add("greeting", "Hola") + .build(); + } + + @BeforeAll + public static void startTheServer() { + + // Use test configuration so we can have ports allocated dynamically + Config config = Config.builder().addSource(ConfigSources.classpath("application-test.yaml")).build(); + + webServer = Main.startServer(config).await(); + webClient = WebClient.builder() + .baseUri("http://localhost:" + webServer.port()) + .addMediaSupport(JsonpSupport.create()) + .build(); + } + + @AfterAll + public static void stopServer() { + if (webServer != null) { + webServer.shutdown().await(10, TimeUnit.SECONDS); + } + } + + @Test + public void testHelloWorld() { + + JsonObject jsonObject; + WebClientResponse response; + + jsonObject = webClient.get() + .path("/greet") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello World!")); + + jsonObject = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(jsonObject.getString("message"), is("Hello Joe!")); + + WebClientResponse res = webClient.put() + .path("/greet/greeting") + .submit(TEST_JSON_OBJECT) + .await(); + assertThat(res.status().code(), is(204)); + + JsonObject json = webClient.get() + .path("/greet/Joe") + .request(JsonObject.class) + .await(); + assertThat(json.getString("message"), is("Hola Joe!")); + + response = webClient.get() + .path("/health") + .request() + .await(); + assertThat(response.status().code(), is(200)); + + response = webClient.get() + .path("/metrics") + .request() + .await(); + assertThat(response.status().code(), is(200)); + } + +} diff --git a/examples/webserver/threadpool/src/test/resources/application-test.yaml b/examples/webserver/threadpool/src/test/resources/application-test.yaml new file mode 100644 index 00000000..50c0fc0c --- /dev/null +++ b/examples/webserver/threadpool/src/test/resources/application-test.yaml @@ -0,0 +1,29 @@ +# +# 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. +# +server: + port: 0 + host: "localhost" + # This controls the size of the Netty worker thread pool + worker-count: 10 + +app: + greeting: "Hello" + +# Configuration for the application thread pool. For config options see +# ThreadPoolSupplier.Builder.config() +application-thread-pool: + thread-name-prefix: "my-thread-" + core-pool-size: 5 diff --git a/examples/webserver/tls/pom.xml b/examples/webserver/tls/pom.xml new file mode 100644 index 00000000..a6149f2f --- /dev/null +++ b/examples/webserver/tls/pom.xml @@ -0,0 +1,92 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + + io.helidon.examples.webserver + helidon-examples-webserver-tls + 1.0.0-SNAPSHOT + Helidon WebServer Examples TLS + + + Application demonstrates TLS configuration using a builder + and config. + + + + io.helidon.webserver.examples.tls.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.config + helidon-config-yaml + + + io.helidon.webclient + helidon-webclient + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-params + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/tls/src/main/java/io/helidon/webserver/examples/tls/Main.java b/examples/webserver/tls/src/main/java/io/helidon/webserver/examples/tls/Main.java new file mode 100644 index 00000000..cd86fd7f --- /dev/null +++ b/examples/webserver/tls/src/main/java/io/helidon/webserver/examples/tls/Main.java @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.tls; + +import java.util.concurrent.CompletionStage; + +import io.helidon.common.LogConfig; +import io.helidon.common.configurable.Resource; +import io.helidon.common.pki.KeyConfig; +import io.helidon.config.Config; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.WebServerTls; + +/** + * Main class of TLS example. + */ +public final class Main { + // utility class + private Main() { + } + + /** + * Start the example. + * This will start two Helidon WebServers, both protected by TLS - one configured from config, one using a builder. + * Port of the servers will be configured from config, to be able to switch to an ephemeral port for tests. + * + * @param args start arguments are ignored + */ + public static void main(String[] args) { + LogConfig.configureRuntime(); + + Config config = Config.create(); + startConfigBasedServer(config.get("config-based")) + .thenAccept(ws -> { + System.out.println("Started config based WebServer on http://localhost:" + ws.port()); + }); + startBuilderBasedServer(config.get("builder-based")) + .thenAccept(ws -> { + System.out.println("Started builder based WebServer on http://localhost:" + ws.port()); + }); + } + + static CompletionStage startBuilderBasedServer(Config config) { + return WebServer.builder() + .config(config) + .routing(routing()) + // now let's configure TLS + .tls(WebServerTls.builder() + .privateKey(KeyConfig.keystoreBuilder() + .keystore(Resource.create("certificate.p12")) + .keystorePassphrase("helidon"))) + .build() + .start(); + } + + static CompletionStage startConfigBasedServer(Config config) { + return WebServer.builder() + .config(config) + .routing(routing()) + .build() + .start(); + } + + private static Routing routing() { + return Routing.builder() + .get("/", (req, res) -> res.send("Hello!")) + .build(); + } +} diff --git a/examples/webserver/tls/src/main/java/io/helidon/webserver/examples/tls/package-info.java b/examples/webserver/tls/src/main/java/io/helidon/webserver/examples/tls/package-info.java new file mode 100644 index 00000000..5c0cecfd --- /dev/null +++ b/examples/webserver/tls/src/main/java/io/helidon/webserver/examples/tls/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2020, 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 of TLS configuration for webserver, using both {@link io.helidon.config.Config} and builder based approach. + */ +package io.helidon.webserver.examples.tls; diff --git a/examples/webserver/tls/src/main/resources/application.yaml b/examples/webserver/tls/src/main/resources/application.yaml new file mode 100644 index 00000000..f12dbe00 --- /dev/null +++ b/examples/webserver/tls/src/main/resources/application.yaml @@ -0,0 +1,25 @@ +# +# Copyright (c) 2020, 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. +# + +config-based: + port: 8080 + tls: + private-key.keystore: + resource.resource-path: "certificate.p12" + passphrase: "helidon" + +builder-based: + port: 8081 diff --git a/examples/webserver/tls/src/main/resources/certificate.p12 b/examples/webserver/tls/src/main/resources/certificate.p12 new file mode 100644 index 00000000..b2cb8342 Binary files /dev/null and b/examples/webserver/tls/src/main/resources/certificate.p12 differ diff --git a/examples/webserver/tls/src/main/resources/logging.properties b/examples/webserver/tls/src/main/resources/logging.properties new file mode 100644 index 00000000..ee3458ed --- /dev/null +++ b/examples/webserver/tls/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2020, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.server.level=INFO diff --git a/examples/webserver/tls/src/test/java/io/helidon/webserver/examples/tls/MainTest.java b/examples/webserver/tls/src/test/java/io/helidon/webserver/examples/tls/MainTest.java new file mode 100644 index 00000000..a8cad805 --- /dev/null +++ b/examples/webserver/tls/src/test/java/io/helidon/webserver/examples/tls/MainTest.java @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.tls; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionStage; +import java.util.concurrent.ExecutionException; +import java.util.stream.Stream; + +import io.helidon.config.Config; +import io.helidon.config.ConfigSources; +import io.helidon.webclient.WebClientTls; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.MethodSource; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +class MainTest { + private static WebServer configBasedServer; + private static WebServer builderBasedServer; + private static WebClient configBasedClient; + private static WebClient builderBasedClient; + + @BeforeAll + static void initClass() throws ExecutionException, InterruptedException { + Config config = Config.create(ConfigSources.classpath("test-application.yaml"), + ConfigSources.classpath("application.yaml")); + + configBasedServer = Main.startConfigBasedServer(config.get("config-based")) + .toCompletableFuture() + .get(); + builderBasedServer = Main.startBuilderBasedServer(config.get("builder-based")) + .toCompletableFuture() + .get(); + + configBasedClient = WebClient.builder() + .baseUri("https://localhost:" + configBasedServer.port()) + // trust all, as we use a self-signed certificate + .tls(WebClientTls.builder().trustAll(true).build()) + .build(); + + builderBasedClient = WebClient.builder() + .baseUri("https://localhost:" + builderBasedServer.port()) + // trust all, as we use a self-signed certificate + .tls(WebClientTls.builder().trustAll(true).build()) + .build(); + } + + @AfterAll + static void destroyClass() { + CompletionStage configBased; + CompletionStage builderBased; + + if (null == configBasedServer) { + configBased = CompletableFuture.completedFuture(null); + } else { + configBased = configBasedServer.shutdown(); + } + + if (null == builderBasedServer) { + builderBased = CompletableFuture.completedFuture(null); + } else { + builderBased = builderBasedServer.shutdown(); + } + + configBased.toCompletableFuture().join(); + builderBased.toCompletableFuture().join(); + } + + static Stream testDataSource() { + return Stream.of(new TestData("Builder based", builderBasedClient), + new TestData("Config based", configBasedClient)); + } + + @ParameterizedTest + @MethodSource("testDataSource") + void testSsl(TestData testData) { + String response = testData.client + .get() + .request(String.class) + .await(); + + assertThat(testData.type + " SSL server response.", response, is("Hello!")); + } + + private static class TestData { + private final String type; + private final WebClient client; + + private TestData(String type, WebClient client) { + this.type = type; + this.client = client; + } + } +} \ No newline at end of file diff --git a/examples/webserver/tls/src/test/resources/test-application.yaml b/examples/webserver/tls/src/test/resources/test-application.yaml new file mode 100644 index 00000000..9c97f4b5 --- /dev/null +++ b/examples/webserver/tls/src/test/resources/test-application.yaml @@ -0,0 +1,22 @@ +# +# Copyright (c) 2020, 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. +# + +config-based: + # switch to available ephemeral port for tests + port: 0 + +builder-based: + port: 0 \ No newline at end of file diff --git a/examples/webserver/tutorial/README.md b/examples/webserver/tutorial/README.md new file mode 100644 index 00000000..89c9e6d6 --- /dev/null +++ b/examples/webserver/tutorial/README.md @@ -0,0 +1,10 @@ +# Tutorial Server + +This application demonstrates various WebServer use cases together and in its complexity. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-webserver-tutorial.jar +``` diff --git a/examples/webserver/tutorial/pom.xml b/examples/webserver/tutorial/pom.xml new file mode 100644 index 00000000..6e0ecfa8 --- /dev/null +++ b/examples/webserver/tutorial/pom.xml @@ -0,0 +1,84 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-tutorial + 1.0.0-SNAPSHOT + Helidon WebServer Examples Tutorial + + + A tutorial documentation server. + It serves various tutorial articles designed based on project examples. + It is also a complex example demonstrating various web server features. + + + + io.helidon.webserver.examples.tutorial.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.common + helidon-common-reactive + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/CommentService.java b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/CommentService.java new file mode 100644 index 00000000..e1272d16 --- /dev/null +++ b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/CommentService.java @@ -0,0 +1,164 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial; + +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.Flow; +import java.util.stream.Collectors; + +import io.helidon.common.http.DataChunk; +import io.helidon.common.http.MediaType; +import io.helidon.media.common.ContentWriters; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; +import io.helidon.webserver.examples.tutorial.user.User; + + +/** + * Basic service for comments. + */ +public class CommentService implements Service { + + private static final String ROOM_PATH_ID = "room-id"; + + private final ConcurrentHashMap> data = new ConcurrentHashMap<>(); + + @Override + public void update(Routing.Rules routingRules) { + routingRules.get((req, res) -> { + // Register a publisher for comment + res.registerWriter(List.class, MediaType.TEXT_PLAIN.withCharset("UTF-8"), this::publish); + req.next(); + }) + .get("/{" + ROOM_PATH_ID + "}", this::getComments) + .post("/{" + ROOM_PATH_ID + "}", this::addComment); + } + + Flow.Publisher publish(List comments) { + String str = comments.stream() + .map(Comment::toString) + .collect(Collectors.joining("\n")); + return ContentWriters.charSequenceWriter(StandardCharsets.UTF_8) + .apply(str + "\n"); + } + + private void getComments(ServerRequest req, ServerResponse resp) { + String roomId = req.path().param(ROOM_PATH_ID); + //resp.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + List comments = getComments(roomId); + resp.send(comments); + } + + /** + * Returns all comments for the room or an empty list if room doesn't exist. + * + * @param roomId a room ID + * @return a list of comments + */ + public List getComments(String roomId) { + if (roomId == null || roomId.isEmpty()) { + return Collections.emptyList(); + } + + List result = data.get(roomId); + return result == null ? Collections.emptyList() : result; + } + + private void addComment(ServerRequest req, ServerResponse resp) { + String roomId = req.path().param(ROOM_PATH_ID); + User user = req.context() + .get(User.class) + .orElse(User.ANONYMOUS); + req.content() + .as(String.class) + .thenAccept(msg -> addComment(roomId, user, msg)) + .thenRun(resp::send) + .exceptionally(t -> { + req.next(t); + return null; + }); + } + + /** + * Adds new comment into the comment-room. + * + * @param roomName a name of the comment-room + * @param user a user who provides the comment + * @param message a comment message + */ + public void addComment(String roomName, User user, String message) { + if (user == null) { + user = User.ANONYMOUS; + } + List comments = data.computeIfAbsent(roomName, k -> Collections.synchronizedList(new ArrayList<>())); + comments.add(new Comment(user, message)); + } + + /** + * Represents a single comment. + */ + public static class Comment { + private final User user; + private final String message; + + Comment(User user, String message) { + this.user = user; + this.message = message; + } + + @Override + public String toString() { + StringBuilder result = new StringBuilder(); + if (user != null) { + result.append(user.getAlias()); + } + result.append(": "); + result.append(message); + return result.toString(); + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (!(o instanceof Comment)) { + return false; + } + + Comment comment = (Comment) o; + + if (user != null ? !user.equals(comment.user) : comment.user != null) { + return false; + } + return message != null ? message.equals(comment.message) : comment.message == null; + } + + @Override + public int hashCode() { + int result = user != null ? user.hashCode() : 0; + result = 31 * result + (message != null ? message.hashCode() : 0); + return result; + } + } +} diff --git a/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/Main.java b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/Main.java new file mode 100644 index 00000000..7963c844 --- /dev/null +++ b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/Main.java @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial; + +import io.helidon.common.http.MediaType; +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.examples.tutorial.user.UserFilter; + +/** + * Application java main class. + * + *

    The TUTORIAL application demonstrates various WebServer use cases together and in its complexity. + *

    It also serves web server tutorial articles composed from life examples. + */ +public final class Main { + + private Main() { + } + + static Routing createRouting() { + UpperXFilter upperXFilter = new UpperXFilter(); + return Routing.builder() + .any(new UserFilter()) + .any((req, res) -> { + res.registerFilter(upperXFilter); + req.next(); + }) + .register("/article", new CommentService()) + .post("/mgmt/shutdown", (req, res) -> { + res.headers().contentType(MediaType.TEXT_PLAIN.withCharset("UTF-8")); + res.send("Shutting down TUTORIAL server. Good bye!\n"); + // Use reactive API nature to stop the server AFTER the response was sent. + res.whenSent().thenRun(() -> req.webServer().shutdown()); + }) + .build(); + } + + /** + * A java main class. + * + * @param args command line arguments. + */ + public static void main(String[] args) { + // Create a web server instance + int port = 8080; + if (args.length > 0) { + try { + port = Integer.parseInt(args[0]); + } catch (NumberFormatException nfe) { + port = 0; + } + } + + WebServer server = WebServer.builder(createRouting()) + .port(port) + .build(); + + // Start the server and print some info. + server.start().thenAccept(ws -> { + System.out.println("TUTORIAL server is up! http://localhost:" + ws.port()); + System.out.println("Call POST on 'http://localhost:" + ws.port() + "/mgmt/shutdown' to STOP the server!"); + }); + + // Server threads are not demon. NO need to block. Just react. + server.whenShutdown() + .thenRun(() -> System.out.println("TUTORIAL server is DOWN. Good bye!")); + + } +} diff --git a/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/UpperXFilter.java b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/UpperXFilter.java new file mode 100644 index 00000000..5b5f53cc --- /dev/null +++ b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/UpperXFilter.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial; + +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.concurrent.Flow.Publisher; +import java.util.function.Function; + +import io.helidon.common.http.DataChunk; +import io.helidon.common.reactive.Multi; + + +/** + * All 'x' must be upper case. + *

    + * This is a naive implementation. + */ +public final class UpperXFilter implements Function, Publisher> { + + private static final Charset CHARSET = StandardCharsets.US_ASCII; + private static final byte LOWER_X = "x".getBytes(CHARSET)[0]; + private static final byte UPPER_X = "X".getBytes(CHARSET)[0]; + + @Override + public Publisher apply(Publisher publisher) { + return Multi.create(publisher).map(responseChunk -> { + if (responseChunk == null) { + return null; + } + try { + ByteBuffer[] originalData = responseChunk.data(); + ByteBuffer[] processedData = new ByteBuffer[originalData.length]; + for (int i = 0; i < originalData.length; i++) { + // Naive but works for demo + byte[] buff = new byte[originalData[i].remaining()]; + originalData[i].get(buff); + for (int j = 0; j < buff.length; j++) { + if (buff[j] == LOWER_X) { + buff[j] = UPPER_X; + } + } + processedData[i] = ByteBuffer.wrap(buff); + } + return DataChunk.create(responseChunk.flush(), processedData); + } finally { + responseChunk.release(); + } + }); + } +} diff --git a/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/package-info.java b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/package-info.java new file mode 100644 index 00000000..4e4dedcf --- /dev/null +++ b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/package-info.java @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * A tutorial documentation server. It serves various tutorial articles designed based on project examples. + * + *

    It is also a complex example demonstrating various web server features. + */ +package io.helidon.webserver.examples.tutorial; diff --git a/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/User.java b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/User.java new file mode 100644 index 00000000..c7417827 --- /dev/null +++ b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/User.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial.user; + +import io.helidon.webserver.Routing; + +/** + * Represents an immutable user. + * + *

    {@link UserFilter} can be registered on Web Server {@link Routing Routing} to provide valid {@link User} + * instance on the request context. + */ +public final class User { + + /** + * Represents an anonymous user. + */ + public static final User ANONYMOUS = new User(); + + private final boolean authenticated; + private final String alias; + private final boolean anonymous; + + /** + * Creates new instance non-anonymous user. + * + * @param authenticated an authenticated is {@code true} if this user identity was validated + * @param alias an alias represents the name of the user which is visible for others + */ + User(boolean authenticated, String alias) { + this.authenticated = authenticated; + this.alias = alias; + this.anonymous = false; + } + + /** + * Creates an unauthenticated user. + * + * @param alias an alias represents the name of the user which is visible for others + */ + User(String alias) { + this(false, alias); + } + + /** + * Creates an anonymous user instance. + */ + private User() { + this.anonymous = true; + this.authenticated = false; + this.alias = "anonymous"; + } + + public boolean isAuthenticated() { + return authenticated; + } + + public String getAlias() { + return alias; + } + + public boolean isAnonymous() { + return anonymous; + } +} diff --git a/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/UserFilter.java b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/UserFilter.java new file mode 100644 index 00000000..7c4e749e --- /dev/null +++ b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/UserFilter.java @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial.user; + +import io.helidon.webserver.Handler; +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; + +/** + * If used as a {@link Routing Routing} {@link Handler} then assign valid {@link User} instance on the request + * {@link io.helidon.common.context.Context context}. + */ +public class UserFilter implements Handler { + + @Override + public void accept(ServerRequest req, ServerResponse res) { + // Register as a supplier. Thanks to it, user instance is resolved ONLY if it is requested in downstream handlers. + req.context().supply(User.class, + () -> req.headers() + .cookies() + .first("Unauthenticated-User-Alias") + .map(User::new) + .orElse(User.ANONYMOUS)); + req.next(); + } +} diff --git a/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/package-info.java b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/package-info.java new file mode 100644 index 00000000..0121eebc --- /dev/null +++ b/examples/webserver/tutorial/src/main/java/io/helidon/webserver/examples/tutorial/user/package-info.java @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2017, 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. + */ + +/** + * The server supports authenticated, unauthenticated and anonymous users. Each request is created in the context + * of some user. + * + *

    {@link io.helidon.webserver.examples.tutorial.user.UserFilter UserFilter} is responsible for registration of valid + * {@link io.helidon.webserver.examples.tutorial.user.User User} instance on the context of each request. + */ +package io.helidon.webserver.examples.tutorial.user; diff --git a/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/CommentServiceTest.java b/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/CommentServiceTest.java new file mode 100644 index 00000000..716243b4 --- /dev/null +++ b/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/CommentServiceTest.java @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial; + +import java.nio.charset.StandardCharsets; + +import io.helidon.common.http.Http; +import io.helidon.common.http.MediaType; +import io.helidon.webserver.Routing; +import io.helidon.webserver.testsupport.MediaPublisher; +import io.helidon.webserver.testsupport.TestClient; +import io.helidon.webserver.testsupport.TestResponse; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.collection.IsCollectionWithSize.hasSize; +import static org.hamcrest.collection.IsEmptyCollection.empty; + + +/** + * Tests {@link CommentService}. + */ +public class CommentServiceTest { + + @Test + public void addAndGetComments() throws Exception { + CommentService service = new CommentService(); + assertThat(service.getComments("one"), empty()); + assertThat(service.getComments("two"), empty()); + service.addComment("one", null, "aaa"); + assertThat(service.getComments("one"), hasSize(1)); + assertThat(service.getComments("two"), empty()); + service.addComment("one", null, "bbb"); + assertThat(service.getComments("one"), hasSize(2)); + assertThat(service.getComments("two"), empty()); + service.addComment("two", null, "bbb"); + assertThat(service.getComments("one"), hasSize(2)); + assertThat(service.getComments("two"), hasSize(1)); + } + + @Test + public void testRouting() throws Exception { + Routing routing = Routing.builder() + .register(new CommentService()) + .build(); + TestResponse response = TestClient.create(routing) + .path("one") + .get(); + assertThat(response.status(), is(Http.Status.OK_200)); + + // Add first comment + response = TestClient.create(routing) + .path("one") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "aaa")); + assertThat(response.status(), is(Http.Status.OK_200)); + response = TestClient.create(routing) + .path("one") + .get(); + assertThat(response.status(), is(Http.Status.OK_200)); + byte[] data = response.asBytes().toCompletableFuture().get(); + assertThat(new String(data, StandardCharsets.UTF_8), is("anonymous: aaa\n")); + + // Add second comment + response = TestClient.create(routing) + .path("one") + .post(MediaPublisher.create(MediaType.TEXT_PLAIN, "bbb")); + assertThat(response.status(), is(Http.Status.OK_200)); + response = TestClient.create(routing) + .path("one") + .get(); + assertThat(response.status(), is(Http.Status.OK_200)); + data = response.asBytes().toCompletableFuture().get(); + assertThat(new String(data, StandardCharsets.UTF_8), is("anonymous: aaa\nanonymous: bbb\n")); + } +} diff --git a/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/MainTest.java b/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/MainTest.java new file mode 100644 index 00000000..6d8ba3c5 --- /dev/null +++ b/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/MainTest.java @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import io.helidon.common.http.Http; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.testsupport.TestClient; +import io.helidon.webserver.testsupport.TestResponse; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Tests {@link Main}. + */ +public class MainTest { + + @Test + public void testShutDown() throws Exception { + TestResponse response = TestClient.create(Main.createRouting()) + .path("/mgmt/shutdown") + .post(); + assertThat(response.status(), is(Http.Status.OK_200)); + CountDownLatch latch = new CountDownLatch(1); + WebServer webServer = response.webServer(); + webServer + .whenShutdown() + .thenRun(latch::countDown); + assertThat(latch.await(10, TimeUnit.SECONDS), is(true)); + } +} diff --git a/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/user/UserFilterTest.java b/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/user/UserFilterTest.java new file mode 100644 index 00000000..076a40b7 --- /dev/null +++ b/examples/webserver/tutorial/src/test/java/io/helidon/webserver/examples/tutorial/user/UserFilterTest.java @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2017, 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.webserver.examples.tutorial.user; + +import java.util.concurrent.atomic.AtomicReference; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.testsupport.TestClient; +import io.helidon.webserver.testsupport.TestResponse; + +import org.junit.jupiter.api.Test; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Tests {@link UserFilter}. + */ +public class UserFilterTest { + + @Test + public void filter() throws Exception { + AtomicReference userReference = new AtomicReference<>(); + Routing routing = Routing.builder() + .any(new UserFilter()) + .any((req, res) -> { + userReference.set(req.context() + .get(User.class) + .orElse(null)); + res.send(); + }) + .build(); + TestResponse response = TestClient.create(routing) + .path("/") + .get(); + assertThat(userReference.get(), is(User.ANONYMOUS)); + response = TestClient.create(routing) + .path("/") + .header("Cookie", "Unauthenticated-User-Alias=Foo") + .get(); + assertThat(userReference.get().getAlias(), is("Foo")); + } +} diff --git a/examples/webserver/websocket/README.md b/examples/webserver/websocket/README.md new file mode 100644 index 00000000..6a1c48eb --- /dev/null +++ b/examples/webserver/websocket/README.md @@ -0,0 +1,13 @@ +# WebSocket Example + +This application demonstrates use of websockets and REST. + +## Build and run + +```shell +mvn package +java -jar target/helidon-examples-webserver-websocket.jar +``` + +Open http://localhost:8080/web/index.html in your browser. +`` diff --git a/examples/webserver/websocket/pom.xml b/examples/webserver/websocket/pom.xml new file mode 100644 index 00000000..5378d515 --- /dev/null +++ b/examples/webserver/websocket/pom.xml @@ -0,0 +1,106 @@ + + + + + 4.0.0 + + io.helidon.applications + helidon-se + 2.6.8-SNAPSHOT + + + io.helidon.examples.webserver + helidon-examples-webserver-websocket + 1.0.0-SNAPSHOT + Helidon WebServer Examples WebSocket + + + Application demonstrates the use of websockets and REST. + + + + io.helidon.webserver.examples.websocket.Main + + + + + io.helidon.webserver + helidon-webserver + + + io.helidon.webserver + helidon-webserver-static-content + + + io.helidon.webserver + helidon-webserver-tyrus + + + jakarta.inject + jakarta.inject-api + test + + + org.junit.jupiter + junit-jupiter-api + test + + + org.hamcrest + hamcrest-all + test + + + io.helidon.webserver + helidon-webserver-test-support + test + + + io.helidon.webclient + helidon-webclient + test + + + org.glassfish.tyrus + tyrus-client + test + + + org.glassfish.tyrus + tyrus-container-grizzly-client + test + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-libs + + + + + + diff --git a/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/Main.java b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/Main.java new file mode 100644 index 00000000..907eb4ed --- /dev/null +++ b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/Main.java @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.websocket; + +import java.util.Collections; +import java.util.List; + +import javax.websocket.Encoder; +import javax.websocket.server.ServerEndpointConfig; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.WebServer; +import io.helidon.webserver.staticcontent.StaticContentSupport; +import io.helidon.webserver.tyrus.TyrusSupport; + +import static io.helidon.webserver.examples.websocket.MessageBoardEndpoint.UppercaseEncoder; + +/** + * Application demonstrates combination of websocket and REST. + */ +public class Main { + + private Main() { + } + + /** + * Creates new {@link Routing}. + * + * @return the new instance + */ + static Routing createRouting() { + List> encoders = Collections.singletonList(UppercaseEncoder.class); + + return Routing.builder() + .register("/rest", new MessageQueueService()) + .register("/websocket", + TyrusSupport.builder().register( + ServerEndpointConfig.Builder.create(MessageBoardEndpoint.class, "/board") + .encoders(encoders).build()) + .build()) + .register("/web", StaticContentSupport.builder("/WEB").build()) + .build(); + } + + static WebServer startWebServer() { + // Wait for webserver to start before returning + WebServer server = WebServer.builder(createRouting()) + .port(8080) + .build() + .start() + .await(); + + System.out.println("WEB server is up! http://localhost:" + server.port()); + + return server; + } + + /** + * A java main class. + * + * @param args command line arguments. + */ + public static void main(String[] args) { + WebServer server = startWebServer(); + + // Server threads are not demon. NO need to block. Just react. + server.whenShutdown() + .thenRun(() -> System.out.println("WEB server is DOWN. Good bye!")); + + } +} diff --git a/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageBoardEndpoint.java b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageBoardEndpoint.java new file mode 100644 index 00000000..00f27206 --- /dev/null +++ b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageBoardEndpoint.java @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.websocket; + +import java.util.logging.Logger; + +import javax.websocket.CloseReason; +import javax.websocket.Encoder; +import javax.websocket.Endpoint; +import javax.websocket.EndpointConfig; +import javax.websocket.MessageHandler; +import javax.websocket.Session; + +/** + * Class MessageBoardEndpoint. + */ +public class MessageBoardEndpoint extends Endpoint { + private static final Logger LOGGER = Logger.getLogger(MessageBoardEndpoint.class.getName()); + + private final MessageQueue messageQueue = MessageQueue.instance(); + + @Override + public void onOpen(Session session, EndpointConfig endpointConfig) { + session.addMessageHandler(new MessageHandler.Whole() { + @Override + public void onMessage(String message) { + try { + // Send all messages in the queue + if (message.equals("SEND")) { + while (!messageQueue.isEmpty()) { + session.getBasicRemote().sendObject(messageQueue.pop()); + } + } + } catch (Exception e) { + LOGGER.info(e.getMessage()); + } + } + }); + } + + @Override + public void onClose(Session session, CloseReason closeReason) { + super.onClose(session, closeReason); + } + + @Override + public void onError(Session session, Throwable thr) { + super.onError(session, thr); + } + + /** + * Uppercase encoder. + */ + public static class UppercaseEncoder implements Encoder.Text { + + @Override + public String encode(String s) { + LOGGER.info("UppercaseEncoder encode called"); + return s.toUpperCase(); + } + + @Override + public void init(EndpointConfig config) { + } + + @Override + public void destroy() { + } + } +} diff --git a/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageQueue.java b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageQueue.java new file mode 100644 index 00000000..54f779b8 --- /dev/null +++ b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageQueue.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.websocket; + +import java.util.Queue; +import java.util.concurrent.ConcurrentLinkedQueue; + +/** + * Class MessageQueue. + */ +public class MessageQueue { + + private static final MessageQueue INSTANCE = new MessageQueue(); + + private Queue queue = new ConcurrentLinkedQueue<>(); + + /** + * Return singleton instance of this class. + * + * @return Singleton. + */ + public static MessageQueue instance() { + return INSTANCE; + } + + private MessageQueue() { + } + + /** + * Push string on stack. + * + * @param s String to push. + */ + public void push(String s) { + queue.add(s); + } + + /** + * Pop string from stack. + * + * @return The string or {@code null}. + */ + public String pop() { + return queue.poll(); + } + + /** + * Check if stack is empty. + * + * @return Outcome of test. + */ + public boolean isEmpty() { + return queue.isEmpty(); + } + + /** + * Peek at stack without changing it. + * + * @return String peeked or {@code null}. + */ + public String peek() { + return queue.peek(); + } +} diff --git a/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageQueueService.java b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageQueueService.java new file mode 100644 index 00000000..88ffa881 --- /dev/null +++ b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/MessageQueueService.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.websocket; + +import io.helidon.webserver.Routing; +import io.helidon.webserver.ServerRequest; +import io.helidon.webserver.ServerResponse; +import io.helidon.webserver.Service; + +/** + * Class MessageQueueResource. + */ +public class MessageQueueService implements Service { + + private final MessageQueue messageQueue = MessageQueue.instance(); + + @Override + public void update(Routing.Rules routingRules) { + routingRules.post("/board", this::handlePost); + } + + private void handlePost(ServerRequest request, ServerResponse response) { + request.content() + .as(String.class) + .thenAccept(it -> { + messageQueue.push(it); + response.status(204).send(); + }); + } +} diff --git a/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/package-info.java b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/package-info.java new file mode 100644 index 00000000..53180b45 --- /dev/null +++ b/examples/webserver/websocket/src/main/java/io/helidon/webserver/examples/websocket/package-info.java @@ -0,0 +1,25 @@ +/* + * Copyright (c) 2020, 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. + */ + +/** + * Application demonstrates combination of the websocket and REST. + * + *

    + * Start with {@link io.helidon.webserver.examples.websocket.Main} class. + * + * @see io.helidon.webserver.examples.websocket.Main + */ +package io.helidon.webserver.examples.websocket; diff --git a/examples/webserver/websocket/src/main/resources/WEB/index.html b/examples/webserver/websocket/src/main/resources/WEB/index.html new file mode 100644 index 00000000..e1d4b3b3 --- /dev/null +++ b/examples/webserver/websocket/src/main/resources/WEB/index.html @@ -0,0 +1,81 @@ + + + + + + + + + + + +

    +
    +

    +

    + +

    +

    + +

    +

    +

    History

    +
    +
    + + \ No newline at end of file diff --git a/examples/webserver/websocket/src/main/resources/logging.properties b/examples/webserver/websocket/src/main/resources/logging.properties new file mode 100644 index 00000000..ee3458ed --- /dev/null +++ b/examples/webserver/websocket/src/main/resources/logging.properties @@ -0,0 +1,20 @@ +# +# Copyright (c) 2020, 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. +# + +handlers=io.helidon.common.HelidonConsoleHandler +java.util.logging.SimpleFormatter.format=[%1$tc] %4$s: %2$s - %5$s %6$s%n +.level=INFO +io.helidon.microprofile.server.level=INFO diff --git a/examples/webserver/websocket/src/test/java/io/helidon/webserver/examples/websocket/MessageBoardTest.java b/examples/webserver/websocket/src/test/java/io/helidon/webserver/examples/websocket/MessageBoardTest.java new file mode 100644 index 00000000..1341be20 --- /dev/null +++ b/examples/webserver/websocket/src/test/java/io/helidon/webserver/examples/websocket/MessageBoardTest.java @@ -0,0 +1,130 @@ +/* + * Copyright (c) 2020, 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.webserver.examples.websocket; + +import javax.websocket.ClientEndpointConfig; +import javax.websocket.CloseReason; +import javax.websocket.DeploymentException; +import javax.websocket.Endpoint; +import javax.websocket.EndpointConfig; +import javax.websocket.MessageHandler; +import javax.websocket.Session; + +import java.io.IOException; +import java.net.URI; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.logging.Logger; + +import io.helidon.common.http.Http; +import io.helidon.webclient.WebClient; +import io.helidon.webserver.WebServer; +import org.glassfish.tyrus.client.ClientManager; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import static io.helidon.webserver.examples.websocket.Main.startWebServer; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.CoreMatchers.is; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * Class MessageBoardTest. + */ +public class MessageBoardTest { + private static final Logger LOGGER = Logger.getLogger(MessageBoardTest.class.getName()); + + private static WebClient restClient = WebClient.create(); + private static ClientManager websocketClient = ClientManager.createClient(); + private static WebServer server; + + private String[] messages = { "Whisky", "Tango", "Foxtrot" }; + + @BeforeAll + static void initClass() { + server = startWebServer(); + } + + @AfterAll + static void destroyClass() { + server.shutdown(); + } + + @Test + public void testBoard() throws IOException, DeploymentException, InterruptedException, ExecutionException { + // Post messages using REST resource + URI restUri = URI.create("http://localhost:" + server.port() + "/rest/board"); + for (String message : messages) { + restClient.post() + .uri(restUri) + .submit(message) + .thenAccept(it -> assertThat(it.status(), is(Http.Status.NO_CONTENT_204))) + .toCompletableFuture() + .get(); + LOGGER.info("Posting message '" + message + "'"); + } + + // Now connect to message board using WS and them back + URI websocketUri = URI.create("ws://localhost:" + server.port() + "/websocket/board"); + CountDownLatch messageLatch = new CountDownLatch(messages.length); + ClientEndpointConfig config = ClientEndpointConfig.Builder.create().build(); + + websocketClient.connectToServer(new Endpoint() { + @Override + public void onOpen(Session session, EndpointConfig EndpointConfig) { + try { + // Set message handler to receive messages + session.addMessageHandler(new MessageHandler.Whole() { + @Override + public void onMessage(String message) { + LOGGER.info("Client OnMessage called '" + message + "'"); + messageLatch.countDown(); + if (messageLatch.getCount() == 0) { + try { + session.close(); + } catch (IOException e) { + fail("Unexpected exception " + e); + } + } + } + }); + + // Send an initial message to start receiving + session.getBasicRemote().sendText("SEND"); + } catch (IOException e) { + fail("Unexpected exception " + e); + } + } + + @Override + public void onClose(Session session, CloseReason closeReason) { + LOGGER.info("Client OnClose called '" + closeReason + "'"); + } + + @Override + public void onError(Session session, Throwable thr) { + LOGGER.info("Client OnError called '" + thr + "'"); + + } + }, config, websocketUri); + + // Wait until all messages are received + messageLatch.await(1000000, TimeUnit.SECONDS); + } +} diff --git a/pom.xml b/pom.xml index 1766a867..a814ccd8 100644 --- a/pom.xml +++ b/pom.xml @@ -58,7 +58,7 @@ - 17 + 11 UTF-8 UTF-8 2.6.8-SNAPSHOT