1. https://access.redhat.com/ にアクセスします。
2. ダウンロード → JBoss Enterprise Middleware → ダウンロード と選択します。
3. ドロップボックスから JBoss Developer Studio を選択します。
4. 適切なバージョンを選択し、ダウンロード をクリックします。

手順1.1 JBoss Developer Studio 5 のインストール

1. 端末を開きます。
2. ダウンロードした .jar ファイルが含まれるディレクトリへ移動します。
3. 次のコマンドを実行して GUI インストーラーを開始します。

   java -jar jbdevstudio-build_version.jar

4. [Next] をクリックしてインストールを開始します。
5. [I accept the terms of this license agreement] を選択し、[Next] をクリックします。
6. インストールパスを調整し、[Next] をクリックします。

   注記

   インストールパスのフォルダーが存在しない場合はメッセージが表示されます。[Ok] をクリックしてフォルダーを作成します。
7. デフォルトの JVM が選択されます。他の JVM を選択するか、そのまま [Next] をクリックします。
8. 使用可能なアプリケーションプラットフォームを追加し、[Next] をクリックします。
9. インストールの詳細を確認し、[Next] をクリックします。
10. インストールが完了したら [Next] をクリックします。
11. JBoss Developer Studio のデスクトップショートカットを設定し、[Next] をクリックします。
12. [Done] をクリックします。

手順1.2 JBoss Developer Studio を起動するコマンド

1. 端末を開きます。
2. インストールディレクトリへ移動します。
3. 次のコマンドを実行して JBoss Developer Studio を起動します。

   [localhost]$ ./jbdevstudio

手順1.3 サーバーの追加

1. [Servers]タブを開きます。[Servers]タブがない場合は次のようにパネルへ追加します。
   1. [Window] → [Show View] → [Other...] をクリックします。
   2. [Servers] フォルダーより [Server] を選択し、[OK] をクリックします。
2. [new server wizard]リンクをクリックするか、空のサーバーパネル内で右クリックし、[New] → [Server] と選択します。
   

   図1.1 新しいサーバーの追加 - 使用できるサーバーがない場合

3. [JBoss Enterprise Middleware] を拡張し、 [JBoss Enterprise Application Platform 6.x] を選択します。その後、[Next] ボタンをクリックします。
   

   図1.2 サーバータイプの選択

4. [Browse] をクリックし、JBoss Enterprise Application Platform 6 のインストール場所へ移動します。そして [Next] をクリックします。
   

   図1.3 サーバーインストールの閲覧

5. この画面でサーバーの動作を定義します。手作業でサーバーを起動するか、JBoss Developer Studio に管理を任せます。デプロイメントのリモートサーバーを定義し、そのサーバーの管理ポートを公開するかどうかを決定できます (たとえば、JMX を使用してこのサーバーに接続する必要がある場合)。この例では、サーバーがローカルサーバーであり、JBoss Developer Studio がサーバーを管理するため、何もチェックする必要がないことを前提とします。次へ (Next) をクリックします。
   

   図1.4 新しい JBoss サーバーの挙動の定義

6. この画面により新しいサーバーに対して既存のプロジェクトを設定することが可能です。現時点ではプロジェクトがないため、 [Finish] をクリックします。
   

   図1.5 新しい JBoss サーバーのリソースの変更

手順1.5 クイックスタートのダウンロード

1. Web ブラウザーを開き、URL https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?product=appplatform にアクセスします。
2. リストに「Application Platform 6 クイックスタート」があることを確認します。
3. [ダウンロード] ボタンをクリックし、サンプルが含まれる .zip ファイルをダウンロードします。
4. 希望のディレクトリにアーカイブを展開します。

手順1.6 JBoss Developer Studio にクイックスタートをインポートする

1. この作業を行っていない場合は、 「Maven 設定を使用した JBoss Enterprise Application Platform の Maven リポジトリーの設定」に記載された手順に従ってください。

2. JBoss Developer Studio を起動します。

3. メニューより [File] → [Import] と選択します。

4. 選択リストより [Maven] → [Maven Projects] と選択し、[Next] を選択します。
   

   図1.7 既存の Maven プロジェクトのインポート

5. インポートするクイックスタートのディレクトリーを参照し、OK をクリックします。[Projects] リストボックスに、選択したクイックスタートプロジェクトの pom.xml ファイルが示されます。
   

   図1.8 Maven プロジェクトの選択

6. [Next] をクリックした後、 [Finish] をクリックします。

手順1.7 helloworld クイックスタートのビルドとデプロイ

1. [Servers] タブを開き、パネルにアプリケーションを追加します。
   1. [Window] → [Show View] → [Other...] をクリックします。
   2. [Servers] フォルダーから [Server] を選択し[Ok] をクリックします。
2. [Project Explorer] タブで [helloworld] を右クリックし、[Run As] → [Run on Server] を選択します。
3. [JBoss EAP 6.0 Runtime Server] サーバーを選択し、[Next] をクリックします。これにより helloworld クイックスタートが JBoss サーバーにデプロイされます。
4. helloworld が JBoss サーバーに正しくデプロイされたことを確認するには、Web ブラウザーを開いて、URL http://localhost:8080/jboss-as-helloworld でアプリケーションに接続します。

手順1.8 コマンドラインを使用したクイックスタートのビルドおよびデプロイ

1. クイックスタートのルートディレクトリにある README ファイルを確認してください。

   このファイルにはシステム要件に関する一般的な情報、Maven の設定方法、ユーザーの追加方法、クイックスタートの実行方法が含まれています。クイックスタートを始める前に必ず読むようにしてください。
   このファイルには使用可能なクイックスタートの一覧表も含まれています。この表にはクイックスタート名と使用する技術が記載され、各クイックスタートの簡単な説明と設定するために必要な経験レベルが記載されています。クイックスタートの詳細情報はクイックスタート名をクリックしてください。
   他のクイックスタートを向上したり拡張するため作成されたクイックスタートもあります。このようなクイックスタートは Prerequisites カラムに記載されています。クイックスタートに前提条件がある場合、クイックスタートを始める前にこれらをインストールする必要があります。
   任意コンポーネントのインストールや設定が必要になるクイックスタートもあります。これらのコンポーネントはクイックスタートが必要である場合のみインストールしてください。

2. helloworld クイックスタートを実行します。

   helloworld クイックスタートは最も単純なクイックスタートの 1 つで、JBoss サーバーが適切に設定され実行されているか検証することができます。helloworld クイックスタートのルートにある README ファイルを開きます。このファイルにはクイックスタートのビルドおよびデプロイ方法や実行しているアプリケーションへのアクセス方法の詳細手順が含まれています。

3. 別のクイックスタートを実行します。

   各クイックスタートのルートフォルダーにある README ファイルの手順に従って例を実行します。

手順1.9 helloworld クイックスタートを JBoss Developer Studio にインポートします。

1. インポートしていない場合は、 「Maven 設定を使用した JBoss Enterprise Application Platform の Maven リポジトリーの設定」に記述された手順に従います。

2. JBoss Developer Studio がインストールされていない場合は、 「JBoss Developer Studio 5 のインストール」に記述された手順に従います。

3. 「JBoss Developer Studio の起動」に記述された手順に従います。

4. メニューより [File] → [Import] と選択します。

5. 選択リストより [Maven] → [Maven Projects] と選択し、[Next] を選択します。
   

   図1.9 既存の Maven プロジェクトのインポート

6. QUICKSTART_HOME/quickstart/helloworld/ ディレクトリを閲覧し、[OK] をクリックします。[ Projects] リストボックスに [helloworld] クイックスタートプロジェクトから pom.xml ファイルが追加されます。
   

   図1.10 Maven プロジェクトの選択

7. [Finish] をクリックします。

手順1.10 helloworld クイックスタートのビルドとデプロイ

1. JBoss Enterprise Application Platform 6 用 JBoss Developer Studio がまだ設定されていない場合は、 「JBoss Enterprise Application Platform 6 サーバーの JBoss Developer Studio への追加」に記述された手順に従います。
2. [Project Explorer] タブの [jboss-as-helloworld] を右クリックし、[Run As] → [Run on Server] と選択します。
   

   図1.11 サーバー上での実行

3. [JBoss EAP 6.0 Runtime Server] サーバーを選択し、[Next] をクリックします。これにより helloworld クイックスタートが JBoss サーバーにデプロイされます。
4. helloworld が JBoss サーバーに正しくデプロイされたことを確認するには、Web ブラウザーを開き、URL http://localhost:8080/jboss-as-helloworld を指定してアプリケーションにアクセスします。

手順1.11 ディレクトリ構造の確認

1. beans.xml はクイックスタートの src/main/webapp/ ディレクトリにある WEB-INF/ フォルダーにあります。

2. src/main/webapp/ ディレクトリには、単純なメタリフレッシュを使用してユーザーのブラウザーを http://localhost:8080/jboss-as-helloworld/HelloWorld にあるサーブレットへリダイレクトする index.html ファイルも含まれています。

3. この例の全設定は、例の src/main/webapp/ ディレクトリにある WEB-INF/ にあります。

4. クイックスタートには web.xml ファイルは必要ありません。

手順1.12 コードの確認

1. HelloWorldServlet コードの検証

   HelloWorldServlet.java は src/main/java/org/jboss/as/quickstarts/helloworld/ ディレクトリにあります。このサーブレットが情報をブラウザーに送ります。

   27. @WebServlet("/HelloWorld")
   28. public class HelloWorldServlet extends HttpServlet {
   29. 
   30.    static String PAGE_HEADER = "<html><head /><body>";
   31.
   32.    static String PAGE_FOOTER = "</body></html>";
   33.
   34.    @Inject
   35.    HelloService helloService;
   36.
   37.    @Override
   38.    protected void doGet(HttpServletRequest req, HttpServletResponse resp) 
                                throws ServletException, IOException {
   39.       PrintWriter writer = resp.getWriter();
   40.       writer.println(PAGE_HEADER);
   41.       writer.println("<h1>" + helloService.createHelloMessage("World") + "</h1>");
   42.       writer.println(PAGE_FOOTER);
   43.       writer.close();
   44.     }
   45. 
   46. }
   
   

   表1.1 HelloWorldServlet の詳細

   行	注記
   27	Java EE 6 以前はサーブレットの登録に XML ファイルが使用されました。サーブレットの登録はかなり簡易化され、@WebServlet アノテーションを追加し、サーブレットへのアクセスに使用される URL へのマッピングを提供することのみが必要となります。
   30-32	各 Web ページには適切な形式の HTML が必要になります。本クイックスタートは静的な文字列を使用して最低限のヘッダーとフッターの出力を書き出します。
   34-35	これらの行は実際のメッセージを生成する HelloService CDI Bean を挿入します。HelloService の API を変更しない限り、ビューレイヤーを変更せずに HelloService の実装を後日変更することが可能です。
   41	この行はサービスへ呼び出し、「Hello World」というメッセージを生成して HTTP 要求へ書き出します。

2. HelloService コードの検証

   HelloService.java ファイルは src/main/java/org/jboss/as/quickstarts/helloworld/ ディレクトリにあります。このサービスは非常に単純であり、メッセージを返します。XML やアノテーションの登録は必要ありません。

    9. public class HelloService {
   10. 
   11.    String createHelloMessage(String name) {
   12.       return "Hello " + name + "!"; 
   32.    }
   33. }
   34.  
   
   

手順1.13 numberguess クイックスタートを JBoss Developer Studio にインポートします。

1. JBoss Developer Studio がインストールされていない場合は、 「JBoss Developer Studio 5 のインストール」に記述された手順に従います。

2. 「JBoss Developer Studio の起動」に記述された手順に従います。

3. メニューより [File] → [Import] と選択します。

4. 選択リストより [Maven] → [Maven Projects] と選択し、[Next] を選択します。
   

   図1.12 既存の Maven プロジェクトのインポート

5. QUICKSTART_HOME/quickstart/numberguess/ ディレクトリを閲覧し、[OK] をクリックします。 [Projects] リストボックスに [numberguess] クイックスタートプロジェクトから pom.xml ファイルが追加されます。

6. [Finish] をクリックします。

手順1.14 numberguess クイックスタートのビルドとデプロイ

1. JBoss Enterprise Application Platform 6 用 JBoss Developer Studio がまだ設定されていない場合は、 「JBoss Enterprise Application Platform 6 サーバーの JBoss Developer Studio への追加」に記述された手順に従います。
2. [Project Explorer] タブの [jboss-as-numberguess] を右クリックし、[Run As] → [Run on Server] と選択します。
3. [JBoss EAP 6.0 Runtime Server] サーバーを選択し、[Next] をクリックします。これにより numberguess クイックスタートが JBoss サーバーにデプロイされます。
4. numberguess が JBoss サーバーに正しくデプロイされたことを確認するには、Web ブラウザを開き、URL http://localhost:8080/jboss-as-numberguess を指定してアプリケーションにアクセスします。

手順1.15 設定ファイルの確認

1. faces-config ファイルの確認

   本クイックスタートは faces-config.xml ファイル名の JSF 2.0 バージョンを使用します。Facelets の標準的なバージョンが JSF 2.0 のデフォルトのビューハンドラーであるため、特に必要なものはありません。ここでは JBoss Enterprise Application Platform 6 は Java EE の領域を越えます。この設定ファイルが含まれると JSF が自動的に設定されます。そのため、設定はルート要素のみで構成されます。

   03. <faces-config version="2.0"
   04.    xmlns="http://java.sun.com/xml/ns/javaee"
   05.    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   06.    xsi:schemaLocation="
   07.       http://java.sun.com/xml/ns/javaee>
   08.       http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd">
   09.      
   10. </faces-config>
   
   

2. beans.xml ファイルの確認

   アプリケーションの Bean を検索し、CDI を有効にするよう JBoss Enterprise Application Platform に伝える空の beans.xml ファイルも存在します。

3. web.xml ファイルはありません

   クイックスタートには web.xml ファイルは必要ありません。

手順1.16 JSF コードの確認

• home.xhtml コードの確認

  home.xhtml ファイルは src/main/webapp/ ディレクトリにあります。

  03. <html xmlns="http://www.w3.org/1999/xhtml"
  04.    xmlns:ui="http://java.sun.com/jsf/facelets"
  05.    xmlns:h="http://java.sun.com/jsf/html"
  06.    xmlns:f="http://java.sun.com/jsf/core">
  07.
  08. <head>
  09. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10. <title>Numberguess</title>
  11. </head>
  12.
  13. <body>
  14.    <div id="content">
  15.       <h1>Guess a number...</h1>
  16.       <h:form id="numberGuess">
  17.
  18.          <!-- Feedback for the user on their guess -->
  19.          <div style="color: red">
  20.             <h:messages id="messages" globalOnly="false" />
  21.             <h:outputText id="Higher" value="Higher!"
  22.                rendered="#{game.number gt game.guess and game.guess ne 0}" />
  23.             <h:outputText id="Lower" value="Lower!"
  24.                rendered="#{game.number lt game.guess and game.guess ne 0}" />
  25.          </div>
  26.
  27.          <!-- Instructions for the user -->
  28.          <div>
  29.             I'm thinking of a number between <span
  30.                id="numberGuess:smallest">#{game.smallest}</span> and <span
  31.                id="numberGuess:biggest">#{game.biggest}</span>. You have
  32.             #{game.remainingGuesses} guesses remaining.
  33.          </div>
  34.
  35.          <!-- Input box for the users guess, plus a button to submit, and reset -->
  36.          <!-- These are bound using EL to our CDI beans -->
  37.          <div>
  38.             Your guess:
  39.             <h:inputText id="inputGuess" value="#{game.guess}"
  40.                required="true" size="3"
  41.                disabled="#{game.number eq game.guess}"
  42.                validator="#{game.validateNumberRange}" />
  43.             <h:commandButton id="guessButton" value="Guess"
  44.                action="#{game.check}"
  45.                disabled="#{game.number eq game.guess}" />
  46.          </div>
  47.          <div>
  48.             <h:commandButton id="restartButton" value="Reset"
  49.                action="#{game.reset}" immediate="true" />
  50.          </div>
  51.       </h:form>
  52.
  53.    </div>
  54.
  55.    <br style="clear: both" />
  56.
  57. </body>
  58. </html>
  
  

  表1.2 JSF の詳細

  行	注記
  20-24	ユーザーに送信できるメッセージ、「Higher」(より大きい) と「Lower」(より小さい) になります。
  29-32	ユーザーが数を選択するごとに数字の範囲が狭まります。有効な数の範囲が分かるようにこの文章は変更されます。
  38-42	このフィールドは値式を使用して Bean プロパティーにバインドされます。
  42	ユーザーが誤って範囲外の数字を入力しないようバリデーターのバインディングが使用されます。バリデーターがない場合は、ユーザーが範囲外の数字を使用することがあります。
  43-45	ユーザーの選択した数字をサーバーに送る方法があるはずです。ここでは Bean 上のアクションメソッドをバインドします。

手順1.17 クラスファイルの確認

1. Random.java 限定子コードの検証

   型に基づき挿入の対象となる 2 つの Bean 間の曖昧さを取り除くために修飾子が使用されます。修飾子の詳細については、 「修飾子を使用して不明な挿入を解決」を参照してください。
   @Random 限定子は乱数の挿入に使用されます。

   21. @Target({ TYPE, METHOD, PARAMETER, FIELD })
   22. @Retention(RUNTIME)
   23. @Documented
   24. @Qualifier
   25. public @interface Random {
   26.
   27. }
   
   

2. MaxNumber.java 限定子コードの検証

   @MaxNumberqualifier は最大許可数の挿入に使用されます。

   21. @Target({ TYPE, METHOD, PARAMETER, FIELD })
   22. @Retention(RUNTIME)
   23. @Documented
   24. @Qualifier
   25. public @interface MaxNumber {
   26.
   27. }
   
   

3. ジェネレーターコードの検証

   Generator クラスは producer メソッドより乱数を作成する役割があります。また、producer メソッドより最大可能数も公開します。このクラスはアプリケーションスコープ指定であるため、毎回異なる乱数になることはありません。

   28. @ApplicationScoped
   29. public class Generator implements Serializable {
   30.    private static final long serialVersionUID = -7213673465118041882L;
   31.
   32.    private java.util.Random random = new java.util.Random(System.currentTimeMillis());
   33.
   34.    private int maxNumber = 100;
   35.
   36.    java.util.Random getRandom() {
   37.       return random;
   38.    }
   39.
   40.    @Produces
   41.    @Random
   42.    int next() {
   43.       // a number between 1 and 100
   44.       return getRandom().nextInt(maxNumber - 1) + 1;
   45.    }
   46.
   47.    @Produces
   48.    @MaxNumber
   49.    int getMaxNumber() {
   50.       return maxNumber;
   51.    }
   52. }
   
   

4. ゲームコードの検証

   セッションスコープ指定クラス Game はアプリケーションのプライマリエントリーポイントです。ゲームの設定や再設定、ユーザーが選択する数字のキャプチャーや検証、FacesMessage によるユーザーへのフィードバック提供を行う役割があります。コンストラクト後の lifecycle メソッドを使用し、@Random Instance<Integer> Bean より乱数を読み出してゲームを初期化します。
   このクラスの @Named アノテーションを見てください。このアノテーションは式言語 (EL) より Bean を JSF ビューにアクセスできるようにしたい場合のみ必要です。この場合 #{game} が EL になります。

   035. @Named
   036. @SessionScoped
   037. public class Game implements Serializable {
   038.
   039.    private static final long serialVersionUID = 991300443278089016L;
   040.
   041.    /**
   042.     * The number that the user needs to guess
   043.     */
   044.    private int number;
   045.
   046.    /**
   047.     * The users latest guess
   048.     */
   049.    private int guess;
   050.
   051.    /**
   052.     * The smallest number guessed so far (so we can track the valid guess range).
   053.     */
   054.    private int smallest;
   055.
   056.    /**
   057.     * The largest number guessed so far
   058.     */
   059.    private int biggest;
   060.
   061.    /**
   062.     * The number of guesses remaining
   063.     */
   064.    private int remainingGuesses;
   065.
   066.    /**
   067.     * The maximum number we should ask them to guess
   068.     */
   069.    @Inject
   070.    @MaxNumber
   071.    private int maxNumber;
   072.
   073.    /**
   074.     * The random number to guess
   075.     */
   076.    @Inject
   077.    @Random
   078.    Instance<Integer> randomNumber;
   079.
   080.    public Game() {
   081.    }
   082.
   083.    public int getNumber() {
   084.       return number;
   085.    }
   086.
   087.    public int getGuess() {
   088.       return guess;
   089.    }
   090.
   091.    public void setGuess(int guess) {
   092.       this.guess = guess;
   093.    }
   094.
   095.    public int getSmallest() {
   096.       return smallest;
   097.    }
   098.
   099.    public int getBiggest() {
   100.       return biggest;
   101.    }
   102.
   103.    public int getRemainingGuesses() {
   104.       return remainingGuesses;
   105.    }
   106.
   107.    /**
   108.     * Check whether the current guess is correct, and update the biggest/smallest guesses as needed.
   109.     * Give feedback to the user if they are correct.
   110.     */
   111.    public void check() {
   112.       if (guess > number) {
   113.          biggest = guess - 1;
   114.       } else if (guess < number) {
   115.          smallest = guess + 1;
   116.       } else if (guess == number) {
   117.          FacesContext.getCurrentInstance().addMessage(null, new FacesMessage("Correct!"));
   118.       }
   119.       remainingGuesses--;
   120.    }
   121.
   122.    /**
   123.     * Reset the game, by putting all values back to their defaults, and getting a new random number.
   124.     * We also call this method when the user starts playing for the first time using
   125.     * {@linkplain PostConstruct @PostConstruct} to set the initial values.
   126.     */
   127.    @PostConstruct
   128.    public void reset() {
   129.       this.smallest = 0;
   130.       this.guess = 0;
   131.       this.remainingGuesses = 10;
   132.       this.biggest = maxNumber;
   133.       this.number = randomNumber.get();
   134.    }
   135.
   136.    /**
   137.     * A JSF validation method which checks whether the guess is valid. It might not be valid because
   138.     * there are no guesses left, or because the guess is not in range.
   139.     *
   140.     */
   141.    public void validateNumberRange(FacesContext context, UIComponent toValidate, Object value) {
   142.       if (remainingGuesses <= 0) {
   143.          FacesMessage message = new FacesMessage("No guesses left!");
   144.          context.addMessage(toValidate.getClientId(context), message);
   145.          ((UIInput) toValidate).setValid(false);
   146.          return;
   147.       }
   148.       int input = (Integer) value;
   149.
   150.       if (input < smallest || input > biggest) {
   151.          ((UIInput) toValidate).setValid(false);
   152.
   153.          FacesMessage message = new FacesMessage("Invalid guess");
   154.          context.addMessage(toValidate.getClientId(context), message);
   155.       }
   156.    }
   157. }
   
   

手順6.1 国際化されたログメッセージバンドルの作成

1. メッセージロガーインターフェースの作成

   ログメッセージの定義が含まれるように Java インターフェースをプロジェクトに追加します。定義されるログメッセージに対し、インターフェースにその内容を表す名前を付けます。
   ログメッセージインターフェースの要件は次の通りです。
   • @org.jboss.logging.MessageLogger アノテーションが付けられていなければなりません。
   • org.jboss.logging.BasicLogger を拡張しなければなりません。
   • このインターフェースを実装する型付きロガーのフィールドをインターフェースが定義する必要があります。org.jboss.logging.Logger の getMessageLogger() メソッドで定義します。

   package com.company.accounts.loggers;
   
   import org.jboss.logging.BasicLogger;
   import org.jboss.logging.Logger;
   import org.jboss.logging.MessageLogger;
   
   @MessageLogger(projectCode="")
   interface AccountsLogger extends BasicLogger
   {
      AccountsLogger LOGGER = Logger.getMessageLogger(
            AccountsLogger.class,
            AccountsLogger.class.getPackage().getName() );
   }
   

2. メソッド定義の追加

   各ログメッセージのインターフェースにメソッド定義を追加します。ログメッセージに対する各メソッドにその内容を表す名前を付けます。
   各メソッドの要件は次の通りです。
   • メソッドは void を返さなければなりません。
   • @org.jboss.logging.LogMessage アノテーションが付いていなければなりません。
   • @org.jboss.logging.Message アノテーションが付いていなければなりません。
   • @org.jboss.logging.Message の値属性にはデフォルトのログインメッセージが含まれます。翻訳がない場合にこのメッセージが使用されます。

   @LogMessage
   @Message(value = "Customer query failed, Database not available.")
   void customerQueryFailDBClosed();
   

   デフォルトのログレベルは INFO です。

3. メソッドの呼び出し

   メッセージがロギングされなければならない場所にコードのインターフェースメソッドへの呼び出しを追加します。プロジェクトがコンパイルされる時にアノテーションプロセッサーがインターフェースの実装を作成するため、インターフェースの実装を作成する必要はありません。

   AccountsLogger.LOGGER.customerQueryFailDBClosed();
   

   カスタムのロガーは BasicLogger よりサブクラス化されるため、BasicLogger のロギングメソッド (debug() や error() など) を使用することもできます。国際化されていないメッセージをログに記録するため他のロガーを作成する必要はありません。

   AccountsLogger.LOGGER.error("Invalid query syntax.");
   

手順6.2 国際化されたメッセージの作成と使用

1. 例外のインターフェースの作成

   JBoss ロギングツールはインターフェースで国際化されたメッセージを定義します。定義されるメッセージに対し、インターフェースにその内容を表す名前を付けます。
   インターフェースの要件は次の通りです。
   • パブリックとして宣言される必要があります。
   • @org.jboss.logging.MessageBundle アノテーションが付けられていなければなりません。
   • インターフェースと同じ型のメッセージバンドルであるフィールドをインターフェースが定義する必要があります。

   @MessageBundle(projectCode="")
   public interface GreetingMessageBundle 
   {
      GreetingMessageBundle MESSAGES = Messages.getBundle(GreetingMessageBundle.class);
   }
   

2. メソッド定義の追加

   各メッセージのインターフェースにメソッド定義を追加します。メッセージに対する各メソッドにその内容を表す名前を付けます。
   各メソッドの要件は次の通りです。
   • 型 String のオブジェクトを返す必要があります。
   • @org.jboss.logging.Message アノテーションが付いていなければなりません。
   • デフォルトメッセージに @org.jboss.logging.Message の値属性が設定されていなければなりません。翻訳がない場合にこのメッセージが使用されます。

   @Message(value = "Hello world.")
      String helloworldString();
   

3. 呼び出しメソッド

   メッセージを取得する必要がある場所でアプリケーションのインターフェースメソッドを呼び出します。

   System.console.out.println(helloworldString());
   

手順6.3 国際化された例外の作成と使用

1. JBoss ロギングツール設定の追加

   JBoss ロギングツールをサポートするために必要なプロジェクト設定を追加します。「JBoss ロギングツールの Maven 設定」を参照してください。

2. 例外のインターフェースの作成

   JBoss ロギングツールはインターフェースで国際化された例外を定義します。定義される例外に対し、インターフェースにその内容を表す名前を付けます。
   インターフェースの要件は次の通りです。
   • public として宣言される必要があります。
   • @org.jboss.logging.MessageBundle アノテーションが付けられていなければなりません。
   • インターフェースと同じ型のメッセージバンドルであるフィールドをインターフェースが定義する必要があります。

   @MessageBundle(projectCode="")
   public interface ExceptionBundle 
   {
      ExceptionBundle EXCEPTIONS = Messages.getBundle(ExceptionBundle.class);
   }
   
   

3. メソッド定義の追加

   各例外のインターフェースにメソッド定義を追加します。例外に対する各メソッドにその内容を表す名前を付けます。
   各メソッドの要件は次の通りです。
   • 型 Exception のオブジェクトまたは Exception のサブタイプを返す必要があります。
   • @org.jboss.logging.Message アノテーションが付いていなければなりません。
   • デフォルトの例外メッセージに @org.jboss.logging.Message の値属性が設定されていなければなりません。翻訳がない場合にこのメッセージが使用されます。
   • メッセージ文字列の他にパラメータを必要とするコンストラクターが返された例外にある場合、@Param アノテーションを使用してこれらのパラメーターをメソッド定義に提供しなければなりません。パラメーターはコンストラクターと同じ型で同じ順番でなければなりません。

   @Message(value = "The config file could not be opened.")
   IOException configFileAccessError();
   
   @Message(id = 13230, value = "Date string '%s' was invalid.")
   ParseException dateWasInvalid(String dateString, @Param int errorOffset);
   

4. 呼び出しメソッド

   例外を取得する必要がある場所でコードのインターフェースメソッドを呼び出します。メソッドは例外をスローしませんが、スローできる例外オブジェクトを返します。

   try 
   {
      propsInFile=new File(configname);
      props.load(new FileInputStream(propsInFile));
   }
   catch(IOException ioex) //in case props file does not exist
   {
      throw ExceptionBundle.EXCEPTIONS.configFileAccessError(); 
   }
   

手順6.4 Maven で新しい翻訳プロパティーファイルを生成する

1. Maven 設定の追加

   -AgenereatedTranslationFilePath コンパイラー引数を Maven コンパイラープラグイン設定に追加し、新しいファイルが作成されるパスを割り当てます。

   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>2.3.2</version>
      <configuration> 
         <source>1.6</source>
         <target>1.6</target>             
         <compilerArgument>
         -AgeneratedTranslationFilesPath=${project.basedir}/target/generated-translation-files
         </compilerArgument>
         <showDeprecation>true</showDeprecation>
      </configuration>
   </plugin>
   

   上記の設定は Maven プロジェクトの target/generated-translation-files ディレクトリに新しいファイルを作成します。

2. プロジェクトの構築

   Maven を使用したプロジェクトの構築

   [Localhost]$ mvn compile

手順6.5 国際化されたロガーや例外、メッセージの翻訳

1. テンプレートプロパティーファイルの生成

   mvn compile コマンドを実行し、テンプレート翻訳プロパティーファイルを作成します。

2. プロジェクトへのテンプレートファイルの追加

   翻訳したいインターフェースのテンプレートを、テンプレートが作成されたディレクトリからプロジェクトの src/main/resources ディレクトリへコピーします。プロパティーファイルは翻訳するインターフェースと同じパッケージに存在しなければなりません。

3. コピーしたテンプレートファイルの名前変更

   GreeterLogger.i18n_fr_FR.properties のように、含まれる翻訳に応じてテンプレートファイルのコピーの名前を変更します。

4. テンプレートの内容の翻訳

   新しい翻訳プロパティーファイルを編集し、適切な翻訳が含まれるようにします。

   # Level: Logger.Level.INFO
   # Message: Hello message sent.
   logHelloMessageSent=Bonjour message envoyé.
   

   実行された各バンドルの各翻訳に対して手順の 2、3、4 を繰り返します。

手順6.6 メッセージ ID とプロジェクトコードをログメッセージに追加する

1. インターフェースのプロジェクトコードを指定します。

   カスタムのロガーインターフェースに付けられる @MessageLogger アノテーションの projectCode 属性を使用してプロジェクトコードを指定します。インターフェースに定義されるすべてのメッセージがこのプロジェクトコードを使用します。

   @MessageLogger(projectCode="ACCNTS")
   interface AccountsLogger extends BasicLogger
   {
   
   }
   

2. メッセージ ID の指定

   メッセージを定義するメソッドに付けられる @Message アノテーションの id 属性を使用して各メッセージに対してメッセージ ID を指定します。

   @LogMessage
   @Message(id=43, value = "Customer query failed, Database not available.")  void customerQueryFailDBClosed();
   

手順6.7 メッセージのログレベルの指定

1. level 属性の指定

   ログメッセージメソッド定義の @LogMessage アノテーションに level 属性を追加します。

2. ログレベルの割り当て

   このメッセージに対するログレベルの値を level 属性に割り当てます。level に有効な値は org.jboss.logging.Logger.Level に定義される 6 つの列挙定数である DEBUG、ERROR、FATAL、 INFO、TRACE、 WARN になります。

   Import org.jboss.logging.Logger.Level;
   
   @LogMessage(level=Level.ERROR)
   @Message(value = "Customer query failed, Database not available.")
   void customerQueryFailDBClosed();
   
   

手順6.8 パラメーターによるログメッセージのカスタマイズ

1. メソッド定義へパラメーターを追加する

   すべての型のパラメーターをメソッド定義に追加することができます。型に関係なくパラメーターの String 表現がメッセージに表示されます。

2. ログメッセージへパラメーター参照を追加する

   参照は明示的なインデックスか通常のインデックスを使用できます。
   • 通常のインデックスを使用するには、各パラメーターを表示したいメッセージ文字列に %s 文字を挿入します。%s の最初のインスタンスにより最初のパラメーターが挿入され、2 番目のインスタンスにより 2 番目のパラメーターが挿入されます。
   • 明示的なインデックスを使用するには、文字 %{#} をメッセージに挿入します。# は表示したいパラメーターの数に置き換えます。

手順6.9 ログメッセージの原因として例外を指定する

1. パラメーターの追加

   Throwable 型のパラメーターまたはサブクラスをメソッドに追加します。

   @Message(id=404, value="Loading configuration failed. Config file:%s")
   void loadConfigFailed(Exception ex, File file);
   

2. アノテーションの追加

   パラメーターに @Cause アノテーションを追加します。

   import org.jboss.logging.Cause
   
   @Message(value = "Loading configuration failed. Config file: %s")
   void loadConfigFailed(@Cause Exception ex, File file);
   
   

3. メソッドの呼び出し

   コードでメソッドが呼び出されると、正しい型のオブジェクトが渡され、ログメッセージの後に表示されます。

   try 
   {
      confFile=new File(filename);
      props.load(new FileInputStream(confFile));
   }
   catch(Exception ex) //in case properties file cannot be read
   {
        ConfigLogger.LOGGER.loadConfigFailed(ex, filename);
   }
   
   

   コードが FileNotFoundException 型の例外をスローした場合、上記コード例の出力は次のようになります。

   10:50:14,675 INFO [com.company.app.Main] (MSC service thread 1-3) Loading configuration failed. Config file: customised.properties
   java.io.FileNotFoundException: customised.properties (No such file or directory)
      at java.io.FileInputStream.open(Native Method)
      at java.io.FileInputStream.<init>(FileInputStream.java:120)
      at com.company.app.demo.Main.openCustomProperties(Main.java:70)
      at com.company.app.Main.go(Main.java:53)
      at com.company.app.Main.main(Main.java:43)
   

手順6.10 メッセージ ID とプロジェクトコードを例外メッセージに追加する

1. プロジェクトコードの指定

   例外バンドルインターフェースに付けられる @MessageBundle アノテーションの projectCode 属性を使用してプロジェクトコードを指定します。インターフェースに定義されるすべてのメッセージがこのプロジェクトコードを使用します。

   @MessageBundle(projectCode="ACCTS")
   interface ExceptionBundle
   {
      ExceptionBundle EXCEPTIONS = Messages.getBundle(ExceptionBundle.class);
   }
   

2. メッセージ ID の指定

   例外を定義するメソッドに付けられる @Message アノテーションの id 属性を使用して各例外に対してメッセージ ID を指定します。

   @Message(id=143, value = "The config file could not be opened.")
   IOException configFileAccessError();
   

手順6.11 パラメーターによる例外メッセージのカスタマイズ

1. メソッド定義へパラメーターを追加する

   すべての型のパラメーターをメソッド定義に追加することができます。型に関係なくパラメーターの String 表現がメッセージに表示されます。

2. 例外メッセージへパラメーター参照を追加する

   参照は明示的なインデックスか通常のインデックスを使用できます。
   • 通常のインデックスを使用するには、各パラメーターを表示したいメッセージ文字列に %s 文字を挿入します。%s の最初のインスタンスにより最初のパラメーターが挿入され、2 番目のインスタンスにより 2 番目のパラメーターが挿入されます。
   • 明示的なインデックスを使用するには、文字 %{#} をメッセージに挿入します。# は表示したいパラメーターの数に置き換えます。
   明示的なインデックスを使用すると、メッセージのパラメーター参照の順番がメソッドで定義される順番とは異なるようになります。これは、異なるパラメーターの順番が必要な翻訳メッセージで重要になります。

手順6.12 別の例外の原因として 1 つの例外を指定する

1. パラメーターの追加

   Throwable 型のパラメーターまたはサブクラスをメソッドに追加します。

   @Message(id=328, value = "Error calculating: %s.")
   ArithmeticException calculationError(Throwable cause, String msg);
   

2. アノテーションの追加

   パラメーターに @Cause アノテーションを追加します。

   import org.jboss.logging.Cause
   
   @Message(id=328, value = "Error calculating: %s.")
   ArithmeticException calculationError(@Cause Throwable cause, String msg);
   

3. メソッドの呼び出し

   例外オブジェクトを取得するためインターフェースメソッドを呼び出します。キャッチした例外を原因として使用し、キャッチブロックより新しい例外をスローするのが最も一般的なユースケースになります。

   try 
   {
      ...
   }
   catch(Exception ex)
   {
      throw ExceptionBundle.EXCEPTIONS.calculationError(
                                       ex, "calculating payment due per day");
   }
   

手順9.1 JBoss Enterprise Application Platform での CDI の有効化

1. 設定ファイルで、CDI サブシステムの詳細がコメントアウトされているかどうかを確認します。

   サブシステムは、domain.xml または standalone.xml 設定ファイルの該当するセクションをコメントアウトするか、該当するセクション全体を削除することにより、無効にできます。
   EAP_HOME/domain/configuration/domain.xml または EAP_HOME/standalone/configuration/standalone.xml で CDI サブシステムを検索するには、これらのファイルで文字列 <extension module="org.jboss.as.weld"/> を検索します。検索候補が存在する場合、検索候補は <extensions> セクション内部に存在します。

2. ファイルを編集する前に、JBoss Enterprise Application Platform を停止します。

   JBoss Enterprise Application Platform により実行中に設定ファイルが変更されるため、設定ファイルを直接編集する前にサーバーを停止する必要があります。

3. CDI サブシステムを復元するよう設定ファイルを編集します。

   CDI サブシステムがコメントアウトされている場合は、コメントを削除します。
   CDI サブシステムが完全に削除されたら、次の行を、</extensions> タグのすぐ上にある新しい行に追加することにより、CDI サブシステムを復元します。

   <extension module="org.jboss.as.weld"/>

4. JBoss Enterprise Application Platform を再起動します。

   更新された設定で JBoss Enterprise Application Platform を起動します。

手順9.2 CDI アプリケーションでのレガシー Bean の使用

1. Bean をアーカイブにパッケージ化します。

   Bean を JAR または WAR アーカイブにパッケージ化します。

2. beans.xml ファイルをアーカイブに含めます。

   beans.xml ファイルを JAR アーカイブの META-INF/ ディレクトリーまたは WAR アーカイブの WEB-INF/ ディレクトリーに配置します。このファイルは空白の場合があります。

手順9.3 修飾子を使用して不明な挿入を解決する

1. @Translating という修飾子アノテーションを作成します。

   @Qualifier
   @Retention(RUNTIME)
   @Target({TYPE,METHOD,FIELD,PARAMETERS})
   public @interface Translating{}
   

2. 翻訳を行う Welcome を @Translating アノテーションでアノテートします。

   @Translating
   public class TranslatingWelcome extends Welcome {
       @Inject Translator translator;
       public String buildPhrase(String city) {
           return translator.translate("Welcome to " + city + "!");
       }
       ...
   }
   

3. 挿入の、翻訳を行う Welcome を要求します。

   ファクトリーメソッドパターンの場合と同様に、修飾された実装を明示的に要求する必要があります。不明な点は、挿入時に解決されます。

   public class Greeter {
     private Welcome welcome;
     @Inject
     void init(@Translating Welcome welcome) {
       this.welcome = welcome;
     } 
     public void welcomeVisitors() {
       System.out.println(welcome.buildPhrase("San Francisco"));
     }
   }
   

1. @Inject アノテーションを用いてオブジェクトを Bean の一部に挿入します。

   Bean 内でクラスのインスタンスを取得するには、フィールドに @Inject アノテーションを付けます。

   例9.6 TranslateController へ TextTranslator インスタンスを挿入する

   public class TranslateController {
   
      @Inject TextTranslator textTranslator;
      ...
   

2. 挿入したオブジェクトのメソッドを使用する

   挿入したオブジェクトのメソッドを直接使用することが可能です。TextTranslator にメソッド translate があることを前提とします。

   例9.7 挿入したオブジェクトのメソッドを使用する

   // in TranslateController class
   
   public void translate() {
   
      translation = textTranslator.translate(inputText); 
   
   }
   

3. Bean のコンストラクターで挿入を使用する

   ファクトリーやサービスロケーターを使用して作成する代わりに、Bean のコンストラクターへオブジェクトを挿入することができます。

   例9.8 Bean のコンストラクターで挿入を使用する

   public class TextTranslator {
   
      private SentenceParser sentenceParser;
   
      private Translator sentenceTranslator;
   
       
   
      @Inject
   
      TextTranslator(SentenceParser sentenceParser, Translator sentenceTranslator) {
   
         this.sentenceParser = sentenceParser;
   
         this.sentenceTranslator = sentenceTranslator;
   
      }
   
      // Methods of the TextTranslator class
      ...
   }
   

4. Instance(<T>) インターフェースを使用し、プログラムを用いてインスタンスを取得します。

   Bean 型でパラメーター化されると、Instance インターフェースは TextTranslator のインスタンスを返すことができます。

   例9.9 プログラムを用いてインスタンスを取得する

   @Inject Instance<TextTranslator> textTranslatorInstance;
   
   ...
   
   public void translate() {
   
      textTranslatorInstance.get().translate(inputText);
   
   }
   

手順9.4 Bean ライフサイクルを管理する

1. 必要なスコープに対応するスコープで Bean をアノテートします。

   @RequestScoped
   @Named("greeter")
   public class GreeterBean {
     private Welcome welcome;
     private String city; // getter & setter not shown
     @Inject   void init(Welcome welcome) {
       this.welcome = welcome;
     }
     public void welcomeVisitors() {
       System.out.println(welcome.buildPhrase(city));
     }
   }
   

2. Bean が JSF ビューで使用される場合、Bean はステートを保持します。

   <h:form>
     <h:inputText value="#{greeter.city}"/>
     <h:commandButton value="Welcome visitors" action="#{greeter.welcomeVisitors}"/>
   </h:form>
   

1. @Named アノテーションを使用して名前を Bean に割り当てます。

   @Named("greeter")
   public class GreeterBean {
     private Welcome welcome;
   
     @Inject
     void init (Welcome welcome) {
       this.welcome = welcome;
     }
   
     public void welcomeVisitors() {
       System.out.println(welcome.buildPhrase("San Francisco"));
     }
   }
   

   Bean 名自体はオプションです。省略された場合、クラス名に基づいて Bean に名前が付けられます (最初の文字は小文字になります)。上記の例では、デフォルトの名前は greeterBean になります。

2. JSF ビューで名前付き Bean を使用します。

   <h:form>
     <h:commandButton value="Welcome visitors" action="#{greeter.welcomeVisitors}"/>
   </h:form>
   

手順9.5 挿入をオーバーライドする

1. 代替を定義します。

   @Alternative
   @Translating 
   public class MockTranslatingWelcome extends Welcome {
     public String buildPhrase(string city) {
       return "Bienvenue à " + city + "!");
     }
   }
   

2. 代替を置換します。

   置換実装をアクティベートするために、完全修飾クラス名を META-INF/beans.xml または WEB-INF/beans.xmlファイルに追加します。

   <beans>
     <alternatives>
       <class>com.acme.MockTranslatingWelcome</class>
     </alternatives>
   </beans>
   

手順9.6 ステレオタイプを定義および使用する

1. ステレオタイプを定義します。

   @Secure
   @Transactional
   @RequestScoped
   @Named
   @Stereotype
   @Retention(RUNTIME)
   @Target(TYPE)
   public @interface BusinessComponent {
    ...
   }
   

2. ステレオタイプを使用します。

   @BusinessComponent
   public class AccountManager {
     public boolean transfer(Account a, Account b) {
       ...
     }
   }
   

手順9.7 CDI とのインターセプターの使用

1. インターセプターバインディングタイプを定義します。

   @InterceptorBinding
   @Retention(RUNTIME)
   @Target({TYPE, METHOD})
   public @interface Secure {}
   

2. インターセプター実装をマークします。

   @Secure
   @Interceptor
   public class SecurityInterceptor {
     @AroundInvoke
     public Object aroundInvoke(InvocationContext ctx) throws Exception {
       // enforce security ...
       return ctx.proceed();
       }
   }
   

3. ビジネスコードでインターセプターを使用します。

   @Secure
   public class AccountManager {
     public boolean transfer(Account a, Account b) {
       ...
     }
   }
   

4. インターセプターを META-INF/beans.xml または WEB-INF/beans.xml に追加することにより、インターセプターをデプロイメントで有効にします。

   <beans>
     <interceptors>
       <class>com.acme.SecurityInterceptor</class>
       <class>com.acme.TransactionInterceptor</class>
     </interceptors>
   </beans>
   

   インターセプターは、リストされた順序で適用されます。