JBoss EAP XP 1.0.0 での Eclipse MicroProfile の使用

手順

1. 以下の管理コマンドを使用して microprofile-opentracing-smallrye サブシステムを有効にします。

   /subsystem=microprofile-opentracing-smallrye:add()

2. 変更を反映するためにサーバーをリロードします。

   reload

手順

1. サブシステムを削除します。

   /subsystem=microprofile-opentracing-smallrye:remove()

2. 変更を反映するためにサーバーをリロードします。

   reload

手順

1. サブシステムを追加します。

   /subsystem=microprofile-opentracing-smallrye:add()

2. 変更を反映するためにサーバーをリロードします。

   reload

手順

1. CLI で以下のコマンドを実行して docker を使用して Jaeger をインストールします。

   $ docker run -d --name jaeger   -p 6831:6831/udp   -p 5778:5778   -p 14268:14268   -p 16686:16686   jaegertracing/all-in-one:1.16

手順

1. ファイルを保存するディレクトリーを作成します。

   $ mkdir -p ~/config/prop-files/

2. ディレクトリーに移動します。

   $ cd ~/config/prop-files/

3. プロパティー name の値を保存するファイル name を作成します。

   $ touch name

4. プロパティーの値をファイルに追加します。

   $ echo "jim" > name

5. ファイル名がプロパティーであり、プロパティーの値が含まれるファイルが含まれる ConfigSource を作成します。

   /subsystem=microprofile-config-smallrye/config-source=file-props:add(dir={path=~/config/prop-files})

   これにより、以下の XML 設定が以下のようになります。

   <subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
       <config-source name="file-props">
           <dir path="/etc/config/prop-files"/>
       </config-source>
   </subsystem>

手順

1. 以下の管理 CLI コマンドを使用して MicroProfile Fault Tolerance 拡張を追加します。

   /extension=org.wildfly.extension.microprofile.fault-tolerance-smallrye:add

2. 以下の managenent コマンドを使用して、microprofile-fault-tolerance-smallrye サブシステムを有効にします。

   /subsystem=microprofile-fault-tolerance-smallrye:add

3. 以下の管理コマンドでサーバーをリロードします。

   reload

手順

1. Runtime タブに移動し、サーバーを選択します。
2. Monitor の列で MicroProfile Health → View の順にクリックします。

手順

1. microprofile-health-smallrye サブシステムで security-enabled 属性を true に設定します。

   /subsystem=microprofile-health-smallrye:write-attribute(name=security-enabled,value=true)

2. 変更を反映するためにサーバーをリロードします。

   reload

手順

1. JBoss EAP で MicroProfile JWT smallrye 拡張を有効にします。

   /extension=org.wildfly.extension.microprofile.jwt-smallrye:add

2. microprofile-jwt-smallrye サブシステムを有効にします。

   /subsystem=microprofile-jwt-smallrye:add

3. サーバーをリロードします。

   reload

手順

1. microprofile-metrics-smallrye サブシステムで security-enabled 属性を true に設定します。

   /subsystem=microprofile-metrics-smallrye:write-attribute(name=security-enabled,value=true)

2. 変更を反映するためにサーバーをリロードします。

   reload

手順

1. undertow サブシステムの統計を有効にします。

   • 統計が有効な状態でスタンドアロンサーバーを起動します。

     $ ./standalone.sh -Dwildfly.statistics-enabled=true

   • 既にサーバーが稼働している場合は、undertow サブシステムの統計を有効にします。

     /subsystem=undertow:write-attribute(name=statistics-enabled,value=true)

2. helloworld-rs クイックスタートをデプロイします。

   • クイックスタートのルートディレクトリーに、Maven を使用して web アプリケーションをデプロイします。

     $ mvn clean install wildfly:deploy

3. curl コマンドを使用して CLI で http エンドポイントをクエリーし、request_count に対してフィルター処理を行います。

   $ curl -v http://localhost:9990/metrics |  grep request_count

   想定される出力:

   jboss_undertow_request_count_total{server="default-server",http_listener="default",} 0.0

   返された属性値は 0.0 です。

4. Web ブラウザーで http://localhost:8080/helloworld-rs/ にあるクイックスタートにアクセスし、任意のリンクをクリックします。

5. CLI から HTTP エンドポイントを再度クエリーします。

   $ curl -v http://localhost:9990/metrics |  grep request_count

   想定される出力:

   jboss_undertow_request_count_total{server="default-server",http_listener="default",} 1.0

   値は 1.0 に更新されました。

   最後の 2 つの手順を繰り返して、要求数が更新されていることを確認します。

手順

1. JBoss EAP で MicroProfile OpenAPI smallrye 拡張を有効にします。

   /extension=org.wildfly.extension.microprofile.openapi-smallrye:add()

2. 以下の管理コマンドを使用して microprofile-openapi-smallrye サブシステムを有効にします。

   /subsystem=microprofile-openapi-smallrye:add()

3. サーバーをリロードします。

   reload

手順

1. アプリケーションソースツリーにディレクトリーを作成します。

   $ mkdir APPLICATION_ROOT/src/main/webapp/META-INF

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

2. OpenAPI エンドポイントをクエリーし、出力をファイルにリダイレクトします。

   $ curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json

   デフォルトでは、エンドポイントは YAML ドキュメントを提供し、format=JSON は JSON ドキュメントを返すことを指定します。

3. OpenAPI ドキュメントモデルの処理時にアノテーションのスキャンを省略するようにアプリケーションを設定します。

   $ echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties

4. アプリケーションをリビルドします。

   $ mvn clean install

5. 以下の管理 CLI コマンドを使用してアプリケーションを再度デプロイします。

   1. アプリケーションのアンデプロイ:

      undeploy microprofile-openapi.war

   2. アプリケーションのデプロイ:

      deploy APPLICATION_ROOT/target/microprofile-openapi.war

手順

1. 以下の CLI スクリプトを実行して、デフォルトの standalone.xml サーバー設定ファイルを更新します。

   $ EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli

2. 以下のコマンドを使用して、デフォルトの standalone.xml サーバー設定ファイル以外のスタンドアロンサーバー設定を選択します。

   $ EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli -Dconfig=<standalone-full.xml|standalone-ha.xml|standalone-full-ha.xml>

3. 指定した設定ファイルに Eclipse MicroProfile サブシステムおよび拡張機能が含まれるようになりました。

手順

1. ブラウザーを開き、Red Hat カスタマーポータル にログインします。
2. ページの上部にあるメニューから Downloads を選択します。
3. 一覧で Red Hat JBoss Enterprise Application Platform エントリーを見つけ、選択します。
4. Product ドロップダウンリストから、JBoss EAP XP を選択します。
5. Version ドロップダウンリストから 1.0.0 を選択します。
6. Release タブをクリックします。
7. 一覧で JBoss EAP XP 1.0.0 Incremental Maven Repository を見つけ、Download をクリックします。
8. アーカイブファイルをローカルディレクトリーに保存します。

手順

1. Red Hat JBoss Enterprise Application Platform 7.3.0.GA Maven リポジトリーへのパスを見つけます。例: /path/to/repo/jboss-eap-7.3.0.GA-maven-repository/maven-repository/

2. ダウンロードした JBoss EAP XP 1.0.0 Incremental Maven リポジトリーを直接 Red Hat JBoss Enterprise Application Platform 7.3.0.GA Maven リポジトリーのディレクトリーに展開します。たとえば、ターミナルを開いて以下のコマンドを実行し、Red Hat JBoss Enterprise Application Platform 7.3.0.GA Maven リポジトリーパスの値を置き換えます。

   $ unzip -o jboss-eap-xp-1.0.0-incremental-maven-repository.zip -d EAP_MAVEN_REPOSITORY_PATH

手順

1. 設定方法を選択し、JBoss EAP Eclipse MicroProfile Maven リポジトリーを設定します。

2. JBoss EAP Eclipse MicroProfile Maven リポジトリーを設定したら、jboss-eap-xp-microprofile BOM をプロジェクトの POM ファイルに追加します。以下の例は、pom.xml ファイルの <dependencyManagement> セクションで BOM を設定する方法を示しています。

   <dependencyManagement>
     <dependencies>
       ...
       <dependency>
         <groupId>org.jboss.bom</groupId>
         <artifactId>jboss-eap-xp-microprofile</artifactId>
         <version>1.0.0.GA</version>
         <type>pom</type>
         <scope>import</scope>
     </dependency>
       ...
     </dependencies>
   </dependencyManagement>

   注記

   pom.xml ファイルに type 要素の値を指定しない場合、Maven は要素に jar 値を指定します。

手順

1. Maven プロジェクトを設定します。

   $ mvn archetype:generate \
       -DgroupId=com.example \
       -DartifactId=microprofile-config \
       -DinteractiveMode=false \
       -DarchetypeGroupId=org.apache.maven.archetypes \
       -DarchetypeArtifactId=maven-archetype-webapp
   cd microprofile-config

   これにより、プロジェクトのディレクトリー構造と pom.xml 設定ファイルが作成されます。

2. POM ファイルが jboss-eap-xp-microprofile BOM の Eclipse MicroProfile Config アーティファクトおよび Eclipse MicroProfile REST Client アーティファクトのバージョンを自動的に管理できるようにするには、POM ファイルの <dependencyManagement> セクションに BOM をインポートします。

   <dependencyManagement>
     <dependencies>
       <!-- importing the microprofile BOM adds MicroProfile specs -->
       <dependency>
           <groupId>org.jboss.bom</groupId>
           <artifactId>jboss-eap-xp-microprofile</artifactId>
           <version>1.0.0.GA</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>

3. BOM によって管理される Eclipse MicroProfile Config アーティファクトおよび Eclipse MicroProfile REST Client アーティファクトおよびその他依存関係をプロジェクト POM ファイルの <dependency> セクションに追加します。以下の例は、Eclipse MicroProfile Config および Eclipse MicroProfile REST Client 依存関係をファイルに追加する方法を示しています。

   <!-- Add the MicroProfile REST Client API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.rest.client</groupId>
     <artifactId>microprofile-rest-client-api</artifactId>
     <scope>provided</scope>
   </dependency>
   <!-- Add the MicroProfile Config API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.config</groupId>
     <artifactId>microprofile-config-api</artifactId>
     <scope>provided</scope>
   </dependency>
   <!-- Add the JAX-RS API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.jboss.spec.javax.ws.rs</groupId>
     <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
     <scope>provided</scope>
   </dependency>
   <!-- Add the CDI API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>jakarta.enterprise</groupId>
     <artifactId>jakarta.enterprise.cdi-api</artifactId>
     <scope>provided</scope>
   </dependency>

手順

1. クラスファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/microprofile/config/

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

2. 新しいディレクトリーに移動します。

   $ cd APPLICATION_ROOT/src/main/java/com/example/microprofile/config/

   このディレクトリーに、この手順で説明しているすべてのクラスファイルを作成します。

3. 以下の内容でクラスファイル HelloApplication.java を作成します。

   package com.example.microprofile.config;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/")
   public class HelloApplication extends Application {
   
   }

   このクラスは、アプリケーションを JAX-RS アプリケーションとして定義します。

4. 以下の内容を含むクラスファイル HelloService.java を作成します。

   package com.example.microprofile.config;
   
   public class HelloService {
   	String createHelloMessage(String name){
           return "Hello " + name;
       }
   }

5. 以下の内容を含むクラスファイル HelloWorld.java を作成します。

   package com.example.microprofile.config;
   
   import javax.inject.Inject;
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import org.eclipse.microprofile.config.inject.ConfigProperty;
   
   @Path("/config")
   public class HelloWorld {
   
       @Inject
       @ConfigProperty(name="name", defaultValue="jim") 

   1

   
       String name;
   
      	@Inject
      	HelloService helloService;
   
      	@GET
      	@Path("/json")
      	@Produces({ "application/json" })
      	public String getHelloWorldJSON() {
           String message = helloService.createHelloMessage(name);
          	return "{\"result\":\"" + message + "\"}";
   	}
   }

   1

   MicroProfile Config プロパティーは、@ConfigProperty(name="name", defaultValue="jim") アノテーションでクラスにインジェクトされます。ConfigSource が設定されていない場合、この値 jim が返されます。

6. src/main/webapp/WEB-INF/ ディレクトリーに beans.xml という名前の空のファイルを作成します。

   $ touch APPLICATION_ROOT/src/main/webapp/WEB-INF/beans.xml

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

7. アプリケーションの root ディレクトリーに移動します。

   $ cd APPLICATION_ROOT

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

8. プロジェクトをビルドします。

   $ mvn clean install wildfly:deploy

9. 出力をテストします。

   $ curl http://localhost:8080/microprofile-config/config/json

   以下が想定される出力です。

   {"result":"Hello jim"}

手順

1. 以下の管理 CLI コマンドを使用して MicroProfile Fault Tolerance 拡張を追加します。

   /extension=org.wildfly.extension.microprofile.fault-tolerance-smallrye:add

2. 以下の managenent コマンドを使用して、microprofile-fault-tolerance-smallrye サブシステムを有効にします。

   /subsystem=microprofile-fault-tolerance-smallrye:add

3. 以下の管理コマンドでサーバーをリロードします。

   reload

手順

1. Maven プロジェクトを設定します。

   mvn archetype:generate \
       -DgroupId=com.example.microprofile.faulttolerance \
       -DartifactId=microprofile-fault-tolerance \
       -DarchetypeGroupId=org.apache.maven.archetypes \
       -DarchetypeArtifactId=maven-archetype-webapp \
       -DinteractiveMode=false
   cd microprofile-fault-tolerance

   このコマンドは、プロジェクトのディレクトリー構造と pom.xml 設定ファイルを作成します。

2. POM ファイルが jboss-eap-xp-microprofile BOM の Eclipse MicroProfile Fault Tolerance アーティファクトのバージョンを自動的に管理できるようにするには、POM ファイルの <dependencyManagement> セクションに BOM をインポートします。

   <dependencyManagement>
     <dependencies>
       <!-- importing the microprofile BOM adds MicroProfile specs -->
       <dependency>
           <groupId>org.jboss.bom</groupId>
           <artifactId>jboss-eap-xp-microprofile</artifactId>
           <version>${version.microprofile.bom}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>

   ${version.microprofile.bom} を、インストールされた BOM のバージョンに置き換えます。

3. BOM によって管理される Eclipse MicroProfile Fault Tolerance アーティファクトをプロジェクト POM ファイルの <dependency> セクションに追加します。以下の例は、Eclipse MicroProfile Fault Tolerance 依存関係をファイルに追加する方法を示しています。

   <!-- Add the MicroProfile Fault Tolerance API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.fault.tolerance</groupId>
     <artifactId>microprofile-fault-tolerance-api</artifactId>
     <scope>provided</scope>
   </dependency>

手順

1. クラスファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/microprofile/faulttolerance

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

2. 新しいディレクトリーに移動します。

   $ cd APPLICATION_ROOT/src/main/java/com/example/microprofile/faulttolerance

   以下の手順では、新しいディレクトリーにすべてのクラスファイルを作成します。

3. 以下の内容で、Coffee.java としてクロージサンプルを表す単純なエンティティーを作成します。

   package com.example.microprofile.faulttolerance;
   
   public class Coffee {
   
       public Integer id;
       public String name;
       public String countryOfOrigin;
       public Integer price;
   
       public Coffee() {
       }
   
       public Coffee(Integer id, String name, String countryOfOrigin, Integer price) {
           this.id = id;
           this.name = name;
           this.countryOfOrigin = countryOfOrigin;
           this.price = price;
       }
   }

4. 以下の内容でクラスファイル CoffeeApplication.java を作成します。

   package com.example.microprofile.faulttolerance;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/")
   public class CoffeeApplication extends Application {
   }

5. CDI Bean を以下の内容で CoffeeRepositoryService.java として作成します。

   package com.example.microprofile.faulttolerance;
   
   import java.util.ArrayList;
   import java.util.Collections;
   import java.util.HashMap;
   import java.util.List;
   import java.util.Map;
   import java.util.stream.Collectors;
   import javax.enterprise.context.ApplicationScoped;
   
   @ApplicationScoped
   public class CoffeeRepositoryService {
   
       private Map<Integer, Coffee> coffeeList = new HashMap<>();
   
       public CoffeeRepositoryService() {
           coffeeList.put(1, new Coffee(1, "Fernandez Espresso", "Colombia", 23));
           coffeeList.put(2, new Coffee(2, "La Scala Whole Beans", "Bolivia", 18));
           coffeeList.put(3, new Coffee(3, "Dak Lak Filter", "Vietnam", 25));
       }
   
       public List<Coffee> getAllCoffees() {
           return new ArrayList<>(coffeeList.values());
       }
   
       public Coffee getCoffeeById(Integer id) {
           return coffeeList.get(id);
       }
   
       public List<Coffee> getRecommendations(Integer id) {
           if (id == null) {
               return Collections.emptyList();
           }
           return coffeeList.values().stream()
                   .filter(coffee -> !id.equals(coffee.id))
                   .limit(2)
                   .collect(Collectors.toList());
       }
   }

6. 以下の内容でクラスファイル CoffeeResource.java を作成します。

   package com.example.microprofile.faulttolerance;
   
   import java.util.List;
   import java.util.Random;
   import java.util.concurrent.atomic.AtomicLong;
   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 java.util.Collections;
   import javax.ws.rs.PathParam;
   import org.eclipse.microprofile.faulttolerance.Fallback;
   import org.eclipse.microprofile.faulttolerance.Timeout;
   import org.eclipse.microprofile.faulttolerance.Retry;
   
   @Path("/coffee")
   @Produces(MediaType.APPLICATION_JSON)
   public class CoffeeResource {
   
       @Inject
       private CoffeeRepositoryService coffeeRepository;
   
       private AtomicLong counter = new AtomicLong(0);
   
       @GET
       @Retry(maxRetries = 4) 

   1

   
       public List<Coffee> coffees() {
           final Long invocationNumber = counter.getAndIncrement();
           return coffeeRepository.getAllCoffees();
       }
   
   
       @GET
       @Path("/{id}/recommendations")
       @Timeout(250) 

   2

   
       public List<Coffee> recommendations(@PathParam("id") int id) {
               return coffeeRepository.getRecommendations(id);
           }
   
       @GET
       @Path("fallback/{id}/recommendations")
       @Fallback(fallbackMethod = "fallbackRecommendations") 

   3

   
       public List<Coffee> recommendations2(@PathParam("id") int id) {
           return coffeeRepository.getRecommendations(id);
           }
   
       public List<Coffee> fallbackRecommendations(int id) {
           //always return a default coffee
           return Collections.singletonList(coffeeRepository.getCoffeeById(1));
       }
   }

   1

   4 への再試行回数を定義します。

   2

   タイムアウト間隔をミリ秒単位で定義します。

   3

   呼び出しに失敗した場合に呼び出されるフォールバックメソッドを定義します。

7. アプリケーションの root ディレクトリーに移動します。

   $ cd APPLICATION_ROOT

8. 以下の Maven コマンドを使用してアプリケーションをビルドします。

   $ mvn clean install wildfly:deploy

   http://localhost:8080/microprofile-fault-tolerance/coffee でアプリケーションにアクセスします。

手順

1. JBoss EAP で MicroProfile JWT smallrye 拡張を有効にします。

   /extension=org.wildfly.extension.microprofile.jwt-smallrye:add

2. microprofile-jwt-smallrye サブシステムを有効にします。

   /subsystem=microprofile-jwt-smallrye:add

3. サーバーをリロードします。

   reload

手順

1. Maven プロジェクトを設定します。

   $ mvn archetype:generate -DinteractiveMode=false \
       -DarchetypeGroupId=org.apache.maven.archetypes \
       -DarchetypeArtifactId=maven-archetype-webapp \
       -DgroupId=com.example -DartifactId=microprofile-jwt \
       -Dversion=1.0.0.Alpha1-SNAPSHOT
     cd microprofile-jwt

   このコマンドは、プロジェクトのディレクトリー構造と pom.xml 設定ファイルを作成します。

2. POM ファイルが jboss-eap-xp-microprofile BOM の Eclipse MicroProfile JWT アーティファクトのバージョンを自動的に管理できるようにするには、POM ファイルの <dependencyManagement> セクションに BOM をインポートします。

   <dependencyManagement>
     <dependencies>
       <!-- importing the microprofile BOM adds MicroProfile specs -->
       <dependency>
           <groupId>org.jboss.bom</groupId>
           <artifactId>jboss-eap-xp-microprofile</artifactId>
           <version>${version.microprofile.bom}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>

   ${version.microprofile.bom} を、インストールされた BOM のバージョンに置き換えます。

3. BOM によって管理される Eclipse MicroProfile JWT アーティファクトをプロジェクト POM ファイルの <dependency> セクションに追加します。以下の例は、Eclipse MicroProfile JWT 依存関係をファイルに追加する方法を示しています。

   <!-- Add the MicroProfile JWT API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.jwt</groupId>
     <artifactId>microprofile-jwt-auth-api</artifactId>
     <scope>provided</scope>
   </dependency>

手順

1. トークンジェネレーターを作成します。

   この手順は参照用です。実稼働環境の場合は、独自のトークンジェネレーターを実装します。

   1. トークンジェネレーターユーティリティーの src/test/java ディレクトリーを作成し、これに移動します。

      $ mkdir -p src/test/java
      $ cd src/test/java

   2. 以下の内容でクラスファイル TokenUtil.java を作成します。

      package  com.example.mpjwt;
      
      import java.io.FileInputStream;
      import java.io.InputStream;
      import java.nio.charset.StandardCharsets;
      import java.security.KeyFactory;
      import java.security.PrivateKey;
      import java.security.spec.PKCS8EncodedKeySpec;
      import java.util.Base64;
      import java.util.UUID;
      
      import javax.json.Json;
      import javax.json.JsonArrayBuilder;
      import javax.json.JsonObjectBuilder;
      
      import com.nimbusds.jose.JOSEObjectType;
      import com.nimbusds.jose.JWSAlgorithm;
      import com.nimbusds.jose.JWSHeader;
      import com.nimbusds.jose.JWSObject;
      import com.nimbusds.jose.JWSSigner;
      import com.nimbusds.jose.Payload;
      import com.nimbusds.jose.crypto.RSASSASigner;
      
      public class TokenUtil {
      
          private static PrivateKey loadPrivateKey(final String fileName) throws Exception {
              try (InputStream is = new FileInputStream(fileName)) {
                  byte[] contents = new byte[4096];
                  int length = is.read(contents);
                  String rawKey = new String(contents, 0, length, StandardCharsets.UTF_8)
                          .replaceAll("-----BEGIN (.*)-----", "")
                          .replaceAll("-----END (.*)----", "")
                          .replaceAll("\r\n", "").replaceAll("\n", "").trim();
      
                  PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(Base64.getDecoder().decode(rawKey));
                  KeyFactory keyFactory = KeyFactory.getInstance("RSA");
      
                  return keyFactory.generatePrivate(keySpec);
              }
          }
      
          public static String generateJWT(final String principal, final String birthdate, final String...groups) throws Exception {
          	PrivateKey privateKey = loadPrivateKey("private.pem");
      
              JWSSigner signer = new RSASSASigner(privateKey);
              JsonArrayBuilder groupsBuilder = Json.createArrayBuilder();
              for (String group : groups) { groupsBuilder.add(group); }
      
              long currentTime = System.currentTimeMillis() / 1000;
              JsonObjectBuilder claimsBuilder = Json.createObjectBuilder()
                      .add("sub", principal)
                      .add("upn", principal)
                      .add("iss", "quickstart-jwt-issuer")
                      .add("aud", "jwt-audience")
                      .add("groups", groupsBuilder.build())
                      .add("birthdate", birthdate)
                      .add("jti", UUID.randomUUID().toString())
                      .add("iat", currentTime)
                      .add("exp", currentTime + 14400);
      
              JWSObject jwsObject = new JWSObject(new JWSHeader.Builder(JWSAlgorithm.RS256)
                      .type(new JOSEObjectType("jwt"))
                      .keyID("Test Key").build(),
                      new Payload(claimsBuilder.build().toString()));
      
              jwsObject.sign(signer);
      
              return jwsObject.serialize();
          }
      
          public static void main(String[] args) throws Exception {
              if (args.length < 2) throw new IllegalArgumentException("Usage TokenUtil {principal} {birthdate} {groups}");
              String principal = args[0];
              String birthdate = args[1];
              String[] groups = new String[args.length - 2];
              System.arraycopy(args, 2, groups, 0, groups.length);
      
              String token = generateJWT(principal, birthdate, groups);
              String[] parts = token.split("\\.");
              System.out.println(String.format("\nJWT Header - %s", new String(Base64.getDecoder().decode(parts[0]), StandardCharsets.UTF_8)));
              System.out.println(String.format("\nJWT Claims - %s", new String(Base64.getDecoder().decode(parts[1]), StandardCharsets.UTF_8)));
              System.out.println(String.format("\nGenerated JWT Token \n%s\n", token));
          }
      }

2. 以下の内容を含む src/main/webapp/WEB-INF ディレクトリーに web.xml ファイルを作成します。

   <context-param>
       <param-name>resteasy.role.based.security</param-name>
       <param-value>true</param-value>
   </context-param>
   
   <security-role>
       <role-name>Subscriber</role-name>
   </security-role>

3. 以下の内容でクラスファイル SampleEndPoint.java を作成します。

   package com.example.mpjwt;
   
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   
   import java.security.Principal;
   import javax.ws.rs.core.Context;
   import javax.ws.rs.core.SecurityContext;
   
   import javax.annotation.security.RolesAllowed;
   import javax.inject.Inject;
   
   import java.time.LocalDate;
   import java.time.Period;
   import java.util.Optional;
   
   import org.eclipse.microprofile.jwt.Claims;
   import org.eclipse.microprofile.jwt.Claim;
   
   import org.eclipse.microprofile.jwt.JsonWebToken;
   
   @Path("/Sample")
   public class SampleEndPoint {
   
       @GET
       @Path("/helloworld")
       public String helloworld(@Context SecurityContext securityContext) {
           Principal principal = securityContext.getUserPrincipal();
           String caller = principal == null ? "anonymous" : principal.getName();
   
           return "Hello " + caller;
       }
   
       @Inject
   	JsonWebToken jwt;
   
   	@GET()
   	@Path("/subscription")
   	@RolesAllowed({"Subscriber"})
   	public String helloRolesAllowed(@Context SecurityContext ctx) {
       	Principal caller =  ctx.getUserPrincipal();
       	String name = caller == null ? "anonymous" : caller.getName();
       	boolean hasJWT = jwt.getClaimNames() != null;
       	String helloReply = String.format("hello + %s, hasJWT: %s", name, hasJWT);
   
       	return helloReply;
   	}
   
   	@Inject
   	@Claim(standard = Claims.birthdate)
   	Optional<String> birthdate;
   
   	@GET()
   	@Path("/birthday")
   	@RolesAllowed({ "Subscriber" })
   	public String birthday() {
       	if (birthdate.isPresent()) {
           	LocalDate birthdate = LocalDate.parse(this.birthdate.get().toString());
           	LocalDate today = LocalDate.now();
           	LocalDate next = birthdate.withYear(today.getYear());
           	if (today.equals(next)) {
               	return "Happy Birthday";
           }
           if (next.isBefore(today)) {
               next = next.withYear(next.getYear() + 1);
           }
   
           Period wait = today.until(next);
   
           return String.format("%d months and %d days until your next birthday.", wait.getMonths(), wait.getDays());
       }
   
       return "Sorry, we don't know your birthdate.";
   
   	}
   
   }

   @Path アノテーション付きのメソッドは JAX-RS エンドポイントです。

   @Claim アノテーションは JWT 要求を定義します。

4. クラスファイル App.java を作成して JAX-RS を有効にします。

   package com.example.mpjwt;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   import org.eclipse.microprofile.auth.LoginConfig;
   
   @ApplicationPath("/rest")
   @LoginConfig(authMethod="MP-JWT", realmName="MP JWT Realm")
   public class App extends Application {}

   アノテーション @LoginConfig(authMethod="MP-JWT", realmName="MP JWT Realm") は、デプロイメント中に JWT RBAC を有効にします。

5. 以下の Maven コマンドを使用してアプリケーションをコンパイルします。

   $ mvn package

6. トークンジェネレーターユーティリティーを使用して JWT トークンを生成します。

   $ mvn exec:java -Dexec.mainClass=org.wildfly.quickstarts.mpjwt.TokenUtil -Dexec.classpathScope=test -Dexec.args="testUser 2017-09-15 Echoer Subscriber"

7. 以下の Maven コマンドを使用してアプリケーションをビルドおよびデプロイします。

   $ mvn package wildfly:deploy

8. アプリケーションをテストします。

   • ベアラートークンを使用して Sample/subscription エンドポイントを呼び出します。

     $ curl -H "Authorization: Bearer ey..rg" http://localhost:8080/microprofile-jwt/rest/Sample/subscription

   • Sample/birthday エンドポイントを呼び出します。

     $ curl -H "Authorization: Bearer ey..rg" http://localhost:8080/microprofile-jwt/rest/Sample/birthday

手順

1. 以下の内容を含むクラスファイル HelloService.java を作成します。

   package com.example.microprofile.metrics;
   
   public class HelloService {
       String createHelloMessage(String name){
           return "Hello" + name;
       }
   }

2. 以下の内容を含むクラスファイル HelloWorld.java を作成します。

   package com.example.microprofile.metrics;
   
   import javax.inject.Inject;
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import org.eclipse.microprofile.metrics.annotation.Counted;
   
   @Path("/")
   public class HelloWorld {
   @Inject
       HelloService helloService;
   
   @GET
   @Path("/json")
       @Produces({ "application/json" })
       @Counted(name = "requestCount",
     		 absolute = true,
   description = "Number of times the getHelloWorldJSON was requested")
       public String getHelloWorldJSON() {
           return "{\"result\":\"" + helloService.createHelloMessage("World") + "\"}";
       }
   }

3. 以下の依存関係を含めるように pom.xml ファイルを更新します。

   <dependency>
       <groupId>org.eclipse.microprofile.metrics</groupId>
       <artifactId>microprofile-metrics-api</artifactId>
       <scope>provided</scope>
   </dependency>

4. 以下の Maven コマンドを使用してアプリケーションをビルドします。

   $ mvn clean install wildfly:deploy

5. メトリクスをテストします。

   1. CLI で以下のコマンドを実行します。

      $ curl -v http://localhost:9990/metrics |  grep request_count | grep helloworld-rs-metrics

      想定される出力:

      jboss_undertow_request_count_total{deployment="helloworld-rs-metrics.war",servlet="org.jboss.as.quickstarts.rshelloworld.JAXActivator",subdeployment="helloworld-rs-metrics.war",microprofile_scope="vendor"} 0.0

   2. ブラウザーで http://localhost:8080/helloworld-rs/rest/json にアクセスします。

   3. CLI で以下のコマンドを再度実行します。

      $ curl -v http://localhost:9990/metrics |  grep request_count | grep helloworld-rs-metrics

      想定される出力:

      jboss_undertow_request_count_total{deployment="helloworld-rs-metrics.war",servlet="org.jboss.as.quickstarts.rshelloworld.JAXActivator",subdeployment="helloworld-rs-metrics.war",microprofile_scope="vendor"} 1.0

手順

1. JBoss EAP で MicroProfile OpenAPI smallrye 拡張を有効にします。

   /extension=org.wildfly.extension.microprofile.openapi-smallrye:add()

2. 以下の管理コマンドを使用して microprofile-openapi-smallrye サブシステムを有効にします。

   /subsystem=microprofile-openapi-smallrye:add()

3. サーバーをリロードします。

   reload

手順

1. プロジェクトを初期化します。

   mvn archetype:generate \
        -DgroupId=com.example.microprofile.openapi \
        -DartifactId=microprofile-openapi\
        -DarchetypeGroupId=org.apache.maven.archetypes \
        -DarchetypeArtifactId=maven-archetype-webapp \
        -DinteractiveMode=false
   cd microprofile-openapi

   このコマンドは、プロジェクトのディレクトリー構造と pom.xml 設定ファイルを作成します。

2. pom.xml 設定ファイルを編集して以下を追加します。

   <?xml version="1.0" encoding="UTF-8"?>
   
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
   
       <groupId>com.example.microprofile.openapi</groupId>
       <artifactId>microprofile-openapi</artifactId>
       <version>1.0-SNAPSHOT</version>
       <packaging>war</packaging>
   
       <name>microprofile-openapi Maven Webapp</name>
       <!-- Update the value with the URL of the project -->
       <url>http://www.example.com</url>
   
       <properties>
           <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
           <maven.compiler.source>1.8</maven.compiler.source>
           <maven.compiler.target>1.8</maven.compiler.target>
           <version.server.bom>1.0.0.GA</version.server.bom>
       </properties>
   
       <dependencyManagement>
           <dependencies>
               <dependency>
                   <groupId>org.jboss.bom</groupId>
                   <artifactId>jboss-eap-xp-microprofile</artifactId>
                   <version>${version.server.bom}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
           </dependencies>
       </dependencyManagement>
   
       <dependencies>
           <dependency>
               <groupId>org.jboss.spec.javax.ws.rs</groupId>
               <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
               <scope>provided</scope>
           </dependency>
       </dependencies>
   
       <build>
           <!-- Set the name of the archive -->
           <finalName>${project.artifactId}</finalName>
           <plugins>
               <plugin>
                   <artifactId>maven-clean-plugin</artifactId>
                   <version>3.1.0</version>
               </plugin>
               <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
               <plugin>
                   <artifactId>maven-resources-plugin</artifactId>
                   <version>3.0.2</version>
               </plugin>
               <plugin>
                   <artifactId>maven-compiler-plugin</artifactId>
                   <version>3.8.0</version>
               </plugin>
               <plugin>
                   <artifactId>maven-surefire-plugin</artifactId>
                   <version>2.22.1</version>
               </plugin>
               <plugin>
                   <artifactId>maven-war-plugin</artifactId>
                   <version>3.2.2</version>
               </plugin>
               <plugin>
                   <artifactId>maven-install-plugin</artifactId>
                   <version>2.5.2</version>
               </plugin>
               <plugin>
                   <artifactId>maven-deploy-plugin</artifactId>
                   <version>2.8.2</version>
               </plugin>
               <!-- Allows to use mvn wildfly:deploy -->
               <plugin>
                   <groupId>org.wildfly.plugins</groupId>
                   <artifactId>wildfly-maven-plugin</artifactId>
               </plugin>
           </plugins>
       </build>
   </project>

手順

1. クラスファイルを保存するディレクトリーを作成します。

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/microprofile/openapi/

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

2. 新しいディレクトリーに移動します。

   $ cd APPLICATION_ROOT/src/main/java/com/example/microprofile/openapi/

   以下の手順のクラスファイルすべては、このディレクトリーに作成する必要があります。

3. 以下の内容でクラスファイル InventoryApplication.java を作成します。

   package com.example.microprofile.openapi;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/inventory")
   public class InventoryApplication extends Application {
   }

   このクラスはアプリケーションの REST エンドポイントとして機能します。

4. 以下の内容でクラスファイル Fruit.java を作成します。

   package com.example.microprofile.openapi;
   
   public class Fruit {
   
       private final String name;
       private final String description;
   
       public Fruit(String name, String description) {
           this.name = name;
           this.description = description;
       }
   
       public String getName() {
           return this.name;
       }
   
       public String getDescription() {
           return this.description;
       }
   }

5. 以下の内容でクラスファイル FruitResource.java を作成します。

   package com.example.microprofile.openapi;
   
   import java.util.Collections;
   import java.util.LinkedHashMap;
   import java.util.Set;
   
   import javax.ws.rs.Consumes;
   import javax.ws.rs.DELETE;
   import javax.ws.rs.GET;
   import javax.ws.rs.POST;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.MediaType;
   
   @Path("/fruit")
   @Produces(MediaType.APPLICATION_JSON)
   @Consumes(MediaType.APPLICATION_JSON)
   public class FruitResource {
   
       private final Set<Fruit> fruits = Collections.newSetFromMap(Collections.synchronizedMap(new LinkedHashMap<>()));
   
       public FruitResource() {
           this.fruits.add(new Fruit("Apple", "Winter fruit"));
           this.fruits.add(new Fruit("Pineapple", "Tropical fruit"));
       }
   
       @GET
       public Set<Fruit> all() {
           return this.fruits;
       }
   
       @POST
       public Set<Fruit> add(Fruit fruit) {
           this.fruits.add(fruit);
           return this.fruits;
       }
   
       @DELETE
       public Set<Fruit> remove(Fruit fruit) {
           this.fruits.removeIf(existingFruit -> existingFruit.getName().contentEquals(fruit.getName()));
           return this.fruits;
       }
   }

6. アプリケーションの root ディレクトリーに移動します。

   $ cd APPLICATION_ROOT

7. 以下の Maven コマンドを使用してアプリケーションをビルドおよびデプロイします。

   $ mvn wildfly:deploy

8. アプリケーションをテストします。

   • curl を使用して、サンプルアプリケーションの OpenAPI ドキュメントにアクセスします。

     $ curl http://localhost:8080/openapi

   • 以下の出力が返されます。

     openapi: 3.0.1
     info:
       title: Archetype Created Web Application
       version: "1.0"
     servers:
     - url: /microprofile-openapi
     paths:
       /inventory/fruit:
         get:
           responses:
             "200":
               description: OK
               content:
                 application/json:
                   schema:
                     type: array
                     items:
                       $ref: '#/components/schemas/Fruit'
         post:
           requestBody:
             content:
               application/json:
                 schema:
                   $ref: '#/components/schemas/Fruit'
           responses:
             "200":
               description: OK
               content:
                 application/json:
                   schema:
                     type: array
                     items:
                       $ref: '#/components/schemas/Fruit'
         delete:
           requestBody:
             content:
               application/json:
                 schema:
                   $ref: '#/components/schemas/Fruit'
           responses:
             "200":
               description: OK
               content:
                 application/json:
                   schema:
                     type: array
                     items:
                       $ref: '#/components/schemas/Fruit'
     components:
       schemas:
         Fruit:
           type: object
           properties:
             description:
               type: string
             name:
               type: string

手順

1. アプリケーションソースツリーにディレクトリーを作成します。

   $ mkdir APPLICATION_ROOT/src/main/webapp/META-INF

   APPLICATION_ROOT は、アプリケーションの pom.xml 設定ファイルが含まれるディレクトリーです。

2. OpenAPI エンドポイントをクエリーし、出力をファイルにリダイレクトします。

   $ curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json

   デフォルトでは、エンドポイントは YAML ドキュメントを提供し、format=JSON は JSON ドキュメントを返すことを指定します。

3. OpenAPI ドキュメントモデルの処理時にアノテーションのスキャンを省略するようにアプリケーションを設定します。

   $ echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties

4. アプリケーションをリビルドします。

   $ mvn clean install

5. 以下の管理 CLI コマンドを使用してアプリケーションを再度デプロイします。

   1. アプリケーションのアンデプロイ:

      undeploy microprofile-openapi.war

   2. アプリケーションのデプロイ:

      deploy APPLICATION_ROOT/target/microprofile-openapi.war