エンティティークラスの作成

この課題では、NewsEntity エンティティークラスを作成します。エンティティークラスは、通常はデータベース内の表を表す簡単な Java クラスです。このエンティティークラスを作成すると、クラスをエンティティークラスとして定義するための @Entity という注釈が IDE によって追加されます。このクラスを作成したあとで、表に必要なデータを表すフィールドを、クラス内に作成します。

各エンティティークラスは主キーを持つ必要があります。エンティティークラスを作成すると、IDE によって、どのフィールドを主キーとして使用するかを宣言するための @Id という注釈が追加されます。また、主 ID のキー生成方法を指定するための @GeneratedValue という注釈も IDE によって追加されます。

NewsEntity クラスを作成するには、次の手順を実行します。

1. 「プロジェクト」ウィンドウで EJB モジュールを右クリックし、「新規」>「その他」を選択して「新規ファイル」ウィザードを開きます。
2. 「持続性」カテゴリから「エンティティークラス」を選択し、「次へ」をクリックします。
3. クラス名に「NewsEntity」と入力します。
4. 「パッケージ」に「ejb」と入力します。
5. 「新規エンティティークラス」ウィザードの「主キー型」は「Long」のままにします。
6. 「持続性ユニットを作成」を選択します。「次へ」をクリックします。
7. 持続性ユニットの名前はデフォルトのままにしておきます。
8. 「持続性プロバイダ」には「EclipseLink (JPA2.0)」(デフォルト) を選択します。
9. 「データソース」にはデータソースを選択します (たとえば JavaDB を使用する場合は jdbc/sample を選択します)。
10. 持続性ユニットが「Java Transaction API を使用」になっていること、アプリケーション配備時にエンティティークラスに基づいた表が作成されるように「表生成の方針」が「作成」に設定されていることを確認します。
    
11. 「完了」をクリックします。

「完了」をクリックすると、persistence.xml およびエンティティークラス NewsEntity.java が作成されます。NewsEntity.java がソースエディタで表示されます。

ソースエディタで、次の手順を実行します。

1. このクラスに次のフィールド宣言を追加します。

   private String title;
   private String body;

2. ソースエディタ内を右クリックして「コードを挿入」(Alt-Insert、Mac の場合は Ctrl-I) を選択し、「取得メソッドおよび設定メソッド」を選択して「取得メソッドおよび設定メソッドの生成」ダイアログボックスを開きます。
3. ダイアログで、body フィールドと title フィールドを選択します。「生成」をクリックします。
   

   「生成」をクリックすると、フィールド用の取得メソッドと設定メソッドが追加されます。

4. 変更内容を NewsEntity.java に保存します。

NewsEntity.java を閉じます。

エンティティークラスに関する詳細については、「Java EE 6 のチュートリアル、パート I 」の「Java Persistence API 入門」を参照してください。

メッセージ駆動型 Bean の作成

この課題では、ウィザードを使用して、EJB モジュールに NewMessage メッセージ駆動型 Bean を作成します。ウィザードは、必要な JMS リソースを作成するのにも役立ちます。メッセージ駆動型 Bean は、Web モジュール内のサーブレットによってキューに送信されたメッセージを受信および処理します。

メッセージ駆動型 Bean を作成するには、次の手順に従います。

1. 「プロジェクト」ウィンドウで EJB モジュールを右クリックし、「新規」>「その他」を選択して「新規ファイル」ウィザードを開きます。
2. 「エンタープライズ JavaBeans」カテゴリから「メッセージ駆動型 Bean」ファイルタイプを選択します。「次へ」をクリックします。

   注: NetBeans IDE 6.9 では、「メッセージ駆動型 Bean」ファイルタイプは「Java EE」カテゴリに含まれています。

3. EJB 名に「NewMessage」と入力します。
4. 「パッケージ」ドロップダウンリストから「 ejb 」を選択します。
5. 「プロジェクトの送信先」フィールドの横の「追加」ボタンをクリックして「メッセージ送信先を追加」ダイアログを開きます。
6. 「メッセージ送信先を追加」ダイアログで「jms/NewMessage」と入力し、送信先タイプに「キュー」を選択します。「了解」をクリックします。
7. プロジェクトの送信先が正しいことを確認します。「完了」をクリックします。

「完了」をクリックすると、NewMessage.java という Bean クラスがソースエディタに表示されます。@MessageDriven 注釈と構成プロパティーがクラスに追加されたことがわかります。

       
@MessageDriven(mappedName = "jms/NewMessage", activationConfig =  {
        @ActivationConfigProperty(propertyName = "acknowledgeMode", propertyValue = "Auto-acknowledge"),
        @ActivationConfigProperty(propertyName = "destinationType", propertyValue = "javax.jms.Queue")
    })
public class NewMessage implements MessageListener {

@MessageDriven 注釈は、コンポーネントがメッセージ駆動型 Bean であり、この Bean が使用する JMS リソースを指定していることをコンテナに示します。IDE によってクラスが生成されるとき、リソースのマップされた名前 (jms/NewMessage) は、クラスの名前 (NewMessage.java) から取得されます。この JMS リソースは送信先の JNDI 名にマッピングされていて、そこから Bean がメッセージを受信します。新規メッセージ駆動型 Bean ウィザードでは、sun-resources.xml に JMS リソースの情報も追加します。JMS リソースを指定するために、配備記述子を構成する必要はありません。IDE で「実行」アクションを使用してアプリケーションを GlassFish に配備する場合は、配備時に JMS リソースがサーバー上に作成されます。

EJB 仕様では、注釈を使用して、クラスに直接リソースを導入できます。ここで、注釈を使用して、クラスに MessageDrivenContext リソースを導入し、持続性エンティティーのインスタンス管理のために EntityManager API によって使用されることになる PersistenceContext リソースを注入します。クラスへの注釈の追加は、ソースエディタで行います。

1. 次の注釈済みフィールド (ボールド部分) をクラスに追加することで、MessageDrivenContext リソースをクラスに注入します。

   public class NewMessage implements MessageListener {
   
   @Resource
   private MessageDrivenContext mdc;

2. コード内を右クリックして「コードを挿入」(Alt-Insert、Mac の場合は Ctrl-I) を選択し、ポップアップメニューから「エンティティーマネージャーを使用」を選択することで、クラスにエンティティーマネージャーを導入します。

   注: NetBeans IDE 6.9 では、「持続性」>「エンティティーマネージャーを使用」を選択します。

   次の @PersistenceContext 注釈がソースコードに追加されます。

   @PersistenceContext(unitName = "NewsApp-ejbPU")
   private EntityManager em;

   また、次の persist メソッドも生成されます。

   public void persist(Object object) {
       em.persist(object);
   }

3. persist メソッドを修正して名前を save に変更します。メソッドは次のようになります。

   public void save(Object object) {     
       em.persist(object);
   }

4. 次のコード (ボールド部分) をメソッドの本体に追加することで、onMessage メソッドを変更します。

   public void onMessage(Message message) {
       ObjectMessage msg = null;
       try {
           if (message instanceof ObjectMessage) {
               msg = (ObjectMessage) message;
               NewsEntity e = (NewsEntity) msg.getObject();
               save(e);            
           }
       } catch (JMSException e) {
           e.printStackTrace();
           mdc.setRollbackOnly();
       } catch (Throwable te) {
           te.printStackTrace();
       }
   }

5. エディタを右クリックして「インポートを修正」(Alt-Shift-I、Mac の場合は ⌘-Shift-I) を選択し、必要なインポート文を生成します。変更を保存します。

注: インポート文を生成するときは、javax.jms ライブラリと javax.annotation.Resource ライブラリをインポートしていることを確認することをお勧めします。

メッセージ駆動型 Bean の詳細については、「Java EE 6 チュートリアル、パート 1」の「メッセージ駆動型 Bean とは」章を参照してください。

セッションファサードの作成

この課題では、NewsEntity エンティティークラスのセッションファサードを作成します。EJB 3.0 仕様では、必須コードの量を少なくし、注釈を使用してクラスをセッション Bean として宣言できるようにすることで、セッション Bean の作成を簡素化します。さらに、EJB 3.1 仕様では、ビジネスインタフェースを任意にすることで、セッション Bean の要件を簡素化します。セッション Bean には、ローカルクライアントから、ローカルインタフェースまたはインタフェースなしのビューを使ってアクセスできます。このチュートリアルでは、Bean 用のインタフェースは作成しません。Web アプリケーションは、インタフェースなしのビューから Bean にアクセスします。

セッションファサードを作成するには、次の手順に従います。

1. EJB モジュールを右クリックし、「新規」>「その他」を選択します。
2. 「持続性」カテゴリから「エンティティークラスのセッション Bean」を選択します。「次へ」をクリックします。
3. 利用可能なエンティティークラスのリストから ejb.NewsEntity を選択し、「追加」をクリックして、そのクラスを「選択されているエンティティークラス」区画に移動します。「次へ」をクリックします。
4. 「パッケージ」が ejb に設定されていることを確認します。「完了」をクリックします。

「完了」をクリックすると、IDE によってセッションファサードクラス NewsEntityFacade.java および AbstractFacade.java が生成され、エディタでこれらのファイルが開きます。生成されたコードでわかるように、ステートレスセッション Bean コンポーネントとして NewsEntityFacade.java を宣言するため、注釈 @Stateless が使用されます。さらに、PersistenceContext 注釈が追加され、リソースが直接セッション Bean コンポーネントに注入されます。NewsEntityFacade.java は、AbstractFacade.java を拡張したもので、ビジネスロジックを含み、トランザクションを管理します。

注: リモートクライアントから Bean にアクセスする場合は、引き続きリモートインタフェースが必要です。

セッション Bean の詳細については、「Java EE 6 のチュートリアル、パート I」の「セッション Bean とは」を参照してください。

シングルトンセッション Bean の作成

EJB 3.1 仕様では、シングルトンセッション Bean を簡単に作成できる @Singleton 注釈が導入されています。また、EJB 3.1 では、Bean が初期化される場合など、シングルトンセッション Bean のプロパティーを構成するためのその他の注釈も定義されています。

シングルトンセッション Bean は、インスタンス化されたあと、アプリケーションのライフサイクルの間は存在します。名前が示すとおり、アプリケーションでは、シングルトンセッション Bean のインスタンスは 1 つしかありません。ステートレスセッション Bean と同様、シングルトンセッション Bean は複数のクライアントを持つことができます。

シングルトンセッション Bean を作成するには、次の手順に従います。

1. Web モジュールを右クリックし、「新規」>「その他」を選択して新規ファイルウィザードを開きます。
2. 「エンタープライズ JavaBeans」カテゴリで「セッション Bean」を選択します。

   注: NetBeans IDE 6.9 では、「セッション Bean」は「Java EE」カテゴリに含まれています。

3. 「EJB 名」に「SessionManagerBean」と入力します。
4. 「パッケージ名」に「ejb」と入力します。
5. 「シングルトン」を選択します。「完了」をクリックします。

「完了」をクリックするとシングルトンセッション Bean クラスが作成され、そのクラスがエディタに表示されます。シングルトンセッション Bean を宣言するための注釈 @Singleton がクラスに追加されたことがわかります。このウィザードでは、クラスに @LocalBean という注釈も追加されます。

@Singleton
@LocalBean
public class SessionManagerBean {

}

1. @WebListener を使用してクラスに注釈を付け、HttpSessionListener を実装します。

   @Singleton
   @LocalBean
   @WebListener
   public class SessionManagerBean implements HttpSessionListener{
   
   }

   @WebListener 注釈は Servlet 3.0 API の一部で、これによりコードで直接リスナーを実装できます。

   HttpSessionListener を実装すると、マージンに警告が表示されます。

2. 左マージンにある警告バッジをクリックして、「すべての抽象メソッドを実装」を選択します。
   

   sessionCreated メソッドと sessionDestroyed メソッドが追加されます。

3. 静的フィールド counter を追加し、初期値を 0 に設定します。

   @LocalBean
   @WebListener
   public class SessionManagerBean implements HttpSessionListener{
       private static int counter = 0;

4. 生成された sessionCreated メソッドと sessionDestroyed メソッドの本体を、新しいセッションが開始されるときにフィールドの値を増やし、セッションが終了するときに値を減らすように変更します。値は、フィールド counter に保存されます。

   public void sessionCreated(HttpSessionEvent se) {
       counter++;
   }
   
   public void sessionDestroyed(HttpSessionEvent se) {
       counter--;
   }

5. counter の現在の値を返す次のメソッドを追加します。

   public int getActiveSessionsCount() {
           return counter;
       }

   このメソッドをサーブレットから呼び出し、現在のユーザー数または開かれているセッション数を表示します。

6. 変更を保存します。

セッション Bean のコードは、次のようになっているはずです。

@Singleton
@LocalBean
@WebListener
public class SessionManagerBean implements HttpSessionListener {
    private static int counter = 0;

    public void sessionCreated(HttpSessionEvent se) {
        counter++;
    }

    public void sessionDestroyed(HttpSessionEvent se) {
        counter--;
    }

    public int getActiveSessionsCount() {
        return counter;
    }

}

シングルトンセッション Bean の詳細については、「Java EE 6 のチュートリアル、パート I」の「セッション Bean とは」を参照してください。

ListNews サーブレットの作成

この課題では、保存されているメッセージを表示するための簡単なサーブレットを作成します。注釈を使用して、サーブレットからエンタープライズ Bean の NewsEntityFacade を呼び出します。

1. Web モジュールプロジェクトを右クリックし、「新規」>「サーブレット」を選択します。
2. 「クラス名」には「 ListNews 」と入力します。
3. パッケージ名に「web」と入力します。「完了」をクリックします。

「完了」をクリックすると、 ListNews.java というクラスがソースエディタに表示されます。ソースエディタで、次の手順を実行します。

1. ソースエディタ内を右クリックして「コードを挿入」(Alt-Insert、Mac の場合は Ctrl-I) を選択し、「エンタープライズ Bean を呼び出し」を選択します。
2. 「エンタープライズ Bean を呼び出し」ダイアログで、「NewsApp-ejb」ノードを展開し、「NewsEntityFacade」を選択します。「閉じる」をクリックします。

   エンタープライズ Bean を注入する @EJB 注釈が追加されます。

3. もう一度「エンタープライズ Bean を呼び出し」ダイアログを使用して、「NewsApp-war」ノードの下に SessionManagerBean を注入します。

   2 つのエンタープライズ Bean を注入する次の注釈がコードに表示されます。

   @WebServlet(name = "ListNews", urlPatterns = {"/ListNews"})
   public class ListNews extends HttpServlet {
   
       @EJB
       private SessionManagerBean sessionManagerBean;
       @EJB
       private NewsEntityFacade newsEntityFacade;
                   

   また、クラスサーブレットの宣言とサーブレット名の指定用に、@WebServlet 注釈が使用されています。@WebServlet 注釈は、Java EE 6 仕様で導入された Servlet 3.0 API の一部です。web.xml 配備記述子で指定する代わりに、注釈を使用してサーブレットを特定できます。NewsApp アプリケーションには web.xml は含まれません。

4. processRequest メソッドに、現在のセッションを返すか新規に作成する、次のコード (ボールド部分) を追加します。

   protected void processRequest(HttpServletRequest request, HttpServletResponse response)
           throws ServletException, IOException {
           request.getSession(true);
           response.setContentType("text/html;charset=UTF-8");

5. processRequest メソッドにメッセージを出力する次のコード (ボールド部分) を追加して、リンクを PostMessage サーブレットに追加します。(必要な場合はメソッド内のコードをコメント解除します。)

   out.println("<h1>Servlet ListNews at " + request.getContextPath () + "</h1>");
   
   List news = newsEntityFacade.findAll();
   for (Iterator it = news.iterator(); it.hasNext();) {
       NewsEntity elem = (NewsEntity) it.next();
       out.println(" <b>"+elem.getTitle()+" </b><br />");
       out.println(elem.getBody()+"<br /> ");
   }
   out.println("<a href='PostMessage'>Add new message</a>");
   
   out.println("</body>");
                       

6. ユーザー数または開かれているセッションの数を取得および出力する、次のコード (ボールド部分) を追加します。

   out.println("<a href='PostMessage'>Add new message</a>");
   
   out.println("<br><br>");
   out.println(sessionManagerBean.getActiveSessionsCount() + " user(s) reading the news.");
   
   out.println("</body>");
                       

7. Ctrl-Shift-I キーを押し、このクラスに必要なインポート文を生成します。インポート文を生成するときは、java.util ライブラリをインポートする必要があります。
8. 変更内容をファイルに保存します。

PostMessage サーブレットの作成

この課題では、メッセージの投稿に使用される PostMessage サーブレットを作成します。注釈を使用して、作成した JMS リソースを直接このサーブレットに注入します。このとき、変数名と、この JMS リソースがマッピングされる名前を指定します。次に、JMS メッセージを送信するためのコードと、メッセージを追加するための HTML 形式のコードを追加します。

1. Web モジュールプロジェクトを右クリックし、「新規」>「サーブレット」を選択します。
2. 「クラス名」には「 PostMessage 」と入力します。
3. パッケージ名に「 web 」と入力し、「完了」をクリックします。

「完了」をクリックすると、PostMessage.java というクラスがソースエディタに表示されます。ソースエディタで、次の手順を実行します。

1. 次のフィールド宣言 (ボールド部分) を追加することにより、注釈を使用して ConnectionFactory および Queue リソースを注入します。

   @WebServlet(name="PostMessage", urlPatterns={"/PostMessage"})
   public class PostMessage extends HttpServlet {                
       @Resource(mappedName="jms/NewMessageFactory")
       private  ConnectionFactory connectionFactory;
   
       @Resource(mappedName="jms/NewMessage")
       private  Queue queue;

2. 今度は、次に示すボールドのコードを processRequest メソッドに追加し、JMS メッセージを送信するためのコードの追加を行います。

   response.setContentType("text/html;charset=UTF-8");
   
   // JMS メッセージを送信する次のコードを追加
   String title=request.getParameter("title");
   String body=request.getParameter("body");
   if ((title!=null) && (body!=null)) {
       try {
           Connection connection = connectionFactory.createConnection();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           MessageProducer messageProducer = session.createProducer(queue);
   
           ObjectMessage message = session.createObjectMessage();
           // ここで JMS メッセージに送信される NewsEntity を作成
           NewsEntity e = new NewsEntity();
           e.setTitle(title);
           e.setBody(body);
   
           message.setObject(e);                
           messageProducer.send(message);
           messageProducer.close();
           connection.close();
           response.sendRedirect("ListNews");
   
       } catch (JMSException ex) {
           ex.printStackTrace();
       }
   }
                           
   PrintWriter out = response.getWriter();
                       

3. processRequest メソッドに次の行 (ボールド部分) を追加して、メッセージを追加するための Web フォームを追加します。(必要な場合は HTML を出力するコードをコメント解除します。)

   out.println("Servlet PostMessage at " + request.getContextPath() + "</h1>");
   
   // 次のコードで Web ページにフォームを追加
   out.println("<form>");
   out.println("Title: <input type='text' name='title'><br/>");
   out.println("Message: <textarea name='body'></textarea><br/>");
   out.println("<input type='submit'><br/>");
   out.println("</form>");
   
   out.println("</body>");
                   

4. Ctrl-Shift-I キーを押し、このクラスに必要なインポート文を生成します。

   注: Connection、ConnectionFactory、Session、および Queue 用にインポートするライブラリを選択するときは、必ず javax.jms ライブラリをインポートしてください。

   
5. 変更内容をファイルに保存します。

JMS リソースの問題

ウィザードを使用して JMS リソースを作成するとき、出力ウィンドウに次のサーバーエラーメッセージが表示される場合があります。

[com.sun.enterprise.connectors.ConnectorRuntimeException:
                    JMS resource not created : jms/Queue]
                

このメッセージは、JMS リソースが作成されなかったか、アプリケーションサーバーに登録されなかったことを示している可能性があります。アプリケーションサーバーの管理コンソールを使用すると、JMS リソースを確認、作成、および編集できます。

管理コンソールを開くには、次の手順を実行します。

1. IDE の「サービス」ウィンドウにある「サーバー」ノードを展開して、アプリケーションサーバーが実行中であることを確認します。アプリケーションサーバーのノードの横に小さな緑の矢印が表示されていれば、サーバーは実行中です。
2. アプリケーションサーバーのノードを右クリックし、「管理コンソールを表示」を選択して、ブラウザでログインウィンドウを開きます。
3. サーバーにログインします。デフォルトのユーザー名とパスワードは、それぞれ admin と adminadmin です。
4. ブラウザの管理コンソールで、左側フレームにある「リソース」ノードと「JMS リソース」ノードを展開します。
5. 左側フレームの「接続ファクトリ」および「接続先リソース」リンクをクリックして、リソースがサーバーに登録されているかどうかを確認し、必要に応じてリソースを変更します。リソースが存在しない場合は、管理コンソールで作成できます。

Sun Java System Application Server に登録されている JMS 接続ファクトリリソースの正しい JNDI 名に、PostMessage サーブレットの JMS 接続ファクトリリソースがマッピングされていることを確認する必要があります。

Sun Java System Application Server には、次のリソースが登録されている必要があります。

• JNDI 名が jms/NewMessage で、型が javax.jms.Queue の接続先リソース
• JNDI 名が jms/NewMessageFactory で、型が javax.jms.QueueConnectionFactory の接続ファクトリリソース