第2章 ルールを使い始める

1. /home/<USER_NAME>/migration-rules/data/ サブディレクトリーに jboss-web.xml ファイルを作成します。

2. 以下の内容にコピーします。

   <!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 4.2//EN" "http://www.jboss.org/j2ee/dtd/jboss-web_4_2.dtd">
   <jboss-web>
       <class-loading java2ClassLoadingCompliance="false">
           <loader-repository>
               seam.jboss.org:loader=@projectName@
               <loader-repository-config>java2ParentDelegation=false</loader-repository-config>
           </loader-repository>
       </class-loading>
   </jboss-web>

   ルールの作成

手順

1. /home/<USER_NAME>/migration-rules/rules/ ディレクトリーで、以下の内容が含まれる JBoss5-web-class-loading.windup.xml という名前のファイルを作成します。

   <?xml version="1.0"?>
   <ruleset id="<UNIQUE_RULESET_ID>"
     xmlns="http://windup.jboss.org/schema/jboss-ruleset"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://windup.jboss.org/schema/jboss-ruleset http://windup.jboss.org/schema/jboss-ruleset/windup-jboss-ruleset.xsd">
     <metadata>
         <description>
             <!-- Ruleset Description -->
         </description>
         <dependencies>
             <!-- Ruleset Dependencies -->
         </dependencies>
         <sourceTechnology id="<SOURCE_ID>" versionRange="<SOURCE_VERSION_RANGE>"/>
         <targetTechnology id="<TARGET_ID>" versionRange="<TARGET_VERSION_RANGE>"/>
         <tag>Reviewed-2015-05-01</tag>
     </metadata>
     <rules>
         <rule id="<UNIQUE_RULE_ID>">
           <when>
               <!-- Test for a condition here -->
           </when>
           <perform>
               <!-- Perform an action -->
           </perform>
         </rule>
      </rules>
   </ruleset>

   注記

   XML ファイル名には、.windup.xml 拡張子を含める必要があります。それ以外の場合、MTR は新しいルールを評価しません。

2. ruleset および rule に一意の識別子を追加します。

   • <UNIQUE_RULESET_ID> を、適切なルールセット ID (例: JBoss5-web-class-loading) に置き換えます。
   • <UNIQUE_RULE_ID> を、適切なルール ID (例: JBoss5-web-class-loading_001) に置き換えます。

3. 次のルールセットアドオン依存関係を追加します。

   <dependencies>
     <addon id="org.jboss.windup.rules,windup-rules-javaee,3.0.0.Final"/>
     <addon id="org.jboss.windup.rules,windup-rules-java,3.0.0.Final"/>
   </dependencies>

4. ソースおよびターゲットのテクノロジーを追加します。

   • <SOURCE_ID> を eap に置き換えます。
   • <TARGET_ID> を eap に置き換えます。

5. ソースおよびターゲットのテクノロジーバージョンを設定します。

   • <SOURCE_VERSION_RANGE> を (4,5) に置き換えます。
   • <TARGET_VERSION_RANGE> を (6,) に置き換えます。

   詳細は、Apache Maven version range specification を参照してください。

6. when 条件を完了します。このルールは XML ファイルの一致をテストするため、ファイルの評価には xmlfile が使用されます。

   jboss-web の子である class-loading 要素と一致するには、xpath 式 jboss-web/class-loading を使用します。

   <when>
       <xmlfile matches="jboss-web/class-loading" />
   </when>

7. このルールの perform アクションを完了します。

   • 説明的なタイトルと作業レベル 1 を使用して分類を追加します。

   • ヒントに情報メッセージと、移行の詳細を説明するドキュメントへのリンクを提供します。

     <perform>
         <iteration>
             <classification title="JBoss Web Application Descriptor" effort="1"/>
             <hint title="JBoss Web XML class-loading element is no longer valid">
               <message>
                 The class-loading element is no longer valid in the jboss-web.xml file.
               </message>
               <link href="https://access.redhat.com/documentation/ja-JP/JBoss_Enterprise_Application_Platform/6.4/html-single/Migration_Guide/index.html#Create_or_Modify_Files_That_Control_Class_Loading_in_JBoss_Enterprise_Application_Platform_6" title="Create or Modify Files That Control Class Loading in JBoss EAP 6"/>
             </hint>
         </iteration>
     </perform>

1. Web ブラウザーで /home/<USER_NAME>/migration-rules/reports/index.html を開きます。

2. ルールが正常に実行されたことを確認します。

   1. 主な編集ページから、Rule providers execution overview リンクをクリックし、Rule Providers Execution Overview を開きます。

   2. JBoss5-web-class-loading_001 ルールを探して、Status? が Condition met で、Result? が success であることを確認します。

      図2.1 テストルール実行

      

3. ルールがテストデータと一致していることを確認します。

   1. メインの発行ページから、この例の データ であるアプリケーションまたは入力フォルダーの名前をクリックします。
   2. Application Details レポートリンクをクリックします。

   3. jboss-web.xml リンクをクリックして、ソースレポート を表示します。

      <class-loading> 行が強調表示されており、カスタムルールからのヒントがインラインで表示されます。

      図2.2 ルール一致

      

      ファイルの上部には、一致するルールの分類が表示されます。リンクアイコンを使用すると、そのルールの詳細を表示できます。この例では、jboss-web.xml ファイルが 1 つのストーリーポイントを生成した別のルール (JBoss web application descriptor (jboss-web.xml)) と一致することに注意してください。このストーリーポイントは、カスタムルールから 1 つのストーリーポイントと組み合わせて、このファイルの合計部分を 2 にまとめます。