org.pslx.Messaging
クラス QueueManager

java.lang.Object
  上位を拡張 org.pslx.Messaging.QueueManager
すべての実装されたインタフェース:
MessageManager

public class QueueManager
extends java.lang.Object
implements MessageManager

JMS(Java Message Service)によるメッセージ通信を支援するクラス

バージョン:
1.0

コンストラクタの概要
QueueManager()
          JMS(Java Message Service)によるメッセージ通信を支援するクラスを生成します。
 
メソッドの概要
 void connect()
          メッセージブローカへ接続します。
 javax.jms.QueueSession createQueueSession()
          キューセッションを生成します。
 void disconnect()
          メッセージブローカから切断します。
 javax.jms.QueueConnection getConnection()
          メッセージブローカとの接続を表すQueueConnectionを取得します
 javax.jms.Queue getQueue(java.lang.String queueName)
          指定した名前のキューを取得します
 java.lang.String getSenderId()
          送信者を表す識別子を取得します。
 int getSleepingInterval()
          要求メッセージに対する応答メッセージを待ち受ける際に、到着確認する間隔をミリ秒単位で取得します。
 int getTimeOutLength()
          要求メッセージに対する応答メッセージを待ち受ける際に、タイムアウトとする時間をミリ秒単位で取得します。
 boolean isConnected()
          メッセージブローカと接続されているかどうかを取得します。
 java.lang.String receiveMessage(java.lang.String receiveQueueName)
          指定したキューにメッセージが存在する場合、メッセージを取得します。
 java.lang.String request(java.lang.String text, java.lang.String requestQueueName, java.lang.String responseQueueName)
          指定したキューに対して要求メッセージを送信します。
 javax.jms.Message requestAsync(java.lang.String text, java.lang.String requestQueueName, java.lang.String responseQueueName)
          指定したキューに対して要求メッセージを送信します。
 javax.jms.Message send(java.lang.String text, java.lang.String toQueueName)
          メッセージを指定したキューへ送信します。
 javax.jms.Message sendResponseOf(javax.jms.Message requestMessage, java.lang.String text)
          指定した要求メッセージに対する応答メッセージを送信します。
 void setSenderId(java.lang.String id)
          送信者を表す識別子を設定します。
 void setSleepingInterval(int value)
          要求メッセージに対する応答メッセージを待ち受ける際に、到着確認する間隔をミリ秒単位で指定します。
 void setTimeOutLength(int value)
          要求メッセージに対する応答メッセージを待ち受ける際に、タイムアウトとする時間をミリ秒単位で指定します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

QueueManager

public QueueManager()
JMS(Java Message Service)によるメッセージ通信を支援するクラスを生成します。

メソッドの詳細

send

public javax.jms.Message send(java.lang.String text,
                              java.lang.String toQueueName)
                       throws javax.jms.JMSException,
                              javax.naming.NamingException
メッセージを指定したキューへ送信します。

パラメータ:
text - 送信するメッセージ
toQueueName - 送信先のキューの名称(JNDIで宣言された名称)
戻り値:
送信したMessage
例外:
javax.jms.JMSException
javax.naming.NamingException

sendResponseOf

public javax.jms.Message sendResponseOf(javax.jms.Message requestMessage,
                                        java.lang.String text)
                                 throws javax.jms.JMSException,
                                        javax.naming.NamingException,
                                        PpsMessagingException
指定した要求メッセージに対する応答メッセージを送信します。

パラメータ:
requestMessage - 要求メッセージ(この要求メッセージに対する応答メッセージを生成します)
text - 送信する応答メッセージ
戻り値:
送信した応答メッセージ
例外:
javax.jms.JMSException
javax.naming.NamingException
PpsMessagingException

request

public java.lang.String request(java.lang.String text,
                                java.lang.String requestQueueName,
                                java.lang.String responseQueueName)
                         throws PpsMessagingException,
                                javax.jms.JMSException,
                                javax.naming.NamingException
インタフェース MessageManager の記述:
指定したキューに対して要求メッセージを送信します。
また要求メッセージに対する応答メッセージを受け取るまで待機します(同期処理)。

定義:
インタフェース MessageManager 内の request
パラメータ:
text - 送信するメッセージ
requestQueueName - 要求メッセージを送るキューの名称(JNDIで宣言された名称)
responseQueueName - 応答メッセージを受け取るキューの名称(JNDIで宣言された名称)
戻り値:
応答メッセージ
例外:
PpsMessagingException
javax.jms.JMSException
javax.naming.NamingException

requestAsync

public javax.jms.Message requestAsync(java.lang.String text,
                                      java.lang.String requestQueueName,
                                      java.lang.String responseQueueName)
                               throws java.lang.Exception
指定したキューに対して要求メッセージを送信します。
要求メッセージを送信するとすぐにメソッドは終了します(非同期処理)。
応答メッセージを受信するには、別途メッセージを受け付ける必要があります。

パラメータ:
text - 送信するメッセージ
requestQueueName - 送信先のキューの名称(JNDIで宣言された名称)
responseQueueName - 応答メッセージを受け取るキューの名称(JNDIで宣言された名称)
戻り値:
応答メッセージ
例外:
java.lang.Exception

connect

public void connect()
インタフェース MessageManager の記述:
メッセージブローカへ接続します。

定義:
インタフェース MessageManager 内の connect

disconnect

public void disconnect()
インタフェース MessageManager の記述:
メッセージブローカから切断します。

定義:
インタフェース MessageManager 内の disconnect

isConnected

public boolean isConnected()
インタフェース MessageManager の記述:
メッセージブローカと接続されているかどうかを取得します。

定義:
インタフェース MessageManager 内の isConnected

setSenderId

public void setSenderId(java.lang.String id)
インタフェース MessageManager の記述:
送信者を表す識別子を設定します。

定義:
インタフェース MessageManager 内の setSenderId

getSenderId

public java.lang.String getSenderId()
インタフェース MessageManager の記述:
送信者を表す識別子を取得します。

定義:
インタフェース MessageManager 内の getSenderId

getConnection

public javax.jms.QueueConnection getConnection()
メッセージブローカとの接続を表すQueueConnectionを取得します

戻り値:
QueueConnection

receiveMessage

public java.lang.String receiveMessage(java.lang.String receiveQueueName)
                                throws javax.jms.JMSException,
                                       javax.naming.NamingException,
                                       PpsMessagingException
インタフェース MessageManager の記述:
指定したキューにメッセージが存在する場合、メッセージを取得します。

定義:
インタフェース MessageManager 内の receiveMessage
パラメータ:
receiveQueueName - メッセージを確認するキュー(JNDIで宣言された名称)
戻り値:
受信したメッセージ
例外:
javax.jms.JMSException
javax.naming.NamingException
PpsMessagingException

getQueue

public javax.jms.Queue getQueue(java.lang.String queueName)
                         throws javax.naming.NamingException
指定した名前のキューを取得します

パラメータ:
queueName - キューの名称(JNDIで宣言された名称)
戻り値:
Queue
例外:
javax.naming.NamingException

createQueueSession

public javax.jms.QueueSession createQueueSession()
                                          throws javax.jms.JMSException
キューセッションを生成します。
このメソッドで生成したキューセッションの使用を終了するときは、closeメソッドを呼び出す必要があります。

戻り値:
QueueSession
例外:
javax.jms.JMSException

getSleepingInterval

public int getSleepingInterval()
要求メッセージに対する応答メッセージを待ち受ける際に、到着確認する間隔をミリ秒単位で取得します。


setSleepingInterval

public void setSleepingInterval(int value)
                         throws PpsMessagingException
要求メッセージに対する応答メッセージを待ち受ける際に、到着確認する間隔をミリ秒単位で指定します。
既定値は、100ミリ秒です。
設定値は、getTimeOutLength()の値より小さい値である必要があります。

パラメータ:
value - 時間(ミリ秒単位)
例外:
PpsMessagingException

getTimeOutLength

public int getTimeOutLength()
インタフェース MessageManager の記述:
要求メッセージに対する応答メッセージを待ち受ける際に、タイムアウトとする時間をミリ秒単位で取得します。

定義:
インタフェース MessageManager 内の getTimeOutLength

setTimeOutLength

public void setTimeOutLength(int value)
インタフェース MessageManager の記述:
要求メッセージに対する応答メッセージを待ち受ける際に、タイムアウトとする時間をミリ秒単位で指定します。
既定値は、3000ミリ秒です。

定義:
インタフェース MessageManager 内の setTimeOutLength
パラメータ:
value - 時間(ミリ秒単位)