WebOTX Manual V10.3 (第4版) 目次を表示

---

4.2. プログラミング・開発ガイド

• JMS 2.0
• JNDI
• WebOTX JMQ拡張インタフェース

1. アプリケーションプログラムを開発する前に
   アプリケーションプログラムを開発する際に必要となる知識などについて説明しています。
   
   
2. QUEUEを使用したPTPプログラムの開発
   Point-To-Pointメッセージングモデルを使用したアプリケーションのプログラミングについて説明しています。
   
   
3. TOPICを使用したPub／Subプログラムの開発
   Publisher／Subscriberメッセージングモデルを使用したアプリケーションのプログラミングについて説明しています。
   
   
4. メッセージの非同期受信機能を使用したプログラムの開発
   メッセージを非同期受信するためのプログラミングについて説明しています。
   
   
5. その他の機能を使用したプログラムの開発
   JMSで提供されている、より高度な機能を使用したアプリケーションのプログラミングについて説明しています。
   
   

4.2.1. アプリケーションプログラムを開発する前に

4.2.1.1. インポートが必要なパッケージ

4.2.1.2. アプリケーションプログラム作成の流れ

1. メッセージングモデルを決定する。
2. 使用するメッセージのタイプおよびメッセージの永続性を決定する。
3. コンシューマのメッセージ受信形態を決定する。
4. アプリケーションをコーディングする。
5. Java コンパイラでアプリケーションをコンパイルする。
6. アプリケーションを実行する。

4.2.1.3. メッセージングモデル

ポイントツーポイント

パブリッシュ／サブスクライブ (Pub/Sub)

統合タイプ

4.2.1.4. メッセージ

メッセージタイプ

メッセージの構成要素

メッセージの永続性

メッセージの確認応答

4.2.1.5. 同期受信と非同期受信

メッセージの同期受信

メッセージの非同期受信

4.2.1.6. 非同期受信での例外通知

コネクション切断時の例外の受信

4.2.2. QUEUEを使用したPTPプログラムの開発

4.2.2.1. 共通部分のプログラミング

ConnectionFactoryオブジェクトの取得

  javax.naming.InitialContext context;
  javax.jms.QueueConnectionFactory queueConnectionFactory;
 
  try {
      context = new
      InitialContext();
      queueConnectionFactory =
          (javax.jms.QueueConnectionFactory)context.lookup("MyQCF");
  } catch (Exception e) {
  }

Connectionオブジェクトの生成

  javax.jms.QueueConnectionFactory queueConnectionFactory;
  javax.jms.QueueConnection queueConnection;
 
  try {
      queueConnection = queueConnectionFactory.createQueueConnection();
  } catch (Exception e) {
  }

Sessionオブジェクトの生成

  javax.jms.QueueConnection queueConnection;
  javax.jms.QueueSession queueSession;
 
  try {
      queueSession = queueConnection.createQueueSession(false,
          javax.jms.Session.CLIENT_ACKNOWLEDGE);
  } catch (Exception e) {
  }

4.2.2.2. MessageProducer固有部分のプログラミング

Senderオブジェクトの生成

  java.lang.String queueName = "MyQueue";
  javax.naming.InitialContext context;
  javax.jms.QueueSession queueSession;
  javax.jms.QueueSender queueSender;
  javax.jms.Queue queue;
 
  try {
      queue = (javax.jms.Queue)context.lookup(queueName);
      queueSender = queueSession.createSender(queue);
  } catch (Exception e) {
  }

Messageの生成

  javax.jms.QueueSession queueSession;
  javax.jms.TextMessage message;
 
  try {
      message = queueSession.createTextMessage("SampleMessage");
  } catch (Exception e) {
  }

Messageの送信

  javax.jms.QueueSender queueSender;
  javax.jms.TextMessage message;
 
  try {
      queueSender.send(message);
  } catch (Exception e) {
  }

4.2.2.3. MessageConsumer固有部分のプログラミング

Receiverオブジェクトの生成

  java.lang.String queueName = "MyQueue";
  javax.naming.InitialContext context;
  javax.jms.QueueSession queueSession;
  javax.jms.QueueReceiver queueReceiver;
  javax.jms.Queue queue;
 
  try {
      queue = (javax.jms.Queue)context.lookup(queueName);
      queueReceiver = queueSession.createReceiver(queue);
  } catch (Exception e) {
  }

Connectionの開始

  javax.jms.QueueConnection queueConnection;
 
  try {
      queueConnection.start();
  } catch (Exception e) {
  }

Messageの受信

  javax.jms.QueueReceiver queueReceiver;
  javax.jms.Message message;
 
  try {
      message = queueReceiver.receive();
      if (message instanceof javax.jms.TextMessage) {
          System.out.println("Received message : " +
              ((javax.jms.TextMessage)message).getText());
      } else {
          // ignore
      }
  } catch (Exception e) {
  }

確認応答の送信

  javax.jms.Message message;
 
  try {
      message.acknowledge();
  } catch (Exception e) {
  }

Connectionの停止

  javax.jms.QueueConnection queueConnection;
 
  if (queueConnection != null) {
      try {
          queueConnection.close();
      } catch (Exception e) {
      }
  }

4.2.3. TOPICを使用したPub／Subプログラムの開発

4.2.3.1. 共通部分のプログラミング

ConnectionFactoryオブジェクトの取得

  javax.naming.InitialContext context;
  javax.jms.TopicConnectionFactory topicConnectionFactory;
 
  try {
      context = new InitialContext();
      topicConnectionFactory =
          (javax.jms.TopicConnectionFactory) context.lookup("MyTCF");
  } catch (Exception e) {
  }

Connectionオブジェクトの生成

  javax.jms.TopicConnectionFactory topicConnectionFactory;
  javax.jms.TopicConnection topicConnection;
 
  try {
      topicConnection = topicConnectionFactory.createTopicConnection();
  } catch (Exception e) {
  }

Sessionオブジェクトの生成

  javax.jms.TopicConnection topicConnection;
  javax.jms.TopicSession topicSession;
 
  try {
      topicSession = topicConnection.createTopicSession(false,
          javax.jms.Session.CLIENT_ACKNOWLEDGE);
  } catch (Exception e) {
  }

4.2.3.2. MessageProducer固有部分のプログラミング

Publisherオブジェクトの生成

  java.lang.String topicName = "MyTopic";
  javax.naming.InitialContext context;
  javax.jms.TopicSession topicSession;
  javax.jms.TopicPublisher topicPublisher;
  javax.jms.Topic topic;
 
  try {
      topic = (javax.jms.Topic) context.lookup(topicName);
      topicPublisher = topicSession.createPublisher(topic);
  } catch (Exception e) {
  }

Messageの生成

  javax.jms.TopicSession topicSession;
  javax.jms.TextMessage message;
 
  try {
      message = topicSession.createTextMessage("SampleMessage");
  } catch (Exception e) {
  }

Messageの送信

  javax.jms.TopicPublisher topicPublisher;
  javax.jms.TextMessage message;
 
  try {
      topicPublisher.publish(message);
  } catch (Exception e) {
  }

4.2.3.3. MessageConsumer固有部分のプログラミング

Subscriberオブジェクトの生成

  java.lang.String topicName = "MyTopic";
  javax.naming.InitialContext context;
  javax.jms.TopicSession topicSession;
  javax.jms.TopicSubscriber topicSubscriber;
  javax.jms.Topic topic;
 
  try {
      topic = (javax.jms.Topic) context.lookup(topicName);
      topicSubscriber = topicSession.createSubscriber(topic);
  } catch (Exception e) {
  }

Connectionの開始

  javax.jms.TopicConnection topicConnection;
 
  try {
      topicConnection.start();
  } catch (Exception e) {
  }

Messageの受信

  javax.jms.TopicSubscriber topicSubscriber;
  javax.jms.Message message;
 
  try {
      message = topicSubscriber.receive();
      if (message instanceof javax.jms.TextMessage) {
          System.out.println("Received message : " +
              ((javax.jms.TextMessage) message).getText());
      } else {
          // ignore
      }
  } catch (Exception e) {
  }

確認応答の送信

  javax.jms.Message message;
 
  try {
      message.acknowledge();
  } catch (Exception e) {
  }

Connectionの停止

  javax.jms.TopicConnection topicConnection;
 
  if( topicConnection != null) {
      try {
          topicConnection.close();
      } catch (Exception e){
      }
  }

4.2.4. メッセージの非同期受信機能を使用したプログラムの開発

4.2.4.1. 共通部分のプログラミング

4.2.4.2. MessageConsumer固有部分のプログラミング

Receiverオブジェクトの生成

  java.lang.String queueName = "MyQueue";
  javax.naming.InitialContext context;
  javax.jms.QueueSession queueSession;
  javax.jms.QueueReceiver queueReceiver;
  javax.jms.Queue queue;
 
  try {
      queue = (javax.jms.Queue) context.lookup(queueName);
      queueReceiver = queueSession.createReceiver(queue);
  } catch (Exception e) {
  }

MessageListenerインタフェースの実装

  public static class TextListener implements javax.jms.MessageListener
  {
      public void onMessage(javax.jms.Message message)
      {
          try {
              if (message instanceof javax.jms.TextMessage) {
                  System.out.println("Received message : "
                      + ((javax.jms.TextMessage) message).getText());
              } else {
                  // ignore
              }
          } catch (Exception e) {
          }
      }
  }

MessageListenerの登録

  javax.jms.QueueReceiver queueReceiver;
  TextListener textListener;
 
  try {
      textListener = new TextListener();
      queueReceiver.setMessageListener(textListener);
  } catch (Exception e) {
  }

Connectionの開始

  javax.jms.QueueConnection queueConnection;
 
  try {
      queueConnection.start();
  } catch (Exception e) {
  }

Messageの受信

確認応答の送信

  javax.jms.Message message;
 
  try {
      message.acknowledge();
  } catch (Exception e) {
  }

Connectionの停止

  javax.jms.QueueConnection queueConnection;
  
  if (queueConnection != null) {
      try {
          queueConnection.close();
      } catch (Exception e) {
      }
  }

4.2.5. その他の機能を使用したプログラムの開発

4.2.5.1. 持続性サブスクライバを使用したプログラム

持続性サブスクリプション用サブスクライバの生成

  java.lang.String topicName = "MyTopic";
  java.lang.String DurSubName = "TestSubscriberName";
  javax.naming.InitialContext context;
  javax.jms.TopicSession topicSession;
  javax.jms.TopicSubscriber topicSubscriber;
  javax.jms.Topic topic;
 
  try {
      topic = (javax.jms.Topic) context.lookup(topicName);
      topicSubscriber = topicSession.createDurableSubscriber(topic, DurSubName);
  } catch (Exception e) {
  }

Connectionの開始

  javax.jms.TopicConnection topicConnection;
 
  try {
      topicConnection.start();
  } catch (Exception e) {
  }

サブスクライバの停止

  javax.jms.TopicSubscriber topicSubscriber;
 
  try {
      topicSubscriber.close();
  } catch (Exception e) {
  }

持続性サブスクリプションの解除

  java.lang.String DurSubName = "TestSubscriberName";
  javax.jms.TopicSession topicSession;
 
  try {
      topicSession.unsubscribe(DurSubName);
  } catch (Exception e) {
  }

Connectionの停止

  javax.jms.TopicConnection topicConnection;
 
  if (topicConnection != null) {
      try {
          topicConnection.close();
      } catch (Exception e) {
      }
  }

4.2.5.2. メッセージのフィルタリングを使用したプログラム

メッセージセレクタを指定したSubscriberオブジェクトの生成

  java.lang.String MySelector = "JMSPriority >= 6";
  java.lang.String topicName = "MyTopic";
  javax.naming.InitialContext context;
  javax.jms.TopicSession topicSession;
  javax.jms.TopicSubscriber topicSubscriber;
  javax.jms.Topic topic;
 
  try {
      topic = (javax.jms.Topic) context.lookup(topicName);
      topicSubscriber = topicSession.createSubscriber(topic, MySelector, false);
  } catch (Exception e) {
  }

4.2.5.3. JMSのトランザクション機能を使用したプログラム

トランザクションセッションの取得

  javax.jms.QueueConnection queueConnection;
  javax.jms.QueueSession queueSession;
 
  try {
      queueSession = queueConnection.createQueueSession(true,
          javax.jms.Session.SESSION_TRANSACTED);
  } catch (Exception e) {
  }

メッセージ送信でのトランザクションの終了

  javax.jms.QueueSession queueSession;
  javax.jms.QueueSender queueSender;
  javax.jms.TextMessage message;
 
  try {
      queueSender.send(message);
      queueSession.commit();
  } catch (Exception e) {
  }

メッセージ受信でのトランザクションの終了

  javax.jms.QueueSession queueSession;
  javax.jms.QueueReceiver queueReceiver;
  javax.jms.Message message;
 
  try {
      message = queueReceiver.receive();
      if (message instanceof javax.jms.TextMessage) {
          System.out.println("Received message : " +
              ((javax.jms.TextMessage) message).getText());
      } else {
          // ignore
      }
      queueSession.commit();
  } catch (Exception e) {
  }

4.2.5.4. JMSの例外リスナを使用したプログラム

ExceptionListenerインタフェースの実装

  public class QueueAsynchConsumer {
    private static void reconnect() {
        // 再接続処理
    }
 
    public static class ExcpListener implements javax.jms.ExceptionListener {
        public void onException(javax.jms.JMSException excp) {
            System.out.println("Received JMSException : " + excp);
            try {
                QueueAsynchConsumer.reconnect();
            } catch (Exception e) {
            }
        }
    }
  }

ExceptionListenerの登録

  javax.jms.QueueConnection queueConnection;
  ExcpListener excpListener;
 
  try {
      excpListener = new ExcpListener();
      queueConnection.setExceptionListener(excpListener);
  } catch (Exception e) {
  }

4.2.5.5. JMSのイベント通知を使用したプログラム

コネクションイベントリスナや、コンシューマイベントリスナを使用することによって、コネクション切断／再接続や、送信先に対するコンシューマの存在に関するイベントを受信することができます。ここでは、イベントリスナの実装と、各イベントリスナの登録方法について示します。各インタフェースの詳細については、[ リファレンス > APIリファレンス > JMS > 拡張インタフェース ] を参照してください。

EventListenerインタフェースの実装

EventListenerインタフェースを実装します。コネクションイベントリスナの場合も、コンシューマイベントリスナの場合も実装するインタフェースは同じです。

  public class AppEventListener implements com.nec.webotx.messaging.jms.notification.EventListener {
        :
    boolean consumerReady = false;
        :
    public void onEvent(com.nec.webotx.messaging.jms.notification.Event event) {
      String eventCode = event.getEventCode();
      if (com.nec.webotx.messaging.jms.notification.ConsumerEvent.CONSUMER_READY.equals(eventCode)) {
        // CONSUMER_READYに対する処理
        consumerReady = true;
      } else if (com.nec.webotx.messaging.jms.notification.ConsumerEvent.CONSUMER_NOT_READY.equals(eventCode)) {
        // CONSUMER_NOT_READYに対する処理
        consumerReady = false;
      } else if (com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent.CONNECTION_CLOSED_LOST_CONNECTION.equals(eventCode)) {
        // CONNECTION_CLOSED_LOST_CONNECTIONに対する処理
        System.out.println("CONNECTION_CLOSED_LOST_CONNECTION : " + event.getEventMessage());
            :
      }
    }
  }

コネクションイベントリスナの登録

EventListener実装クラスのインスタンスを生成して、コネクションに登録します。イベントリスナを登録する際、コネクションオブジェクトは、com.nec.webotx.messaging.jms.Connection にキャストする必要があります。
なお、コネクションに対して、コネクションイベントリスナと、JMS例外リスナの両方を登録していた場合、呼び出される順番は、コネクションイベントリスナ、例外リスナの順になります。

  javax.jms.Connection connection;
  AppEventListener connEventListener;
    :
  try {
    connEventListener = new AppEventListener();
    ((com.nec.webotx.messaging.jms.Connection) connection).setEventListener(connEventListener);
  } catch (Exception e) {
      // 例外処理
  }

コンシューマイベントリスナの登録と削除

EventListener実装クラスのインスタンスを生成し、対象となる送信先を指定して、コネクションに登録します。イベントリスナの登録や削除をする際、コネクションオブジェクトは、com.nec.webotx.messaging.jms.Connection に、また、送信先オブジェクトは、com.nec.webotx.messaging.Destination にキャストする必要があります。

  javax.jms.Connection connection;
  javax.jms.Queue queue;
  AppEventListener consumerEventListener;

  try {
    consumerEventListener = new AppEventListener();
    // コンシューマイベントリスナ登録
    ((com.nec.webotx.messaging.jms.Connection) connection).setConsumerEventListener(
        (com.nec.webotx.messaging.Destination) queue, consumerEventListener);
          :
    // コンシューマイベントリスナ削除
    ((com.nec.webotx.messaging.jms.Connection) connection).removeConsumerEventListener((com.nec.webotx.messaging.Destination) queue);
  } catch (Exception e) {
      // 例外処理
  }

4.2.6. 注意事項

4.2.6.1. アプリケーションプログラム作成時の注意事項

コンシューマプログラムでの注意

• コンシューマプログラムでは、Connectionオブジェクトのstart() メソッドを呼び出すまでメッセージが配信されません。メッセージ受信開始時には、必ずstart() メソッドを呼び出してください。
  

持続性サブスクリプション解除時の注意

• 持続性サブスクリプションを解除する際、次の条件のいずれかに当てはまる場合は解除できません。
  
  • TopicSubscriberがセッション中でアクティブな場合
  • 持続性サブスクリプションで受信したメッセージがトランザクションの一部であるか、またはセッション中でまだ確認応答されていない場合

4.2.6.2. アプリケーションプログラム実行時の注意事項

Java実行環境に関する注意

• システム中に異なるバージョンのJava実行環境が存在する場合、JNDIサーバとJMSアプリケーションで使用するJVMが同一バージョンとなるように注意してください。異なるバージョンのJVMで実行した場合、予期せぬエラーが発生する可能性があります。