EJB-メッセージ駆動型Bean

メッセージ駆動型BeanはエンタープライズBeanの一種で、EJBコンテナがキューまたはトピックからメッセージを受信したときに呼び出されます。メッセージ駆動型BeanはステートレスBeanであり、タスクを非同期的に実行するために使用されます。

メッセージ駆動型Beanの使用方法を示すために、EJB永続性の章を利用し、次のタスクを実行する必要があります-

*ステップ1 *-データベースにテーブルを作成します（_EJB-Persistence_の章を参照）。
*ステップ2 *-テーブルに対応するEntityクラスを作成します（_EJB-Persistence_の章を参照）。
*ステップ3 *-データソースと永続性ユニットを作成します（_EJB-Persistence_の章を参照）。
*ステップ4 *-EntityManagerインスタンスを持つステートレスEJBを作成します（_EJB-Persistence_の章を参照）。
*ステップ5 *-ステートレスejb.Addメソッドを更新してレコードを追加し、エンティティマネージャーを介してデータベースからレコードを取得します（_EJB-Persistence_の章を参照）。
ステップ6 *-JBoss *default アプリケーションディレクトリに BookQueue という名前のキューを作成します。
*ステップ7 *-コンソールベースのアプリケーションクライアントは、このキューにメッセージを送信します。
*ステップ8 *-ステートレスBeanを使用してクライアントデータを永続化するメッセージ駆動型Beanを作成します。
*ステップ9 *-jbossのEJBコンテナは上記のメッセージ駆動型Beanを呼び出し、クライアントが送信するメッセージを渡します。

キューを作成

*<JBoss Installation Folder>> server> default> deploy* フォルダーにjbossmq-destinations-service.xmlという名前のファイルが存在しない場合は作成します。

ここでは、BookQueueという名前のキューを作成しています-

jbossmq-destinations-service.xml

<mbean code="org.jboss.mq.server.jmx.Queue"
   name="jboss.mq.destination:service=Queue,name=BookQueue">
   <depends optional-attribute-name="DestinationManager">
      jboss.mq:service=DestinationManager
   </depends>
</mbean>

JBossを起動すると、jbossログに同様のエントリが表示されます。

...
10:37:06,167 INFO  [QueueService] Queue[/queue/BookQueue] started, fullSize=200000, pageSize=2000, downCacheSize=2000
...

メッセージ駆動型Beanを作成する

@MessageDriven(
   name = "BookMessageHandler",
   activationConfig = {
      @ActivationConfigProperty( propertyName = "destinationType",
                                 propertyValue = "javax.jms.Queue"),
      @ActivationConfigProperty( propertyName = "destination",
                                 propertyValue ="/queue/BookQueue")
   }
)
public class LibraryMessageBean implements MessageListener {

   @Resource
   private MessageDrivenContext mdctx;

   @EJB
   LibraryPersistentBeanRemote libraryBean;

   public LibraryMessageBean() {
   }

   public void onMessage(Message message) {
   }
}

LibraryMessageBeanには@MessageDrivenアノテーションが付けられ、メッセージ駆動型Beanとしてマークされます。
そのプロパティは、destinationType-Queueおよびdestination-/queue/BookQueueとして定義されています。
onMessageメソッドを公開するMessageListenerインターフェイスを実装します。
リソースとしてMessgeDrivenContextがあります。 *LibraryPersistentBeanRemoteステートレスBeanは、永続化のためにこのBeanに注入されます。

EjbComponentプロジェクトをビルドし、JBossにデプロイします。 EJBモジュールを構築してデプロイした後、jbossキューにメッセージを送信するクライアントが必要です。

応用例

テストEJBアプリケーションを作成して、メッセージ駆動型Beanをテストしましょう。

Step	Description
1	Create a project with a name EjbComponent under a package com.finddevguides.entity as explained in the EJB - Create Application chapter. You can also use the project created in EJB - Create Application chapter as such for this chapter to understand EJB persistence concepts.
2	Create Book.java under package com.finddevguides.entity as created in EJB-Persistence chapter.
3	Create LibraryPersistentBean.java and LibraryPersistentBeanRemote as created in EJB-Persistence chapter.
4	Create jboss-ds.xml in* EjbComponent > setup *folder and persistence.xml* in** EjbComponent > src > conf folder. These folders can be seen in files tab in Netbeans as created in EJB-Persistence* chapter.
5	Create LibraryMessageBean.java under a package com.finddevguides.messagebean and modify it as shown below.
6	Create BookQueue queue in Jboss as described above.
7	Clean and Build the application to make sure business logic is working as per the requirements.
8	Finally, deploy the application in the form of jar file on JBoss Application Server. JBoss Application server will get started automatically if it is not started yet.
9	Now create the EJB client, a console based application in the same way as explained in the EJB - Create Application chapter under topic* Create Client to access EJB*. Modify it as shown below.

EJBComponent（EJBモジュール）

LibraryMessageBean.java

package com.finddevguides.messagebean;

import com.finddevguides.entity.Book;
import com.finddevguides.stateless.LibraryPersistentBeanRemote;
import javax.annotation.Resource;
import javax.ejb.ActivationConfigProperty;
import javax.ejb.EJB;
import javax.ejb.MessageDriven;
import javax.ejb.MessageDrivenContext;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.MessageListener;
import javax.jms.ObjectMessage;

@MessageDriven(
   name = "BookMessageHandler",
   activationConfig = {
      @ActivationConfigProperty( propertyName = "destinationType",
                                 propertyValue = "javax.jms.Queue"),
      @ActivationConfigProperty( propertyName = "destination",
                                 propertyValue ="/queue/BookQueue")
   }
)
public class LibraryMessageBean implements MessageListener {

   @Resource
   private MessageDrivenContext mdctx;

   @EJB
   LibraryPersistentBeanRemote libraryBean;

   public LibraryMessageBean() {
   }

   public void onMessage(Message message) {
      ObjectMessage objectMessage = null;
      try {
         objectMessage = (ObjectMessage) message;
         Book book = (Book) objectMessage.getObject();
         libraryBean.addBook(book);

      } catch (JMSException ex) {
         mdctx.setRollbackOnly();
      }
   }
}

EJBTester（EJBクライアント）

EJBTester.java

package com.finddevguides.test;

import com.finddevguides.entity.Book;
import com.finddevguides.stateless.LibraryPersistentBeanRemote;
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;
import java.util.Properties;
import javax.jms.ObjectMessage;
import javax.jms.Queue;
import javax.jms.QueueConnection;
import javax.jms.QueueConnectionFactory;
import javax.jms.QueueSender;
import javax.jms.QueueSession;
import javax.naming.InitialContext;
import javax.naming.NamingException;

public class EJBTester {

   BufferedReader brConsoleReader = null;
   Properties props;
   InitialContext ctx;
   {
      props = new Properties();
      try {
         props.load(new FileInputStream("jndi.properties"));
      } catch (IOException ex) {
         ex.printStackTrace();
      }
      try {
         ctx = new InitialContext(props);
      } catch (NamingException ex) {
         ex.printStackTrace();
      }
      brConsoleReader =
      new BufferedReader(new InputStreamReader(System.in));
   }

   public static void main(String[] args) {

      EJBTester ejbTester = new EJBTester();

      ejbTester.testMessageBeanEjb();
   }

   private void showGUI() {
      System.out.println("**********************");
      System.out.println("Welcome to Book Store");
      System.out.println("**********************");
      System.out.print("Options \n1. Add Book\n2. Exit \nEnter Choice: ");
   }

   private void testMessageBeanEjb() {

      try {
         int choice = 1;
         Queue queue = (Queue) ctx.lookup("/queue/BookQueue");
         QueueConnectionFactory factory =
         (QueueConnectionFactory) ctx.lookup("ConnectionFactory");
         QueueConnection connection =  factory.createQueueConnection();
         QueueSession session =
         connection.createQueueSession(false, QueueSession.AUTO_ACKNOWLEDGE);
         QueueSender sender = session.createSender(queue);

         while (choice != 2) {
            String bookName;
            showGUI();
            String strChoice = brConsoleReader.readLine();
            choice = Integer.parseInt(strChoice);
            if (choice == 1) {
               System.out.print("Enter book name: ");
               bookName = brConsoleReader.readLine();
               Book book = new Book();
               book.setName(bookName);
               ObjectMessage objectMessage =
                  session.createObjectMessage(book);
               sender.send(objectMessage);
            } else if (choice == 2) {
               break;
            }
         }

         LibraryPersistentBeanRemote libraryBean =
         (LibraryPersistentBeanRemote)
         ctx.lookup("LibraryPersistentBean/remote");

         List<Book> booksList = libraryBean.getBooks();

         System.out.println("Book(s) entered so far: " + booksList.size());
         int i = 0;
         for (Book book:booksList) {
            System.out.println((i+1)+". " + book.getName());
            i++;
         }
      } catch (Exception e) {
         System.out.println(e.getMessage());
         e.printStackTrace();
      }finally {
         try {
            if(brConsoleReader !=null) {
               brConsoleReader.close();
            }
         } catch (IOException ex) {
            System.out.println(ex.getMessage());
         }
      }
   }
}

EJBTesterは次のタスクを実行します-

jndi.propertiesからプロパティをロードし、InitialContextオブジェクトを初期化します。
testStatefulEjb（）メソッドでは、jndiルックアップは名前-"/queue/BookQueue"で実行され、Jbossで利用可能なキューの参照を取得します。次に、キューセッションを使用して送信者が作成されます。
次に、ユーザーにライブラリストアのユーザーインターフェイスが表示され、選択を入力するように求められます。
ユーザーが1を入力すると、システムは書籍名を要求し、送信者は書籍名をキューに送信します。 JBossコンテナがキューでこのメッセージを受信すると、メッセージ駆動型BeanのonMessageメソッドを呼び出します。メッセージ駆動型Beanは、ステートフルセッションBeanのaddBook（）メソッドを使用して本を保存します。セッションBeanは、EntityManager呼び出しを介してデータベースに本を保持しています。
ユーザーが2を入力すると、「LibraryStatefulSessionBean/remote」という名前で別のjndiルックアップが行われ、リモートビジネスオブジェクト（ステートフルEJB）が再度取得され、書籍のリストが作成されます。

クライアントを実行してEJBにアクセスする

プロジェクトエクスプローラーでEJBTester.javaを見つけます。 EJBTesterクラスを右クリックして、 run file を選択します。

Netbeansコンソールで次の出力を確認します-

run:
**********************
Welcome to Book Store
**********************
Options
1. Add Book
2. Exit
Enter Choice: 1
Enter book name: Learn EJB
**********************
Welcome to Book Store
**********************
Options
1. Add Book
2. Exit
Enter Choice: 2
Book(s) entered so far: 2
1. learn java
1. learn EJB
BUILD SUCCESSFUL (total time: 15 seconds)

上記の出力は、メッセージ駆動型Beanがメッセージを受信し、ブックを永続ストレージに保存していること、およびブックがデータベースから取得されたことを示しています。

Ejb-message-driven-beans

目次