第3章 Business Central を使用しないプロジェクトデプロイメント

手順

1. プロジェクトの ~/resources/META-INF ディレクトリーに、最低でも以下の内容を含む kmodule.xml メタデータを作成します。

   <?xml version="1.0" encoding="UTF-8"?>
   <kmodule xmlns="http://www.drools.org/xsd/kmodule">
   </kmodule>

   プロジェクトの resources パスで見つかったすべてのファイルを含むデフォルトの KIE ベースを 1 つ作成するには、この空の kmodule.xml ファイルで十分です。デフォルトの KIE ベースには、ビルド時にアプリケーションに KIE コンテナーを作成する際に発生するデフォルト KIE セッションも 1 つ含まれます。

   以下は、より高度な kmodule.xml ファイルの例です。

   <?xml version="1.0" encoding="UTF-8"?>
   <kmodule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.drools.org/xsd/kmodule">
     <configuration>
         <property key="drools.evaluator.supersetOf" value="org.mycompany.SupersetOfEvaluatorDefinition"/>
     </configuration>
     <kbase name="KBase1" default="true" eventProcessingMode="cloud" equalsBehavior="equality" declarativeAgenda="enabled" packages="org.domain.pkg1">
       <ksession name="KSession1_1" type="stateful" default="true" />
       <ksession name="KSession1_2" type="stateful" default="true" beliefSystem="jtms" />
     </kbase>
     <kbase name="KBase2" default="false" eventProcessingMode="stream" equalsBehavior="equality" declarativeAgenda="enabled" packages="org.domain.pkg2, org.domain.pkg3" includes="KBase1">
       <ksession name="KSession2_1" type="stateless" default="true" clockType="realtime">
         <fileLogger file="debugInfo" threaded="true" interval="10" />
         <workItemHandlers>
           <workItemHandler name="name" type="new org.domain.WorkItemHandler()" />
         </workItemHandlers>
         <listeners>
           <ruleRuntimeEventListener type="org.domain.RuleRuntimeListener" />
           <agendaEventListener type="org.domain.FirstAgendaListener" />
           <agendaEventListener type="org.domain.SecondAgendaListener" />
           <processEventListener type="org.domain.ProcessListener" />
         </listeners>
       </ksession>
     </kbase>
   </kmodule>

   この例は、KIE ベースを 2 つ定義します。ルールアセットの特定の パッケージ は両方 KIE ベースに含まれます。このようにパッケージを指定した場合は、指定したパッケージを反映するディレクトリー構造にルールファイルを整理する必要があります。KIE ベース KBase1 から 2 つの KIE セッションをインスタンス化し、KBase2 から KIE セッションを 1 つインスタンス化します。KBase2 の KIE セッションは ステートレス な KIE セッションですが、これは 1 つ前の KIE セッションで呼び出されたデータ (1 つ前のセッションの状態) が、セッションの呼び出しと呼び出しの間で破棄されることを示しています。また、その KIE セッションには、ファイル (またはコンソール) ロガー、WorkItemHandler、サポートされる 3 種類のリスナー (ruleRuntimeEventListener、agendaEventListener、および processEventListener) も指定されます。<configuration> 要素は、kmodule.xml ファイルをさらにカスタマイズするのに使用できる任意のプロパティーを定義します。

   プロジェクトに kmodule.xml ファイルを手動で追加する代わりに、Java アプリケーションの KieModuleModel インスタンスを使用するか、プログラムで kmodule.xml ファイルを作成し、KIE ベースおよび KIE セッションを定義し、KIE 仮想ファイルシステム KieFileSystem に、プロジェクトのリソースをすべて追加します。

   プログラムを使用して kmodule.xml を作成し、KieFileSystem に追加

   import org.kie.api.KieServices;
   import org.kie.api.builder.model.KieModuleModel;
   import org.kie.api.builder.model.KieBaseModel;
   import org.kie.api.builder.model.KieSessionModel;
   import org.kie.api.builder.KieFileSystem;
   
   KieServices kieServices = KieServices.Factory.get();
   KieModuleModel kieModuleModel = kieServices.newKieModuleModel();
   
   KieBaseModel kieBaseModel1 = kieModuleModel.newKieBaseModel("KBase1")
     .setDefault(true)
     .setEqualsBehavior(EqualityBehaviorOption.EQUALITY)
     .setEventProcessingMode(EventProcessingOption.STREAM);
   
   KieSessionModel ksessionModel1 = kieBaseModel1.newKieSessionModel("KSession1_1")
     .setDefault(true)
     .setType(KieSessionModel.KieSessionType.STATEFUL)
     .setClockType(ClockTypeOption.get("realtime"));
   
   KieFileSystem kfs = kieServices.newKieFileSystem();
   kfs.writeKModuleXML(kieModuleModel.toXML());

2. 手動またはプログラムで kmodule.xml ファイルをプロジェクトに設定したら、設定を検証する KIE コンテナーから KIE ベースおよび KIE セッションを取得します。

   KieServices kieServices = KieServices.Factory.get();
   KieContainer kContainer = kieServices.getKieClasspathContainer();
   
   KieBase kBase1 = kContainer.getKieBase("KBase1");
   KieSession kieSession1 = kContainer.newKieSession("KSession1_1"),
       kieSession2 = kContainer.newKieSession("KSession1_2");
   
   KieBase kBase2 = kContainer.getKieBase("KBase2");
   StatelessKieSession kieSession3 = kContainer.newStatelessKieSession("KSession2_1");

   kmodule.xml ファイルに、KieBase または KieSession を default="true" と設定している場合は、先ほどの kmodule.xml 例で、名前を渡さずに KIE コンテナーから取得できます。

   KieContainer kContainer = ...
   
   KieBase kBase1 = kContainer.getKieBase();
   KieSession kieSession1 = kContainer.newKieSession(),
       kieSession2 = kContainer.newKieSession();
   
   KieBase kBase2 = kContainer.getKieBase();
   StatelessKieSession kieSession3 = kContainer.newStatelessKieSession();

手順

1. Maven プロジェクトの pom.xml ファイルで、パッケージタイプを kjar に設定し、kie-maven-plugin ビルドコンポーネントを追加します。

   <packaging>kjar</packaging>
   ...
   <build>
     <plugins>
       <plugin>
         <groupId>org.kie</groupId>
         <artifactId>kie-maven-plugin</artifactId>
         <version>${rhpam.version}</version>
         <extensions>true</extensions>
       </plugin>
     </plugins>
   </build>

   kjar パッケージングタイプは、kie-maven-plugin コンポーネントをアクティブにして、アーティファクトリソースを検証してプリコンパイルします。<version> は、プロジェクトで現在使用される Red Hat Process Automation Manager の Maven アーティファクトのバージョン (例: 7.7.0.Final-redhat-7) で、デプロイメントに Maven プロジェクトを適切にパッケージがするのに必要です。

2. Maven プロジェクトの ~/resources ディレクトリーに、最低でも以下の内容を含む META-INF/kmodule.xml メタデータファイルを作成します。

   <?xml version="1.0" encoding="UTF-8"?>
   <kmodule xmlns="http://www.drools.org/xsd/kmodule">
   </kmodule>

   この kmodule.xml ファイルは、すべての Red Hat Process Automation Manager プロジェクトに必要な KIE モジュール記述子です。KIE モジュールを使用して、1 つ以上の KIE ベースを定義し、各 KIE ベースに 1 つ以上の KIE セッションを定義します。

   kmodule.xml 設定の詳細は「KIE モジュール記述子ファイルの設定」を参照してください。

3. Maven プロジェクトの関連リソースで、.java クラスを設定して KIE コンテナーおよび KIE セッションを作成して、ナレッジベースをロードします。

   import org.kie.api.KieServices;
   import org.kie.api.runtime.KieContainer;
   import org.kie.api.runtime.KieSession;
   
   public void testApp() {
   
     // Load the knowledge base:
     KieServices ks = KieServices.Factory.get();
     KieContainer kContainer = ks.getKieClasspathContainer();
     KieSession kSession = kContainer.newKieSession();
   
   }

   この例では、KIE コンテナーは、testApp プロジェクトのクラスパスからビルドしたファイルを読み込みます。KieServices API を使用すれば、KIE ビルド設定およびランタイム設定のすべてにアクセスできます。

   プロジェクトの ReleaseId を KieServices API に渡して KIE コンテナーを作成することもできます。ReleaseId は、プロジェクトの pom.xml ファイルの GroupId 値、ArtifactId 値、Version 値 (GAV) から生成します。

   import org.kie.api.KieServices;
   import org.kie.api.runtime.KieContainer;
   import org.kie.api.runtime.KieSession;
   
   public void testApp() {
   
     // Identify the project in the local repository:
     ReleaseId rid = new ReleaseId();
     rid.setGroupId("com.sample");
     rid.setArtifactId("my-app");
     rid.setVersion("1.0.0");
   
     // Load the knowledge base:
     KieServices ks = KieServices.Factory.get();
     KieContainer kContainer = ks.newKieContainer(rid);
     KieSession kSession = kContainer.newKieSession();
   
   }

4. コマンドターミナルで、Maven プロジェクトディレクトリーに移動し、以下のコマンドを実行してテスト用ファイルをビルドし、プロジェクトに設定したリモートの Maven リポジトリーをデプロイします。

   テスト目的で、プロジェクトをローカルにビルドします。

   mvn clean install

   リモートの Maven リポジトリーにプロジェクトをデプロイします。

   mvn deploy

   ビルドに失敗したら、コマンドラインのエラーメッセージに記載されている問題に対応し、ビルドに成功するまでファイルの妥当性確認を行います。

手順

1. クライアントアプリケーションで、KieServices API を使用して、必要な KIE ベースおよび KIE セッションを持つ KieModuleModel インスタンスを作成します。KieServices API を使用して、KIE ビルド設定およびランタイム設定にアクセスできます。KieModuleModel インスタンスは、プロジェクトの kmodule.xml ファイルを生成します。

   kmodule.xml 設定の詳細は「KIE モジュール記述子ファイルの設定」を参照してください。

2. KieModuleModel インスタンスを XML に変換し、XML を KieFileSystem に追加します。

   プログラムを使用して kmodule.xml を作成し、KieFileSystem に追加

   import org.kie.api.KieServices;
   import org.kie.api.builder.model.KieModuleModel;
   import org.kie.api.builder.model.KieBaseModel;
   import org.kie.api.builder.model.KieSessionModel;
   import org.kie.api.builder.KieFileSystem;
   
     KieServices kieServices = KieServices.Factory.get();
     KieModuleModel kieModuleModel = kieServices.newKieModuleModel();
   
     KieBaseModel kieBaseModel1 = kieModuleModel.newKieBaseModel("KBase1")
       .setDefault(true)
       .setEqualsBehavior(EqualityBehaviorOption.EQUALITY)
       .setEventProcessingMode(EventProcessingOption.STREAM);
   
     KieSessionModel ksessionModel1 = kieBaseModel1.newKieSessionModel("KSession1")
       .setDefault(true)
       .setType(KieSessionModel.KieSessionType.STATEFUL)
       .setClockType(ClockTypeOption.get("realtime"));
   
     KieFileSystem kfs = kieServices.newKieFileSystem();
     kfs.writeKModuleXML(kieModuleModel.toXML());

3. プロジェクトで使用する残りの Red Hat Process Automation Manager アセットをすべて KieFileSystem インスタンスに追加します。アーティファクトは、Maven プロジェクトファイル構造に含まれる必要があります。

   import org.kie.api.builder.KieFileSystem;
   
     KieFileSystem kfs = ...
     kfs.write("src/main/resources/KBase1/ruleSet1.drl", stringContainingAValidDRL)
       .write("src/main/resources/dtable.xls",
         kieServices.getResources().newInputStreamResource(dtableFileStream));

   この例では、プロジェクトアセットは、String 変数および Resource インスタンスの両方として追加されます。Resource インスタンスは KieResources ファクトリーを使用して作成され、KieServices インスタンスにより提供されます。KieResources クラスは、InputStream オブジェクト、URL オブジェクト、および File オブジェクト、またはファイルシステムのパスを示す String を、KieFileSystem が管理する Resource インスタンスに変換する factory メソッドを提供します。

   プロジェクトのアーティファクトを KieFileSystem に追加する際に、ResourceType プロパティーを Resource オブジェクトに明示的に割り当てることもできます。

   import org.kie.api.builder.KieFileSystem;
   
     KieFileSystem kfs = ...
     kfs.write("src/main/resources/myDrl.txt",
       kieServices.getResources().newInputStreamResource(drlStream)
         .setResourceType(ResourceType.DRL));

4. KieFileSystem のコンテンツをビルドし、デプロイする KIE コンテナーを作成します。

   import org.kie.api.KieServices;
   import org.kie.api.KieServices.Factory;
   import org.kie.api.builder.KieFileSystem;
   import org.kie.api.builder.KieBuilder;
   import org.kie.api.runtime.KieContainer;
   
     KieServices kieServices = KieServices.Factory.get();
     KieFileSystem kfs = ...
     kieServices.newKieBuilder( kfs ).buildAll();
     KieContainer kieContainer = kieServices
       .newKieContainer(kieServices.getRepository().getDefaultReleaseId());

5. KieBuilder を実行して、ビルドが成功したことを確認します。

   import org.kie.api.builder.KieBuilder;
   import org.kie.api.KieServices;
   
     KieBuilder kieBuilder = kieServices.newKieBuilder( kfs ).buildAll();
     assertEquals(0, kieBuilder.getResults().getMessages(Message.Level.ERROR).size());

   ERROR は、プロジェクトのコンパイルに失敗し、KieModule が作成されず、KieRepository シングルトンに何も追加されないことを示しています。WARNING または INFO の結果は、プロジェクトのコンパイルが成功したことと、ビルドプロセスの詳細を示しています。